diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 9823831..9f02b5b 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -17,7 +17,7 @@ jobs: echo RUNNING GENERATE 2, npm run generate ls - cat dist/api.json + cat src/api.json - uses: adasq/dropbox-v2-api-watcher@v0.3 env: TOKEN: ${{ secrets.TOKEN }} diff --git a/.github/workflows/npmpublish.yml b/.github/workflows/npmpublish.yml index c94903e..11f52d1 100644 --- a/.github/workflows/npmpublish.yml +++ b/.github/workflows/npmpublish.yml @@ -5,8 +5,6 @@ on: push: branches: - master - paths: - - 'dist/*.json' jobs: build: diff --git a/.gitignore b/.gitignore index 3306a22..afabbf3 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ example/credentials.json .DS_Store examples.out config.json -.idea/ \ No newline at end of file +.idea/ +dist/ \ No newline at end of file diff --git a/.npmignore b/.npmignore index c3caad3..5f63724 100644 --- a/.npmignore +++ b/.npmignore @@ -1,2 +1,3 @@ config.json -example \ No newline at end of file +example +test \ No newline at end of file diff --git a/README.md b/README.md index ea35174..dec323e 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ The API is generated programmatically, based on [endpoints description JSON][api.json] fetched from [official docs][docs]. -[api.json]: +[api.json]: ## Why this package? - Always **up-to-date API** (PRs with changes are generated automatically, [see most recent][change-detection-pr]) diff --git a/dist/api.json b/dist/api.json deleted file mode 100644 index 15b32a7..0000000 --- a/dist/api.json +++ /dev/null @@ -1,92776 +0,0 @@ -{ - "account/set_profile_photo": { - "key": "account/set_profile_photo", - "name": "set_profile_photo", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "account_info.write", - "description": "Sets a user's profile photo.", - "request": { - "name": "SetProfilePhotoArg", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoSourceArg", - "type": [ - { - "name": "base64_data", - "type": "String", - "description": "Image data in base64-encoded bytes." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Image to set as the user's new profile photo." - } - ], - "example": [ - { - "value": { - "photo": { - ".tag": "base64_data", - "base64_data": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SetProfilePhotoResult", - "type": [ - { - "name": "profile_photo_url", - "type": "String", - "description": "URL for the photo representing the user, if one is set." - } - ], - "example": [ - { - "value": { - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "SetProfilePhotoError", - "type": [ - { - "name": "file_type_error", - "type": "Void", - "description": "File cannot be set as profile photo." - }, - { - "name": "file_size_error", - "type": "Void", - "description": "File cannot exceed 10 MB." - }, - { - "name": "dimension_error", - "type": "Void", - "description": "Image must be larger than 128 x 128." - }, - { - "name": "thumbnail_error", - "type": "Void", - "description": "Image could not be thumbnailed." - }, - { - "name": "transient_error", - "type": "Void", - "description": "Temporary infrastructure failure, please retry." - } - ], - "example": [ - { - "value": { - ".tag": "file_type_error" - }, - "text": null, - "label": "file_type_error" - }, - { - "value": { - ".tag": "file_size_error" - }, - "text": null, - "label": "file_size_error" - }, - { - "value": { - ".tag": "dimension_error" - }, - "text": null, - "label": "dimension_error" - }, - { - "value": { - ".tag": "thumbnail_error" - }, - "text": null, - "label": "thumbnail_error" - }, - { - "value": { - ".tag": "transient_error" - }, - "text": null, - "label": "transient_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "auth/token/from_oauth1": { - "key": "auth/token/from_oauth1", - "name": "token/from_oauth1", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "app", - "description": "Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access token.", - "allowAppFolderApp": true, - "request": { - "name": "TokenFromOAuth1Arg", - "type": [ - { - "name": "oauth1_token", - "type": "String(min_length=1)", - "description": "The supplied OAuth 1.0 access token." - }, - { - "name": "oauth1_token_secret", - "type": "String(min_length=1)", - "description": "The token secret associated with the supplied access token." - } - ], - "example": [ - { - "value": { - "oauth1_token": "qievr8hamyg6ndck", - "oauth1_token_secret": "qomoftv0472git7" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "TokenFromOAuth1Result", - "type": [ - { - "name": "oauth2_token", - "type": "String(min_length=1)", - "description": "The OAuth 2.0 token generated from the supplied OAuth 1.0 token." - } - ], - "example": [ - { - "value": { - "oauth2_token": "9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "TokenFromOAuth1Error", - "type": [ - { - "name": "invalid_oauth1_token_info", - "type": "Void", - "description": "Part or all of the OAuth 1.0 access token info is invalid." - }, - { - "name": "app_id_mismatch", - "type": "Void", - "description": "The authorized app does not match the app associated with the supplied access token." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_oauth1_token_info" - }, - "text": null, - "label": "invalid_oauth1_token_info" - }, - { - "value": { - ".tag": "app_id_mismatch" - }, - "text": null, - "label": "app_id_mismatch" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "auth/token/revoke": { - "key": "auth/token/revoke", - "name": "token/revoke", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "description": "Disables the access token used to authenticate the call. If there is a corresponding refresh token for the access token, this disables that refresh token, as well as any other access tokens for that refresh token.", - "allowAppFolderApp": true - }, - "check/app": { - "key": "check/app", - "name": "app", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "app", - "description": "This endpoint performs App Authentication, validating the supplied app key and secret, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the app key and secret valid.", - "isPreview": true, - "allowAppFolderApp": true, - "request": { - "name": "EchoArg", - "type": [ - { - "name": "query", - "type": "String(max_length=500)", - "description": "The string that you'd like to be echoed back to you. The default for this field is \"\"." - } - ], - "example": [ - { - "value": { - "query": "foo" - }, - "text": null, - "label": "default" - } - ], - "description": "EchoArg contains the arguments to be sent to the Dropbox servers.", - "typeWrap": "" - }, - "response": { - "name": "EchoResult", - "type": [ - { - "name": "result", - "type": "String", - "description": "If everything worked correctly, this would be the same as query. The default for this field is \"\"." - } - ], - "example": [ - { - "value": { - "result": "foo" - }, - "text": null, - "label": "default" - } - ], - "description": "EchoResult contains the result returned from the Dropbox servers.", - "typeWrap": "" - } - }, - "check/user": { - "key": "check/user", - "name": "user", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "account_info.read", - "description": "This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the access token is valid.", - "isPreview": true, - "allowAppFolderApp": true, - "request": { - "name": "EchoArg", - "type": [ - { - "name": "query", - "type": "String(max_length=500)", - "description": "The string that you'd like to be echoed back to you. The default for this field is \"\"." - } - ], - "example": [ - { - "value": { - "query": "foo" - }, - "text": null, - "label": "default" - } - ], - "description": "EchoArg contains the arguments to be sent to the Dropbox servers.", - "typeWrap": "" - }, - "response": { - "name": "EchoResult", - "type": [ - { - "name": "result", - "type": "String", - "description": "If everything worked correctly, this would be the same as query. The default for this field is \"\"." - } - ], - "example": [ - { - "value": { - "result": "foo" - }, - "text": null, - "label": "default" - } - ], - "description": "EchoResult contains the result returned from the Dropbox servers.", - "typeWrap": "" - } - }, - "contacts/delete_manual_contacts": { - "key": "contacts/delete_manual_contacts", - "name": "delete_manual_contacts", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "contacts.write", - "description": "Removes all manually added contacts. You'll still keep contacts who are on your team or who you imported. New contacts will be added when you share." - }, - "contacts/delete_manual_contacts_batch": { - "key": "contacts/delete_manual_contacts_batch", - "name": "delete_manual_contacts_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "contacts.write", - "description": "Removes manually added contacts from the given list.", - "request": { - "name": "DeleteManualContactsArg", - "type": [ - { - "name": "email_addresses", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "List of manually added contacts to be deleted.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "email_addresses": [ - "contactemailaddress1@domain.com", - "contactemailaddress2@domain.com" - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "DeleteManualContactsError", - "type": [ - { - "name": "contacts_not_found", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Can't delete contacts from this list. Make sure the list only has manually added contacts. The deletion was cancelled.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "file_properties/properties/add": { - "key": "file_properties/properties/add", - "name": "properties/add", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "description": "Add property groups to a Dropbox file. See :route:`templates/add_for_user` or :route:`templates/add_for_team` to create new templates.", - "request": { - "name": "AddPropertiesArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file or folder." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "typeWrap": "" - } - ], - "description": "The property groups which are to be added to a Dropbox file. No two groups in the input should refer to the same template.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "AddPropertiesError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - }, - { - "name": "property_group_already_exists", - "type": "Void", - "description": "A property group associated with this template and file already exists." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "unsupported_folder" - }, - "text": null, - "label": "unsupported_folder" - }, - { - "value": { - ".tag": "property_field_too_large" - }, - "text": null, - "label": "property_field_too_large" - }, - { - "value": { - ".tag": "does_not_fit_template" - }, - "text": null, - "label": "does_not_fit_template" - }, - { - "value": { - ".tag": "duplicate_property_groups" - }, - "text": null, - "label": "duplicate_property_groups" - }, - { - "value": { - ".tag": "property_group_already_exists" - }, - "text": null, - "label": "property_group_already_exists" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "file_properties/properties/overwrite": { - "key": "file_properties/properties/overwrite", - "name": "properties/overwrite", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "description": "Overwrite property groups associated with a file. This endpoint should be used instead of :route:`properties/update` when property groups are being updated via a \"snapshot\" instead of via a \"delta\". In other words, this endpoint will delete all omitted fields from a property group, whereas :route:`properties/update` will only delete fields that are explicitly marked for deletion.", - "request": { - "name": "OverwritePropertyGroupArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file or folder." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "typeWrap": "" - } - ], - "description": "The property groups \"snapshot\" updates to force apply. No two groups in the input should refer to the same template.", - "typeWrap": "List of ({}, min_items=1)" - } - ], - "example": [ - { - "value": { - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "InvalidPropertyGroupError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "unsupported_folder" - }, - "text": null, - "label": "unsupported_folder" - }, - { - "value": { - ".tag": "property_field_too_large" - }, - "text": null, - "label": "property_field_too_large" - }, - { - "value": { - ".tag": "does_not_fit_template" - }, - "text": null, - "label": "does_not_fit_template" - }, - { - "value": { - ".tag": "duplicate_property_groups" - }, - "text": null, - "label": "duplicate_property_groups" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "file_properties/properties/remove": { - "key": "file_properties/properties/remove", - "name": "properties/remove", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "description": "Permanently removes the specified property group from the file. To remove specific property field key value pairs, see :route:`properties/update`. To update a template, see :route:`templates/update_for_user` or :route:`templates/update_for_team`. To remove a template, see :route:`templates/remove_for_user` or :route:`templates/remove_for_team`.", - "request": { - "name": "RemovePropertiesArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file or folder." - }, - { - "name": "property_template_ids", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A list of identifiers for a template created by :route:`templates/add_for_user` or :route:`templates/add_for_team`.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "path": "/my_awesome/word.docx", - "property_template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "RemovePropertiesError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_group_lookup", - "type": [ - { - "name": "LookUpPropertiesError", - "type": [ - { - "name": "property_group_not_found", - "type": "Void", - "description": "No property group was found." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "unsupported_folder" - }, - "text": null, - "label": "unsupported_folder" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "file_properties/properties/search": { - "key": "file_properties/properties/search", - "name": "properties/search", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Search across property templates for particular property field values.", - "request": { - "name": "PropertiesSearchArg", - "type": [ - { - "name": "queries", - "type": [ - { - "name": "PropertiesSearchQuery", - "type": [ - { - "name": "query", - "type": "String", - "description": "The property field value for which to search across templates." - }, - { - "name": "mode", - "type": [ - { - "name": "PropertiesSearchMode", - "type": [ - { - "name": "field_name", - "type": "String", - "description": "Search for a value associated with this field name." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The mode with which to perform the search." - }, - { - "name": "logical_operator", - "type": [ - { - "name": "LogicalOperator", - "type": [ - { - "name": "or_operator", - "type": "Void", - "description": "Append a query with an \"or\" operator." - } - ], - "description": "Logical operator to join search queries together.", - "typeWrap": "{} (open union)" - } - ], - "description": "The logical operator with which to append the query. The default for this union is or_operator." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Queries to search.", - "typeWrap": "List of ({}, min_items=1)" - }, - { - "name": "template_filter", - "type": [ - { - "name": "TemplateFilter", - "type": [ - { - "name": "filter_some", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).", - "typeWrap": "List of ({}, min_items=1)" - }, - { - "name": "filter_none", - "type": "Void", - "description": "No templates will be filtered from the result (all templates will be returned)." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Filter results to contain only properties associated with these template IDs. The default for this union is filter_none." - } - ], - "example": [ - { - "value": { - "queries": [ - { - "query": "Confidential", - "mode": { - ".tag": "field_name", - "field_name": "Security" - }, - "logical_operator": "or_operator" - } - ], - "template_filter": "filter_none" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "PropertiesSearchResult", - "type": [ - { - "name": "matches", - "type": [ - { - "name": "PropertiesSearchMatch", - "type": [ - { - "name": "id", - "type": "String(min_length=1)", - "description": "The ID for the matched file or folder." - }, - { - "name": "path", - "type": "String", - "description": "The path for the matched file or folder." - }, - { - "name": "is_deleted", - "type": "Boolean", - "description": "Whether the file or folder is deleted." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "typeWrap": "" - } - ], - "description": "List of custom property groups associated with the file.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list (possibly empty) of matches for the query.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "Pass the cursor into :route:`properties/search/continue` to continue to receive search results. Cursor will be null when there are no more results. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "matches": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path": "/my_awesome/word.docx", - "is_deleted": false, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "PropertiesSearchError", - "type": [ - { - "name": "property_group_lookup", - "type": [ - { - "name": "LookUpPropertiesError", - "type": [ - { - "name": "property_group_not_found", - "type": "Void", - "description": "No property group was found." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "file_properties/properties/search/continue": { - "key": "file_properties/properties/search/continue", - "name": "properties/search/continue", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Once a cursor has been retrieved from :route:`properties/search`, use this to paginate through all search results.", - "request": { - "name": "PropertiesSearchContinueArg", - "type": [ - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "The cursor returned by your last call to :route:`properties/search` or :route:`properties/search/continue`." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "PropertiesSearchResult", - "type": [ - { - "name": "matches", - "type": [ - { - "name": "PropertiesSearchMatch", - "type": [ - { - "name": "id", - "type": "String(min_length=1)", - "description": "The ID for the matched file or folder." - }, - { - "name": "path", - "type": "String", - "description": "The path for the matched file or folder." - }, - { - "name": "is_deleted", - "type": "Boolean", - "description": "Whether the file or folder is deleted." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "typeWrap": "" - } - ], - "description": "List of custom property groups associated with the file.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list (possibly empty) of matches for the query.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "Pass the cursor into :route:`properties/search/continue` to continue to receive search results. Cursor will be null when there are no more results. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "matches": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path": "/my_awesome/word.docx", - "is_deleted": false, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "PropertiesSearchContinueError", - "type": [ - { - "name": "reset", - "type": "Void", - "description": "Indicates that the cursor has been invalidated. Call :route:`properties/search` to obtain a new cursor." - } - ], - "example": [ - { - "value": { - ".tag": "reset" - }, - "text": null, - "label": "reset" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "file_properties/properties/update": { - "key": "file_properties/properties/update", - "name": "properties/update", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "description": "Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of :route:`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 :route:`properties/overwrite` will delete any fields that are omitted from a property group.", - "request": { - "name": "UpdatePropertiesArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file or folder." - }, - { - "name": "update_property_groups", - "type": [ - { - "name": "PropertyGroupUpdate", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for a property template." - }, - { - "name": "add_or_update_fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "typeWrap": "" - } - ], - "description": "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.", - "typeWrap": "List of ({})?" - }, - { - "name": "remove_fields", - "type": "String", - "description": "Property fields to remove (by name), provided they exist. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The property groups \"delta\" updates to apply.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "path": "/my_awesome/word.docx", - "update_property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "add_or_update_fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "remove_fields": [] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "UpdatePropertiesError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - }, - { - "name": "property_group_lookup", - "type": [ - { - "name": "LookUpPropertiesError", - "type": [ - { - "name": "property_group_not_found", - "type": "Void", - "description": "No property group was found." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "unsupported_folder" - }, - "text": null, - "label": "unsupported_folder" - }, - { - "value": { - ".tag": "property_field_too_large" - }, - "text": null, - "label": "property_field_too_large" - }, - { - "value": { - ".tag": "does_not_fit_template" - }, - "text": null, - "label": "does_not_fit_template" - }, - { - "value": { - ".tag": "duplicate_property_groups" - }, - "text": null, - "label": "duplicate_property_groups" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "file_properties/templates/add_for_user": { - "key": "file_properties/templates/add_for_user", - "name": "templates/add_for_user", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "description": "Add a template associated with a user. See :route:`properties/add` to add properties to a file. This endpoint can't be called on a team member or admin's behalf.", - "request": { - "name": "AddTemplateArg", - "type": [ - { - "name": "name", - "type": "String", - "description": "Display name for the template. Template names can be up to 256 bytes." - }, - { - "name": "description", - "type": "String", - "description": "Description for the template. Template descriptions can be up to 1024 bytes." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyFieldTemplate", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field being described. Property field keys can be up to 256 bytes." - }, - { - "name": "description", - "type": "String", - "description": "Description of the property field. Property field descriptions can be up to 1024 bytes." - }, - { - "name": "type", - "type": [ - { - "name": "PropertyType", - "type": [ - { - "name": "string", - "type": "Void", - "description": "The associated property field will be of type string. Unicode is supported." - } - ], - "description": "Data type of the given property field added.", - "typeWrap": "{} (open union)" - } - ], - "description": "Data type of the value of this property field. This type will be enforced upon property creation and modifications." - } - ], - "description": "Defines how a single property field may be structured. Used exclusively by :type:`PropertyGroupTemplate`.", - "typeWrap": "" - } - ], - "description": "Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "name": "Security", - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "name": "Security Policy", - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "type": "string" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "AddTemplateResult", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "An identifier for template added by See :route:`templates/add_for_user` or :route:`templates/add_for_team`." - } - ], - "example": [ - { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ModifyTemplateError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "conflicting_property_names", - "type": "Void", - "description": "A property field key with that name already exists in the template." - }, - { - "name": "too_many_properties", - "type": "Void", - "description": "There are too many properties in the changed template. The maximum number of properties per template is 32." - }, - { - "name": "too_many_templates", - "type": "Void", - "description": "There are too many templates for the team." - }, - { - "name": "template_attribute_too_large", - "type": "Void", - "description": "The template name, description or one or more of the property field keys is too large." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "conflicting_property_names" - }, - "text": null, - "label": "conflicting_property_names" - }, - { - "value": { - ".tag": "too_many_properties" - }, - "text": null, - "label": "too_many_properties" - }, - { - "value": { - ".tag": "too_many_templates" - }, - "text": null, - "label": "too_many_templates" - }, - { - "value": { - ".tag": "template_attribute_too_large" - }, - "text": null, - "label": "template_attribute_too_large" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "file_properties/templates/get_for_user": { - "key": "file_properties/templates/get_for_user", - "name": "templates/get_for_user", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Get the schema for a specified template. This endpoint can't be called on a team member or admin's behalf.", - "request": { - "name": "GetTemplateArg", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "An identifier for template added by route See :route:`templates/add_for_user` or :route:`templates/add_for_team`." - } - ], - "example": [ - { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "GetTemplateResult", - "type": [ - { - "name": "name", - "type": "String", - "description": "Display name for the template. Template names can be up to 256 bytes." - }, - { - "name": "description", - "type": "String", - "description": "Description for the template. Template descriptions can be up to 1024 bytes." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyFieldTemplate", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field being described. Property field keys can be up to 256 bytes." - }, - { - "name": "description", - "type": "String", - "description": "Description of the property field. Property field descriptions can be up to 1024 bytes." - }, - { - "name": "type", - "type": [ - { - "name": "PropertyType", - "type": [ - { - "name": "string", - "type": "Void", - "description": "The associated property field will be of type string. Unicode is supported." - } - ], - "description": "Data type of the given property field added.", - "typeWrap": "{} (open union)" - } - ], - "description": "Data type of the value of this property field. This type will be enforced upon property creation and modifications." - } - ], - "description": "Defines how a single property field may be structured. Used exclusively by :type:`PropertyGroupTemplate`.", - "typeWrap": "" - } - ], - "description": "Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "name": "Security", - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "name": "Security Policy", - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "type": { - ".tag": "string" - } - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "TemplateError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "file_properties/templates/list_for_user": { - "key": "file_properties/templates/list_for_user", - "name": "templates/list_for_user", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Get the template identifiers for a team. To get the schema of each template use :route:`templates/get_for_user`. This endpoint can't be called on a team member or admin's behalf.", - "response": { - "name": "ListTemplateResult", - "type": [ - { - "name": "template_ids", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "List of identifiers for templates added by See :route:`templates/add_for_user` or :route:`templates/add_for_team`.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "TemplateError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "file_properties/templates/remove_for_user": { - "key": "file_properties/templates/remove_for_user", - "name": "templates/remove_for_user", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "description": "Permanently removes the specified template created from :route:`templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone.", - "request": { - "name": "RemoveTemplateArg", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "An identifier for a template created by :route:`templates/add_for_user` or :route:`templates/add_for_team`." - } - ], - "example": [ - { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "TemplateError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "file_properties/templates/update_for_user": { - "key": "file_properties/templates/update_for_user", - "name": "templates/update_for_user", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "description": "Update a template associated with a user. This route can update the template name, the template description and add optional properties to templates. This endpoint can't be called on a team member or admin's behalf.", - "request": { - "name": "UpdateTemplateArg", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "An identifier for template added by See :route:`templates/add_for_user` or :route:`templates/add_for_team`." - }, - { - "name": "name", - "type": "String", - "description": "A display name for the template. template names can be up to 256 bytes. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "Description for the new template. Template descriptions can be up to 1024 bytes. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "add_fields", - "type": [ - { - "name": "PropertyFieldTemplate", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field being described. Property field keys can be up to 256 bytes." - }, - { - "name": "description", - "type": "String", - "description": "Description of the property field. Property field descriptions can be up to 1024 bytes." - }, - { - "name": "type", - "type": [ - { - "name": "PropertyType", - "type": [ - { - "name": "string", - "type": "Void", - "description": "The associated property field will be of type string. Unicode is supported." - } - ], - "description": "Data type of the given property field added.", - "typeWrap": "{} (open union)" - } - ], - "description": "Data type of the value of this property field. This type will be enforced upon property creation and modifications." - } - ], - "description": "Defines how a single property field may be structured. Used exclusively by :type:`PropertyGroupTemplate`.", - "typeWrap": "" - } - ], - "description": "Property field templates to be added to the group template. There can be up to 32 properties in a single template. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "name": "New Security Template Name", - "description": "These properties will describe how confidential this file or folder is.", - "add_fields": [ - { - "name": "Security Policy", - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "type": "string" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "UpdateTemplateResult", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "An identifier for template added by route See :route:`templates/add_for_user` or :route:`templates/add_for_team`." - } - ], - "example": [ - { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ModifyTemplateError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "conflicting_property_names", - "type": "Void", - "description": "A property field key with that name already exists in the template." - }, - { - "name": "too_many_properties", - "type": "Void", - "description": "There are too many properties in the changed template. The maximum number of properties per template is 32." - }, - { - "name": "too_many_templates", - "type": "Void", - "description": "There are too many templates for the team." - }, - { - "name": "template_attribute_too_large", - "type": "Void", - "description": "The template name, description or one or more of the property field keys is too large." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "conflicting_property_names" - }, - "text": null, - "label": "conflicting_property_names" - }, - { - "value": { - ".tag": "too_many_properties" - }, - "text": null, - "label": "too_many_properties" - }, - { - "value": { - ".tag": "too_many_templates" - }, - "text": null, - "label": "too_many_templates" - }, - { - "value": { - ".tag": "template_attribute_too_large" - }, - "text": null, - "label": "template_attribute_too_large" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "file_requests/count": { - "key": "file_requests/count", - "name": "count", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "file_requests.read", - "description": "Returns the total number of file requests owned by this user. Includes both open and closed file requests.", - "allowAppFolderApp": true, - "response": { - "name": "CountFileRequestsResult", - "type": [ - { - "name": "file_request_count", - "type": "UInt64", - "description": "The number file requests owner by this user." - } - ], - "example": [ - { - "value": { - "file_request_count": 15 - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`count`.", - "typeWrap": "" - }, - "error": { - "name": "CountFileRequestsError", - "type": [ - { - "name": "disabled_for_team", - "type": "Void", - "description": "This user's Dropbox Business team doesn't allow file requests." - } - ], - "example": [ - { - "value": { - ".tag": "disabled_for_team" - }, - "text": null, - "label": "disabled_for_team" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "There was an error counting the file requests.", - "typeWrap": "{} (union)" - } - }, - "file_requests/create": { - "key": "file_requests/create", - "name": "create", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "file_requests.write", - "description": "Creates a file request for this user.", - "allowAppFolderApp": true, - "request": { - "name": "CreateFileRequestArgs", - "type": [ - { - "name": "title", - "type": "String(min_length=1)", - "description": "The title of the file request. Must not be empty." - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "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." - }, - { - "name": "deadline", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The deadline for the file request. Deadlines can only be set by Professional and Business accounts. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "open", - "type": "Boolean", - "description": "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." - }, - { - "name": "description", - "type": "String", - "description": "A description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "title": "Homework submission", - "destination": "/File Requests/Homework", - "deadline": { - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": "seven_days" - }, - "open": true - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`create`.", - "typeWrap": "" - }, - "response": { - "name": "FileRequest", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request." - }, - { - "name": "url", - "type": "String(min_length=1)", - "description": "The URL of the file request." - }, - { - "name": "title", - "type": "String(min_length=1)", - "description": "The title of the file request." - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "When this file request was created." - }, - { - "name": "is_open", - "type": "Boolean", - "description": "Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions." - }, - { - "name": "file_count", - "type": "Int64", - "description": "The number of files this file request has received." - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The path of the folder in the Dropbox where uploaded files will be sent. This can be :val:`null` if the destination was removed. For apps with the app folder permission, this will be relative to the app folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "deadline", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The deadline for this file request. Only set if the request has a deadline. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "A description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "id": "oaCAVmEyrqYnkZX9955Y", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y", - "title": "Homework submission", - "created": "2015-10-05T17:00:00Z", - "is_open": true, - "file_count": 3, - "destination": "/File Requests/Homework", - "deadline": { - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": { - ".tag": "seven_days" - } - }, - "description": "Please submit your homework here." - }, - "text": null, - "label": "default" - }, - { - "value": { - "id": "BAJ7IrRGicQKGToykQdB", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB", - "title": "Photo contest submission", - "created": "2015-11-02T04:00:00Z", - "is_open": true, - "file_count": 105, - "destination": "/Photo contest entries", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - } - }, - "text": null, - "label": "with_deadline" - }, - { - "value": { - "id": "rxwMPvK3ATTa0VxOJu5T", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T", - "title": "Wedding photo submission", - "created": "2015-12-15T13:02:00Z", - "is_open": true, - "file_count": 37, - "destination": "/Wedding photos" - }, - "text": null, - "label": "with_no_deadline" - } - ], - "description": "A :link:`file request https://www.dropbox.com/help/9090` for receiving files into the user's Dropbox account.", - "typeWrap": "" - }, - "error": { - "name": "CreateFileRequestError", - "type": [ - { - "name": "disabled_for_team", - "type": "Void", - "description": "This user's Dropbox Business team doesn't allow file requests." - }, - { - "name": "not_found", - "type": "Void", - "description": "This file request ID was not found." - }, - { - "name": "not_a_folder", - "type": "Void", - "description": "The specified path is not a folder." - }, - { - "name": "app_lacks_access", - "type": "Void", - "description": "This file request is not accessible to this app. Apps with the app folder permission can only access file requests in their app folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "This user doesn't have permission to access or modify this file request." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. File requests are only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "validation_error", - "type": "Void", - "description": "There was an error validating the request. For example, the title was invalid, or there were disallowed characters in the destination path." - }, - { - "name": "invalid_location", - "type": "Void", - "description": "File requests are not available on the specified folder." - }, - { - "name": "rate_limit", - "type": "Void", - "description": "The user has reached the rate limit for creating file requests. The limit is currently 4000 file requests total." - } - ], - "example": [ - { - "value": { - ".tag": "disabled_for_team" - }, - "text": null, - "label": "disabled_for_team" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "not_a_folder" - }, - "text": null, - "label": "not_a_folder" - }, - { - "value": { - ".tag": "app_lacks_access" - }, - "text": null, - "label": "app_lacks_access" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "validation_error" - }, - "text": null, - "label": "validation_error" - }, - { - "value": { - ".tag": "invalid_location" - }, - "text": null, - "label": "invalid_location" - }, - { - "value": { - ".tag": "rate_limit" - }, - "text": null, - "label": "rate_limit" - } - ], - "description": "There was an error creating the file request.", - "typeWrap": "{} (union)" - } - }, - "file_requests/delete": { - "key": "file_requests/delete", - "name": "delete", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "file_requests.write", - "description": "Delete a batch of closed file requests.", - "allowAppFolderApp": true, - "request": { - "name": "DeleteFileRequestArgs", - "type": [ - { - "name": "ids", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "List IDs of the file requests to delete.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "ids": [ - "oaCAVmEyrqYnkZX9955Y", - "BaZmehYoXMPtaRmfTbSG" - ] - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`delete`.", - "typeWrap": "" - }, - "response": { - "name": "DeleteFileRequestsResult", - "type": [ - { - "name": "file_requests", - "type": [ - { - "name": "FileRequest", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request." - }, - { - "name": "url", - "type": "String(min_length=1)", - "description": "The URL of the file request." - }, - { - "name": "title", - "type": "String(min_length=1)", - "description": "The title of the file request." - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "When this file request was created." - }, - { - "name": "is_open", - "type": "Boolean", - "description": "Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions." - }, - { - "name": "file_count", - "type": "Int64", - "description": "The number of files this file request has received." - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The path of the folder in the Dropbox where uploaded files will be sent. This can be :val:`null` if the destination was removed. For apps with the app folder permission, this will be relative to the app folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "deadline", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The deadline for this file request. Only set if the request has a deadline. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "A description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A :link:`file request https://www.dropbox.com/help/9090` for receiving files into the user's Dropbox account.", - "typeWrap": "" - } - ], - "description": "The file requests deleted by the request.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "file_requests": [ - { - "id": "oaCAVmEyrqYnkZX9955Y", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y", - "title": "Homework submission", - "created": "2015-10-05T17:00:00Z", - "is_open": true, - "file_count": 3, - "destination": "/File Requests/Homework", - "deadline": { - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": { - ".tag": "seven_days" - } - }, - "description": "Please submit your homework here." - }, - { - "id": "BAJ7IrRGicQKGToykQdB", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB", - "title": "Photo contest submission", - "created": "2015-11-02T04:00:00Z", - "is_open": true, - "file_count": 105, - "destination": "/Photo contest entries", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - } - }, - { - "id": "rxwMPvK3ATTa0VxOJu5T", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T", - "title": "Wedding photo submission", - "created": "2015-12-15T13:02:00Z", - "is_open": true, - "file_count": 37, - "destination": "/Wedding photos" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`delete`.", - "typeWrap": "" - }, - "error": { - "name": "DeleteFileRequestError", - "type": [ - { - "name": "disabled_for_team", - "type": "Void", - "description": "This user's Dropbox Business team doesn't allow file requests." - }, - { - "name": "not_found", - "type": "Void", - "description": "This file request ID was not found." - }, - { - "name": "not_a_folder", - "type": "Void", - "description": "The specified path is not a folder." - }, - { - "name": "app_lacks_access", - "type": "Void", - "description": "This file request is not accessible to this app. Apps with the app folder permission can only access file requests in their app folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "This user doesn't have permission to access or modify this file request." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. File requests are only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "validation_error", - "type": "Void", - "description": "There was an error validating the request. For example, the title was invalid, or there were disallowed characters in the destination path." - }, - { - "name": "file_request_open", - "type": "Void", - "description": "One or more file requests currently open." - } - ], - "example": [ - { - "value": { - ".tag": "disabled_for_team" - }, - "text": null, - "label": "disabled_for_team" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "not_a_folder" - }, - "text": null, - "label": "not_a_folder" - }, - { - "value": { - ".tag": "app_lacks_access" - }, - "text": null, - "label": "app_lacks_access" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "validation_error" - }, - "text": null, - "label": "validation_error" - }, - { - "value": { - ".tag": "file_request_open" - }, - "text": null, - "label": "file_request_open" - } - ], - "description": "There was an error deleting these file requests.", - "typeWrap": "{} (union)" - } - }, - "file_requests/delete_all_closed": { - "key": "file_requests/delete_all_closed", - "name": "delete_all_closed", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "file_requests.write", - "description": "Delete all closed file requests owned by this user.", - "allowAppFolderApp": true, - "response": { - "name": "DeleteAllClosedFileRequestsResult", - "type": [ - { - "name": "file_requests", - "type": [ - { - "name": "FileRequest", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request." - }, - { - "name": "url", - "type": "String(min_length=1)", - "description": "The URL of the file request." - }, - { - "name": "title", - "type": "String(min_length=1)", - "description": "The title of the file request." - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "When this file request was created." - }, - { - "name": "is_open", - "type": "Boolean", - "description": "Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions." - }, - { - "name": "file_count", - "type": "Int64", - "description": "The number of files this file request has received." - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The path of the folder in the Dropbox where uploaded files will be sent. This can be :val:`null` if the destination was removed. For apps with the app folder permission, this will be relative to the app folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "deadline", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The deadline for this file request. Only set if the request has a deadline. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "A description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A :link:`file request https://www.dropbox.com/help/9090` for receiving files into the user's Dropbox account.", - "typeWrap": "" - } - ], - "description": "The file requests deleted for this user.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "file_requests": [ - { - "id": "oaCAVmEyrqYnkZX9955Y", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y", - "title": "Homework submission", - "created": "2015-10-05T17:00:00Z", - "is_open": true, - "file_count": 3, - "destination": "/File Requests/Homework", - "deadline": { - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": { - ".tag": "seven_days" - } - }, - "description": "Please submit your homework here." - }, - { - "id": "BAJ7IrRGicQKGToykQdB", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB", - "title": "Photo contest submission", - "created": "2015-11-02T04:00:00Z", - "is_open": true, - "file_count": 105, - "destination": "/Photo contest entries", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - } - }, - { - "id": "rxwMPvK3ATTa0VxOJu5T", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T", - "title": "Wedding photo submission", - "created": "2015-12-15T13:02:00Z", - "is_open": true, - "file_count": 37, - "destination": "/Wedding photos" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`delete_all_closed`.", - "typeWrap": "" - }, - "error": { - "name": "DeleteAllClosedFileRequestsError", - "type": [ - { - "name": "disabled_for_team", - "type": "Void", - "description": "This user's Dropbox Business team doesn't allow file requests." - }, - { - "name": "not_found", - "type": "Void", - "description": "This file request ID was not found." - }, - { - "name": "not_a_folder", - "type": "Void", - "description": "The specified path is not a folder." - }, - { - "name": "app_lacks_access", - "type": "Void", - "description": "This file request is not accessible to this app. Apps with the app folder permission can only access file requests in their app folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "This user doesn't have permission to access or modify this file request." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. File requests are only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "validation_error", - "type": "Void", - "description": "There was an error validating the request. For example, the title was invalid, or there were disallowed characters in the destination path." - } - ], - "example": [ - { - "value": { - ".tag": "disabled_for_team" - }, - "text": null, - "label": "disabled_for_team" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "not_a_folder" - }, - "text": null, - "label": "not_a_folder" - }, - { - "value": { - ".tag": "app_lacks_access" - }, - "text": null, - "label": "app_lacks_access" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "validation_error" - }, - "text": null, - "label": "validation_error" - } - ], - "description": "There was an error deleting all closed file requests.", - "typeWrap": "{} (union)" - } - }, - "file_requests/get": { - "key": "file_requests/get", - "name": "get", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "file_requests.read", - "description": "Returns the specified file request.", - "allowAppFolderApp": true, - "request": { - "name": "GetFileRequestArgs", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request to retrieve." - } - ], - "example": [ - { - "value": { - "id": "oaCAVmEyrqYnkZX9955Y" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`get`.", - "typeWrap": "" - }, - "response": { - "name": "FileRequest", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request." - }, - { - "name": "url", - "type": "String(min_length=1)", - "description": "The URL of the file request." - }, - { - "name": "title", - "type": "String(min_length=1)", - "description": "The title of the file request." - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "When this file request was created." - }, - { - "name": "is_open", - "type": "Boolean", - "description": "Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions." - }, - { - "name": "file_count", - "type": "Int64", - "description": "The number of files this file request has received." - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The path of the folder in the Dropbox where uploaded files will be sent. This can be :val:`null` if the destination was removed. For apps with the app folder permission, this will be relative to the app folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "deadline", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The deadline for this file request. Only set if the request has a deadline. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "A description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "id": "oaCAVmEyrqYnkZX9955Y", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y", - "title": "Homework submission", - "created": "2015-10-05T17:00:00Z", - "is_open": true, - "file_count": 3, - "destination": "/File Requests/Homework", - "deadline": { - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": { - ".tag": "seven_days" - } - }, - "description": "Please submit your homework here." - }, - "text": null, - "label": "default" - }, - { - "value": { - "id": "BAJ7IrRGicQKGToykQdB", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB", - "title": "Photo contest submission", - "created": "2015-11-02T04:00:00Z", - "is_open": true, - "file_count": 105, - "destination": "/Photo contest entries", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - } - }, - "text": null, - "label": "with_deadline" - }, - { - "value": { - "id": "rxwMPvK3ATTa0VxOJu5T", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T", - "title": "Wedding photo submission", - "created": "2015-12-15T13:02:00Z", - "is_open": true, - "file_count": 37, - "destination": "/Wedding photos" - }, - "text": null, - "label": "with_no_deadline" - } - ], - "description": "A :link:`file request https://www.dropbox.com/help/9090` for receiving files into the user's Dropbox account.", - "typeWrap": "" - }, - "error": { - "name": "GetFileRequestError", - "type": [ - { - "name": "disabled_for_team", - "type": "Void", - "description": "This user's Dropbox Business team doesn't allow file requests." - }, - { - "name": "not_found", - "type": "Void", - "description": "This file request ID was not found." - }, - { - "name": "not_a_folder", - "type": "Void", - "description": "The specified path is not a folder." - }, - { - "name": "app_lacks_access", - "type": "Void", - "description": "This file request is not accessible to this app. Apps with the app folder permission can only access file requests in their app folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "This user doesn't have permission to access or modify this file request." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. File requests are only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "validation_error", - "type": "Void", - "description": "There was an error validating the request. For example, the title was invalid, or there were disallowed characters in the destination path." - } - ], - "example": [ - { - "value": { - ".tag": "disabled_for_team" - }, - "text": null, - "label": "disabled_for_team" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "not_a_folder" - }, - "text": null, - "label": "not_a_folder" - }, - { - "value": { - ".tag": "app_lacks_access" - }, - "text": null, - "label": "app_lacks_access" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "validation_error" - }, - "text": null, - "label": "validation_error" - } - ], - "description": "There was an error retrieving the specified file request.", - "typeWrap": "{} (union)" - } - }, - "file_requests/list": { - "key": "file_requests/list", - "name": "list", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "file_requests.read", - "description": "Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.", - "allowAppFolderApp": true, - "response": { - "name": "ListFileRequestsResult", - "type": [ - { - "name": "file_requests", - "type": [ - { - "name": "FileRequest", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request." - }, - { - "name": "url", - "type": "String(min_length=1)", - "description": "The URL of the file request." - }, - { - "name": "title", - "type": "String(min_length=1)", - "description": "The title of the file request." - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "When this file request was created." - }, - { - "name": "is_open", - "type": "Boolean", - "description": "Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions." - }, - { - "name": "file_count", - "type": "Int64", - "description": "The number of files this file request has received." - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The path of the folder in the Dropbox where uploaded files will be sent. This can be :val:`null` if the destination was removed. For apps with the app folder permission, this will be relative to the app folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "deadline", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The deadline for this file request. Only set if the request has a deadline. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "A description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A :link:`file request https://www.dropbox.com/help/9090` for receiving files into the user's Dropbox account.", - "typeWrap": "" - } - ], - "description": "The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "file_requests": [ - { - "id": "oaCAVmEyrqYnkZX9955Y", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y", - "title": "Homework submission", - "created": "2015-10-05T17:00:00Z", - "is_open": true, - "file_count": 3, - "destination": "/File Requests/Homework", - "deadline": { - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": { - ".tag": "seven_days" - } - }, - "description": "Please submit your homework here." - }, - { - "id": "BAJ7IrRGicQKGToykQdB", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB", - "title": "Photo contest submission", - "created": "2015-11-02T04:00:00Z", - "is_open": true, - "file_count": 105, - "destination": "/Photo contest entries", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - } - }, - { - "id": "rxwMPvK3ATTa0VxOJu5T", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T", - "title": "Wedding photo submission", - "created": "2015-12-15T13:02:00Z", - "is_open": true, - "file_count": 37, - "destination": "/Wedding photos" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`list`.", - "typeWrap": "" - }, - "error": { - "name": "ListFileRequestsError", - "type": [ - { - "name": "disabled_for_team", - "type": "Void", - "description": "This user's Dropbox Business team doesn't allow file requests." - } - ], - "example": [ - { - "value": { - ".tag": "disabled_for_team" - }, - "text": null, - "label": "disabled_for_team" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "There was an error retrieving the file requests.", - "typeWrap": "{} (union)" - } - }, - "file_requests/list_v2": { - "key": "file_requests/list_v2", - "name": "list", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "file_requests.read", - "description": "Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.", - "isPreview": true, - "allowAppFolderApp": true, - "request": { - "name": "ListFileRequestsArg", - "type": [ - { - "name": "limit", - "type": "UInt64", - "description": "The maximum number of file requests that should be returned per request. The default for this field is 1000." - } - ], - "example": [ - { - "value": { - "limit": 1000 - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`list:2`.", - "typeWrap": "" - }, - "response": { - "name": "ListFileRequestsV2Result", - "type": [ - { - "name": "file_requests", - "type": [ - { - "name": "FileRequest", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request." - }, - { - "name": "url", - "type": "String(min_length=1)", - "description": "The URL of the file request." - }, - { - "name": "title", - "type": "String(min_length=1)", - "description": "The title of the file request." - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "When this file request was created." - }, - { - "name": "is_open", - "type": "Boolean", - "description": "Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions." - }, - { - "name": "file_count", - "type": "Int64", - "description": "The number of files this file request has received." - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The path of the folder in the Dropbox where uploaded files will be sent. This can be :val:`null` if the destination was removed. For apps with the app folder permission, this will be relative to the app folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "deadline", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The deadline for this file request. Only set if the request has a deadline. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "A description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A :link:`file request https://www.dropbox.com/help/9090` for receiving files into the user's Dropbox account.", - "typeWrap": "" - } - ], - "description": "The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Pass the cursor into :route:`list/continue` to obtain additional file requests." - }, - { - "name": "has_more", - "type": "Boolean", - "description": "Is true if there are additional file requests that have not been returned yet. An additional call to :route:list/continue` can retrieve them." - } - ], - "example": [ - { - "value": { - "file_requests": [ - { - "id": "oaCAVmEyrqYnkZX9955Y", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y", - "title": "Homework submission", - "created": "2015-10-05T17:00:00Z", - "is_open": true, - "file_count": 3, - "destination": "/File Requests/Homework", - "deadline": { - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": { - ".tag": "seven_days" - } - }, - "description": "Please submit your homework here." - }, - { - "id": "BAJ7IrRGicQKGToykQdB", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB", - "title": "Photo contest submission", - "created": "2015-11-02T04:00:00Z", - "is_open": true, - "file_count": 105, - "destination": "/Photo contest entries", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - } - }, - { - "id": "rxwMPvK3ATTa0VxOJu5T", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T", - "title": "Wedding photo submission", - "created": "2015-12-15T13:02:00Z", - "is_open": true, - "file_count": 37, - "destination": "/Wedding photos" - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": true - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`list:2` and :route:`list/continue`.", - "typeWrap": "" - }, - "error": { - "name": "ListFileRequestsError", - "type": [ - { - "name": "disabled_for_team", - "type": "Void", - "description": "This user's Dropbox Business team doesn't allow file requests." - } - ], - "example": [ - { - "value": { - ".tag": "disabled_for_team" - }, - "text": null, - "label": "disabled_for_team" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "There was an error retrieving the file requests.", - "typeWrap": "{} (union)" - } - }, - "file_requests/list/continue": { - "key": "file_requests/list/continue", - "name": "list/continue", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "file_requests.read", - "description": "Once a cursor has been retrieved from :route:`list:2`, use this to paginate through all file requests. The cursor must come from a previous call to :route:`list:2` or :route:`list/continue`.", - "isPreview": true, - "allowAppFolderApp": true, - "request": { - "name": "ListFileRequestsContinueArg", - "type": [ - { - "name": "cursor", - "type": "String", - "description": "The cursor returned by the previous API call specified in the endpoint description." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListFileRequestsV2Result", - "type": [ - { - "name": "file_requests", - "type": [ - { - "name": "FileRequest", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request." - }, - { - "name": "url", - "type": "String(min_length=1)", - "description": "The URL of the file request." - }, - { - "name": "title", - "type": "String(min_length=1)", - "description": "The title of the file request." - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "When this file request was created." - }, - { - "name": "is_open", - "type": "Boolean", - "description": "Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions." - }, - { - "name": "file_count", - "type": "Int64", - "description": "The number of files this file request has received." - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The path of the folder in the Dropbox where uploaded files will be sent. This can be :val:`null` if the destination was removed. For apps with the app folder permission, this will be relative to the app folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "deadline", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The deadline for this file request. Only set if the request has a deadline. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "A description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A :link:`file request https://www.dropbox.com/help/9090` for receiving files into the user's Dropbox account.", - "typeWrap": "" - } - ], - "description": "The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Pass the cursor into :route:`list/continue` to obtain additional file requests." - }, - { - "name": "has_more", - "type": "Boolean", - "description": "Is true if there are additional file requests that have not been returned yet. An additional call to :route:list/continue` can retrieve them." - } - ], - "example": [ - { - "value": { - "file_requests": [ - { - "id": "oaCAVmEyrqYnkZX9955Y", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y", - "title": "Homework submission", - "created": "2015-10-05T17:00:00Z", - "is_open": true, - "file_count": 3, - "destination": "/File Requests/Homework", - "deadline": { - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": { - ".tag": "seven_days" - } - }, - "description": "Please submit your homework here." - }, - { - "id": "BAJ7IrRGicQKGToykQdB", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB", - "title": "Photo contest submission", - "created": "2015-11-02T04:00:00Z", - "is_open": true, - "file_count": 105, - "destination": "/Photo contest entries", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - } - }, - { - "id": "rxwMPvK3ATTa0VxOJu5T", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T", - "title": "Wedding photo submission", - "created": "2015-12-15T13:02:00Z", - "is_open": true, - "file_count": 37, - "destination": "/Wedding photos" - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": true - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`list:2` and :route:`list/continue`.", - "typeWrap": "" - }, - "error": { - "name": "ListFileRequestsContinueError", - "type": [ - { - "name": "disabled_for_team", - "type": "Void", - "description": "This user's Dropbox Business team doesn't allow file requests." - }, - { - "name": "invalid_cursor", - "type": "Void", - "description": "The cursor is invalid." - } - ], - "example": [ - { - "value": { - ".tag": "disabled_for_team" - }, - "text": null, - "label": "disabled_for_team" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "invalid_cursor" - }, - "text": null, - "label": "invalid_cursor" - } - ], - "description": "There was an error retrieving the file requests.", - "typeWrap": "{} (union)" - } - }, - "file_requests/update": { - "key": "file_requests/update", - "name": "update", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "file_requests.write", - "description": "Update a file request.", - "allowAppFolderApp": true, - "request": { - "name": "UpdateFileRequestArgs", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request to update." - }, - { - "name": "title", - "type": "String(min_length=1)", - "description": "The new title of the file request. Must not be empty. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "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.", - "typeWrap": "{}?" - }, - { - "name": "deadline", - "type": [ - { - "name": "UpdateFileRequestDeadline", - "type": [ - { - "name": "no_update", - "type": "Void", - "description": "Do not change the file request's deadline." - }, - { - "name": "update", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If :val:`null`, the file request's deadline is cleared. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "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." - }, - { - "name": "open", - "type": "Boolean", - "description": "Whether to set this file request as open or closed. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "The description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "id": "oaCAVmEyrqYnkZX9955Y", - "title": "Homework submission", - "destination": "/File Requests/Homework", - "deadline": { - ".tag": "update", - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": "seven_days" - }, - "open": true - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`update`.", - "typeWrap": "" - }, - "response": { - "name": "FileRequest", - "type": [ - { - "name": "id", - "type": "String(min_length=1, pattern=\"[-_0-9a-zA-Z]+\")", - "description": "The ID of the file request." - }, - { - "name": "url", - "type": "String(min_length=1)", - "description": "The URL of the file request." - }, - { - "name": "title", - "type": "String(min_length=1)", - "description": "The title of the file request." - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "When this file request was created." - }, - { - "name": "is_open", - "type": "Boolean", - "description": "Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions." - }, - { - "name": "file_count", - "type": "Int64", - "description": "The number of files this file request has received." - }, - { - "name": "destination", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The path of the folder in the Dropbox where uploaded files will be sent. This can be :val:`null` if the destination was removed. For apps with the app folder permission, this will be relative to the app folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "deadline", - "type": [ - { - "name": "FileRequestDeadline", - "type": [ - { - "name": "deadline", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The deadline for this file request." - }, - { - "name": "allow_late_uploads", - "type": [ - { - "name": "GracePeriod", - "type": [ - { - "name": "one_day", - "type": "Void" - }, - { - "name": "two_days", - "type": "Void" - }, - { - "name": "seven_days", - "type": "Void" - }, - { - "name": "thirty_days", - "type": "Void" - }, - { - "name": "always", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The deadline for this file request. Only set if the request has a deadline. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "description", - "type": "String", - "description": "A description of the file request. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "id": "oaCAVmEyrqYnkZX9955Y", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y", - "title": "Homework submission", - "created": "2015-10-05T17:00:00Z", - "is_open": true, - "file_count": 3, - "destination": "/File Requests/Homework", - "deadline": { - "deadline": "2020-10-12T17:00:00Z", - "allow_late_uploads": { - ".tag": "seven_days" - } - }, - "description": "Please submit your homework here." - }, - "text": null, - "label": "default" - }, - { - "value": { - "id": "BAJ7IrRGicQKGToykQdB", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB", - "title": "Photo contest submission", - "created": "2015-11-02T04:00:00Z", - "is_open": true, - "file_count": 105, - "destination": "/Photo contest entries", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - } - }, - "text": null, - "label": "with_deadline" - }, - { - "value": { - "id": "rxwMPvK3ATTa0VxOJu5T", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T", - "title": "Wedding photo submission", - "created": "2015-12-15T13:02:00Z", - "is_open": true, - "file_count": 37, - "destination": "/Wedding photos" - }, - "text": null, - "label": "with_no_deadline" - } - ], - "description": "A :link:`file request https://www.dropbox.com/help/9090` for receiving files into the user's Dropbox account.", - "typeWrap": "" - }, - "error": { - "name": "UpdateFileRequestError", - "type": [ - { - "name": "disabled_for_team", - "type": "Void", - "description": "This user's Dropbox Business team doesn't allow file requests." - }, - { - "name": "not_found", - "type": "Void", - "description": "This file request ID was not found." - }, - { - "name": "not_a_folder", - "type": "Void", - "description": "The specified path is not a folder." - }, - { - "name": "app_lacks_access", - "type": "Void", - "description": "This file request is not accessible to this app. Apps with the app folder permission can only access file requests in their app folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "This user doesn't have permission to access or modify this file request." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. File requests are only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "validation_error", - "type": "Void", - "description": "There was an error validating the request. For example, the title was invalid, or there were disallowed characters in the destination path." - } - ], - "example": [ - { - "value": { - ".tag": "disabled_for_team" - }, - "text": null, - "label": "disabled_for_team" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "not_a_folder" - }, - "text": null, - "label": "not_a_folder" - }, - { - "value": { - ".tag": "app_lacks_access" - }, - "text": null, - "label": "app_lacks_access" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "validation_error" - }, - "text": null, - "label": "validation_error" - } - ], - "description": "There is an error updating the file request.", - "typeWrap": "{} (union)" - } - }, - "files/copy": { - "key": "files/copy", - "name": "copy", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Copy a file or folder to a different location in the user's Dropbox.\nIf the source path is a folder all its contents will be copied.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "RelocationArg", - "type": [ - { - "name": "from_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to be copied or moved." - }, - { - "name": "to_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox that is the destination." - }, - { - "name": "allow_shared_folder", - "type": "Boolean", - "description": "Field is deprecated. This flag has no effect. The default for this field is False.", - "isDeprecated": true - }, - { - "name": "autorename", - "type": "Boolean", - "description": "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." - }, - { - "name": "allow_ownership_transfer", - "type": "Boolean", - "description": "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." - } - ], - "example": [ - { - "value": { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra", - "allow_shared_folder": false, - "autorename": false, - "allow_ownership_transfer": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "folder", - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - }, - "error": { - "name": "RelocationError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - } - ], - "example": [ - { - "value": { - ".tag": "cant_copy_shared_folder" - }, - "text": null, - "label": "cant_copy_shared_folder" - }, - { - "value": { - ".tag": "cant_nest_shared_folder" - }, - "text": null, - "label": "cant_nest_shared_folder" - }, - { - "value": { - ".tag": "cant_move_folder_into_itself" - }, - "text": null, - "label": "cant_move_folder_into_itself" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "duplicated_or_nested_paths" - }, - "text": null, - "label": "duplicated_or_nested_paths" - }, - { - "value": { - ".tag": "cant_transfer_ownership" - }, - "text": null, - "label": "cant_transfer_ownership" - }, - { - "value": { - ".tag": "insufficient_quota" - }, - "text": null, - "label": "insufficient_quota" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "cant_move_shared_folder" - }, - "text": null, - "label": "cant_move_shared_folder" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/copy_v2": { - "key": "files/copy_v2", - "name": "copy", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Copy a file or folder to a different location in the user's Dropbox.\nIf the source path is a folder all its contents will be copied.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "RelocationArg", - "type": [ - { - "name": "from_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to be copied or moved." - }, - { - "name": "to_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox that is the destination." - }, - { - "name": "allow_shared_folder", - "type": "Boolean", - "description": "Field is deprecated. This flag has no effect. The default for this field is False.", - "isDeprecated": true - }, - { - "name": "autorename", - "type": "Boolean", - "description": "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." - }, - { - "name": "allow_ownership_transfer", - "type": "Boolean", - "description": "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." - } - ], - "example": [ - { - "value": { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra", - "allow_shared_folder": false, - "autorename": false, - "allow_ownership_transfer": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "RelocationResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the relocated object." - } - ], - "example": [ - { - "value": { - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "RelocationError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - } - ], - "example": [ - { - "value": { - ".tag": "cant_copy_shared_folder" - }, - "text": null, - "label": "cant_copy_shared_folder" - }, - { - "value": { - ".tag": "cant_nest_shared_folder" - }, - "text": null, - "label": "cant_nest_shared_folder" - }, - { - "value": { - ".tag": "cant_move_folder_into_itself" - }, - "text": null, - "label": "cant_move_folder_into_itself" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "duplicated_or_nested_paths" - }, - "text": null, - "label": "duplicated_or_nested_paths" - }, - { - "value": { - ".tag": "cant_transfer_ownership" - }, - "text": null, - "label": "cant_transfer_ownership" - }, - { - "value": { - ".tag": "insufficient_quota" - }, - "text": null, - "label": "insufficient_quota" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "cant_move_shared_folder" - }, - "text": null, - "label": "cant_move_shared_folder" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/copy_batch": { - "key": "files/copy_batch", - "name": "copy_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Copy multiple files or folders to different locations at once in the user's Dropbox.\nThis route will return job ID immediately and do the async copy job in background. Please use :route:`copy_batch/check:1` to check the job status.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "RelocationBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationPath", - "type": [ - { - "name": "from_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to be copied or moved." - }, - { - "name": "to_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox that is the destination." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "List of entries to be moved or copied. Each entry is :type:`RelocationPath`.", - "typeWrap": "List of ({}, min_items=1)" - }, - { - "name": "autorename", - "type": "Boolean", - "description": "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." - }, - { - "name": "allow_shared_folder", - "type": "Boolean", - "description": "Field is deprecated. This flag has no effect. The default for this field is False.", - "isDeprecated": true - }, - { - "name": "allow_ownership_transfer", - "type": "Boolean", - "description": "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." - } - ], - "example": [ - { - "value": { - "entries": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ], - "autorename": false, - "allow_shared_folder": false, - "allow_ownership_transfer": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "RelocationBatchLaunch", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "RelocationBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationBatchResultData", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the relocated object." - } - ], - "description": null, - "typeWrap": "" - } - ], - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "complete" - }, - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "async_job_id" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Result returned by :route:`copy_batch` or :route:`move_batch` that may either launch an asynchronous job or complete synchronously.", - "typeWrap": "{} (open union)" - } - }, - "files/copy_batch_v2": { - "key": "files/copy_batch_v2", - "name": "copy_batch", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Copy multiple files or folders to different locations at once in the user's Dropbox.\nThis route will replace :route:`copy_batch:1`. The main difference is this route will return status for each entry, while :route:`copy_batch:1` raises failure if any entry fails.\nThis route will either finish synchronously, or return a job ID and do the async copy job in background. Please use :route:`copy_batch/check:2` to check the job status.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "RelocationBatchArgBase", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationPath", - "type": [ - { - "name": "from_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to be copied or moved." - }, - { - "name": "to_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox that is the destination." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "List of entries to be moved or copied. Each entry is :type:`RelocationPath`.", - "typeWrap": "List of ({}, min_items=1)" - }, - { - "name": "autorename", - "type": "Boolean", - "description": "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." - } - ], - "example": [ - { - "value": { - "entries": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ], - "autorename": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "RelocationBatchV2Launch", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "RelocationBatchV2Result", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "RelocationBatchErrorEntry", - "type": [ - { - "name": "relocation_error", - "type": [ - { - "name": "RelocationError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "User errors that retry won't help." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Each entry in CopyBatchArg.entries or :field:`MoveBatchArg.entries` will appear at the same position inside :field:`RelocationBatchV2Result.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "complete" - }, - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "async_job_id" - } - ], - "description": "Result returned by :route:`copy_batch:2` or :route:`move_batch:2` that may either launch an asynchronous job or complete synchronously.", - "typeWrap": "{} (union)" - } - }, - "files/copy_batch/check": { - "key": "files/copy_batch/check", - "name": "copy_batch/check", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Returns the status of an asynchronous job for :route:`copy_batch:1`. If success, it returns list of results for each entry.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "RelocationBatchJobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "RelocationBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationBatchResultData", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the relocated object." - } - ], - "description": null, - "typeWrap": "" - } - ], - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The copy or move batch job has finished." - }, - { - "name": "failed", - "type": [ - { - "name": "RelocationBatchError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "The copy or move batch job has failed with exception." - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "files/copy_batch/check_v2": { - "key": "files/copy_batch/check_v2", - "name": "copy_batch/check", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Returns the status of an asynchronous job for :route:`copy_batch:2`. It returns list of results for each entry.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "RelocationBatchV2JobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "RelocationBatchV2Result", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "RelocationBatchErrorEntry", - "type": [ - { - "name": "relocation_error", - "type": [ - { - "name": "RelocationError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "User errors that retry won't help." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Each entry in CopyBatchArg.entries or :field:`MoveBatchArg.entries` will appear at the same position inside :field:`RelocationBatchV2Result.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The copy or move batch job has finished." - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - } - ], - "description": "Result returned by :route:`copy_batch/check:2` or :route:`move_batch/check:2` that may either be in progress or completed with result for each entry.", - "typeWrap": "{} (union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "files/copy_reference/get": { - "key": "files/copy_reference/get", - "name": "copy_reference/get", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to :route:`copy_reference/save`.", - "allowAppFolderApp": true, - "request": { - "name": "GetCopyReferenceArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path to the file or folder you want to get a copy reference to." - } - ], - "example": [ - { - "value": { - "path": "/video.mp4" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "GetCopyReferenceResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the file or folder." - }, - { - "name": "copy_reference", - "type": "String", - "description": "A copy reference to the file or folder." - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The expiration date of the copy reference. This value is currently set to be far enough in the future so that expiration is effectively not an issue." - } - ], - "example": [ - { - "value": { - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "copy_reference": "z1X6ATl6aWtzOGq0c3g5Ng", - "expires": "2045-05-12T15:50:38Z" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "GetCopyReferenceError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/copy_reference/save": { - "key": "files/copy_reference/save", - "name": "copy_reference/save", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Save a copy reference returned by :route:`copy_reference/get` to the user's Dropbox.", - "allowAppFolderApp": true, - "request": { - "name": "SaveCopyReferenceArg", - "type": [ - { - "name": "copy_reference", - "type": "String", - "description": "A copy reference returned by :route:`copy_reference/get`." - }, - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "Path in the user's Dropbox that is the destination." - } - ], - "example": [ - { - "value": { - "copy_reference": "z1X6ATl6aWtzOGq0c3g5Ng", - "path": "/video.mp4" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SaveCopyReferenceResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata of the saved file or folder in the user's Dropbox." - } - ], - "example": [ - { - "value": { - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "SaveCopyReferenceError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "invalid_copy_reference", - "type": "Void", - "description": "The copy reference is invalid." - }, - { - "name": "no_permission", - "type": "Void", - "description": "You don't have permission to save the given copy reference. Please make sure this app is same app which created the copy reference and the source user is still linked to the app." - }, - { - "name": "not_found", - "type": "Void", - "description": "The file referenced by the copy reference cannot be found." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_copy_reference" - }, - "text": null, - "label": "invalid_copy_reference" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/create_folder": { - "key": "files/create_folder", - "name": "create_folder", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Create a folder at a given path.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "CreateFolderArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)\")", - "description": "Path in the user's Dropbox to create." - }, - { - "name": "autorename", - "type": "Boolean", - "description": "If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict. The default for this field is False." - } - ], - "example": [ - { - "value": { - "path": "/Homework/math", - "autorename": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "CreateFolderError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/create_folder_v2": { - "key": "files/create_folder_v2", - "name": "create_folder", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Create a folder at a given path.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "CreateFolderArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)\")", - "description": "Path in the user's Dropbox to create." - }, - { - "name": "autorename", - "type": "Boolean", - "description": "If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict. The default for this field is False." - } - ], - "example": [ - { - "value": { - "path": "/Homework/math", - "autorename": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "CreateFolderResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Metadata of the created folder." - } - ], - "example": [ - { - "value": { - "metadata": { - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "CreateFolderError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/create_folder_batch": { - "key": "files/create_folder_batch", - "name": "create_folder_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Create multiple folders at once.\nThis route is asynchronous for large batches, which returns a job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the folders and returns the result synchronously for smaller inputs. You can force asynchronous behaviour by using the :field:`CreateFolderBatchArg.force_async` flag. Use :route:`create_folder_batch/check` to check the job status.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "CreateFolderBatchArg", - "type": [ - { - "name": "paths", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)\")", - "description": "List of paths to be created in the user's Dropbox. Duplicate path arguments in the batch are considered only once.", - "typeWrap": "List of ({}, max_items=10000)" - }, - { - "name": "autorename", - "type": "Boolean", - "description": "If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict. The default for this field is False." - }, - { - "name": "force_async", - "type": "Boolean", - "description": "Whether to force the create to happen asynchronously. The default for this field is False." - } - ], - "example": [ - { - "value": { - "paths": [ - "/Homework/math" - ], - "autorename": false, - "force_async": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "CreateFolderBatchLaunch", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "CreateFolderBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "CreateFolderBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "CreateFolderEntryResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Metadata of the created folder." - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "CreateFolderEntryError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each entry in :field:`CreateFolderBatchArg.paths` will appear at the same position inside :field:`CreateFolderBatchResult.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - } - } - ] - }, - "text": null, - "label": "complete" - }, - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "async_job_id" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Result returned by :route:`create_folder_batch` that may either launch an asynchronous job or complete synchronously.", - "typeWrap": "{} (open union)" - } - }, - "files/create_folder_batch/check": { - "key": "files/create_folder_batch/check", - "name": "create_folder_batch/check", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Returns the status of an asynchronous job for :route:`create_folder_batch`. If success, it returns list of result for each entry.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "CreateFolderBatchJobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "CreateFolderBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "CreateFolderBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "CreateFolderEntryResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Metadata of the created folder." - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "CreateFolderEntryError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each entry in :field:`CreateFolderBatchArg.paths` will appear at the same position inside :field:`CreateFolderBatchResult.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The batch create folder has finished." - }, - { - "name": "failed", - "type": [ - { - "name": "CreateFolderBatchError", - "type": [ - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve too many files or folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The batch create folder has failed." - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - } - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "files/delete": { - "key": "files/delete", - "name": "delete", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Delete the file or folder at a given path.\nIf the path is a folder, all its contents will be deleted too.\nA successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding :type:`FileMetadata` or :type:`FolderMetadata` for the item at time of deletion, and not a :type:`DeletedMetadata` object.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "DeleteArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to delete." - }, - { - "name": "parent_rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Perform delete if given \"rev\" matches the existing file's latest \"rev\". This field does not support deleting a folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/math/Prime_Numbers.txt" - }, - "text": null, - "label": "delete" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "folder", - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - }, - "error": { - "name": "DeleteError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "path_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - } - ], - "example": [ - { - "value": { - ".tag": "too_many_write_operations" - }, - "text": null, - "label": "too_many_write_operations" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/delete_v2": { - "key": "files/delete_v2", - "name": "delete", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Delete the file or folder at a given path.\nIf the path is a folder, all its contents will be deleted too.\nA successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding :type:`FileMetadata` or :type:`FolderMetadata` for the item at time of deletion, and not a :type:`DeletedMetadata` object.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "DeleteArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to delete." - }, - { - "name": "parent_rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Perform delete if given \"rev\" matches the existing file's latest \"rev\". This field does not support deleting a folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/math/Prime_Numbers.txt" - }, - "text": null, - "label": "delete" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "DeleteResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the deleted object." - } - ], - "example": [ - { - "value": { - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "DeleteError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "path_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - } - ], - "example": [ - { - "value": { - ".tag": "too_many_write_operations" - }, - "text": null, - "label": "too_many_write_operations" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/delete_batch": { - "key": "files/delete_batch", - "name": "delete_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Delete multiple files/folders at once.\nThis route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use :route:`delete_batch/check` to check the job status.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "DeleteBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "DeleteArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to delete." - }, - { - "name": "parent_rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Perform delete if given \"rev\" matches the existing file's latest \"rev\". This field does not support deleting a folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "path": "/Homework/math/Prime_Numbers.txt" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "DeleteBatchLaunch", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "DeleteBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "DeleteBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "DeleteBatchResultData", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the deleted object." - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "DeleteError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "path_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each entry in :field:`DeleteBatchArg.entries` will appear at the same position inside :field:`DeleteBatchResult.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "complete" - }, - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "async_job_id" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Result returned by :route:`delete_batch` that may either launch an asynchronous job or complete synchronously.", - "typeWrap": "{} (open union)" - } - }, - "files/delete_batch/check": { - "key": "files/delete_batch/check", - "name": "delete_batch/check", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Returns the status of an asynchronous job for :route:`delete_batch`. If success, it returns list of result for each entry.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "DeleteBatchJobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "DeleteBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "DeleteBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "DeleteBatchResultData", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the deleted object." - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "DeleteError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "path_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each entry in :field:`DeleteBatchArg.entries` will appear at the same position inside :field:`DeleteBatchResult.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The batch delete has finished." - }, - { - "name": "failed", - "type": [ - { - "name": "DeleteBatchError", - "type": [ - { - "name": "too_many_write_operations", - "type": "Void", - "description": "Field is deprecated. Use :field:`DeleteError.too_many_write_operations`. :route:`delete_batch` now provides smaller granularity about which entry has failed because of this.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The batch delete has failed." - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "files/download": { - "key": "files/download", - "name": "download", - "version": 1, - "subdomain": "content", - "format": "download", - "auth": "user", - "scope": "files.content.read", - "description": "Download a file from a user's Dropbox.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "DownloadArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path of the file to download." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Field is deprecated. Please specify revision in :field:`path` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/math/Prime_Numbers.txt" - }, - "text": null, - "label": "default" - }, - { - "value": { - "path": "id:a4ayc_80_OEAAAAAAAAAYa" - }, - "text": null, - "label": "id" - }, - { - "value": { - "path": "rev:a1c10ce0dd78" - }, - "text": null, - "label": "rev" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "DownloadError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_file", - "type": "Void", - "description": "This file type cannot be downloaded directly; use :route:`export` instead." - } - ], - "example": [ - { - "value": { - ".tag": "unsupported_file" - }, - "text": null, - "label": "unsupported_file" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/download_zip": { - "key": "files/download_zip", - "name": "download_zip", - "version": 1, - "subdomain": "content", - "format": "download", - "auth": "user", - "scope": "files.content.read", - "description": "Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and any single file within must be less than 4 GB in size. The resulting zip must have fewer than 10,000 total file and folder entries, including the top level folder. The input cannot be a single file.\nNote: this endpoint does not support HTTP range requests.", - "allowAppFolderApp": true, - "request": { - "name": "DownloadZipArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path of the folder to download." - } - ], - "example": [ - { - "value": { - "path": "/Homework/math" - }, - "text": null, - "label": "default" - }, - { - "value": { - "path": "id:a4ayc_80_OEAAAAAAAAAYa" - }, - "text": null, - "label": "id" - }, - { - "value": { - "path": "rev:a1c10ce0dd78" - }, - "text": null, - "label": "rev" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "DownloadZipResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - "metadata": { - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "DownloadZipError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "too_large", - "type": "Void", - "description": "The folder or a file is too large to download." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The folder has too many files to download." - } - ], - "example": [ - { - "value": { - ".tag": "too_large" - }, - "text": null, - "label": "too_large" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/export": { - "key": "files/export", - "name": "export", - "version": 1, - "subdomain": "content", - "format": "download", - "auth": "user", - "scope": "files.content.read", - "description": "Export a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose :field:`ExportResult.file_metadata` has :field:`ExportInfo.export_as` populated.", - "isPreview": true, - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "ExportArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path of the file to be exported." - }, - { - "name": "export_format", - "type": "String", - "description": "The file format to which the file should be exported. This must be one of the formats listed in the file's export_options returned by :route:`get_metadata`. If none is specified, the default format (specified in export_as in file metadata) will be used. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/math/Prime_Numbers.gsheet" - }, - "text": null, - "label": "default" - }, - { - "value": { - "path": "id:a4ayc_80_OEAAAAAAAAAYa" - }, - "text": null, - "label": "id" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ExportResult", - "type": [ - { - "name": "export_metadata", - "type": [ - { - "name": "ExportMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "export_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash based on the exported file content. This field can be used to verify data integrity. Similar to content hash. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "paper_revision", - "type": "Int64", - "description": "If the file is a Paper doc, this gives the latest doc revision which can be used in :route:`paper/update`. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Metadata for the exported version of the file." - }, - { - "name": "file_metadata", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Metadata for the original file." - } - ], - "example": [ - { - "value": { - "export_metadata": { - "name": "Prime_Numbers.xlsx", - "size": 7189, - "export_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_metadata": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ExportError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "non_exportable", - "type": "Void", - "description": "This file type cannot be exported. Use :route:`download` instead." - }, - { - "name": "invalid_export_format", - "type": "Void", - "description": "The specified export format is not a valid option for this file type." - }, - { - "name": "retry_error", - "type": "Void", - "description": "The exportable content is not yet available. Please retry later." - } - ], - "example": [ - { - "value": { - ".tag": "non_exportable" - }, - "text": null, - "label": "non_exportable" - }, - { - "value": { - ".tag": "invalid_export_format" - }, - "text": null, - "label": "invalid_export_format" - }, - { - "value": { - ".tag": "retry_error" - }, - "text": null, - "label": "retry_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/get_file_lock_batch": { - "key": "files/get_file_lock_batch", - "name": "get_file_lock_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.read", - "description": "Return the lock metadata for the given list of paths.", - "request": { - "name": "LockFileBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "LockFileArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to a file." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "List of 'entries'. Each 'entry' contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "LockFileBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "LockFileResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "LockFileResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the file." - }, - { - "name": "lock", - "type": [ - { - "name": "FileLock", - "type": [ - { - "name": "content", - "type": [ - { - "name": "FileLockContent", - "type": [ - { - "name": "unlocked", - "type": "Void", - "description": "Empty type to indicate no lock." - }, - { - "name": "single_user", - "type": [ - { - "name": "SingleUserLock", - "type": [ - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time the lock was created." - }, - { - "name": "lock_holder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known." - }, - { - "name": "lock_holder_team_id", - "type": "String", - "description": "The id of the team of the account holder if it exists. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A lock held by a single user." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The lock description." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Field is deprecated. The file lock state after the operation.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "LockFileError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Could not find the specified resource." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user does not have permissions to change the lock state or access the file." - }, - { - "name": "cannot_be_locked", - "type": "Void", - "description": "Item is a type that cannot be locked." - }, - { - "name": "file_not_shared", - "type": "Void", - "description": "Requested file is not currently shared." - }, - { - "name": "lock_conflict", - "type": [ - { - "name": "LockConflictError", - "type": [ - { - "name": "lock", - "type": [ - { - "name": "FileLock", - "type": [ - { - "name": "content", - "type": [ - { - "name": "FileLockContent", - "type": [ - { - "name": "unlocked", - "type": "Void", - "description": "Empty type to indicate no lock." - }, - { - "name": "single_user", - "type": [ - { - "name": "SingleUserLock", - "type": [ - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time the lock was created." - }, - { - "name": "lock_holder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known." - }, - { - "name": "lock_holder_team_id", - "type": "String", - "description": "The id of the team of the account holder if it exists. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A lock held by a single user." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The lock description." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The lock that caused the conflict." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The user action conflicts with an existing lock on the file." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each Entry in the 'entries' will have '.tag' with the operation status (e.g. success), the metadata for the file and the lock state after the operation.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - } - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "LockFileError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Could not find the specified resource." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user does not have permissions to change the lock state or access the file." - }, - { - "name": "cannot_be_locked", - "type": "Void", - "description": "Item is a type that cannot be locked." - }, - { - "name": "file_not_shared", - "type": "Void", - "description": "Requested file is not currently shared." - }, - { - "name": "lock_conflict", - "type": [ - { - "name": "LockConflictError", - "type": [ - { - "name": "lock", - "type": [ - { - "name": "FileLock", - "type": [ - { - "name": "content", - "type": [ - { - "name": "FileLockContent", - "type": [ - { - "name": "unlocked", - "type": "Void", - "description": "Empty type to indicate no lock." - }, - { - "name": "single_user", - "type": [ - { - "name": "SingleUserLock", - "type": [ - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time the lock was created." - }, - { - "name": "lock_holder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known." - }, - { - "name": "lock_holder_team_id", - "type": "String", - "description": "The id of the team of the account holder if it exists. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A lock held by a single user." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The lock description." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The lock that caused the conflict." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The user action conflicts with an existing lock on the file." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "too_many_write_operations" - }, - "text": null, - "label": "too_many_write_operations" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "no_write_permission" - }, - "text": null, - "label": "no_write_permission" - }, - { - "value": { - ".tag": "cannot_be_locked" - }, - "text": null, - "label": "cannot_be_locked" - }, - { - "value": { - ".tag": "file_not_shared" - }, - "text": null, - "label": "file_not_shared" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/get_metadata": { - "key": "files/get_metadata", - "name": "get_metadata", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Returns the metadata for a file or folder.\nNote: Metadata for the root folder is unsupported.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "GetMetadataArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path of a file or folder on Dropbox." - }, - { - "name": "include_media_info", - "type": "Boolean", - "description": "If true, :field:`FileMetadata.media_info` is set for photo and video. The default for this field is False." - }, - { - "name": "include_deleted", - "type": "Boolean", - "description": "If true, :type:`DeletedMetadata` will be returned for deleted file or folder, otherwise :field:`LookupError.not_found` will be returned. The default for this field is False." - }, - { - "name": "include_has_explicit_shared_members", - "type": "Boolean", - "description": "If true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False." - }, - { - "name": "include_property_groups", - "type": [ - { - "name": "TemplateFilterBase", - "type": [ - { - "name": "filter_some", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).", - "typeWrap": "List of ({}, min_items=1)" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ], - "description": "If set to a valid list of template IDs, :field:`FileMetadata.property_groups` is set if there exists property data associated with the file and each of the listed templates. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/math", - "include_media_info": false, - "include_deleted": false, - "include_has_explicit_shared_members": false - }, - "text": null, - "label": "default" - }, - { - "value": { - "path": "id:a4ayc_80_OEAAAAAAAAAYa", - "include_media_info": false, - "include_deleted": false, - "include_has_explicit_shared_members": false - }, - "text": null, - "label": "id" - }, - { - "value": { - "path": "rev:a1c10ce0dd78", - "include_media_info": false, - "include_deleted": false, - "include_has_explicit_shared_members": false - }, - "text": null, - "label": "rev" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "folder", - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - }, - "error": { - "name": "GetMetadataError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/get_preview": { - "key": "files/get_preview", - "name": "get_preview", - "version": 1, - "subdomain": "content", - "format": "download", - "auth": "user", - "scope": "files.content.read", - "description": "Get a preview for a file.\nCurrently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf.\nHTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx.\nOther formats will return an unsupported extension error.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "PreviewArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path of the file to preview." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Field is deprecated. Please specify revision in :field:`path` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/word.docx" - }, - "text": null, - "label": "default" - }, - { - "value": { - "path": "id:a4ayc_80_OEAAAAAAAAAYa" - }, - "text": null, - "label": "id" - }, - { - "value": { - "path": "rev:a1c10ce0dd78" - }, - "text": null, - "label": "rev" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "PreviewError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "An error occurs when downloading metadata for the file." - }, - { - "name": "in_progress", - "type": "Void", - "description": "This preview generation is still in progress and the file is not ready for preview yet." - }, - { - "name": "unsupported_extension", - "type": "Void", - "description": "The file extension is not supported preview generation." - }, - { - "name": "unsupported_content", - "type": "Void", - "description": "The file content is not supported for preview generation." - } - ], - "example": [ - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - }, - { - "value": { - ".tag": "unsupported_extension" - }, - "text": null, - "label": "unsupported_extension" - }, - { - "value": { - ".tag": "unsupported_content" - }, - "text": null, - "label": "unsupported_content" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/get_temporary_link": { - "key": "files/get_temporary_link", - "name": "get_temporary_link", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.read", - "description": "Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file's mime type.", - "allowAppFolderApp": true, - "request": { - "name": "GetTemporaryLinkArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path to the file you want a temporary link to." - } - ], - "example": [ - { - "value": { - "path": "/video.mp4" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "GetTemporaryLinkResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Metadata of the file." - }, - { - "name": "link", - "type": "String", - "description": "The temporary link which can be used to stream content the file." - } - ], - "example": [ - { - "value": { - "metadata": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "link": "https://ucabc123456.dl.dropboxusercontent.com/cd/0/get/abcdefghijklmonpqrstuvwxyz1234567890/file" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "GetTemporaryLinkError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "email_not_verified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "unsupported_file", - "type": "Void", - "description": "Cannot get temporary link to this file type; use :route:`export` instead." - }, - { - "name": "not_allowed", - "type": "Void", - "description": "The user is not allowed to request a temporary link to the specified file. For example, this can occur if the file is restricted or if the user's links are :link:`banned https://help.dropbox.com/files-folders/share/banned-links`." - } - ], - "example": [ - { - "value": { - ".tag": "email_not_verified" - }, - "text": null, - "label": "email_not_verified" - }, - { - "value": { - ".tag": "unsupported_file" - }, - "text": null, - "label": "unsupported_file" - }, - { - "value": { - ".tag": "not_allowed" - }, - "text": null, - "label": "not_allowed" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/get_temporary_upload_link": { - "key": "files/get_temporary_upload_link", - "name": "get_temporary_upload_link", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Get a one-time use temporary upload link to upload a file to a Dropbox location.\n\nThis endpoint acts as a delayed :route:`upload`. The returned temporary upload link may be used to make a POST request with the data to be uploaded. The upload will then be perfomed with the :type:`CommitInfo` previously provided to :route:`get_temporary_upload_link` but evaluated only upon consumption. Hence, errors stemming from invalid :type:`CommitInfo` with respect to the state of the user's Dropbox will only be communicated at consumption time. Additionally, these errors are surfaced as generic HTTP 409 Conflict responses, potentially hiding issue details. The maximum temporary upload link duration is 4 hours. Upon consumption or expiration, a new link will have to be generated. Multiple links may exist for a specific upload path at any given time.\n\nThe POST request on the temporary upload link must have its Content-Type set to \"application/octet-stream\".\n\nExample temporary upload link consumption request:\n\ncurl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND\n--header \"Content-Type: application/octet-stream\"\n--data-binary @local_file.txt\n\nA successful temporary upload link consumption request returns the content hash of the uploaded data in JSON format.\n\nExample successful temporary upload link consumption response:\n{\"content-hash\": \"599d71033d700ac892a0e48fa61b125d2f5994\"}\n\nAn unsuccessful temporary upload link consumption request returns any of the following status codes:\n\nHTTP 400 Bad Request: Content-Type is not one of application/octet-stream and text/plain or request is invalid.\nHTTP 409 Conflict: The temporary upload link does not exist or is currently unavailable, the upload failed, or another error happened.\nHTTP 410 Gone: The temporary upload link is expired or consumed.\n\nExample unsuccessful temporary upload link consumption response:\nTemporary upload link has been recently consumed.", - "allowAppFolderApp": true, - "request": { - "name": "GetTemporaryUploadLinkArg", - "type": [ - { - "name": "commit_info", - "type": [ - { - "name": "CommitInfo", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to save the file." - }, - { - "name": "mode", - "type": [ - { - "name": "WriteMode", - "type": [ - { - "name": "add", - "type": "Void", - "description": "Do not overwrite an existing file if there is a conflict. The autorename strategy is to append a number to the file name. For example, \"document.txt\" might become \"document (2).txt\"." - }, - { - "name": "overwrite", - "type": "Void", - "description": "Always overwrite the existing file. The autorename strategy is the same as it is for :field:`add`." - }, - { - "name": "update", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Overwrite if the given \"rev\" matches the existing file's \"rev\". The supplied value should be the latest known \"rev\" of the file, for example, from :type:`FileMetadata`, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given \"rev\" matches the existing file's current \"rev\" on the Dropbox servers. The autorename strategy is to append the string \"conflicted copy\" to the file name. For example, \"document.txt\" might become \"document (conflicted copy).txt\" or \"document (Panda's conflicted copy).txt\"." - } - ], - "description": "Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is.\nIn some situations, the conflict behavior is identical: (a) If the target path doesn't refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it's always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict.\nThe conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write.", - "typeWrap": "{} (union)" - } - ], - "description": "Selects what to do if the file already exists. The default for this union is add." - }, - { - "name": "autorename", - "type": "Boolean", - "description": "If there's a conflict, as determined by :field:`mode`, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The value to store as the :field:`client_modified` timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "mute", - "type": "Boolean", - "description": "Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If :val:`true`, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "List of custom properties to add to file. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "strict_conflict", - "type": "Boolean", - "description": "Be more strict about how each :type:`WriteMode` detects conflict. For example, always return a conflict error when :field:`mode` = :field:`WriteMode.update` and the given \"rev\" doesn't match the existing file's \"rev\", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents. The default for this field is False." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Contains the path and other optional modifiers for the future upload commit. Equivalent to the parameters provided to :route:`upload`." - }, - { - "name": "duration", - "type": "Float64(min=60.0, max=14400.0)", - "description": "How long before this link expires, in seconds. Attempting to start an upload with this link longer than this period of time after link creation will result in an error. The default for this field is 14400.0." - } - ], - "example": [ - { - "value": { - "commit_info": { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - }, - "duration": 3600 - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "GetTemporaryUploadLinkResult", - "type": [ - { - "name": "link", - "type": "String", - "description": "The temporary link which can be used to stream a file to a Dropbox location." - } - ], - "example": [ - { - "value": { - "link": "https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - } - }, - "files/get_thumbnail": { - "key": "files/get_thumbnail", - "name": "get_thumbnail", - "version": 1, - "subdomain": "content", - "format": "download", - "auth": "user", - "scope": "files.content.read", - "description": "Get a thumbnail for an image.\nThis method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "ThumbnailArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path to the image file you want to thumbnail." - }, - { - "name": "format", - "type": [ - { - "name": "ThumbnailFormat", - "type": [ - { - "name": "jpeg", - "type": "Void" - }, - { - "name": "png", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "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." - }, - { - "name": "size", - "type": [ - { - "name": "ThumbnailSize", - "type": [ - { - "name": "w32h32", - "type": "Void", - "description": "32 by 32 px." - }, - { - "name": "w64h64", - "type": "Void", - "description": "64 by 64 px." - }, - { - "name": "w128h128", - "type": "Void", - "description": "128 by 128 px." - }, - { - "name": "w256h256", - "type": "Void", - "description": "256 by 256 px." - }, - { - "name": "w480h320", - "type": "Void", - "description": "480 by 320 px." - }, - { - "name": "w640h480", - "type": "Void", - "description": "640 by 480 px." - }, - { - "name": "w960h640", - "type": "Void", - "description": "960 by 640 px." - }, - { - "name": "w1024h768", - "type": "Void", - "description": "1024 by 768 px." - }, - { - "name": "w2048h1536", - "type": "Void", - "description": "2048 by 1536 px." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "The size for the thumbnail image. The default for this union is w64h64." - }, - { - "name": "mode", - "type": [ - { - "name": "ThumbnailMode", - "type": [ - { - "name": "strict", - "type": "Void", - "description": "Scale down the image to fit within the given size." - }, - { - "name": "bestfit", - "type": "Void", - "description": "Scale down the image to fit within the given size or its transpose." - }, - { - "name": "fitone_bestfit", - "type": "Void", - "description": "Scale down the image to completely cover the given size or its transpose." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "How to resize and crop the image to achieve the desired size. The default for this union is strict." - } - ], - "example": [ - { - "value": { - "path": "/image.jpg", - "format": "jpeg", - "size": "w64h64", - "mode": "strict" - }, - "text": null, - "label": "default" - }, - { - "value": { - "path": "id:a4ayc_80_OEAAAAAAAAAYa", - "format": "jpeg", - "size": "w64h64", - "mode": "strict" - }, - "text": null, - "label": "id" - }, - { - "value": { - "path": "rev:a1c10ce0dd78", - "format": "jpeg", - "size": "w64h64", - "mode": "strict" - }, - "text": null, - "label": "rev" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ThumbnailError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "An error occurs when downloading metadata for the image." - }, - { - "name": "unsupported_extension", - "type": "Void", - "description": "The file extension doesn't allow conversion to a thumbnail." - }, - { - "name": "unsupported_image", - "type": "Void", - "description": "The image cannot be converted to a thumbnail." - }, - { - "name": "conversion_error", - "type": "Void", - "description": "An error occurs during thumbnail conversion." - } - ], - "example": [ - { - "value": { - ".tag": "unsupported_extension" - }, - "text": null, - "label": "unsupported_extension" - }, - { - "value": { - ".tag": "unsupported_image" - }, - "text": null, - "label": "unsupported_image" - }, - { - "value": { - ".tag": "conversion_error" - }, - "text": null, - "label": "conversion_error" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/get_thumbnail_v2": { - "key": "files/get_thumbnail_v2", - "name": "get_thumbnail", - "version": 2, - "subdomain": "content", - "format": "download", - "auth": "app, user", - "scope": "files.content.read", - "description": "Get a thumbnail for an image.\nThis method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "ThumbnailV2Arg", - "type": [ - { - "name": "resource", - "type": [ - { - "name": "PathOrLink", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")" - }, - { - "name": "link", - "type": [ - { - "name": "SharedLinkFileInfo", - "type": [ - { - "name": "url", - "type": "String", - "description": "The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for." - }, - { - "name": "path", - "type": "String", - "description": "The path corresponding to a file in a shared link to a folder. Required for shared links to folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "password", - "type": "String", - "description": "Password for the shared link. Required for password-protected shared links to files unless it can be read from a cookie. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Information specifying which file to preview. This could be a path to a file, a shared link pointing to a file, or a shared link pointing to a folder, with a relative path." - }, - { - "name": "format", - "type": [ - { - "name": "ThumbnailFormat", - "type": [ - { - "name": "jpeg", - "type": "Void" - }, - { - "name": "png", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "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." - }, - { - "name": "size", - "type": [ - { - "name": "ThumbnailSize", - "type": [ - { - "name": "w32h32", - "type": "Void", - "description": "32 by 32 px." - }, - { - "name": "w64h64", - "type": "Void", - "description": "64 by 64 px." - }, - { - "name": "w128h128", - "type": "Void", - "description": "128 by 128 px." - }, - { - "name": "w256h256", - "type": "Void", - "description": "256 by 256 px." - }, - { - "name": "w480h320", - "type": "Void", - "description": "480 by 320 px." - }, - { - "name": "w640h480", - "type": "Void", - "description": "640 by 480 px." - }, - { - "name": "w960h640", - "type": "Void", - "description": "960 by 640 px." - }, - { - "name": "w1024h768", - "type": "Void", - "description": "1024 by 768 px." - }, - { - "name": "w2048h1536", - "type": "Void", - "description": "2048 by 1536 px." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "The size for the thumbnail image. The default for this union is w64h64." - }, - { - "name": "mode", - "type": [ - { - "name": "ThumbnailMode", - "type": [ - { - "name": "strict", - "type": "Void", - "description": "Scale down the image to fit within the given size." - }, - { - "name": "bestfit", - "type": "Void", - "description": "Scale down the image to fit within the given size or its transpose." - }, - { - "name": "fitone_bestfit", - "type": "Void", - "description": "Scale down the image to completely cover the given size or its transpose." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "How to resize and crop the image to achieve the desired size. The default for this union is strict." - } - ], - "example": [ - { - "value": { - "resource": { - ".tag": "path", - "path": "/a.docx" - }, - "format": "jpeg", - "size": "w64h64", - "mode": "strict" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "PreviewResult", - "type": [ - { - "name": "file_metadata", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Metadata corresponding to the file received as an argument. Will be populated if the endpoint is called with a path (ReadPath). This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "MinimalFileLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "Unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path", - "type": "String", - "description": "Full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's Dropbox. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Minimal metadata corresponding to the file received as an argument. Will be populated if the endpoint is called using a shared link (SharedLinkFileInfo). This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "file_metadata": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ThumbnailV2Error", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "An error occurred when downloading metadata for the image." - }, - { - "name": "unsupported_extension", - "type": "Void", - "description": "The file extension doesn't allow conversion to a thumbnail." - }, - { - "name": "unsupported_image", - "type": "Void", - "description": "The image cannot be converted to a thumbnail." - }, - { - "name": "conversion_error", - "type": "Void", - "description": "An error occurred during thumbnail conversion." - }, - { - "name": "access_denied", - "type": "Void", - "description": "Access to this shared link is forbidden." - }, - { - "name": "not_found", - "type": "Void", - "description": "The shared link does not exist." - } - ], - "example": [ - { - "value": { - ".tag": "unsupported_extension" - }, - "text": null, - "label": "unsupported_extension" - }, - { - "value": { - ".tag": "unsupported_image" - }, - "text": null, - "label": "unsupported_image" - }, - { - "value": { - ".tag": "conversion_error" - }, - "text": null, - "label": "conversion_error" - }, - { - "value": { - ".tag": "access_denied" - }, - "text": null, - "label": "access_denied" - }, - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/get_thumbnail_batch": { - "key": "files/get_thumbnail_batch", - "name": "get_thumbnail_batch", - "version": 1, - "subdomain": "content", - "format": "rpc", - "auth": "user", - "scope": "files.content.read", - "description": "Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch.\nThis method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "GetThumbnailBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "ThumbnailArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path to the image file you want to thumbnail." - }, - { - "name": "format", - "type": [ - { - "name": "ThumbnailFormat", - "type": [ - { - "name": "jpeg", - "type": "Void" - }, - { - "name": "png", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "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." - }, - { - "name": "size", - "type": [ - { - "name": "ThumbnailSize", - "type": [ - { - "name": "w32h32", - "type": "Void", - "description": "32 by 32 px." - }, - { - "name": "w64h64", - "type": "Void", - "description": "64 by 64 px." - }, - { - "name": "w128h128", - "type": "Void", - "description": "128 by 128 px." - }, - { - "name": "w256h256", - "type": "Void", - "description": "256 by 256 px." - }, - { - "name": "w480h320", - "type": "Void", - "description": "480 by 320 px." - }, - { - "name": "w640h480", - "type": "Void", - "description": "640 by 480 px." - }, - { - "name": "w960h640", - "type": "Void", - "description": "960 by 640 px." - }, - { - "name": "w1024h768", - "type": "Void", - "description": "1024 by 768 px." - }, - { - "name": "w2048h1536", - "type": "Void", - "description": "2048 by 1536 px." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "The size for the thumbnail image. The default for this union is w64h64." - }, - { - "name": "mode", - "type": [ - { - "name": "ThumbnailMode", - "type": [ - { - "name": "strict", - "type": "Void", - "description": "Scale down the image to fit within the given size." - }, - { - "name": "bestfit", - "type": "Void", - "description": "Scale down the image to fit within the given size or its transpose." - }, - { - "name": "fitone_bestfit", - "type": "Void", - "description": "Scale down the image to completely cover the given size or its transpose." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "How to resize and crop the image to achieve the desired size. The default for this union is strict." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "List of files to get thumbnails.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "path": "/image.jpg", - "format": "jpeg", - "size": "w64h64", - "mode": "strict" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`get_thumbnail_batch`.", - "typeWrap": "" - }, - "response": { - "name": "GetThumbnailBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "GetThumbnailBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "GetThumbnailBatchResultData", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "thumbnail", - "type": "String", - "description": "A string containing the base64-encoded thumbnail data for this file." - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "ThumbnailError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "An error occurs when downloading metadata for the image." - }, - { - "name": "unsupported_extension", - "type": "Void", - "description": "The file extension doesn't allow conversion to a thumbnail." - }, - { - "name": "unsupported_image", - "type": "Void", - "description": "The image cannot be converted to a thumbnail." - }, - { - "name": "conversion_error", - "type": "Void", - "description": "An error occurs during thumbnail conversion." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "The result for this file if it was an error." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "List of files and their thumbnails.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - ".tag": "success", - "metadata": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "thumbnail": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "GetThumbnailBatchError", - "type": [ - { - "name": "too_many_files", - "type": "Void", - "description": "The operation involves more than 25 files." - } - ], - "example": [ - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/list_folder": { - "key": "files/list_folder", - "name": "list_folder", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "app, user", - "scope": "files.metadata.read", - "description": "Starts returning the contents of a folder. If the result's :field:`ListFolderResult.has_more` field is :val:`true`, call :route:`list_folder/continue` with the returned :field:`ListFolderResult.cursor` to retrieve more entries.\nIf you're using :field:`ListFolderArg.recursive` set to :val:`true` to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync:\nFor each :type:`FileMetadata`, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it and remove all its children.\nFor each :type:`FolderMetadata`, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it but leave the children as they are. Check the new entry's :field:`FolderSharingInfo.read_only` and set all its children's read-only statuses to match.\nFor each :type:`DeletedMetadata`, if your local state has something at the given path, remove it and all its children. If there's nothing at the given path, ignore this entry.\nNote: :type:`auth.RateLimitError` may be returned if multiple :route:`list_folder` or :route:`list_folder/continue` calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "ListFolderArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file." - }, - { - "name": "recursive", - "type": "Boolean", - "description": "If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. The default for this field is False." - }, - { - "name": "include_media_info", - "type": "Boolean", - "description": "Field is deprecated. If true, :field:`FileMetadata.media_info` is set for photo and video. This parameter will no longer have an effect starting December 2, 2019. The default for this field is False.", - "isDeprecated": true - }, - { - "name": "include_deleted", - "type": "Boolean", - "description": "If true, the results will include entries for files and folders that used to exist but were deleted. The default for this field is False." - }, - { - "name": "include_has_explicit_shared_members", - "type": "Boolean", - "description": "If true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False." - }, - { - "name": "include_mounted_folders", - "type": "Boolean", - "description": "If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder. The default for this field is True." - }, - { - "name": "limit", - "type": "UInt32(min=1, max=2000)", - "description": "The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_link", - "type": [ - { - "name": "SharedLink", - "type": [ - { - "name": "url", - "type": "String", - "description": "Shared link url." - }, - { - "name": "password", - "type": "String", - "description": "Password for the shared link. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, :field:`ListFolderArg.path` will be relative to root of the shared link. Only non-recursive mode is supported for shared link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "include_property_groups", - "type": [ - { - "name": "TemplateFilterBase", - "type": [ - { - "name": "filter_some", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).", - "typeWrap": "List of ({}, min_items=1)" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ], - "description": "If set to a valid list of template IDs, :field:`FileMetadata.property_groups` is set if there exists property data associated with the file and each of the listed templates. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "include_non_downloadable_files", - "type": "Boolean", - "description": "If true, include files that are not downloadable, i.e. Google Docs. The default for this field is True." - } - ], - "example": [ - { - "value": { - "path": "/Homework/math", - "recursive": false, - "include_media_info": false, - "include_deleted": false, - "include_has_explicit_shared_members": false, - "include_mounted_folders": true, - "include_non_downloadable_files": true - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListFolderResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The files and (direct) subfolders in the folder.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "Pass the cursor into :route:`list_folder/continue` to see what's changed in the folder since your previous query." - }, - { - "name": "has_more", - "type": "Boolean", - "description": "If true, then there are more entries available. Pass the cursor to :route:`list_folder/continue` to retrieve the rest." - } - ], - "example": [ - { - "value": { - "entries": [ - { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - { - ".tag": "folder", - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ListFolderError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "template_error", - "type": [ - { - "name": "TemplateError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/list_folder/continue": { - "key": "files/list_folder/continue", - "name": "list_folder/continue", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "app, user", - "scope": "files.metadata.read", - "description": "Once a cursor has been retrieved from :route:`list_folder`, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for :route:`list_folder`.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "ListFolderContinueArg", - "type": [ - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "The cursor returned by your last call to :route:`list_folder` or :route:`list_folder/continue`." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListFolderResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The files and (direct) subfolders in the folder.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "Pass the cursor into :route:`list_folder/continue` to see what's changed in the folder since your previous query." - }, - { - "name": "has_more", - "type": "Boolean", - "description": "If true, then there are more entries available. Pass the cursor to :route:`list_folder/continue` to retrieve the rest." - } - ], - "example": [ - { - "value": { - "entries": [ - { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - { - ".tag": "folder", - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ListFolderContinueError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "reset", - "type": "Void", - "description": "Indicates that the cursor has been invalidated. Call :route:`list_folder` to obtain a new cursor." - } - ], - "example": [ - { - "value": { - ".tag": "reset" - }, - "text": null, - "label": "reset" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/list_folder/get_latest_cursor": { - "key": "files/list_folder/get_latest_cursor", - "name": "list_folder/get_latest_cursor", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "A way to quickly get a cursor for the folder's state. Unlike :route:`list_folder`, :route:`list_folder/get_latest_cursor` doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "ListFolderArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file." - }, - { - "name": "recursive", - "type": "Boolean", - "description": "If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. The default for this field is False." - }, - { - "name": "include_media_info", - "type": "Boolean", - "description": "Field is deprecated. If true, :field:`FileMetadata.media_info` is set for photo and video. This parameter will no longer have an effect starting December 2, 2019. The default for this field is False.", - "isDeprecated": true - }, - { - "name": "include_deleted", - "type": "Boolean", - "description": "If true, the results will include entries for files and folders that used to exist but were deleted. The default for this field is False." - }, - { - "name": "include_has_explicit_shared_members", - "type": "Boolean", - "description": "If true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False." - }, - { - "name": "include_mounted_folders", - "type": "Boolean", - "description": "If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder. The default for this field is True." - }, - { - "name": "limit", - "type": "UInt32(min=1, max=2000)", - "description": "The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_link", - "type": [ - { - "name": "SharedLink", - "type": [ - { - "name": "url", - "type": "String", - "description": "Shared link url." - }, - { - "name": "password", - "type": "String", - "description": "Password for the shared link. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, :field:`ListFolderArg.path` will be relative to root of the shared link. Only non-recursive mode is supported for shared link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "include_property_groups", - "type": [ - { - "name": "TemplateFilterBase", - "type": [ - { - "name": "filter_some", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).", - "typeWrap": "List of ({}, min_items=1)" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ], - "description": "If set to a valid list of template IDs, :field:`FileMetadata.property_groups` is set if there exists property data associated with the file and each of the listed templates. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "include_non_downloadable_files", - "type": "Boolean", - "description": "If true, include files that are not downloadable, i.e. Google Docs. The default for this field is True." - } - ], - "example": [ - { - "value": { - "path": "/Homework/math", - "recursive": false, - "include_media_info": false, - "include_deleted": false, - "include_has_explicit_shared_members": false, - "include_mounted_folders": true, - "include_non_downloadable_files": true - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListFolderGetLatestCursorResult", - "type": [ - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "Pass the cursor into :route:`list_folder/continue` to see what's changed in the folder since your previous query." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ListFolderError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "template_error", - "type": [ - { - "name": "TemplateError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/list_folder/longpoll": { - "key": "files/list_folder/longpoll", - "name": "list_folder/longpoll", - "version": 1, - "subdomain": "notify", - "format": "rpc", - "auth": "noauth", - "scope": "files.metadata.read", - "description": "A longpoll endpoint to wait for changes on an account. In conjunction with :route:`list_folder/continue`, this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps. If you're looking for server-side notifications, check out our :link:`webhooks documentation https://www.dropbox.com/developers/reference/webhooks`.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "ListFolderLongpollArg", - "type": [ - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "A cursor as returned by :route:`list_folder` or :route:`list_folder/continue`. Cursors retrieved by setting :field:`ListFolderArg.include_media_info` to :val:`true` are not supported." - }, - { - "name": "timeout", - "type": "UInt64(min=30, max=480)", - "description": "A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts. The default for this field is 30." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "timeout": 30 - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListFolderLongpollResult", - "type": [ - { - "name": "changes", - "type": "Boolean", - "description": "Indicates whether new changes are available. If true, call :route:`list_folder/continue` to retrieve the changes." - }, - { - "name": "backoff", - "type": "UInt64", - "description": "If present, backoff for at least this many seconds before calling :route:`list_folder/longpoll` again. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "changes": true - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ListFolderLongpollError", - "type": [ - { - "name": "reset", - "type": "Void", - "description": "Indicates that the cursor has been invalidated. Call :route:`list_folder` to obtain a new cursor." - } - ], - "example": [ - { - "value": { - ".tag": "reset" - }, - "text": null, - "label": "reset" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/list_revisions": { - "key": "files/list_revisions", - "name": "list_revisions", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Returns revisions for files based on a file path or a file id. The file path or file id is identified from the latest file entry at the given file path or id. This end point allows your app to query either by file path or file id by setting the mode parameter appropriately.\nIn the :field:`ListRevisionsMode.path` (default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file id are desired, then mode must be set to :field:`ListRevisionsMode.id`. The :field:`ListRevisionsMode.id` mode is useful to retrieve revisions for a given file across moves or renames.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "request": { - "name": "ListRevisionsArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "The path to the file you want to see the revisions of." - }, - { - "name": "mode", - "type": [ - { - "name": "ListRevisionsMode", - "type": [ - { - "name": "path", - "type": "Void", - "description": "Returns revisions with the same file path as identified by the latest file entry at the given file path or id." - }, - { - "name": "id", - "type": "Void", - "description": "Returns revisions with the same file id as identified by the latest file entry at the given file path or id." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Determines the behavior of the API in listing the revisions for a given file path or id. The default for this union is path." - }, - { - "name": "limit", - "type": "UInt64(min=1, max=100)", - "description": "The maximum number of revision entries returned. The default for this field is 10." - } - ], - "example": [ - { - "value": { - "path": "/root/word.docx", - "mode": "path", - "limit": 10 - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListRevisionsResult", - "type": [ - { - "name": "is_deleted", - "type": "Boolean", - "description": "If the file identified by the latest revision in the response is either deleted or moved." - }, - { - "name": "entries", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The revisions for the file. Only revisions that are not deleted will show up here.", - "typeWrap": "List of ({})" - }, - { - "name": "server_deleted", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time of deletion if the file was deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "is_deleted": false, - "entries": [ - { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ListRevisionsError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/lock_file_batch": { - "key": "files/lock_file_batch", - "name": "lock_file_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Lock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation.", - "request": { - "name": "LockFileBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "LockFileArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to a file." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "List of 'entries'. Each 'entry' contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "LockFileBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "LockFileResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "LockFileResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the file." - }, - { - "name": "lock", - "type": [ - { - "name": "FileLock", - "type": [ - { - "name": "content", - "type": [ - { - "name": "FileLockContent", - "type": [ - { - "name": "unlocked", - "type": "Void", - "description": "Empty type to indicate no lock." - }, - { - "name": "single_user", - "type": [ - { - "name": "SingleUserLock", - "type": [ - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time the lock was created." - }, - { - "name": "lock_holder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known." - }, - { - "name": "lock_holder_team_id", - "type": "String", - "description": "The id of the team of the account holder if it exists. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A lock held by a single user." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The lock description." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Field is deprecated. The file lock state after the operation.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "LockFileError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Could not find the specified resource." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user does not have permissions to change the lock state or access the file." - }, - { - "name": "cannot_be_locked", - "type": "Void", - "description": "Item is a type that cannot be locked." - }, - { - "name": "file_not_shared", - "type": "Void", - "description": "Requested file is not currently shared." - }, - { - "name": "lock_conflict", - "type": [ - { - "name": "LockConflictError", - "type": [ - { - "name": "lock", - "type": [ - { - "name": "FileLock", - "type": [ - { - "name": "content", - "type": [ - { - "name": "FileLockContent", - "type": [ - { - "name": "unlocked", - "type": "Void", - "description": "Empty type to indicate no lock." - }, - { - "name": "single_user", - "type": [ - { - "name": "SingleUserLock", - "type": [ - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time the lock was created." - }, - { - "name": "lock_holder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known." - }, - { - "name": "lock_holder_team_id", - "type": "String", - "description": "The id of the team of the account holder if it exists. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A lock held by a single user." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The lock description." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The lock that caused the conflict." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The user action conflicts with an existing lock on the file." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each Entry in the 'entries' will have '.tag' with the operation status (e.g. success), the metadata for the file and the lock state after the operation.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - } - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "LockFileError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Could not find the specified resource." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user does not have permissions to change the lock state or access the file." - }, - { - "name": "cannot_be_locked", - "type": "Void", - "description": "Item is a type that cannot be locked." - }, - { - "name": "file_not_shared", - "type": "Void", - "description": "Requested file is not currently shared." - }, - { - "name": "lock_conflict", - "type": [ - { - "name": "LockConflictError", - "type": [ - { - "name": "lock", - "type": [ - { - "name": "FileLock", - "type": [ - { - "name": "content", - "type": [ - { - "name": "FileLockContent", - "type": [ - { - "name": "unlocked", - "type": "Void", - "description": "Empty type to indicate no lock." - }, - { - "name": "single_user", - "type": [ - { - "name": "SingleUserLock", - "type": [ - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time the lock was created." - }, - { - "name": "lock_holder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known." - }, - { - "name": "lock_holder_team_id", - "type": "String", - "description": "The id of the team of the account holder if it exists. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A lock held by a single user." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The lock description." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The lock that caused the conflict." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The user action conflicts with an existing lock on the file." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "too_many_write_operations" - }, - "text": null, - "label": "too_many_write_operations" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "no_write_permission" - }, - "text": null, - "label": "no_write_permission" - }, - { - "value": { - ".tag": "cannot_be_locked" - }, - "text": null, - "label": "cannot_be_locked" - }, - { - "value": { - ".tag": "file_not_shared" - }, - "text": null, - "label": "file_not_shared" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/move": { - "key": "files/move", - "name": "move", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Move a file or folder to a different location in the user's Dropbox.\nIf the source path is a folder all its contents will be moved.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "RelocationArg", - "type": [ - { - "name": "from_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to be copied or moved." - }, - { - "name": "to_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox that is the destination." - }, - { - "name": "allow_shared_folder", - "type": "Boolean", - "description": "Field is deprecated. This flag has no effect. The default for this field is False.", - "isDeprecated": true - }, - { - "name": "autorename", - "type": "Boolean", - "description": "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." - }, - { - "name": "allow_ownership_transfer", - "type": "Boolean", - "description": "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." - } - ], - "example": [ - { - "value": { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra", - "allow_shared_folder": false, - "autorename": false, - "allow_ownership_transfer": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "folder", - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - }, - "error": { - "name": "RelocationError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - } - ], - "example": [ - { - "value": { - ".tag": "cant_copy_shared_folder" - }, - "text": null, - "label": "cant_copy_shared_folder" - }, - { - "value": { - ".tag": "cant_nest_shared_folder" - }, - "text": null, - "label": "cant_nest_shared_folder" - }, - { - "value": { - ".tag": "cant_move_folder_into_itself" - }, - "text": null, - "label": "cant_move_folder_into_itself" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "duplicated_or_nested_paths" - }, - "text": null, - "label": "duplicated_or_nested_paths" - }, - { - "value": { - ".tag": "cant_transfer_ownership" - }, - "text": null, - "label": "cant_transfer_ownership" - }, - { - "value": { - ".tag": "insufficient_quota" - }, - "text": null, - "label": "insufficient_quota" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "cant_move_shared_folder" - }, - "text": null, - "label": "cant_move_shared_folder" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/move_v2": { - "key": "files/move_v2", - "name": "move", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Move a file or folder to a different location in the user's Dropbox.\nIf the source path is a folder all its contents will be moved.\nNote that we do not currently support case-only renaming.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "RelocationArg", - "type": [ - { - "name": "from_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to be copied or moved." - }, - { - "name": "to_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox that is the destination." - }, - { - "name": "allow_shared_folder", - "type": "Boolean", - "description": "Field is deprecated. This flag has no effect. The default for this field is False.", - "isDeprecated": true - }, - { - "name": "autorename", - "type": "Boolean", - "description": "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." - }, - { - "name": "allow_ownership_transfer", - "type": "Boolean", - "description": "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." - } - ], - "example": [ - { - "value": { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra", - "allow_shared_folder": false, - "autorename": false, - "allow_ownership_transfer": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "RelocationResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the relocated object." - } - ], - "example": [ - { - "value": { - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "RelocationError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - } - ], - "example": [ - { - "value": { - ".tag": "cant_copy_shared_folder" - }, - "text": null, - "label": "cant_copy_shared_folder" - }, - { - "value": { - ".tag": "cant_nest_shared_folder" - }, - "text": null, - "label": "cant_nest_shared_folder" - }, - { - "value": { - ".tag": "cant_move_folder_into_itself" - }, - "text": null, - "label": "cant_move_folder_into_itself" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "duplicated_or_nested_paths" - }, - "text": null, - "label": "duplicated_or_nested_paths" - }, - { - "value": { - ".tag": "cant_transfer_ownership" - }, - "text": null, - "label": "cant_transfer_ownership" - }, - { - "value": { - ".tag": "insufficient_quota" - }, - "text": null, - "label": "insufficient_quota" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "cant_move_shared_folder" - }, - "text": null, - "label": "cant_move_shared_folder" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/move_batch": { - "key": "files/move_batch", - "name": "move_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Move multiple files or folders to different locations at once in the user's Dropbox.\nThis route will return job ID immediately and do the async moving job in background. Please use :route:`move_batch/check:1` to check the job status.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "RelocationBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationPath", - "type": [ - { - "name": "from_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to be copied or moved." - }, - { - "name": "to_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox that is the destination." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "List of entries to be moved or copied. Each entry is :type:`RelocationPath`.", - "typeWrap": "List of ({}, min_items=1)" - }, - { - "name": "autorename", - "type": "Boolean", - "description": "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." - }, - { - "name": "allow_shared_folder", - "type": "Boolean", - "description": "Field is deprecated. This flag has no effect. The default for this field is False.", - "isDeprecated": true - }, - { - "name": "allow_ownership_transfer", - "type": "Boolean", - "description": "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." - } - ], - "example": [ - { - "value": { - "entries": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ], - "autorename": false, - "allow_shared_folder": false, - "allow_ownership_transfer": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "RelocationBatchLaunch", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "RelocationBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationBatchResultData", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the relocated object." - } - ], - "description": null, - "typeWrap": "" - } - ], - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "complete" - }, - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "async_job_id" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Result returned by :route:`copy_batch` or :route:`move_batch` that may either launch an asynchronous job or complete synchronously.", - "typeWrap": "{} (open union)" - } - }, - "files/move_batch_v2": { - "key": "files/move_batch_v2", - "name": "move_batch", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Move multiple files or folders to different locations at once in the user's Dropbox. Note that we do not currently support case-only renaming.\nThis route will replace :route:`move_batch:1`. The main difference is this route will return status for each entry, while :route:`move_batch:1` raises failure if any entry fails.\nThis route will either finish synchronously, or return a job ID and do the async move job in background. Please use :route:`move_batch/check:2` to check the job status.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "MoveBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationPath", - "type": [ - { - "name": "from_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to be copied or moved." - }, - { - "name": "to_path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox that is the destination." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "List of entries to be moved or copied. Each entry is :type:`RelocationPath`.", - "typeWrap": "List of ({}, min_items=1)" - }, - { - "name": "autorename", - "type": "Boolean", - "description": "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." - }, - { - "name": "allow_ownership_transfer", - "type": "Boolean", - "description": "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." - } - ], - "example": [ - { - "value": { - "entries": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ], - "autorename": false, - "allow_ownership_transfer": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "RelocationBatchV2Launch", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "RelocationBatchV2Result", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "RelocationBatchErrorEntry", - "type": [ - { - "name": "relocation_error", - "type": [ - { - "name": "RelocationError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "User errors that retry won't help." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Each entry in CopyBatchArg.entries or :field:`MoveBatchArg.entries` will appear at the same position inside :field:`RelocationBatchV2Result.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "complete" - }, - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "async_job_id" - } - ], - "description": "Result returned by :route:`copy_batch:2` or :route:`move_batch:2` that may either launch an asynchronous job or complete synchronously.", - "typeWrap": "{} (union)" - } - }, - "files/move_batch/check": { - "key": "files/move_batch/check", - "name": "move_batch/check", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Returns the status of an asynchronous job for :route:`move_batch:1`. If success, it returns list of results for each entry.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "RelocationBatchJobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "RelocationBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationBatchResultData", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the relocated object." - } - ], - "description": null, - "typeWrap": "" - } - ], - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The copy or move batch job has finished." - }, - { - "name": "failed", - "type": [ - { - "name": "RelocationBatchError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "The copy or move batch job has failed with exception." - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "files/move_batch/check_v2": { - "key": "files/move_batch/check_v2", - "name": "move_batch/check", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Returns the status of an asynchronous job for :route:`move_batch:2`. It returns list of results for each entry.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "RelocationBatchV2JobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "RelocationBatchV2Result", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "RelocationBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "RelocationBatchErrorEntry", - "type": [ - { - "name": "relocation_error", - "type": [ - { - "name": "RelocationError", - "type": [ - { - "name": "from_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "from_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "to", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "cant_copy_shared_folder", - "type": "Void", - "description": "Shared folders can't be copied." - }, - { - "name": "cant_nest_shared_folder", - "type": "Void", - "description": "Your move operation would result in nested shared folders. This is not allowed." - }, - { - "name": "cant_move_folder_into_itself", - "type": "Void", - "description": "You cannot move a folder into itself." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "The operation would involve more than 10,000 files and folders." - }, - { - "name": "duplicated_or_nested_paths", - "type": "Void", - "description": "There are duplicated/nested paths among :field:`RelocationArg.from_path` and :field:`RelocationArg.to_path`." - }, - { - "name": "cant_transfer_ownership", - "type": "Void", - "description": "Your move operation would result in an ownership transfer. You may reissue the request with the field :field:`RelocationArg.allow_ownership_transfer` to true." - }, - { - "name": "insufficient_quota", - "type": "Void", - "description": "The current user does not have enough space to move or copy the files." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "cant_move_shared_folder", - "type": "Void", - "description": "Can't move the shared folder to the given destination." - }, - { - "name": "cant_move_into_vault", - "type": [ - { - "name": "MoveIntoVaultError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Vault is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into Vault under certain circumstances, see detailed error." - }, - { - "name": "cant_move_into_family", - "type": [ - { - "name": "MoveIntoFamilyError", - "type": [ - { - "name": "is_shared_folder", - "type": "Void", - "description": "Moving shared folder into Family Room folder is not allowed." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "User errors that retry won't help." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Each entry in CopyBatchArg.entries or :field:`MoveBatchArg.entries` will appear at the same position inside :field:`RelocationBatchV2Result.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The copy or move batch job has finished." - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - } - ], - "description": "Result returned by :route:`copy_batch/check:2` or :route:`move_batch/check:2` that may either be in progress or completed with result for each entry.", - "typeWrap": "{} (union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "files/paper/create": { - "key": "files/paper/create", - "name": "paper/create", - "version": 1, - "subdomain": "api", - "format": "upload", - "auth": "user", - "scope": "files.content.write", - "description": "Creates a new Paper doc with the provided content.", - "isPreview": true, - "request": { - "name": "PaperCreateArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The fully qualified path to the location in the user's Dropbox where the Paper Doc should be created. This should include the document's title and end with .paper." - }, - { - "name": "import_format", - "type": [ - { - "name": "ImportFormat", - "type": [ - { - "name": "html", - "type": "Void", - "description": "The provided data is interpreted as standard HTML." - }, - { - "name": "markdown", - "type": "Void", - "description": "The provided data is interpreted as markdown." - }, - { - "name": "plain_text", - "type": "Void", - "description": "The provided data is interpreted as plain text." - } - ], - "description": "The import format of the incoming Paper doc content.", - "typeWrap": "{} (open union)" - } - ], - "description": "The format of the provided data." - } - ], - "example": [ - { - "value": { - "path": "/Paper Docs/New Doc.paper", - "import_format": "html" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "PaperCreateResult", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL to open the Paper Doc." - }, - { - "name": "result_path", - "type": "String", - "description": "The fully qualified path the Paper Doc was actually created at." - }, - { - "name": "file_id", - "type": "String(min_length=4, pattern=\"id:.+\")", - "description": "The id to use in Dropbox APIs when referencing the Paper Doc." - }, - { - "name": "paper_revision", - "type": "Int64", - "description": "The current doc revision." - } - ], - "example": [ - { - "value": { - "url": "https://www.dropbox.com/scl/xxx.paper?dl=0", - "result_path": "/Paper Docs/New Doc.paper", - "file_id": "id:a4ayc_80_OEAAAAAAAAAXw", - "paper_revision": 1 - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "PaperCreateError", - "type": [ - { - "name": "insufficient_permissions", - "type": "Void", - "description": "Your account does not have permissions to edit Paper docs." - }, - { - "name": "content_malformed", - "type": "Void", - "description": "The provided content was malformed and cannot be imported to Paper." - }, - { - "name": "doc_length_exceeded", - "type": "Void", - "description": "The Paper doc would be too large, split the content into multiple docs." - }, - { - "name": "image_size_exceeded", - "type": "Void", - "description": "The imported document contains an image that is too large. The current limit is 1MB. This only applies to HTML with data URI." - }, - { - "name": "invalid_path", - "type": "Void", - "description": "The file could not be saved to the specified location." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "The user's email must be verified to create Paper docs." - }, - { - "name": "invalid_file_extension", - "type": "Void", - "description": "The file path must end in .paper." - }, - { - "name": "paper_disabled", - "type": "Void", - "description": "Paper is disabled for your team." - } - ], - "example": [ - { - "value": { - ".tag": "insufficient_permissions" - }, - "text": null, - "label": "insufficient_permissions" - }, - { - "value": { - ".tag": "content_malformed" - }, - "text": null, - "label": "content_malformed" - }, - { - "value": { - ".tag": "doc_length_exceeded" - }, - "text": null, - "label": "doc_length_exceeded" - }, - { - "value": { - ".tag": "image_size_exceeded" - }, - "text": null, - "label": "image_size_exceeded" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "invalid_path" - }, - "text": null, - "label": "invalid_path" - }, - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "invalid_file_extension" - }, - "text": null, - "label": "invalid_file_extension" - }, - { - "value": { - ".tag": "paper_disabled" - }, - "text": null, - "label": "paper_disabled" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/paper/update": { - "key": "files/paper/update", - "name": "paper/update", - "version": 1, - "subdomain": "api", - "format": "upload", - "auth": "user", - "scope": "files.content.write", - "description": "Updates an existing Paper doc with the provided content.", - "isPreview": true, - "request": { - "name": "PaperUpdateArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to update. The path must correspond to a Paper doc or an error will be returned." - }, - { - "name": "import_format", - "type": [ - { - "name": "ImportFormat", - "type": [ - { - "name": "html", - "type": "Void", - "description": "The provided data is interpreted as standard HTML." - }, - { - "name": "markdown", - "type": "Void", - "description": "The provided data is interpreted as markdown." - }, - { - "name": "plain_text", - "type": "Void", - "description": "The provided data is interpreted as plain text." - } - ], - "description": "The import format of the incoming Paper doc content.", - "typeWrap": "{} (open union)" - } - ], - "description": "The format of the provided data." - }, - { - "name": "doc_update_policy", - "type": [ - { - "name": "PaperDocUpdatePolicy", - "type": [ - { - "name": "update", - "type": "Void", - "description": "Sets the doc content to the provided content if the provided paper_revision matches the latest doc revision. Otherwise, returns an error." - }, - { - "name": "overwrite", - "type": "Void", - "description": "Sets the doc content to the provided content without checking paper_revision." - }, - { - "name": "prepend", - "type": "Void", - "description": "Adds the provided content to the beginning of the doc without checking paper_revision." - }, - { - "name": "append", - "type": "Void", - "description": "Adds the provided content to the end of the doc without checking paper_revision." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "How the provided content should be applied to the doc." - }, - { - "name": "paper_revision", - "type": "Int64", - "description": "The latest doc revision. Required when doc_update_policy is update. This value must match the current revision of the doc or error revision_mismatch will be returned. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Paper Docs/My Doc.paper", - "import_format": "html", - "doc_update_policy": "update", - "paper_revision": 123 - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "PaperUpdateResult", - "type": [ - { - "name": "paper_revision", - "type": "Int64", - "description": "The current doc revision." - } - ], - "example": [ - { - "value": { - "paper_revision": 124 - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "PaperUpdateError", - "type": [ - { - "name": "insufficient_permissions", - "type": "Void", - "description": "Your account does not have permissions to edit Paper docs." - }, - { - "name": "content_malformed", - "type": "Void", - "description": "The provided content was malformed and cannot be imported to Paper." - }, - { - "name": "doc_length_exceeded", - "type": "Void", - "description": "The Paper doc would be too large, split the content into multiple docs." - }, - { - "name": "image_size_exceeded", - "type": "Void", - "description": "The imported document contains an image that is too large. The current limit is 1MB. This only applies to HTML with data URI." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "revision_mismatch", - "type": "Void", - "description": "The provided revision does not match the document head." - }, - { - "name": "doc_archived", - "type": "Void", - "description": "This operation is not allowed on archived Paper docs." - }, - { - "name": "doc_deleted", - "type": "Void", - "description": "This operation is not allowed on deleted Paper docs." - } - ], - "example": [ - { - "value": { - ".tag": "insufficient_permissions" - }, - "text": null, - "label": "insufficient_permissions" - }, - { - "value": { - ".tag": "content_malformed" - }, - "text": null, - "label": "content_malformed" - }, - { - "value": { - ".tag": "doc_length_exceeded" - }, - "text": null, - "label": "doc_length_exceeded" - }, - { - "value": { - ".tag": "image_size_exceeded" - }, - "text": null, - "label": "image_size_exceeded" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "revision_mismatch" - }, - "text": null, - "label": "revision_mismatch" - }, - { - "value": { - ".tag": "doc_archived" - }, - "text": null, - "label": "doc_archived" - }, - { - "value": { - ".tag": "doc_deleted" - }, - "text": null, - "label": "doc_deleted" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/permanently_delete": { - "key": "files/permanently_delete", - "name": "permanently_delete", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.permanent_delete", - "description": "Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40).\nIf the given file or folder is not yet deleted, this route will first delete it. It is possible for this route to successfully delete, then fail to permanently delete.\nNote: This endpoint is only available for Dropbox Business apps.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "DeleteArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to delete." - }, - { - "name": "parent_rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Perform delete if given \"rev\" matches the existing file's latest \"rev\". This field does not support deleting a folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/math/Prime_Numbers.txt" - }, - "text": null, - "label": "delete" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "DeleteError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "path_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - } - ], - "example": [ - { - "value": { - ".tag": "too_many_write_operations" - }, - "text": null, - "label": "too_many_write_operations" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/restore": { - "key": "files/restore", - "name": "restore", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Restore a specific revision of a file to the given path.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "RestoreArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)\")", - "description": "The path to save the restored file." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "The revision to restore." - } - ], - "example": [ - { - "value": { - "path": "/root/word.docx", - "rev": "a1c10ce0dd78" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "RestoreError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "An error occurs when downloading metadata for the file." - }, - { - "name": "path_write", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "An error occurs when trying to restore the file to that path." - }, - { - "name": "invalid_revision", - "type": "Void", - "description": "The revision is invalid. It may not exist or may point to a deleted file." - }, - { - "name": "in_progress", - "type": "Void", - "description": "The restore is currently executing, but has not yet completed." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_revision" - }, - "text": null, - "label": "invalid_revision" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/save_url": { - "key": "files/save_url", - "name": "save_url", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Save the data from a specified URL into a file in user's Dropbox.\nNote that the transfer from the URL must complete within 5 minutes, or the operation will time out and the job will fail.\nIf the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).", - "allowAppFolderApp": true, - "request": { - "name": "SaveUrlArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "The path in Dropbox where the URL will be saved to." - }, - { - "name": "url", - "type": "String", - "description": "The URL to be saved." - } - ], - "example": [ - { - "value": { - "path": "/a.txt", - "url": "http://example.com/a.txt" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SaveUrlResult", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Metadata of the file where the URL is saved to." - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "SaveUrlError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "download_failed", - "type": "Void", - "description": "Failed downloading the given URL. The URL may be password-protected and the password provided was incorrect, or the link may be disabled." - }, - { - "name": "invalid_url", - "type": "Void", - "description": "The given URL is invalid." - }, - { - "name": "not_found", - "type": "Void", - "description": "The file where the URL is saved to no longer exists." - } - ], - "example": [ - { - "value": { - ".tag": "download_failed" - }, - "text": null, - "label": "download_failed" - }, - { - "value": { - ".tag": "invalid_url" - }, - "text": null, - "label": "invalid_url" - }, - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/save_url/check_job_status": { - "key": "files/save_url/check_job_status", - "name": "save_url/check_job_status", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Check the status of a :route:`save_url` job.", - "allowAppFolderApp": true, - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "SaveUrlJobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Metadata of the file where the URL is saved to." - }, - { - "name": "failed", - "type": [ - { - "name": "SaveUrlError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "download_failed", - "type": "Void", - "description": "Failed downloading the given URL. The URL may be password-protected and the password provided was incorrect, or the link may be disabled." - }, - { - "name": "invalid_url", - "type": "Void", - "description": "The given URL is invalid." - }, - { - "name": "not_found", - "type": "Void", - "description": "The file where the URL is saved to no longer exists." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "files/search": { - "key": "files/search", - "name": "search", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Searches for files and folders.\nNote: Recent changes will be reflected in search results within a few seconds and older revisions of existing files may still match your query for up to a few days.", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "SearchArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "The path in the user's Dropbox to search. Should probably be a folder." - }, - { - "name": "query", - "type": "String(max_length=1000)", - "description": "The string to search for. Query string may be rewritten to improve relevance of results. The string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. \"bat c\" matches \"bat cave\" but not \"batman car\")." - }, - { - "name": "start", - "type": "UInt64(max=9999)", - "description": "The starting index within the search results (used for paging). The default for this field is 0." - }, - { - "name": "max_results", - "type": "UInt64(min=1, max=1000)", - "description": "The maximum number of search results to return. The default for this field is 100." - }, - { - "name": "mode", - "type": [ - { - "name": "SearchMode", - "type": [ - { - "name": "filename", - "type": "Void", - "description": "Search file and folder names." - }, - { - "name": "filename_and_content", - "type": "Void", - "description": "Search file and folder names as well as file contents." - }, - { - "name": "deleted_filename", - "type": "Void", - "description": "Search for deleted file and folder names." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts. The default for this union is filename." - } - ], - "example": [ - { - "value": { - "path": "", - "query": "prime numbers", - "start": 0, - "max_results": 100, - "mode": "filename" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SearchResult", - "type": [ - { - "name": "matches", - "type": [ - { - "name": "SearchMatch", - "type": [ - { - "name": "match_type", - "type": [ - { - "name": "SearchMatchType", - "type": [ - { - "name": "filename", - "type": "Void", - "description": "This item was matched on its file or folder name." - }, - { - "name": "content", - "type": "Void", - "description": "This item was matched based on its file contents." - }, - { - "name": "both", - "type": "Void", - "description": "This item was matched based on both its contents and its file name." - } - ], - "description": "Indicates what type of match was found for a given item.", - "typeWrap": "{} (union)" - } - ], - "description": "The type of the match." - }, - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the matched file or folder." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list (possibly empty) of matches for the query.", - "typeWrap": "List of ({})" - }, - { - "name": "more", - "type": "Boolean", - "description": "Used for paging. If true, indicates there is another page of results available that can be fetched by calling :route:`search` again." - }, - { - "name": "start", - "type": "UInt64", - "description": "Used for paging. Value to set the start argument to when calling :route:`search` to fetch the next page of results." - } - ], - "example": [ - { - "value": { - "matches": [ - { - "match_type": { - ".tag": "content" - }, - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - } - ], - "more": false, - "start": 1 - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "SearchError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "invalid_argument", - "type": "String", - "description": " This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong, please try again." - } - ], - "example": [ - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/search_v2": { - "key": "files/search_v2", - "name": "search", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Searches for files and folders.\nNote: :route:`search:2` along with :route:`search/continue:2` can only be used to retrieve a maximum of 10,000 matches.\nRecent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.", - "allowAppFolderApp": true, - "request": { - "name": "SearchV2Arg", - "type": [ - { - "name": "query", - "type": "String(max_length=1000)", - "description": "The string to search for. May match across multiple fields based on the request arguments." - }, - { - "name": "options", - "type": [ - { - "name": "SearchOptions", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "max_results", - "type": "UInt64(min=1, max=1000)", - "description": "The maximum number of search results to return. The default for this field is 100." - }, - { - "name": "order_by", - "type": [ - { - "name": "SearchOrderBy", - "type": [ - { - "name": "relevance", - "type": "Void" - }, - { - "name": "last_modified_time", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specified property of the order of search results. By default, results are sorted by relevance. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_status", - "type": [ - { - "name": "FileStatus", - "type": [ - { - "name": "active", - "type": "Void" - }, - { - "name": "deleted", - "type": "Void" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Restricts search to the given file status. The default for this union is active." - }, - { - "name": "filename_only", - "type": "Boolean", - "description": "Restricts search to only match on filenames. The default for this field is False." - }, - { - "name": "file_extensions", - "type": "String", - "description": "Restricts search to only the extensions specified. Only supported for active file search. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "file_categories", - "type": [ - { - "name": "FileCategory", - "type": [ - { - "name": "image", - "type": "Void", - "description": "jpg, png, gif, and more." - }, - { - "name": "document", - "type": "Void", - "description": "doc, docx, txt, and more." - }, - { - "name": "pdf", - "type": "Void", - "description": "pdf." - }, - { - "name": "spreadsheet", - "type": "Void", - "description": "xlsx, xls, csv, and more." - }, - { - "name": "presentation", - "type": "Void", - "description": "ppt, pptx, key, and more." - }, - { - "name": "audio", - "type": "Void", - "description": "mp3, wav, mid, and more." - }, - { - "name": "video", - "type": "Void", - "description": "mov, wmv, mp4, and more." - }, - { - "name": "folder", - "type": "Void", - "description": "dropbox folder." - }, - { - "name": "paper", - "type": "Void", - "description": "dropbox paper doc." - }, - { - "name": "others", - "type": "Void", - "description": "any file not in one of the categories above." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Restricts search to only the file categories specified. Only supported for active file search. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "Restricts results to the given account id. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Options for more targeted search results. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "match_field_options", - "type": [ - { - "name": "SearchMatchFieldOptions", - "type": [ - { - "name": "include_highlights", - "type": "Boolean", - "description": "Whether to include highlight span from file title. The default for this field is False." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Options for search results match fields. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "include_highlights", - "type": "Boolean", - "description": "Field is deprecated. Deprecated and moved this option to SearchMatchFieldOptions. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "query": "cat", - "options": { - "path": "/Folder", - "max_results": 20, - "file_status": "active", - "filename_only": false - }, - "match_field_options": { - "include_highlights": false - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SearchV2Result", - "type": [ - { - "name": "matches", - "type": [ - { - "name": "SearchMatchV2", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "MetadataV2", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ] - } - ], - "description": "Metadata for a file, folder or other resource types.", - "typeWrap": "{} (open union)" - } - ], - "description": "The metadata for the matched file or folder." - }, - { - "name": "match_type", - "type": [ - { - "name": "SearchMatchTypeV2", - "type": [ - { - "name": "filename", - "type": "Void", - "description": "This item was matched on its file or folder name." - }, - { - "name": "file_content", - "type": "Void", - "description": "This item was matched based on its file contents." - }, - { - "name": "filename_and_content", - "type": "Void", - "description": "This item was matched based on both its contents and its file name." - }, - { - "name": "image_content", - "type": "Void", - "description": "This item was matched on image content." - } - ], - "description": "Indicates what type of match was found for a given item.", - "typeWrap": "{} (open union)" - } - ], - "description": "The type of the match. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "highlight_spans", - "type": [ - { - "name": "HighlightSpan", - "type": [ - { - "name": "highlight_str", - "type": "String", - "description": "String to be determined whether it should be highlighted or not." - }, - { - "name": "is_highlighted", - "type": "Boolean", - "description": "The string should be highlighted or not." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The list of HighlightSpan determines which parts of the file title should be highlighted. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list (possibly empty) of matches for the query.", - "typeWrap": "List of ({})" - }, - { - "name": "has_more", - "type": "Boolean", - "description": "Used for paging. If true, indicates there is another page of results available that can be fetched by calling :route:`search/continue:2` with the cursor." - }, - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "Pass the cursor into :route:`search/continue:2` to fetch the next page of results. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "matches": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - } - } - } - ], - "has_more": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "SearchError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "invalid_argument", - "type": "String", - "description": " This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong, please try again." - } - ], - "example": [ - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/search/continue_v2": { - "key": "files/search/continue_v2", - "name": "search/continue", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Fetches the next page of search results returned from :route:`search:2`.\nNote: :route:`search:2` along with :route:`search/continue:2` can only be used to retrieve a maximum of 10,000 matches.\nRecent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.", - "allowAppFolderApp": true, - "request": { - "name": "SearchV2ContinueArg", - "type": [ - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "The cursor returned by your last call to :route:`search:2`. Used to fetch the next page of results." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SearchV2Result", - "type": [ - { - "name": "matches", - "type": [ - { - "name": "SearchMatchV2", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "MetadataV2", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ] - } - ], - "description": "Metadata for a file, folder or other resource types.", - "typeWrap": "{} (open union)" - } - ], - "description": "The metadata for the matched file or folder." - }, - { - "name": "match_type", - "type": [ - { - "name": "SearchMatchTypeV2", - "type": [ - { - "name": "filename", - "type": "Void", - "description": "This item was matched on its file or folder name." - }, - { - "name": "file_content", - "type": "Void", - "description": "This item was matched based on its file contents." - }, - { - "name": "filename_and_content", - "type": "Void", - "description": "This item was matched based on both its contents and its file name." - }, - { - "name": "image_content", - "type": "Void", - "description": "This item was matched on image content." - } - ], - "description": "Indicates what type of match was found for a given item.", - "typeWrap": "{} (open union)" - } - ], - "description": "The type of the match. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "highlight_spans", - "type": [ - { - "name": "HighlightSpan", - "type": [ - { - "name": "highlight_str", - "type": "String", - "description": "String to be determined whether it should be highlighted or not." - }, - { - "name": "is_highlighted", - "type": "Boolean", - "description": "The string should be highlighted or not." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The list of HighlightSpan determines which parts of the file title should be highlighted. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list (possibly empty) of matches for the query.", - "typeWrap": "List of ({})" - }, - { - "name": "has_more", - "type": "Boolean", - "description": "Used for paging. If true, indicates there is another page of results available that can be fetched by calling :route:`search/continue:2` with the cursor." - }, - { - "name": "cursor", - "type": "String(min_length=1)", - "description": "Pass the cursor into :route:`search/continue:2` to fetch the next page of results. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "matches": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - } - } - } - ], - "has_more": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "SearchError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "invalid_argument", - "type": "String", - "description": " This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong, please try again." - } - ], - "example": [ - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/tags/add": { - "key": "files/tags/add", - "name": "tags/add", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "description": "Add a tag to an item. A tag is a string. The strings are automatically converted to lowercase letters. No more than 20 tags can be added to a given item.", - "isPreview": true, - "request": { - "name": "AddTagArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "Path to the item to be tagged." - }, - { - "name": "tag_text", - "type": "String(min_length=1, max_length=32, pattern=\"[A-Za-z0-9_]+\")", - "description": "The value of the tag to add. Will be automatically converted to lowercase letters." - } - ], - "example": [ - { - "value": { - "path": "/Prime_Numbers.txt", - "tag_text": "my_tag" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "AddTagError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "too_many_tags", - "type": "Void", - "description": "The item already has the maximum supported number of tags." - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "too_many_tags" - }, - "text": null, - "label": "too_many_tags" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/tags/get": { - "key": "files/tags/get", - "name": "tags/get", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Get list of tags assigned to items.", - "isPreview": true, - "request": { - "name": "GetTagsArg", - "type": [ - { - "name": "paths", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "Path to the items.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "paths": [ - "/Prime_Numbers.txt" - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "GetTagsResult", - "type": [ - { - "name": "paths_to_tags", - "type": [ - { - "name": "PathToTags", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "Path of the item." - }, - { - "name": "tags", - "type": [ - { - "name": "Tag", - "type": [ - { - "name": "user_generated_tag", - "type": [ - { - "name": "UserGeneratedTag", - "type": [ - { - "name": "tag_text", - "type": "String(min_length=1, max_length=32, pattern=\"[A-Za-z0-9_]+\")" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Tag generated by the user." - } - ], - "description": "Tag that can be added in multiple ways.", - "typeWrap": "{} (open union)" - } - ], - "description": "Tags assigned to this item.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "List of paths and their corresponding tags.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "paths_to_tags": [ - { - "path": "/Prime_Numbers.txt", - "tags": [ - { - ".tag": "user_generated_tag", - "tag_text": "my_tag" - } - ] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "BaseTagError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/tags/remove": { - "key": "files/tags/remove", - "name": "tags/remove", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "description": "Remove a tag from an item.", - "isPreview": true, - "request": { - "name": "RemoveTagArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "Path to the item to tag." - }, - { - "name": "tag_text", - "type": "String(min_length=1, max_length=32, pattern=\"[A-Za-z0-9_]+\")", - "description": "The tag to remove. Will be automatically converted to lowercase letters." - } - ], - "example": [ - { - "value": { - "path": "/Prime_Numbers.txt", - "tag_text": "my_tag" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "RemoveTagError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "tag_not_present", - "type": "Void", - "description": "That tag doesn't exist at this path." - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "tag_not_present" - }, - "text": null, - "label": "tag_not_present" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/unlock_file_batch": { - "key": "files/unlock_file_batch", - "name": "unlock_file_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Unlock the files at the given paths. A locked file can only be unlocked by the lock holder or, if a business account, a team admin. A successful response indicates that the file has been unlocked. Returns a list of the unlocked file paths and their metadata after this operation.", - "selectAdminMode": "whole_team", - "request": { - "name": "UnlockFileBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "UnlockFileArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to a file." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "List of 'entries'. Each 'entry' contains a path of the file which will be unlocked. Duplicate path arguments in the batch are considered only once.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "LockFileBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "LockFileResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "LockFileResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the file." - }, - { - "name": "lock", - "type": [ - { - "name": "FileLock", - "type": [ - { - "name": "content", - "type": [ - { - "name": "FileLockContent", - "type": [ - { - "name": "unlocked", - "type": "Void", - "description": "Empty type to indicate no lock." - }, - { - "name": "single_user", - "type": [ - { - "name": "SingleUserLock", - "type": [ - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time the lock was created." - }, - { - "name": "lock_holder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known." - }, - { - "name": "lock_holder_team_id", - "type": "String", - "description": "The id of the team of the account holder if it exists. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A lock held by a single user." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The lock description." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Field is deprecated. The file lock state after the operation.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "LockFileError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Could not find the specified resource." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user does not have permissions to change the lock state or access the file." - }, - { - "name": "cannot_be_locked", - "type": "Void", - "description": "Item is a type that cannot be locked." - }, - { - "name": "file_not_shared", - "type": "Void", - "description": "Requested file is not currently shared." - }, - { - "name": "lock_conflict", - "type": [ - { - "name": "LockConflictError", - "type": [ - { - "name": "lock", - "type": [ - { - "name": "FileLock", - "type": [ - { - "name": "content", - "type": [ - { - "name": "FileLockContent", - "type": [ - { - "name": "unlocked", - "type": "Void", - "description": "Empty type to indicate no lock." - }, - { - "name": "single_user", - "type": [ - { - "name": "SingleUserLock", - "type": [ - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time the lock was created." - }, - { - "name": "lock_holder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known." - }, - { - "name": "lock_holder_team_id", - "type": "String", - "description": "The id of the team of the account holder if it exists. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A lock held by a single user." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The lock description." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The lock that caused the conflict." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The user action conflicts with an existing lock on the file." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each Entry in the 'entries' will have '.tag' with the operation status (e.g. success), the metadata for the file and the lock state after the operation.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - } - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "LockFileError", - "type": [ - { - "name": "path_lookup", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Could not find the specified resource." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "There are too many files in one request. Please retry with fewer files." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user does not have permissions to change the lock state or access the file." - }, - { - "name": "cannot_be_locked", - "type": "Void", - "description": "Item is a type that cannot be locked." - }, - { - "name": "file_not_shared", - "type": "Void", - "description": "Requested file is not currently shared." - }, - { - "name": "lock_conflict", - "type": [ - { - "name": "LockConflictError", - "type": [ - { - "name": "lock", - "type": [ - { - "name": "FileLock", - "type": [ - { - "name": "content", - "type": [ - { - "name": "FileLockContent", - "type": [ - { - "name": "unlocked", - "type": "Void", - "description": "Empty type to indicate no lock." - }, - { - "name": "single_user", - "type": [ - { - "name": "SingleUserLock", - "type": [ - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The time the lock was created." - }, - { - "name": "lock_holder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known." - }, - { - "name": "lock_holder_team_id", - "type": "String", - "description": "The id of the team of the account holder if it exists. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A lock held by a single user." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The lock description." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The lock that caused the conflict." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The user action conflicts with an existing lock on the file." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "too_many_write_operations" - }, - "text": null, - "label": "too_many_write_operations" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "no_write_permission" - }, - "text": null, - "label": "no_write_permission" - }, - { - "value": { - ".tag": "cannot_be_locked" - }, - "text": null, - "label": "cannot_be_locked" - }, - { - "value": { - ".tag": "file_not_shared" - }, - "text": null, - "label": "file_not_shared" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/upload": { - "key": "files/upload", - "name": "upload", - "version": 1, - "subdomain": "content", - "format": "upload", - "auth": "user", - "scope": "files.content.write", - "description": "Create a new file with the contents provided in the request.\nDo not use this to upload a file larger than 150 MB. Instead, create an upload session with :route:`upload_session/start`.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the :link:`Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit`.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "UploadArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to save the file." - }, - { - "name": "mode", - "type": [ - { - "name": "WriteMode", - "type": [ - { - "name": "add", - "type": "Void", - "description": "Do not overwrite an existing file if there is a conflict. The autorename strategy is to append a number to the file name. For example, \"document.txt\" might become \"document (2).txt\"." - }, - { - "name": "overwrite", - "type": "Void", - "description": "Always overwrite the existing file. The autorename strategy is the same as it is for :field:`add`." - }, - { - "name": "update", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Overwrite if the given \"rev\" matches the existing file's \"rev\". The supplied value should be the latest known \"rev\" of the file, for example, from :type:`FileMetadata`, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given \"rev\" matches the existing file's current \"rev\" on the Dropbox servers. The autorename strategy is to append the string \"conflicted copy\" to the file name. For example, \"document.txt\" might become \"document (conflicted copy).txt\" or \"document (Panda's conflicted copy).txt\"." - } - ], - "description": "Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is.\nIn some situations, the conflict behavior is identical: (a) If the target path doesn't refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it's always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict.\nThe conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write.", - "typeWrap": "{} (union)" - } - ], - "description": "Selects what to do if the file already exists. The default for this union is add." - }, - { - "name": "autorename", - "type": "Boolean", - "description": "If there's a conflict, as determined by :field:`mode`, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The value to store as the :field:`client_modified` timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "mute", - "type": "Boolean", - "description": "Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If :val:`true`, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "List of custom properties to add to file. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "strict_conflict", - "type": "Boolean", - "description": "Be more strict about how each :type:`WriteMode` detects conflict. For example, always return a conflict error when :field:`mode` = :field:`WriteMode.update` and the given \"rev\" doesn't match the existing file's \"rev\", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents. The default for this field is False." - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": false, - "mute": false, - "strict_conflict": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "UploadError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "UploadWriteFailed", - "type": [ - { - "name": "reason", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the file couldn't be saved." - }, - { - "name": "upload_session_id", - "type": "String", - "description": "The upload session ID; data has already been uploaded to the corresponding upload session and this ID may be used to retry the commit with :route:`upload_session/finish`." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Unable to save the uploaded contents to a file." - }, - { - "name": "properties_error", - "type": [ - { - "name": "InvalidPropertyGroupError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - ], - "description": "The supplied property group is invalid. The file has uploaded without property groups." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - }, - { - "name": "content_hash_mismatch", - "type": "Void", - "description": "The content received by the Dropbox server in this call does not match the provided content hash." - } - ], - "example": [ - { - "value": { - ".tag": "payload_too_large" - }, - "text": null, - "label": "payload_too_large" - }, - { - "value": { - ".tag": "content_hash_mismatch" - }, - "text": null, - "label": "content_hash_mismatch" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/upload_session/append": { - "key": "files/upload_session/append", - "name": "upload_session/append", - "version": 1, - "subdomain": "content", - "format": "upload", - "auth": "user", - "scope": "files.content.write", - "description": "Append more data to an upload session.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the :link:`Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit`.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "UploadSessionCursor", - "type": [ - { - "name": "session_id", - "type": "String", - "description": "The upload session ID (returned by :route:`upload_session/start`)." - }, - { - "name": "offset", - "type": "UInt64", - "description": "Offset in bytes at which data should be appended. We use this to make sure upload data isn't lost or duplicated in the event of a network error." - } - ], - "example": [ - { - "value": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "text": null, - "label": "default" - }, - { - "value": { - "session_id": "8dd9d57374911153", - "offset": 1073741824 - }, - "text": null, - "label": "another" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "UploadSessionAppendError", - "type": [ - { - "name": "not_found", - "type": "Void", - "description": "The upload session ID was not found or has expired. Upload sessions are valid for 7 days." - }, - { - "name": "incorrect_offset", - "type": [ - { - "name": "UploadSessionOffsetError", - "type": [ - { - "name": "correct_offset", - "type": "UInt64", - "description": "The offset up to which data has been collected." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error." - }, - { - "name": "closed", - "type": "Void", - "description": "You are attempting to append data to an upload session that has already been closed (i.e. committed)." - }, - { - "name": "not_closed", - "type": "Void", - "description": "The session must be closed before calling upload_session/finish_batch." - }, - { - "name": "too_large", - "type": "Void", - "description": "You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB)." - }, - { - "name": "concurrent_session_invalid_offset", - "type": "Void", - "description": "For concurrent upload sessions, offset needs to be multiple of 4194304 bytes." - }, - { - "name": "concurrent_session_invalid_data_size", - "type": "Void", - "description": "For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - }, - { - "name": "content_hash_mismatch", - "type": "Void", - "description": "The content received by the Dropbox server in this call does not match the provided content hash." - } - ], - "example": [ - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "closed" - }, - "text": null, - "label": "closed" - }, - { - "value": { - ".tag": "not_closed" - }, - "text": null, - "label": "not_closed" - }, - { - "value": { - ".tag": "too_large" - }, - "text": null, - "label": "too_large" - }, - { - "value": { - ".tag": "concurrent_session_invalid_offset" - }, - "text": null, - "label": "concurrent_session_invalid_offset" - }, - { - "value": { - ".tag": "concurrent_session_invalid_data_size" - }, - "text": null, - "label": "concurrent_session_invalid_data_size" - }, - { - "value": { - ".tag": "payload_too_large" - }, - "text": null, - "label": "payload_too_large" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "content_hash_mismatch" - }, - "text": null, - "label": "content_hash_mismatch" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/upload_session/append_v2": { - "key": "files/upload_session/append_v2", - "name": "upload_session/append", - "version": 2, - "subdomain": "content", - "format": "upload", - "auth": "user", - "scope": "files.content.write", - "description": "Append more data to an upload session.\nWhen the parameter close is set, this call will close the session.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the :link:`Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit`.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "UploadSessionAppendArg", - "type": [ - { - "name": "cursor", - "type": [ - { - "name": "UploadSessionCursor", - "type": [ - { - "name": "session_id", - "type": "String", - "description": "The upload session ID (returned by :route:`upload_session/start`)." - }, - { - "name": "offset", - "type": "UInt64", - "description": "Offset in bytes at which data should be appended. We use this to make sure upload data isn't lost or duplicated in the event of a network error." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Contains the upload session ID and the offset." - }, - { - "name": "close", - "type": "Boolean", - "description": "If true, the current session will be closed, at which point you won't be able to call :route:`upload_session/append:2` anymore with the current session. The default for this field is False." - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "cursor": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "close": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "UploadSessionAppendError", - "type": [ - { - "name": "not_found", - "type": "Void", - "description": "The upload session ID was not found or has expired. Upload sessions are valid for 7 days." - }, - { - "name": "incorrect_offset", - "type": [ - { - "name": "UploadSessionOffsetError", - "type": [ - { - "name": "correct_offset", - "type": "UInt64", - "description": "The offset up to which data has been collected." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error." - }, - { - "name": "closed", - "type": "Void", - "description": "You are attempting to append data to an upload session that has already been closed (i.e. committed)." - }, - { - "name": "not_closed", - "type": "Void", - "description": "The session must be closed before calling upload_session/finish_batch." - }, - { - "name": "too_large", - "type": "Void", - "description": "You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB)." - }, - { - "name": "concurrent_session_invalid_offset", - "type": "Void", - "description": "For concurrent upload sessions, offset needs to be multiple of 4194304 bytes." - }, - { - "name": "concurrent_session_invalid_data_size", - "type": "Void", - "description": "For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - }, - { - "name": "content_hash_mismatch", - "type": "Void", - "description": "The content received by the Dropbox server in this call does not match the provided content hash." - } - ], - "example": [ - { - "value": { - ".tag": "not_found" - }, - "text": null, - "label": "not_found" - }, - { - "value": { - ".tag": "closed" - }, - "text": null, - "label": "closed" - }, - { - "value": { - ".tag": "not_closed" - }, - "text": null, - "label": "not_closed" - }, - { - "value": { - ".tag": "too_large" - }, - "text": null, - "label": "too_large" - }, - { - "value": { - ".tag": "concurrent_session_invalid_offset" - }, - "text": null, - "label": "concurrent_session_invalid_offset" - }, - { - "value": { - ".tag": "concurrent_session_invalid_data_size" - }, - "text": null, - "label": "concurrent_session_invalid_data_size" - }, - { - "value": { - ".tag": "payload_too_large" - }, - "text": null, - "label": "payload_too_large" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "content_hash_mismatch" - }, - "text": null, - "label": "content_hash_mismatch" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/upload_session/finish": { - "key": "files/upload_session/finish", - "name": "upload_session/finish", - "version": 1, - "subdomain": "content", - "format": "upload", - "auth": "user", - "scope": "files.content.write", - "description": "Finish an upload session and save the uploaded data to the given file path.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the :link:`Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit`.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "UploadSessionFinishArg", - "type": [ - { - "name": "cursor", - "type": [ - { - "name": "UploadSessionCursor", - "type": [ - { - "name": "session_id", - "type": "String", - "description": "The upload session ID (returned by :route:`upload_session/start`)." - }, - { - "name": "offset", - "type": "UInt64", - "description": "Offset in bytes at which data should be appended. We use this to make sure upload data isn't lost or duplicated in the event of a network error." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Contains the upload session ID and the offset." - }, - { - "name": "commit", - "type": [ - { - "name": "CommitInfo", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to save the file." - }, - { - "name": "mode", - "type": [ - { - "name": "WriteMode", - "type": [ - { - "name": "add", - "type": "Void", - "description": "Do not overwrite an existing file if there is a conflict. The autorename strategy is to append a number to the file name. For example, \"document.txt\" might become \"document (2).txt\"." - }, - { - "name": "overwrite", - "type": "Void", - "description": "Always overwrite the existing file. The autorename strategy is the same as it is for :field:`add`." - }, - { - "name": "update", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Overwrite if the given \"rev\" matches the existing file's \"rev\". The supplied value should be the latest known \"rev\" of the file, for example, from :type:`FileMetadata`, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given \"rev\" matches the existing file's current \"rev\" on the Dropbox servers. The autorename strategy is to append the string \"conflicted copy\" to the file name. For example, \"document.txt\" might become \"document (conflicted copy).txt\" or \"document (Panda's conflicted copy).txt\"." - } - ], - "description": "Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is.\nIn some situations, the conflict behavior is identical: (a) If the target path doesn't refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it's always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict.\nThe conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write.", - "typeWrap": "{} (union)" - } - ], - "description": "Selects what to do if the file already exists. The default for this union is add." - }, - { - "name": "autorename", - "type": "Boolean", - "description": "If there's a conflict, as determined by :field:`mode`, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The value to store as the :field:`client_modified` timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "mute", - "type": "Boolean", - "description": "Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If :val:`true`, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "List of custom properties to add to file. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "strict_conflict", - "type": "Boolean", - "description": "Be more strict about how each :type:`WriteMode` detects conflict. For example, always return a conflict error when :field:`mode` = :field:`WriteMode.update` and the given \"rev\" doesn't match the existing file's \"rev\", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents. The default for this field is False." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Contains the path and other optional modifiers for the commit." - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "cursor": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "commit": { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - }, - "text": null, - "label": "default" - }, - { - "value": { - "cursor": { - "session_id": "8dd9d57374911153", - "offset": 1073741824 - }, - "commit": { - "path": "/Homework/math/Vectors.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - }, - "text": null, - "label": "another" - }, - { - "value": { - "cursor": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "commit": { - "path": "/Homework/math/Matrices.txt", - "mode": { - ".tag": "update", - "update": "a1c10ce0dd78" - }, - "autorename": false, - "mute": false, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "strict_conflict": false - } - }, - "text": null, - "label": "update" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "UploadSessionFinishError", - "type": [ - { - "name": "lookup_failed", - "type": [ - { - "name": "UploadSessionLookupError", - "type": [ - { - "name": "not_found", - "type": "Void", - "description": "The upload session ID was not found or has expired. Upload sessions are valid for 7 days." - }, - { - "name": "incorrect_offset", - "type": [ - { - "name": "UploadSessionOffsetError", - "type": [ - { - "name": "correct_offset", - "type": "UInt64", - "description": "The offset up to which data has been collected." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error." - }, - { - "name": "closed", - "type": "Void", - "description": "You are attempting to append data to an upload session that has already been closed (i.e. committed)." - }, - { - "name": "not_closed", - "type": "Void", - "description": "The session must be closed before calling upload_session/finish_batch." - }, - { - "name": "too_large", - "type": "Void", - "description": "You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB)." - }, - { - "name": "concurrent_session_invalid_offset", - "type": "Void", - "description": "For concurrent upload sessions, offset needs to be multiple of 4194304 bytes." - }, - { - "name": "concurrent_session_invalid_data_size", - "type": "Void", - "description": "For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The session arguments are incorrect; the value explains the reason." - }, - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset." - }, - { - "name": "properties_error", - "type": [ - { - "name": "InvalidPropertyGroupError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - ], - "description": "The supplied property group is invalid. The file has uploaded without property groups." - }, - { - "name": "too_many_shared_folder_targets", - "type": "Void", - "description": "Field is deprecated. The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder.", - "isDeprecated": true - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations happening in the user's Dropbox. You should retry uploading this file." - }, - { - "name": "concurrent_session_data_not_allowed", - "type": "Void", - "description": "Uploading data not allowed when finishing concurrent upload session." - }, - { - "name": "concurrent_session_not_closed", - "type": "Void", - "description": "Concurrent upload sessions need to be closed before finishing." - }, - { - "name": "concurrent_session_missing_data", - "type": "Void", - "description": "Not all pieces of data were uploaded before trying to finish the session." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - }, - { - "name": "content_hash_mismatch", - "type": "Void", - "description": "The content received by the Dropbox server in this call does not match the provided content hash." - } - ], - "example": [ - { - "value": { - ".tag": "too_many_shared_folder_targets" - }, - "text": null, - "label": "too_many_shared_folder_targets" - }, - { - "value": { - ".tag": "too_many_write_operations" - }, - "text": null, - "label": "too_many_write_operations" - }, - { - "value": { - ".tag": "concurrent_session_data_not_allowed" - }, - "text": null, - "label": "concurrent_session_data_not_allowed" - }, - { - "value": { - ".tag": "concurrent_session_not_closed" - }, - "text": null, - "label": "concurrent_session_not_closed" - }, - { - "value": { - ".tag": "concurrent_session_missing_data" - }, - "text": null, - "label": "concurrent_session_missing_data" - }, - { - "value": { - ".tag": "payload_too_large" - }, - "text": null, - "label": "payload_too_large" - }, - { - "value": { - ".tag": "content_hash_mismatch" - }, - "text": null, - "label": "content_hash_mismatch" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/upload_session/finish_batch": { - "key": "files/upload_session/finish_batch", - "name": "upload_session/finish_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "This route helps you commit many files at once into a user's Dropbox. Use :route:`upload_session/start` and :route:`upload_session/append:2` to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling :route:`upload_session/finish`, use this route to finish all your upload sessions in a single request.\n:field:`UploadSessionStartArg.close` or :field:`UploadSessionAppendArg.close` needs to be true for the last :route:`upload_session/start` or :route:`upload_session/append:2` call. The maximum size of a file one can upload to an upload session is 350 GB.\nThis route will return a job_id immediately and do the async commit job in background. Use :route:`upload_session/finish_batch/check` to check the job status.\nFor the same account, this route should be executed serially. That means you should not start the next job before current job finishes. We allow up to 1000 entries in a single request.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the :link:`Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit`.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "version": 2 - }, - "request": { - "name": "UploadSessionFinishBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "UploadSessionFinishArg", - "type": [ - { - "name": "cursor", - "type": [ - { - "name": "UploadSessionCursor", - "type": [ - { - "name": "session_id", - "type": "String", - "description": "The upload session ID (returned by :route:`upload_session/start`)." - }, - { - "name": "offset", - "type": "UInt64", - "description": "Offset in bytes at which data should be appended. We use this to make sure upload data isn't lost or duplicated in the event of a network error." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Contains the upload session ID and the offset." - }, - { - "name": "commit", - "type": [ - { - "name": "CommitInfo", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to save the file." - }, - { - "name": "mode", - "type": [ - { - "name": "WriteMode", - "type": [ - { - "name": "add", - "type": "Void", - "description": "Do not overwrite an existing file if there is a conflict. The autorename strategy is to append a number to the file name. For example, \"document.txt\" might become \"document (2).txt\"." - }, - { - "name": "overwrite", - "type": "Void", - "description": "Always overwrite the existing file. The autorename strategy is the same as it is for :field:`add`." - }, - { - "name": "update", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Overwrite if the given \"rev\" matches the existing file's \"rev\". The supplied value should be the latest known \"rev\" of the file, for example, from :type:`FileMetadata`, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given \"rev\" matches the existing file's current \"rev\" on the Dropbox servers. The autorename strategy is to append the string \"conflicted copy\" to the file name. For example, \"document.txt\" might become \"document (conflicted copy).txt\" or \"document (Panda's conflicted copy).txt\"." - } - ], - "description": "Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is.\nIn some situations, the conflict behavior is identical: (a) If the target path doesn't refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it's always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict.\nThe conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write.", - "typeWrap": "{} (union)" - } - ], - "description": "Selects what to do if the file already exists. The default for this union is add." - }, - { - "name": "autorename", - "type": "Boolean", - "description": "If there's a conflict, as determined by :field:`mode`, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The value to store as the :field:`client_modified` timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "mute", - "type": "Boolean", - "description": "Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If :val:`true`, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "List of custom properties to add to file. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "strict_conflict", - "type": "Boolean", - "description": "Be more strict about how each :type:`WriteMode` detects conflict. For example, always return a conflict error when :field:`mode` = :field:`WriteMode.update` and the given \"rev\" doesn't match the existing file's \"rev\", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents. The default for this field is False." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Contains the path and other optional modifiers for the commit." - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Commit information for each file in the batch.", - "typeWrap": "List of ({}, max_items=1000)" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "cursor": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "commit": { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - "entries": [ - { - "cursor": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "commit": { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - }, - { - "cursor": { - "session_id": "8dd9d57374911153", - "offset": 1073741824 - }, - "commit": { - "path": "/Homework/math/Vectors.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - } - ] - }, - "text": null, - "label": "multiple" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "UploadSessionFinishBatchLaunch", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "UploadSessionFinishBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "UploadSessionFinishBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "UploadSessionFinishError", - "type": [ - { - "name": "lookup_failed", - "type": [ - { - "name": "UploadSessionLookupError", - "type": [ - { - "name": "not_found", - "type": "Void", - "description": "The upload session ID was not found or has expired. Upload sessions are valid for 7 days." - }, - { - "name": "incorrect_offset", - "type": [ - { - "name": "UploadSessionOffsetError", - "type": [ - { - "name": "correct_offset", - "type": "UInt64", - "description": "The offset up to which data has been collected." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error." - }, - { - "name": "closed", - "type": "Void", - "description": "You are attempting to append data to an upload session that has already been closed (i.e. committed)." - }, - { - "name": "not_closed", - "type": "Void", - "description": "The session must be closed before calling upload_session/finish_batch." - }, - { - "name": "too_large", - "type": "Void", - "description": "You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB)." - }, - { - "name": "concurrent_session_invalid_offset", - "type": "Void", - "description": "For concurrent upload sessions, offset needs to be multiple of 4194304 bytes." - }, - { - "name": "concurrent_session_invalid_data_size", - "type": "Void", - "description": "For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The session arguments are incorrect; the value explains the reason." - }, - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset." - }, - { - "name": "properties_error", - "type": [ - { - "name": "InvalidPropertyGroupError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - ], - "description": "The supplied property group is invalid. The file has uploaded without property groups." - }, - { - "name": "too_many_shared_folder_targets", - "type": "Void", - "description": "Field is deprecated. The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder.", - "isDeprecated": true - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations happening in the user's Dropbox. You should retry uploading this file." - }, - { - "name": "concurrent_session_data_not_allowed", - "type": "Void", - "description": "Uploading data not allowed when finishing concurrent upload session." - }, - { - "name": "concurrent_session_not_closed", - "type": "Void", - "description": "Concurrent upload sessions need to be closed before finishing." - }, - { - "name": "concurrent_session_missing_data", - "type": "Void", - "description": "Not all pieces of data were uploaded before trying to finish the session." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - }, - { - "name": "content_hash_mismatch", - "type": "Void", - "description": "The content received by the Dropbox server in this call does not match the provided content hash." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each entry in :field:`UploadSessionFinishBatchArg.entries` will appear at the same position inside :field:`UploadSessionFinishBatchResult.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - ] - }, - "text": null, - "label": "complete" - }, - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "async_job_id" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Result returned by :route:`upload_session/finish_batch` that may either launch an asynchronous job or complete synchronously.", - "typeWrap": "{} (open union)" - } - }, - "files/upload_session/finish_batch_v2": { - "key": "files/upload_session/finish_batch_v2", - "name": "upload_session/finish_batch", - "version": 2, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "This route helps you commit many files at once into a user's Dropbox. Use :route:`upload_session/start` and :route:`upload_session/append:2` to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling :route:`upload_session/finish`, use this route to finish all your upload sessions in a single request.\n:field:`UploadSessionStartArg.close` or :field:`UploadSessionAppendArg.close` needs to be true for the last :route:`upload_session/start` or :route:`upload_session/append:2` call of each upload session. The maximum size of a file one can upload to an upload session is 350 GB.\nWe allow up to 1000 entries in a single request.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the :link:`Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit`.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "UploadSessionFinishBatchArg", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "UploadSessionFinishArg", - "type": [ - { - "name": "cursor", - "type": [ - { - "name": "UploadSessionCursor", - "type": [ - { - "name": "session_id", - "type": "String", - "description": "The upload session ID (returned by :route:`upload_session/start`)." - }, - { - "name": "offset", - "type": "UInt64", - "description": "Offset in bytes at which data should be appended. We use this to make sure upload data isn't lost or duplicated in the event of a network error." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Contains the upload session ID and the offset." - }, - { - "name": "commit", - "type": [ - { - "name": "CommitInfo", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to save the file." - }, - { - "name": "mode", - "type": [ - { - "name": "WriteMode", - "type": [ - { - "name": "add", - "type": "Void", - "description": "Do not overwrite an existing file if there is a conflict. The autorename strategy is to append a number to the file name. For example, \"document.txt\" might become \"document (2).txt\"." - }, - { - "name": "overwrite", - "type": "Void", - "description": "Always overwrite the existing file. The autorename strategy is the same as it is for :field:`add`." - }, - { - "name": "update", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Overwrite if the given \"rev\" matches the existing file's \"rev\". The supplied value should be the latest known \"rev\" of the file, for example, from :type:`FileMetadata`, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given \"rev\" matches the existing file's current \"rev\" on the Dropbox servers. The autorename strategy is to append the string \"conflicted copy\" to the file name. For example, \"document.txt\" might become \"document (conflicted copy).txt\" or \"document (Panda's conflicted copy).txt\"." - } - ], - "description": "Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is.\nIn some situations, the conflict behavior is identical: (a) If the target path doesn't refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it's always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict.\nThe conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write.", - "typeWrap": "{} (union)" - } - ], - "description": "Selects what to do if the file already exists. The default for this union is add." - }, - { - "name": "autorename", - "type": "Boolean", - "description": "If there's a conflict, as determined by :field:`mode`, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The value to store as the :field:`client_modified` timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "mute", - "type": "Boolean", - "description": "Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If :val:`true`, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "List of custom properties to add to file. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "strict_conflict", - "type": "Boolean", - "description": "Be more strict about how each :type:`WriteMode` detects conflict. For example, always return a conflict error when :field:`mode` = :field:`WriteMode.update` and the given \"rev\" doesn't match the existing file's \"rev\", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents. The default for this field is False." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Contains the path and other optional modifiers for the commit." - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Commit information for each file in the batch.", - "typeWrap": "List of ({}, max_items=1000)" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "cursor": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "commit": { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - "entries": [ - { - "cursor": { - "session_id": "1234faaf0678bcde", - "offset": 0 - }, - "commit": { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - }, - { - "cursor": { - "session_id": "8dd9d57374911153", - "offset": 1073741824 - }, - "commit": { - "path": "/Homework/math/Vectors.txt", - "mode": "add", - "autorename": true, - "mute": false, - "strict_conflict": false - } - } - ] - }, - "text": null, - "label": "multiple" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "UploadSessionFinishBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "UploadSessionFinishBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "UploadSessionFinishError", - "type": [ - { - "name": "lookup_failed", - "type": [ - { - "name": "UploadSessionLookupError", - "type": [ - { - "name": "not_found", - "type": "Void", - "description": "The upload session ID was not found or has expired. Upload sessions are valid for 7 days." - }, - { - "name": "incorrect_offset", - "type": [ - { - "name": "UploadSessionOffsetError", - "type": [ - { - "name": "correct_offset", - "type": "UInt64", - "description": "The offset up to which data has been collected." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error." - }, - { - "name": "closed", - "type": "Void", - "description": "You are attempting to append data to an upload session that has already been closed (i.e. committed)." - }, - { - "name": "not_closed", - "type": "Void", - "description": "The session must be closed before calling upload_session/finish_batch." - }, - { - "name": "too_large", - "type": "Void", - "description": "You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB)." - }, - { - "name": "concurrent_session_invalid_offset", - "type": "Void", - "description": "For concurrent upload sessions, offset needs to be multiple of 4194304 bytes." - }, - { - "name": "concurrent_session_invalid_data_size", - "type": "Void", - "description": "For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The session arguments are incorrect; the value explains the reason." - }, - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset." - }, - { - "name": "properties_error", - "type": [ - { - "name": "InvalidPropertyGroupError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - ], - "description": "The supplied property group is invalid. The file has uploaded without property groups." - }, - { - "name": "too_many_shared_folder_targets", - "type": "Void", - "description": "Field is deprecated. The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder.", - "isDeprecated": true - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations happening in the user's Dropbox. You should retry uploading this file." - }, - { - "name": "concurrent_session_data_not_allowed", - "type": "Void", - "description": "Uploading data not allowed when finishing concurrent upload session." - }, - { - "name": "concurrent_session_not_closed", - "type": "Void", - "description": "Concurrent upload sessions need to be closed before finishing." - }, - { - "name": "concurrent_session_missing_data", - "type": "Void", - "description": "Not all pieces of data were uploaded before trying to finish the session." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - }, - { - "name": "content_hash_mismatch", - "type": "Void", - "description": "The content received by the Dropbox server in this call does not match the provided content hash." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each entry in :field:`UploadSessionFinishBatchArg.entries` will appear at the same position inside :field:`UploadSessionFinishBatchResult.entries`.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "entries": [ - { - ".tag": "success", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - } - }, - "files/upload_session/finish_batch/check": { - "key": "files/upload_session/finish_batch/check", - "name": "upload_session/finish_batch/check", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "Returns the status of an asynchronous job for :route:`upload_session/finish_batch`. If success, it returns list of result for each entry.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "UploadSessionFinishBatchJobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "UploadSessionFinishBatchResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "UploadSessionFinishBatchResultEntry", - "type": [ - { - "name": "success", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "failure", - "type": [ - { - "name": "UploadSessionFinishError", - "type": [ - { - "name": "lookup_failed", - "type": [ - { - "name": "UploadSessionLookupError", - "type": [ - { - "name": "not_found", - "type": "Void", - "description": "The upload session ID was not found or has expired. Upload sessions are valid for 7 days." - }, - { - "name": "incorrect_offset", - "type": [ - { - "name": "UploadSessionOffsetError", - "type": [ - { - "name": "correct_offset", - "type": "UInt64", - "description": "The offset up to which data has been collected." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error." - }, - { - "name": "closed", - "type": "Void", - "description": "You are attempting to append data to an upload session that has already been closed (i.e. committed)." - }, - { - "name": "not_closed", - "type": "Void", - "description": "The session must be closed before calling upload_session/finish_batch." - }, - { - "name": "too_large", - "type": "Void", - "description": "You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB)." - }, - { - "name": "concurrent_session_invalid_offset", - "type": "Void", - "description": "For concurrent upload sessions, offset needs to be multiple of 4194304 bytes." - }, - { - "name": "concurrent_session_invalid_data_size", - "type": "Void", - "description": "For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The session arguments are incorrect; the value explains the reason." - }, - { - "name": "path", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset." - }, - { - "name": "properties_error", - "type": [ - { - "name": "InvalidPropertyGroupError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - ], - "description": "The supplied property group is invalid. The file has uploaded without property groups." - }, - { - "name": "too_many_shared_folder_targets", - "type": "Void", - "description": "Field is deprecated. The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder.", - "isDeprecated": true - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations happening in the user's Dropbox. You should retry uploading this file." - }, - { - "name": "concurrent_session_data_not_allowed", - "type": "Void", - "description": "Uploading data not allowed when finishing concurrent upload session." - }, - { - "name": "concurrent_session_not_closed", - "type": "Void", - "description": "Concurrent upload sessions need to be closed before finishing." - }, - { - "name": "concurrent_session_missing_data", - "type": "Void", - "description": "Not all pieces of data were uploaded before trying to finish the session." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - }, - { - "name": "content_hash_mismatch", - "type": "Void", - "description": "The content received by the Dropbox server in this call does not match the provided content hash." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Each entry in :field:`UploadSessionFinishBatchArg.entries` will appear at the same position inside :field:`UploadSessionFinishBatchResult.entries`.", - "typeWrap": "List of ({})" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The :route:`upload_session/finish_batch` has finished." - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "files/upload_session/start": { - "key": "files/upload_session/start", - "name": "upload_session/start", - "version": 1, - "subdomain": "content", - "format": "upload", - "auth": "user", - "scope": "files.content.write", - "description": "Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB. This call starts a new upload session with the given data. You can then use :route:`upload_session/append:2` to add more data and :route:`upload_session/finish` to save all the data to a file in Dropbox.\nA single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.\nAn upload session can be used for a maximum of 7 days. Attempting to use an :field:`UploadSessionStartResult.session_id` with :route:`upload_session/append:2` or :route:`upload_session/finish` more than 7 days after its creation will return a :field:`UploadSessionLookupError.not_found`.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the :link:`Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit`.\nBy default, upload sessions require you to send content of the file in sequential order via consecutive :route:`upload_session/start`, :route:`upload_session/append:2`, :route:`upload_session/finish` calls. For better performance, you can instead optionally use a :field:`UploadSessionType.concurrent` upload session. To start a new concurrent session, set :field:`UploadSessionStartArg.session_type` to :field:`UploadSessionType.concurrent`. After that, you can send file data in concurrent :route:`upload_session/append:2` requests. Finally finish the session with :route:`upload_session/finish`.\nThere are couple of constraints with concurrent sessions to make them work. You can not send data with :route:`upload_session/start` or :route:`upload_session/finish` call, only with :route:`upload_session/append:2` call. Also data uploaded in :route:`upload_session/append:2` call must be multiple of 4194304 bytes (except for last :route:`upload_session/append:2` with :field:`UploadSessionStartArg.close` to :val:`true`, that may contain any remaining data).", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "UploadSessionStartArg", - "type": [ - { - "name": "close", - "type": "Boolean", - "description": "If true, the current session will be closed, at which point you won't be able to call :route:`upload_session/append:2` anymore with the current session. The default for this field is False." - }, - { - "name": "session_type", - "type": [ - { - "name": "UploadSessionType", - "type": [ - { - "name": "sequential", - "type": "Void", - "description": "Pieces of data are uploaded sequentially one after another. This is the default behavior." - }, - { - "name": "concurrent", - "type": "Void", - "description": "Pieces of data can be uploaded in concurrent RPCs in any order." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Type of upload session you want to start. If not specified, default is :field:`UploadSessionType.sequential`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "close": false - }, - "text": null, - "label": "with_close" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "UploadSessionStartResult", - "type": [ - { - "name": "session_id", - "type": "String", - "description": "A unique identifier for the upload session. Pass this to :route:`upload_session/append:2` and :route:`upload_session/finish`." - } - ], - "example": [ - { - "value": { - "session_id": "1234faaf0678bcde" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "UploadSessionStartError", - "type": [ - { - "name": "concurrent_session_data_not_allowed", - "type": "Void", - "description": "Uploading data not allowed when starting concurrent upload session." - }, - { - "name": "concurrent_session_close_not_allowed", - "type": "Void", - "description": "Can not start a closed concurrent upload session." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - }, - { - "name": "content_hash_mismatch", - "type": "Void", - "description": "The content received by the Dropbox server in this call does not match the provided content hash." - } - ], - "example": [ - { - "value": { - ".tag": "concurrent_session_data_not_allowed" - }, - "text": null, - "label": "concurrent_session_data_not_allowed" - }, - { - "value": { - ".tag": "concurrent_session_close_not_allowed" - }, - "text": null, - "label": "concurrent_session_close_not_allowed" - }, - { - "value": { - ".tag": "payload_too_large" - }, - "text": null, - "label": "payload_too_large" - }, - { - "value": { - ".tag": "content_hash_mismatch" - }, - "text": null, - "label": "content_hash_mismatch" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/upload_session/start_batch": { - "key": "files/upload_session/start_batch", - "name": "upload_session/start_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.content.write", - "description": "This route starts batch of upload_sessions. Please refer to `upload_session/start` usage.\nCalls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the :link:`Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit`.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "UploadSessionStartBatchArg", - "type": [ - { - "name": "num_sessions", - "type": "UInt64(min=1, max=1000)", - "description": "The number of upload sessions to start." - }, - { - "name": "session_type", - "type": [ - { - "name": "UploadSessionType", - "type": [ - { - "name": "sequential", - "type": "Void", - "description": "Pieces of data are uploaded sequentially one after another. This is the default behavior." - }, - { - "name": "concurrent", - "type": "Void", - "description": "Pieces of data can be uploaded in concurrent RPCs in any order." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Type of upload session you want to start. If not specified, default is :field:`UploadSessionType.sequential`. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "num_sessions": 1 - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "UploadSessionStartBatchResult", - "type": [ - { - "name": "session_ids", - "type": "String", - "description": "A List of unique identifiers for the upload session. Pass each session_id to :route:`upload_session/append:2` and :route:`upload_session/finish`.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "session_ids": [ - "1234faaf0678bcde" - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - } - }, - "files/alpha/get_metadata": { - "key": "files/alpha/get_metadata", - "name": "alpha/get_metadata", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "description": "Returns the metadata for a file or folder. This is an alpha endpoint compatible with the properties API.\nNote: Metadata for the root folder is unsupported.", - "isPreview": true, - "allowAppFolderApp": true, - "deprecated": { - "route": "get_metadata" - }, - "request": { - "name": "AlphaGetMetadataArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path of a file or folder on Dropbox." - }, - { - "name": "include_media_info", - "type": "Boolean", - "description": "If true, :field:`FileMetadata.media_info` is set for photo and video. The default for this field is False." - }, - { - "name": "include_deleted", - "type": "Boolean", - "description": "If true, :type:`DeletedMetadata` will be returned for deleted file or folder, otherwise :field:`LookupError.not_found` will be returned. The default for this field is False." - }, - { - "name": "include_has_explicit_shared_members", - "type": "Boolean", - "description": "If true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False." - }, - { - "name": "include_property_groups", - "type": [ - { - "name": "TemplateFilterBase", - "type": [ - { - "name": "filter_some", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).", - "typeWrap": "List of ({}, min_items=1)" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ], - "description": "If set to a valid list of template IDs, :field:`FileMetadata.property_groups` is set if there exists property data associated with the file and each of the listed templates. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "include_property_templates", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Field is deprecated. If set to a valid list of template IDs, :field:`FileMetadata.property_groups` is set for files with custom properties. This field is optional.", - "isDeprecated": true, - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/math", - "include_media_info": false, - "include_deleted": false, - "include_has_explicit_shared_members": false - }, - "text": null, - "label": "default" - }, - { - "value": { - "path": "id:a4ayc_80_OEAAAAAAAAAYa", - "include_media_info": false, - "include_deleted": false, - "include_has_explicit_shared_members": false - }, - "text": null, - "label": "id" - }, - { - "value": { - "path": "rev:a1c10ce0dd78", - "include_media_info": false, - "include_deleted": false, - "include_has_explicit_shared_members": false - }, - "text": null, - "label": "rev" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "Metadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the folder." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`sharing_info` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FolderSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Set if the folder is contained by a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "traverse_only", - "type": "Boolean", - "description": "Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder. The default for this field is False." - }, - { - "name": "no_access", - "type": "Boolean", - "description": "Specifies that the folder cannot be accessed by the user. The default for this field is False." - } - ], - "description": "Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.", - "typeWrap": "" - } - ], - "description": "Set if the folder is contained in a shared folder or is a shared folder mount point. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "typeWrap": "" - } - ] - }, - { - "name": "deleted", - "type": [ - { - "name": "DeletedMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Indicates that there used to be a file or folder at this path, but it no longer exists.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "folder", - "name": "math", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "path_lower": "/homework/math", - "path_display": "/Homework/math", - "sharing_info": { - "read_only": false, - "parent_shared_folder_id": "84528192421", - "traverse_only": false, - "no_access": false - }, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "file", - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": "Metadata for a file or folder.", - "typeWrap": "{} (datatype with subtypes)" - }, - "error": { - "name": "AlphaGetMetadataError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "properties_error", - "type": [ - { - "name": "LookUpPropertiesError", - "type": [ - { - "name": "property_group_not_found", - "type": "Void", - "description": "No property group was found." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [], - "description": null, - "typeWrap": "{} (union)" - } - }, - "files/alpha/upload": { - "key": "files/alpha/upload", - "name": "alpha/upload", - "version": 1, - "subdomain": "content", - "format": "upload", - "auth": "user", - "scope": "files.content.write", - "description": "Create a new file with the contents provided in the request. Note that the behavior of this alpha endpoint is unstable and subject to change.\nDo not use this to upload a file larger than 150 MB. Instead, create an upload session with :route:`upload_session/start`.", - "isPreview": true, - "allowAppFolderApp": true, - "deprecated": { - "route": "upload" - }, - "request": { - "name": "UploadArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)\")", - "description": "Path in the user's Dropbox to save the file." - }, - { - "name": "mode", - "type": [ - { - "name": "WriteMode", - "type": [ - { - "name": "add", - "type": "Void", - "description": "Do not overwrite an existing file if there is a conflict. The autorename strategy is to append a number to the file name. For example, \"document.txt\" might become \"document (2).txt\"." - }, - { - "name": "overwrite", - "type": "Void", - "description": "Always overwrite the existing file. The autorename strategy is the same as it is for :field:`add`." - }, - { - "name": "update", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "Overwrite if the given \"rev\" matches the existing file's \"rev\". The supplied value should be the latest known \"rev\" of the file, for example, from :type:`FileMetadata`, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given \"rev\" matches the existing file's current \"rev\" on the Dropbox servers. The autorename strategy is to append the string \"conflicted copy\" to the file name. For example, \"document.txt\" might become \"document (conflicted copy).txt\" or \"document (Panda's conflicted copy).txt\"." - } - ], - "description": "Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is.\nIn some situations, the conflict behavior is identical: (a) If the target path doesn't refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it's always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict.\nThe conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write.", - "typeWrap": "{} (union)" - } - ], - "description": "Selects what to do if the file already exists. The default for this union is add." - }, - { - "name": "autorename", - "type": "Boolean", - "description": "If there's a conflict, as determined by :field:`mode`, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The value to store as the :field:`client_modified` timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "mute", - "type": "Boolean", - "description": "Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If :val:`true`, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "List of custom properties to add to file. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "strict_conflict", - "type": "Boolean", - "description": "Be more strict about how each :type:`WriteMode` detects conflict. For example, always return a conflict error when :field:`mode` = :field:`WriteMode.update` and the given \"rev\" doesn't match the existing file's \"rev\", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents. The default for this field is False." - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/math/Matrices.txt", - "mode": "add", - "autorename": false, - "mute": false, - "strict_conflict": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "FileMetadata", - "type": [ - { - "name": "name", - "type": "String", - "description": "The last component of the path (including extension). This never contains a slash." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the file." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by :route:`list_folder/continue`. This field will be null if the file or folder is not mounted. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "Field is deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id` or :field:`FolderSharingInfo.parent_shared_folder_id` instead. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "preview_url", - "type": "String", - "description": "The preview URL of the file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "media_info", - "type": [ - { - "name": "MediaInfo", - "type": [ - { - "name": "pending", - "type": "Void", - "description": "Indicate the photo/video is still under processing and metadata is not available yet." - }, - { - "name": "metadata", - "type": [ - { - "name": "MediaMetadata", - "type": [ - { - "name": "photo", - "type": [ - { - "name": "PhotoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a photo.", - "typeWrap": "" - } - ] - }, - { - "name": "video", - "type": [ - { - "name": "VideoMetadata", - "type": [ - { - "name": "dimensions", - "type": [ - { - "name": "Dimensions", - "type": [ - { - "name": "height", - "type": "UInt64", - "description": "Height of the photo/video." - }, - { - "name": "width", - "type": "UInt64", - "description": "Width of the photo/video." - } - ], - "description": "Dimensions for a photo or video.", - "typeWrap": "" - } - ], - "description": "Dimension of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "location", - "type": [ - { - "name": "GpsCoordinates", - "type": [ - { - "name": "latitude", - "type": "Float64", - "description": "Latitude of the GPS coordinates." - }, - { - "name": "longitude", - "type": "Float64", - "description": "Longitude of the GPS coordinates." - } - ], - "description": "GPS coordinates for a photo or video.", - "typeWrap": "" - } - ], - "description": "The GPS coordinate of the photo/video. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "time_taken", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp when the photo/video is taken. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "duration", - "type": "UInt64", - "description": "The duration of the video in milliseconds. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a video.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a photo or video.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The metadata for the photo/video." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "Additional information if the file is a photo or video. This field will not be set on entries returned by :route:`list_folder`, :route:`list_folder/continue`, or :route:`get_thumbnail_batch`, starting December 2, 2019. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "symlink_info", - "type": [ - { - "name": "SymlinkInfo", - "type": [ - { - "name": "target", - "type": "String", - "description": "The target this symlink points to." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set if this file is a symlink. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "sharing_info", - "type": [ - { - "name": "FileSharingInfo", - "type": [ - { - "name": "read_only", - "type": "Boolean", - "description": "True if the file or folder is inside a read-only shared folder." - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "ID of shared folder that holds this file." - }, - { - "name": "modified_by", - "type": "String(min_length=40, max_length=40)", - "description": "The last user who modified the file. This field will be null if the user's account has been deleted. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Sharing info for a file which is contained by a shared folder.", - "typeWrap": "" - } - ], - "description": "Set if this file is contained in a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "is_downloadable", - "type": "Boolean", - "description": "If true, file can be downloaded directly; else the file must be exported. The default for this field is True." - }, - { - "name": "export_info", - "type": [ - { - "name": "ExportInfo", - "type": [ - { - "name": "export_as", - "type": "String", - "description": "Format to which the file can be exported to. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "export_options", - "type": "String", - "description": "Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Export information for a file.", - "typeWrap": "" - } - ], - "description": "Information about format this file can be exported to. This filed must be set if :field:`is_downloadable` is set to false. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Additional information if the file has custom properties with the property template specified. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "has_explicit_shared_members", - "type": "Boolean", - "description": "This flag will only be present if include_has_explicit_shared_members is true in :route:`list_folder` or :route:`get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_hash", - "type": "String(min_length=64, max_length=64)", - "description": "A hash of the file content. This field can be used to verify data integrity. For more information see our :link:`Content hash https://www.dropbox.com/developers/reference/content-hash` page. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "file_lock_info", - "type": [ - { - "name": "FileLockMetadata", - "type": [ - { - "name": "is_lockholder", - "type": "Boolean", - "description": "True if caller holds the file lock. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_name", - "type": "String", - "description": "The display name of the lock holder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "lockholder_account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the lock holder if known. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "created", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The timestamp of the lock was created. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "If present, the metadata associated with the file's current lock. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ], - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "is_lockholder": true, - "lockholder_name": "Imaginary User", - "created": "2015-05-12T15:50:38Z" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - "name": "Prime_Numbers.txt", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "path_lower": "/homework/math/prime_numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "sharing_info": { - "read_only": true, - "parent_shared_folder_id": "84528192421", - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "is_downloadable": true, - "has_explicit_shared_members": false, - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "text": null, - "label": "search_file_metadata" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "UploadError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "UploadWriteFailed", - "type": [ - { - "name": "reason", - "type": [ - { - "name": "WriteError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "conflict", - "type": [ - { - "name": "WriteConflictError", - "type": [ - { - "name": "file", - "type": "Void", - "description": "There's a file in the way." - }, - { - "name": "folder", - "type": "Void", - "description": "There's a folder in the way." - }, - { - "name": "file_ancestor", - "type": "Void", - "description": "There's a file at an ancestor path, so we couldn't create the required parent folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Couldn't write to the target path because there was something in the way." - }, - { - "name": "no_write_permission", - "type": "Void", - "description": "The user doesn't have permissions to write to the target location." - }, - { - "name": "insufficient_space", - "type": "Void", - "description": "The user doesn't have enough available space (bytes) to write more data." - }, - { - "name": "disallowed_name", - "type": "Void", - "description": "Dropbox will not save the file or folder because of its name." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This endpoint cannot move or delete team folders." - }, - { - "name": "operation_suppressed", - "type": "Void", - "description": "This file operation is not allowed at this path." - }, - { - "name": "too_many_write_operations", - "type": "Void", - "description": "There are too many write operations in user's Dropbox. Please retry this request." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the file couldn't be saved." - }, - { - "name": "upload_session_id", - "type": "String", - "description": "The upload session ID; data has already been uploaded to the corresponding upload session and this ID may be used to retry the commit with :route:`upload_session/finish`." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Unable to save the uploaded contents to a file." - }, - { - "name": "properties_error", - "type": [ - { - "name": "InvalidPropertyGroupError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - ], - "description": "The supplied property group is invalid. The file has uploaded without property groups." - }, - { - "name": "payload_too_large", - "type": "Void", - "description": "The request payload must be at most 150 MB." - }, - { - "name": "content_hash_mismatch", - "type": "Void", - "description": "The content received by the Dropbox server in this call does not match the provided content hash." - } - ], - "example": [ - { - "value": { - ".tag": "payload_too_large" - }, - "text": null, - "label": "payload_too_large" - }, - { - "value": { - ".tag": "content_hash_mismatch" - }, - "text": null, - "label": "content_hash_mismatch" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "files/properties/add": { - "key": "files/properties/add", - "name": "properties/add", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "deprecated": {}, - "request": { - "name": "AddPropertiesArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file or folder." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The property groups which are to be added to a Dropbox file. No two groups in the input should refer to the same template.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "" - }, - "error": { - "name": "AddPropertiesError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - }, - { - "name": "property_group_already_exists", - "type": "Void", - "description": "A property group associated with this template and file already exists." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "unsupported_folder" - }, - "text": null, - "label": "unsupported_folder" - }, - { - "value": { - ".tag": "property_field_too_large" - }, - "text": null, - "label": "property_field_too_large" - }, - { - "value": { - ".tag": "does_not_fit_template" - }, - "text": null, - "label": "does_not_fit_template" - }, - { - "value": { - ".tag": "duplicate_property_groups" - }, - "text": null, - "label": "duplicate_property_groups" - }, - { - "value": { - ".tag": "property_group_already_exists" - }, - "text": null, - "label": "property_group_already_exists" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - }, - "files/properties/overwrite": { - "key": "files/properties/overwrite", - "name": "properties/overwrite", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "deprecated": {}, - "request": { - "name": "OverwritePropertyGroupArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file or folder." - }, - { - "name": "property_groups", - "type": [ - { - "name": "PropertyGroup", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for the associated template." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The actual properties associated with the template. There can be up to 32 property types per template.", - "typeWrap": "List of ({})" - } - ], - "description": "A subset of the property fields described by the corresponding :type:`PropertyGroupTemplate`. Properties are always added to a Dropbox file as a :type:`PropertyGroup`. The possible key names and value types in this group are defined by the corresponding :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The property groups \"snapshot\" updates to force apply. No two groups in the input should refer to the same template.", - "typeWrap": "List of ({}, min_items=1)" - } - ], - "example": [ - { - "value": { - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "" - }, - "error": { - "name": "InvalidPropertyGroupError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "unsupported_folder" - }, - "text": null, - "label": "unsupported_folder" - }, - { - "value": { - ".tag": "property_field_too_large" - }, - "text": null, - "label": "property_field_too_large" - }, - { - "value": { - ".tag": "does_not_fit_template" - }, - "text": null, - "label": "does_not_fit_template" - }, - { - "value": { - ".tag": "duplicate_property_groups" - }, - "text": null, - "label": "duplicate_property_groups" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - }, - "files/properties/remove": { - "key": "files/properties/remove", - "name": "properties/remove", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "deprecated": {}, - "request": { - "name": "RemovePropertiesArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file or folder." - }, - { - "name": "property_template_ids", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A list of identifiers for a template created by :route:`templates/add_for_user` or :route:`templates/add_for_team`.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "path": "/my_awesome/word.docx", - "property_template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "" - }, - "error": { - "name": "RemovePropertiesError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_group_lookup", - "type": [ - { - "name": "LookUpPropertiesError", - "type": [ - { - "name": "property_group_not_found", - "type": "Void", - "description": "No property group was found." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "unsupported_folder" - }, - "text": null, - "label": "unsupported_folder" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - }, - "files/properties/template/get": { - "key": "files/properties/template/get", - "name": "properties/template/get", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "deprecated": {}, - "request": { - "name": "GetTemplateArg", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "An identifier for template added by route See :route:`templates/add_for_user` or :route:`templates/add_for_team`." - } - ], - "example": [ - { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "" - }, - "response": { - "name": "GetTemplateResult", - "type": [ - { - "name": "name", - "type": "String", - "description": "Display name for the template. Template names can be up to 256 bytes." - }, - { - "name": "description", - "type": "String", - "description": "Description for the template. Template descriptions can be up to 1024 bytes." - }, - { - "name": "fields", - "type": [ - { - "name": "PropertyFieldTemplate", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field being described. Property field keys can be up to 256 bytes." - }, - { - "name": "description", - "type": "String", - "description": "Description of the property field. Property field descriptions can be up to 1024 bytes." - }, - { - "name": "type", - "type": [ - { - "name": "PropertyType", - "type": [ - { - "name": "string", - "type": "Void", - "description": "The associated property field will be of type string. Unicode is supported." - } - ], - "description": "Data type of the given property field added.", - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ], - "description": "Data type of the value of this property field. This type will be enforced upon property creation and modifications." - } - ], - "description": "Defines how a single property field may be structured. Used exclusively by :type:`PropertyGroupTemplate`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "name": "Security", - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "name": "Security Policy", - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "type": { - ".tag": "string" - } - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "" - }, - "error": { - "name": "TemplateError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - }, - "files/properties/template/list": { - "key": "files/properties/template/list", - "name": "properties/template/list", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.read", - "deprecated": {}, - "response": { - "name": "ListTemplateResult", - "type": [ - { - "name": "template_ids", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "List of identifiers for templates added by See :route:`templates/add_for_user` or :route:`templates/add_for_team`.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "" - }, - "error": { - "name": "TemplateError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - }, - "files/properties/update": { - "key": "files/properties/update", - "name": "properties/update", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "files.metadata.write", - "deprecated": {}, - "request": { - "name": "UpdatePropertiesArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)\")", - "description": "A unique identifier for the file or folder." - }, - { - "name": "update_property_groups", - "type": [ - { - "name": "PropertyGroupUpdate", - "type": [ - { - "name": "template_id", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "A unique identifier for a property template." - }, - { - "name": "add_or_update_fields", - "type": [ - { - "name": "PropertyField", - "type": [ - { - "name": "name", - "type": "String", - "description": "Key of the property field associated with a file and template. Keys can be up to 256 bytes." - }, - { - "name": "value", - "type": "String", - "description": "Value of the property field associated with a file and template. Values can be up to 1024 bytes." - } - ], - "description": "Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a :type:`PropertyGroup`.", - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "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.", - "typeWrap": "List of ({})?" - }, - { - "name": "remove_fields", - "type": "String", - "description": "Property fields to remove (by name), provided they exist. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "" - } - ], - "description": "The property groups \"delta\" updates to apply.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "path": "/my_awesome/word.docx", - "update_property_groups": [ - { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa", - "add_or_update_fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "remove_fields": [] - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "" - }, - "error": { - "name": "UpdatePropertiesError", - "type": [ - { - "name": "template_not_found", - "type": "String(min_length=1, pattern=\"(/|ptid:).*\")", - "description": "Template does not exist for the given identifier." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "You do not have permission to modify this template." - }, - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "unsupported_folder", - "type": "Void", - "description": "This folder cannot be tagged. Tagging folders is not supported for team-owned templates." - }, - { - "name": "property_field_too_large", - "type": "Void", - "description": "One or more of the supplied property field values is too large." - }, - { - "name": "does_not_fit_template", - "type": "Void", - "description": "One or more of the supplied property fields does not conform to the template specifications." - }, - { - "name": "duplicate_property_groups", - "type": "Void", - "description": "There are 2 or more property groups referring to the same templates in the input." - }, - { - "name": "property_group_lookup", - "type": [ - { - "name": "LookUpPropertiesError", - "type": [ - { - "name": "property_group_not_found", - "type": "Void", - "description": "No property group was found." - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "restricted_content" - }, - "text": null, - "label": "restricted_content" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "unsupported_folder" - }, - "text": null, - "label": "unsupported_folder" - }, - { - "value": { - ".tag": "property_field_too_large" - }, - "text": null, - "label": "property_field_too_large" - }, - { - "value": { - ".tag": "does_not_fit_template" - }, - "text": null, - "label": "does_not_fit_template" - }, - { - "value": { - ".tag": "duplicate_property_groups" - }, - "text": null, - "label": "duplicate_property_groups" - } - ], - "description": null, - "importedNamespace": "file_properties", - "typeWrap": "{} (union)" - } - }, - "sharing/add_file_member": { - "key": "sharing/add_file_member", - "name": "add_file_member", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Adds specified members to a file.", - "selectAdminMode": "team_admin", - "request": { - "name": "AddFileMemberArgs", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "File to which to add members." - }, - { - "name": "members", - "type": [ - { - "name": "MemberSelector", - "type": [ - { - "name": "dropbox_id", - "type": "String(min_length=1)", - "description": "Dropbox account, team member, or group ID of member." - }, - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of member." - } - ], - "description": "Includes different ways to identify a member of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user's main account email.", - "typeWrap": "List of ({})" - }, - { - "name": "custom_message", - "type": "String", - "description": "Message to send to added members in their invitation. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "quiet", - "type": "Boolean", - "description": "Whether added members should be notified via email and device notifications of their invitation. The default for this field is False." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "AccessLevel union object, describing what access level we want to give new members. The default for this union is viewer." - }, - { - "name": "add_message_as_comment", - "type": "Boolean", - "description": "If the custom message should be added as a comment on the file. The default for this field is False." - } - ], - "example": [ - { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "members": [ - { - ".tag": "email", - "email": "justin@example.com" - } - ], - "custom_message": "This is a custom message about ACME.doc", - "quiet": false, - "access_level": "viewer", - "add_message_as_comment": false - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`add_file_member`.", - "typeWrap": "" - }, - "response": { - "name": "FileMemberActionResult", - "type": [ - { - "name": "member", - "type": [ - { - "name": "MemberSelector", - "type": [ - { - "name": "dropbox_id", - "type": "String(min_length=1)", - "description": "Dropbox account, team member, or group ID of member." - }, - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of member." - } - ], - "description": "Includes different ways to identify a member of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "One of specified input members." - }, - { - "name": "result", - "type": [ - { - "name": "FileMemberActionIndividualResult", - "type": [ - { - "name": "success", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "member_error", - "type": [ - { - "name": "FileMemberActionError", - "type": [ - { - "name": "invalid_member", - "type": "Void", - "description": "Specified member was not found." - }, - { - "name": "no_permission", - "type": "Void", - "description": "User does not have permission to perform this action on this member." - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ], - "description": "Specified file was invalid or user does not have access." - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "User was not able to perform this action." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "The outcome of the action on this member." - }, - { - "name": "sckey_sha1", - "type": "String", - "description": "The SHA-1 encrypted shared content key. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "invitation_signature", - "type": "String", - "description": "The sharing sender-recipient invitation signatures for the input member_id. A member_id can be a group and thus have multiple users and multiple invitation signatures. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Per-member result for :route:`add_file_member`.", - "typeWrap": "List of ({})" - }, - "error": { - "name": "AddFileMemberError", - "type": [ - { - "name": "user_error", - "type": [ - { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "rate_limit", - "type": "Void", - "description": "The user has reached the rate limit for invitations." - }, - { - "name": "invalid_comment", - "type": "Void", - "description": "The custom message did not pass comment permissions checks." - } - ], - "example": [ - { - "value": { - ".tag": "rate_limit" - }, - "text": null, - "label": "rate_limit" - }, - { - "value": { - ".tag": "invalid_comment" - }, - "text": null, - "label": "invalid_comment" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Errors for :route:`add_file_member`.", - "typeWrap": "{} (open union)" - } - }, - "sharing/add_folder_member": { - "key": "sharing/add_folder_member", - "name": "add_folder_member", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.\nFor the new member to get access to all the functionality for this folder, you will need to call :route:`mount_folder` on their behalf.", - "selectAdminMode": "team_admin", - "request": { - "name": "AddFolderMemberArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "members", - "type": [ - { - "name": "AddMember", - "type": [ - { - "name": "member", - "type": [ - { - "name": "MemberSelector", - "type": [ - { - "name": "dropbox_id", - "type": "String(min_length=1)", - "description": "Dropbox account, team member, or group ID of member." - }, - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of member." - } - ], - "description": "Includes different ways to identify a member of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member to add to the shared folder." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level to grant :field:`member` to the shared folder. :field:`AccessLevel.owner` is disallowed. The default for this union is viewer." - } - ], - "description": "The member and type of access the member should have when added to a shared folder.", - "typeWrap": "" - } - ], - "description": "The intended list of members to add. Added members will receive invites to join the shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "quiet", - "type": "Boolean", - "description": "Whether added members should be notified via email and device notifications of their invite. The default for this field is False." - }, - { - "name": "custom_message", - "type": "String(min_length=1)", - "description": "Optional message to display to added members in their invitation. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "members": [ - { - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "access_level": "editor" - }, - { - "member": { - ".tag": "dropbox_id", - "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - }, - "access_level": "viewer" - } - ], - "quiet": false, - "custom_message": "Documentation for launch day" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "AddFolderMemberError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Unable to access shared folder." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "banned_member", - "type": "Void", - "description": "The current user has been banned." - }, - { - "name": "bad_member", - "type": [ - { - "name": "AddMemberSelectorError", - "type": [ - { - "name": "automatic_group", - "type": "Void", - "description": "Automatically created groups can only be added to team folders." - }, - { - "name": "invalid_dropbox_id", - "type": "String(min_length=1)", - "description": "The value is the ID that could not be identified." - }, - { - "name": "invalid_email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "The value is the e-email address that is malformed." - }, - { - "name": "unverified_dropbox_id", - "type": "String(min_length=1)", - "description": "The value is the ID of the Dropbox user with an unverified email address. Invite unverified users by email address instead of by their Dropbox ID." - }, - { - "name": "group_deleted", - "type": "Void", - "description": "At least one of the specified groups in :field:`AddFolderMemberArg.members` is deleted." - }, - { - "name": "group_not_on_team", - "type": "Void", - "description": "Sharing to a group that is not on the current user's team." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": ":field:`AddFolderMemberArg.members` contains a bad invitation recipient." - }, - { - "name": "cant_share_outside_team", - "type": "Void", - "description": "Your team policy does not allow sharing outside of the team." - }, - { - "name": "too_many_members", - "type": "UInt64", - "description": "The value is the member limit that was reached." - }, - { - "name": "too_many_pending_invites", - "type": "UInt64", - "description": "The value is the pending invite limit that was reached." - }, - { - "name": "rate_limit", - "type": "Void", - "description": "The current user has hit the limit of invites they can send per day. Try again in 24 hours." - }, - { - "name": "too_many_invitees", - "type": "Void", - "description": "The current user is trying to share with too many people at once." - }, - { - "name": "insufficient_plan", - "type": "Void", - "description": "The current user's account doesn't support this action. An example of this is when adding a read-only member. This action can only be performed by users that have upgraded to a Pro or Business plan." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "invalid_shared_folder", - "type": "Void", - "description": "Field is deprecated. Invalid shared folder error will be returned as an access_error.", - "isDeprecated": true - } - ], - "example": [ - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "bad_member", - "bad_member": { - ".tag": "invalid_dropbox_id", - "invalid_dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - } - }, - "text": null, - "label": "member" - }, - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "banned_member" - }, - "text": null, - "label": "banned_member" - }, - { - "value": { - ".tag": "cant_share_outside_team" - }, - "text": null, - "label": "cant_share_outside_team" - }, - { - "value": { - ".tag": "rate_limit" - }, - "text": null, - "label": "rate_limit" - }, - { - "value": { - ".tag": "too_many_invitees" - }, - "text": null, - "label": "too_many_invitees" - }, - { - "value": { - ".tag": "insufficient_plan" - }, - "text": null, - "label": "insufficient_plan" - }, - { - "value": { - ".tag": "team_folder" - }, - "text": null, - "label": "team_folder" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "invalid_shared_folder" - }, - "text": null, - "label": "invalid_shared_folder" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/check_job_status": { - "key": "sharing/check_job_status", - "name": "check_job_status", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Returns the status of an asynchronous job.", - "selectAdminMode": "team_admin", - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "JobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": "Void", - "description": "The asynchronous job has finished." - }, - { - "name": "failed", - "type": [ - { - "name": "JobError", - "type": [ - { - "name": "unshare_folder_error", - "type": [ - { - "name": "UnshareFolderError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "This shared folder has too many files to be unshared." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Error occurred while performing :route:`unshare_folder` action." - }, - { - "name": "remove_folder_member_error", - "type": [ - { - "name": "RemoveFolderMemberError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "member_error", - "type": [ - { - "name": "SharedFolderMemberError", - "type": [ - { - "name": "invalid_dropbox_id", - "type": "Void", - "description": "The target dropbox_id is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The target dropbox_id is not a member of the shared folder." - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "The target member only has inherited access to the shared folder." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "folder_owner", - "type": "Void", - "description": "The target user is the owner of the shared folder. You can't remove this user until ownership has been transferred to another member." - }, - { - "name": "group_access", - "type": "Void", - "description": "The target user has access to the shared folder via a group." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "This shared folder has too many files for leaving a copy. You can still remove this user without leaving a copy." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Error occurred while performing :route:`remove_folder_member` action." - }, - { - "name": "relinquish_folder_membership_error", - "type": [ - { - "name": "RelinquishFolderMembershipError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "folder_owner", - "type": "Void", - "description": "The current user is the owner of the shared folder. Owners cannot relinquish membership to their own folders. Try unsharing or transferring ownership first." - }, - { - "name": "mounted", - "type": "Void", - "description": "The shared folder is currently mounted. Unmount the shared folder before relinquishing membership." - }, - { - "name": "group_access", - "type": "Void", - "description": "The current user has access to the shared folder via a group. You can't relinquish membership to folders shared via groups." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "no_explicit_access", - "type": "Void", - "description": "The current user only has inherited access to the shared folder. You can't relinquish inherited membership to folders." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Error occurred while performing :route:`relinquish_folder_membership` action." - } - ], - "description": "Error occurred while performing an asynchronous job from :route:`unshare_folder` or :route:`remove_folder_member`.", - "typeWrap": "{} (open union)" - } - ], - "description": "The asynchronous job returned an error." - } - ], - "example": [ - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - }, - { - "value": { - ".tag": "complete" - }, - "text": null, - "label": "complete" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "sharing/check_remove_member_job_status": { - "key": "sharing/check_remove_member_job_status", - "name": "check_remove_member_job_status", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Returns the status of an asynchronous job for sharing a folder.", - "selectAdminMode": "team_admin", - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "RemoveMemberJobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "Removing the folder member has finished. The value is information about whether the member has another form of access." - }, - { - "name": "failed", - "type": [ - { - "name": "RemoveFolderMemberError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "member_error", - "type": [ - { - "name": "SharedFolderMemberError", - "type": [ - { - "name": "invalid_dropbox_id", - "type": "Void", - "description": "The target dropbox_id is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The target dropbox_id is not a member of the shared folder." - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "The target member only has inherited access to the shared folder." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "folder_owner", - "type": "Void", - "description": "The target user is the owner of the shared folder. You can't remove this user until ownership has been transferred to another member." - }, - { - "name": "group_access", - "type": "Void", - "description": "The target user has access to the shared folder via a group." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "This shared folder has too many files for leaving a copy. You can still remove this user without leaving a copy." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete" - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "sharing/check_share_job_status": { - "key": "sharing/check_share_job_status", - "name": "check_share_job_status", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Returns the status of an asynchronous job for sharing a folder.", - "selectAdminMode": "team_admin", - "request": { - "name": "PollArg", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "Id of the asynchronous job. This is the value of a response returned from the method that launched the job." - } - ], - "example": [ - { - "value": { - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for methods that poll the status of an asynchronous job.", - "importedNamespace": "async", - "typeWrap": "" - }, - "response": { - "name": "ShareFolderJobStatus", - "type": [ - { - "name": "in_progress", - "type": "Void", - "description": "The asynchronous job is still in progress." - }, - { - "name": "complete", - "type": [ - { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - } - ], - "description": "The share job has finished. The value is the metadata for the folder." - }, - { - "name": "failed", - "type": [ - { - "name": "ShareFolderError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "bad_path", - "type": [ - { - "name": "SharePathError", - "type": [ - { - "name": "is_file", - "type": "Void", - "description": "A file is at the specified path." - }, - { - "name": "inside_shared_folder", - "type": "Void", - "description": "We do not support sharing a folder inside a shared folder." - }, - { - "name": "contains_shared_folder", - "type": "Void", - "description": "We do not support shared folders that contain shared folders." - }, - { - "name": "contains_app_folder", - "type": "Void", - "description": "We do not support shared folders that contain app folders." - }, - { - "name": "contains_team_folder", - "type": "Void", - "description": "We do not support shared folders that contain team folders." - }, - { - "name": "is_app_folder", - "type": "Void", - "description": "We do not support sharing an app folder." - }, - { - "name": "inside_app_folder", - "type": "Void", - "description": "We do not support sharing a folder inside an app folder." - }, - { - "name": "is_public_folder", - "type": "Void", - "description": "A public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A folder inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "already_shared", - "type": [ - { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - } - ], - "description": "Folder is already shared. Contains metadata about the existing shared folder." - }, - { - "name": "invalid_path", - "type": "Void", - "description": "Path is not valid." - }, - { - "name": "is_osx_package", - "type": "Void", - "description": "We do not support sharing a Mac OS X package." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "We do not support sharing a folder inside a Mac OS X package." - }, - { - "name": "is_vault", - "type": "Void", - "description": "We do not support sharing the Vault folder." - }, - { - "name": "is_vault_locked", - "type": "Void", - "description": "We do not support sharing a folder inside a locked Vault." - }, - { - "name": "is_family", - "type": "Void", - "description": "We do not support sharing the Family folder." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": ":field:`ShareFolderArg.path` is invalid." - }, - { - "name": "team_policy_disallows_member_policy", - "type": "Void", - "description": "Team policy is more restrictive than :field:`ShareFolderArg.member_policy`." - }, - { - "name": "disallowed_shared_link_policy", - "type": "Void", - "description": "The current user's account is not allowed to select the specified :field:`ShareFolderArg.shared_link_policy`." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "in_progress" - }, - "text": null, - "label": "in_progress" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "PollError", - "type": [ - { - "name": "invalid_async_job_id", - "type": "Void", - "description": "The job ID is invalid." - }, - { - "name": "internal_error", - "type": "Void", - "description": "Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_async_job_id" - }, - "text": null, - "label": "invalid_async_job_id" - }, - { - "value": { - ".tag": "internal_error" - }, - "text": null, - "label": "internal_error" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error returned by methods for polling the status of asynchronous job.", - "importedNamespace": "async", - "typeWrap": "{} (open union)" - } - }, - "sharing/create_shared_link_with_settings": { - "key": "sharing/create_shared_link_with_settings", - "name": "create_shared_link_with_settings", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Create a shared link with custom settings. If no settings are given then the default visibility is :field:`RequestedVisibility.public` (The resolved visibility, though, may depend on other aspects such as team and shared folder settings).", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "CreateSharedLinkWithSettingsArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "The path to be shared by the shared link." - }, - { - "name": "settings", - "type": [ - { - "name": "SharedLinkSettings", - "type": [ - { - "name": "require_password", - "type": "Boolean", - "description": "Boolean flag to enable or disable password protection. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_password", - "type": "String", - "description": "If :field:`require_password` is true, this is needed to specify the password to access the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time of the shared link. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The new audience who can benefit from the access level specified by the link's access level specified in the `link_access_level` field of `LinkPermissions`. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the `effective_audience` field of `LinkPermissions. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access", - "type": [ - { - "name": "RequestedLinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content. Note not all file types support edit links yet." - }, - { - "name": "max", - "type": "Void", - "description": "Request for the maximum access level you can set the link to." - }, - { - "name": "default", - "type": "Void", - "description": "Request for the default access level the user has set." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "Field is deprecated. Use :field:`audience` instead. The requested access for this shared link. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Boolean flag to allow or not download capabilities for shared links. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The requested settings for the newly created shared link. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Prime_Numbers.txt", - "settings": { - "audience": "public", - "access": "viewer", - "requested_visibility": "public", - "allow_download": true - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SharedLinkMetadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a file shared link.", - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a folder shared link.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "file", - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "name": "Prime_Numbers.txt", - "link_permissions": { - "can_revoke": false, - "visibility_policies": [ - { - "policy": { - ".tag": "public" - }, - "resolved_policy": { - ".tag": "public" - }, - "allowed": true - }, - { - "policy": { - ".tag": "password" - }, - "resolved_policy": { - ".tag": "password" - }, - "allowed": true - } - ], - "can_set_expiry": false, - "can_remove_expiry": false, - "allow_download": true, - "can_allow_download": true, - "can_disallow_download": false, - "allow_comments": true, - "team_restricts_comments": true, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - }, - "audience_options": [ - { - "audience": { - ".tag": "public" - }, - "allowed": true - }, - { - "audience": { - ".tag": "team" - }, - "allowed": false - }, - { - "audience": { - ".tag": "no_one" - }, - "allowed": true - } - ], - "can_set_password": true, - "can_remove_password": true, - "require_password": false, - "can_use_extended_sharing_controls": false - }, - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "path_lower": "/homework/math/prime_numbers.txt", - "team_member_info": { - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "folder", - "url": "https://www.dropbox.com/sh/s6fvw6ol7rmqo1x/AAAgWRSbjmYDvPpDB30Sykjfa?dl=0", - "name": "Math", - "link_permissions": { - "can_revoke": false, - "visibility_policies": [ - { - "policy": { - ".tag": "public" - }, - "resolved_policy": { - ".tag": "public" - }, - "allowed": true - }, - { - "policy": { - ".tag": "password" - }, - "resolved_policy": { - ".tag": "password" - }, - "allowed": true - } - ], - "can_set_expiry": false, - "can_remove_expiry": false, - "allow_download": true, - "can_allow_download": true, - "can_disallow_download": false, - "allow_comments": true, - "team_restricts_comments": true, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - }, - "audience_options": [ - { - "audience": { - ".tag": "public" - }, - "allowed": true - }, - { - "audience": { - ".tag": "team" - }, - "allowed": false - }, - { - "audience": { - ".tag": "no_one" - }, - "allowed": true - } - ], - "can_set_password": true, - "can_remove_password": true, - "require_password": false, - "can_use_extended_sharing_controls": false - }, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "path_lower": "/homework/math", - "team_member_info": { - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234" - } - }, - "text": null, - "label": "default" - } - ], - "description": "The metadata of a shared link.", - "typeWrap": "{} (datatype with subtypes)" - }, - "error": { - "name": "CreateSharedLinkWithSettingsError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "importedNamespace": "files", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "email_not_verified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "shared_link_already_exists", - "type": [ - { - "name": "SharedLinkAlreadyExistsMetadata", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "SharedLinkMetadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a file shared link.", - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a folder shared link.", - "typeWrap": "" - } - ] - } - ], - "description": "The metadata of a shared link.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Metadata of the shared link that already exists." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The shared link already exists. You can call :route:`list_shared_links` to get the existing link, or use the provided metadata if it is returned. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "settings_error", - "type": [ - { - "name": "SharedLinkSettingsError", - "type": [ - { - "name": "invalid_settings", - "type": "Void", - "description": "The given settings are invalid (for example, all attributes of the :type:`SharedLinkSettings` are empty, the requested visibility is :field:`RequestedVisibility.password` but the :field:`SharedLinkSettings.link_password` is missing, :field:`SharedLinkSettings.expires` is set to the past, etc.)." - }, - { - "name": "not_authorized", - "type": "Void", - "description": "User is not allowed to modify the settings of this link. Note that basic users can only set :field:`RequestedVisibility.public` as the :field:`SharedLinkSettings.requested_visibility` and cannot set :field:`SharedLinkSettings.expires`." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "There is an error with the given settings." - }, - { - "name": "access_denied", - "type": "Void", - "description": "The user is not allowed to create a shared link to the specified file. For example, this can occur if the file is restricted or if the user's links are :link:`banned https://help.dropbox.com/files-folders/share/banned-links`." - } - ], - "example": [ - { - "value": { - ".tag": "email_not_verified" - }, - "text": null, - "label": "email_not_verified" - }, - { - "value": { - ".tag": "access_denied" - }, - "text": null, - "label": "access_denied" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "sharing/get_file_metadata": { - "key": "sharing/get_file_metadata", - "name": "get_file_metadata", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Returns shared file metadata.", - "selectAdminMode": "team_admin", - "request": { - "name": "GetFileMetadataArg", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "The file to query." - }, - { - "name": "actions", - "type": [ - { - "name": "FileAction", - "type": [ - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information on the file." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the file." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the file." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Add a member with view permissions." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Add a member with view permissions but no comment permissions." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Add a member with edit permissions." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this file." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership to the file." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_view_link", - "type": "Void", - "description": "Create a shared link to a file that only allows users to view the content." - }, - { - "name": "create_edit_link", - "type": "Void", - "description": "Create a shared link to a file that allows users to edit the content." - } - ], - "description": "Sharing actions that may be taken on files.", - "typeWrap": "{} (open union)" - } - ], - "description": "A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's :field:`SharedFileMetadata.permissions` field describing the actions the authenticated user can perform on the file. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "actions": [] - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments of :route:`get_file_metadata`.", - "typeWrap": "" - }, - "response": { - "name": "SharedFileMetadata", - "type": [ - { - "name": "id", - "type": "String(min_length=4, pattern=\"id:.+\")", - "description": "The ID of the file." - }, - { - "name": "name", - "type": "String", - "description": "The name of this file." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared file." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared file." - }, - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expected_link_metadata", - "type": [ - { - "name": "ExpectedSharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The expected metadata of a shared link for a file or folder when a link is first created for the content. Absent if the link already exists.", - "typeWrap": "" - } - ], - "description": "The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the file. This field is not present if the file is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the file is contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-case full path of this file. Absent for unmounted files. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FilePermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FileAction", - "type": [ - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information on the file." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the file." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the file." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Add a member with view permissions." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Add a member with view permissions but no comment permissions." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Add a member with edit permissions." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this file." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership to the file." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_view_link", - "type": "Void", - "description": "Create a shared link to a file that only allows users to view the content." - }, - { - "name": "create_edit_link", - "type": "Void", - "description": "Create a shared link to a file that allows users to edit the content." - } - ], - "description": "Sharing actions that may be taken on files.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the file." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the sharing action on the file.", - "typeWrap": "" - } - ], - "description": "The sharing permissions that requesting user has on this file. This corresponds to the entries given in :field:`GetFileMetadataBatchArg.actions` or :field:`GetFileMetadataArg.actions`. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "access_type": { - ".tag": "viewer" - }, - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "time_invited": "2016-01-20T00:00:00Z" - }, - "text": null, - "label": "default" - } - ], - "description": "Properties of the shared file.", - "typeWrap": "" - }, - "error": { - "name": "GetFileMetadataError", - "type": [ - { - "name": "user_error", - "type": [ - { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error result for :route:`get_file_metadata`.", - "typeWrap": "{} (open union)" - } - }, - "sharing/get_file_metadata/batch": { - "key": "sharing/get_file_metadata/batch", - "name": "get_file_metadata/batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Returns shared file metadata.", - "request": { - "name": "GetFileMetadataBatchArg", - "type": [ - { - "name": "files", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "The files to query.", - "typeWrap": "List of ({}, max_items=100)" - }, - { - "name": "actions", - "type": [ - { - "name": "FileAction", - "type": [ - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information on the file." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the file." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the file." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Add a member with view permissions." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Add a member with view permissions but no comment permissions." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Add a member with edit permissions." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this file." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership to the file." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_view_link", - "type": "Void", - "description": "Create a shared link to a file that only allows users to view the content." - }, - { - "name": "create_edit_link", - "type": "Void", - "description": "Create a shared link to a file that allows users to edit the content." - } - ], - "description": "Sharing actions that may be taken on files.", - "typeWrap": "{} (open union)" - } - ], - "description": "A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's :field:`SharedFileMetadata.permissions` field describing the actions the authenticated user can perform on the file. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "files": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ], - "actions": [] - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments of :route:`get_file_metadata/batch`.", - "typeWrap": "" - }, - "response": { - "name": "GetFileMetadataBatchResult", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "This is the input file identifier corresponding to one of :field:`GetFileMetadataBatchArg.files`." - }, - { - "name": "result", - "type": [ - { - "name": "GetFileMetadataIndividualResult", - "type": [ - { - "name": "metadata", - "type": [ - { - "name": "SharedFileMetadata", - "type": [ - { - "name": "id", - "type": "String(min_length=4, pattern=\"id:.+\")", - "description": "The ID of the file." - }, - { - "name": "name", - "type": "String", - "description": "The name of this file." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared file." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared file." - }, - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expected_link_metadata", - "type": [ - { - "name": "ExpectedSharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The expected metadata of a shared link for a file or folder when a link is first created for the content. Absent if the link already exists.", - "typeWrap": "" - } - ], - "description": "The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the file. This field is not present if the file is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the file is contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-case full path of this file. Absent for unmounted files. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FilePermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FileAction", - "type": [ - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information on the file." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the file." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the file." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Add a member with view permissions." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Add a member with view permissions but no comment permissions." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Add a member with edit permissions." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this file." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership to the file." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_view_link", - "type": "Void", - "description": "Create a shared link to a file that only allows users to view the content." - }, - { - "name": "create_edit_link", - "type": "Void", - "description": "Create a shared link to a file that allows users to edit the content." - } - ], - "description": "Sharing actions that may be taken on files.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the file." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the sharing action on the file.", - "typeWrap": "" - } - ], - "description": "The sharing permissions that requesting user has on this file. This corresponds to the entries given in :field:`GetFileMetadataBatchArg.actions` or :field:`GetFileMetadataArg.actions`. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Properties of the shared file.", - "typeWrap": "" - } - ], - "description": "The result for this file if it was successful." - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ], - "description": "The result for this file if it was an error." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The result for this particular file." - } - ], - "description": "Per file results of :route:`get_file_metadata/batch`.", - "typeWrap": "List of ({})" - }, - "error": { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "example": [ - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - }, - "sharing/get_folder_metadata": { - "key": "sharing/get_folder_metadata", - "name": "get_folder_metadata", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Returns shared folder metadata by its folder ID.", - "selectAdminMode": "whole_team", - "request": { - "name": "GetMetadataArgs", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "actions", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's :field:`SharedFolderMetadata.permissions` field describing the actions the authenticated user can perform on the folder. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "actions": [] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "example": [ - { - "value": { - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - }, - "text": null, - "label": "default" - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - }, - "error": { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_id" - }, - "text": null, - "label": "invalid_id" - }, - { - "value": { - ".tag": "not_a_member" - }, - "text": null, - "label": "not_a_member" - }, - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "unmounted" - }, - "text": null, - "label": "unmounted" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - }, - "sharing/get_shared_link_file": { - "key": "sharing/get_shared_link_file", - "name": "get_shared_link_file", - "version": 1, - "subdomain": "content", - "format": "download", - "auth": "user", - "scope": "sharing.read", - "description": "Download the shared link's file from a user's Dropbox.", - "allowAppFolderApp": true, - "request": { - "name": "GetSharedLinkMetadataArg", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_password", - "type": "String", - "description": "If the shared link has a password, this parameter can be used. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "path": "/Prime_Numbers.txt" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SharedLinkMetadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a file shared link.", - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a folder shared link.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "file", - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "name": "Prime_Numbers.txt", - "link_permissions": { - "can_revoke": false, - "visibility_policies": [ - { - "policy": { - ".tag": "public" - }, - "resolved_policy": { - ".tag": "public" - }, - "allowed": true - }, - { - "policy": { - ".tag": "password" - }, - "resolved_policy": { - ".tag": "password" - }, - "allowed": true - } - ], - "can_set_expiry": false, - "can_remove_expiry": false, - "allow_download": true, - "can_allow_download": true, - "can_disallow_download": false, - "allow_comments": true, - "team_restricts_comments": true, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - }, - "audience_options": [ - { - "audience": { - ".tag": "public" - }, - "allowed": true - }, - { - "audience": { - ".tag": "team" - }, - "allowed": false - }, - { - "audience": { - ".tag": "no_one" - }, - "allowed": true - } - ], - "can_set_password": true, - "can_remove_password": true, - "require_password": false, - "can_use_extended_sharing_controls": false - }, - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "path_lower": "/homework/math/prime_numbers.txt", - "team_member_info": { - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "folder", - "url": "https://www.dropbox.com/sh/s6fvw6ol7rmqo1x/AAAgWRSbjmYDvPpDB30Sykjfa?dl=0", - "name": "Math", - "link_permissions": { - "can_revoke": false, - "visibility_policies": [ - { - "policy": { - ".tag": "public" - }, - "resolved_policy": { - ".tag": "public" - }, - "allowed": true - }, - { - "policy": { - ".tag": "password" - }, - "resolved_policy": { - ".tag": "password" - }, - "allowed": true - } - ], - "can_set_expiry": false, - "can_remove_expiry": false, - "allow_download": true, - "can_allow_download": true, - "can_disallow_download": false, - "allow_comments": true, - "team_restricts_comments": true, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - }, - "audience_options": [ - { - "audience": { - ".tag": "public" - }, - "allowed": true - }, - { - "audience": { - ".tag": "team" - }, - "allowed": false - }, - { - "audience": { - ".tag": "no_one" - }, - "allowed": true - } - ], - "can_set_password": true, - "can_remove_password": true, - "require_password": false, - "can_use_extended_sharing_controls": false - }, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "path_lower": "/homework/math", - "team_member_info": { - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234" - } - }, - "text": null, - "label": "default" - } - ], - "description": "The metadata of a shared link.", - "typeWrap": "{} (datatype with subtypes)" - }, - "error": { - "name": "GetSharedLinkFileError", - "type": [ - { - "name": "shared_link_not_found", - "type": "Void", - "description": "The shared link wasn't found." - }, - { - "name": "shared_link_access_denied", - "type": "Void", - "description": "The caller is not allowed to access this shared link." - }, - { - "name": "unsupported_link_type", - "type": "Void", - "description": "This type of link is not supported; use :route:`files.export` instead." - }, - { - "name": "shared_link_is_directory", - "type": "Void", - "description": "Directories cannot be retrieved by this endpoint." - } - ], - "example": [ - { - "value": { - ".tag": "shared_link_not_found" - }, - "text": null, - "label": "shared_link_not_found" - }, - { - "value": { - ".tag": "shared_link_access_denied" - }, - "text": null, - "label": "shared_link_access_denied" - }, - { - "value": { - ".tag": "unsupported_link_type" - }, - "text": null, - "label": "unsupported_link_type" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "shared_link_is_directory" - }, - "text": null, - "label": "shared_link_is_directory" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "sharing/get_shared_link_metadata": { - "key": "sharing/get_shared_link_metadata", - "name": "get_shared_link_metadata", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "app, user", - "scope": "sharing.read", - "description": "Get the shared link's metadata.", - "allowAppFolderApp": true, - "request": { - "name": "GetSharedLinkMetadataArg", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "path", - "type": "String(pattern=\"/(.|[\\r\\n])*\")", - "description": "If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_password", - "type": "String", - "description": "If the shared link has a password, this parameter can be used. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "path": "/Prime_Numbers.txt" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SharedLinkMetadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a file shared link.", - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a folder shared link.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "file", - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "name": "Prime_Numbers.txt", - "link_permissions": { - "can_revoke": false, - "visibility_policies": [ - { - "policy": { - ".tag": "public" - }, - "resolved_policy": { - ".tag": "public" - }, - "allowed": true - }, - { - "policy": { - ".tag": "password" - }, - "resolved_policy": { - ".tag": "password" - }, - "allowed": true - } - ], - "can_set_expiry": false, - "can_remove_expiry": false, - "allow_download": true, - "can_allow_download": true, - "can_disallow_download": false, - "allow_comments": true, - "team_restricts_comments": true, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - }, - "audience_options": [ - { - "audience": { - ".tag": "public" - }, - "allowed": true - }, - { - "audience": { - ".tag": "team" - }, - "allowed": false - }, - { - "audience": { - ".tag": "no_one" - }, - "allowed": true - } - ], - "can_set_password": true, - "can_remove_password": true, - "require_password": false, - "can_use_extended_sharing_controls": false - }, - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "path_lower": "/homework/math/prime_numbers.txt", - "team_member_info": { - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "folder", - "url": "https://www.dropbox.com/sh/s6fvw6ol7rmqo1x/AAAgWRSbjmYDvPpDB30Sykjfa?dl=0", - "name": "Math", - "link_permissions": { - "can_revoke": false, - "visibility_policies": [ - { - "policy": { - ".tag": "public" - }, - "resolved_policy": { - ".tag": "public" - }, - "allowed": true - }, - { - "policy": { - ".tag": "password" - }, - "resolved_policy": { - ".tag": "password" - }, - "allowed": true - } - ], - "can_set_expiry": false, - "can_remove_expiry": false, - "allow_download": true, - "can_allow_download": true, - "can_disallow_download": false, - "allow_comments": true, - "team_restricts_comments": true, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - }, - "audience_options": [ - { - "audience": { - ".tag": "public" - }, - "allowed": true - }, - { - "audience": { - ".tag": "team" - }, - "allowed": false - }, - { - "audience": { - ".tag": "no_one" - }, - "allowed": true - } - ], - "can_set_password": true, - "can_remove_password": true, - "require_password": false, - "can_use_extended_sharing_controls": false - }, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "path_lower": "/homework/math", - "team_member_info": { - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234" - } - }, - "text": null, - "label": "default" - } - ], - "description": "The metadata of a shared link.", - "typeWrap": "{} (datatype with subtypes)" - }, - "error": { - "name": "SharedLinkError", - "type": [ - { - "name": "shared_link_not_found", - "type": "Void", - "description": "The shared link wasn't found." - }, - { - "name": "shared_link_access_denied", - "type": "Void", - "description": "The caller is not allowed to access this shared link." - }, - { - "name": "unsupported_link_type", - "type": "Void", - "description": "This type of link is not supported; use :route:`files.export` instead." - } - ], - "example": [ - { - "value": { - ".tag": "shared_link_not_found" - }, - "text": null, - "label": "shared_link_not_found" - }, - { - "value": { - ".tag": "shared_link_access_denied" - }, - "text": null, - "label": "shared_link_access_denied" - }, - { - "value": { - ".tag": "unsupported_link_type" - }, - "text": null, - "label": "unsupported_link_type" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/list_file_members": { - "key": "sharing/list_file_members", - "name": "list_file_members", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Use to obtain the members who have been invited to a file, both inherited and uninherited members.", - "selectAdminMode": "team_admin", - "request": { - "name": "ListFileMembersArg", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "The file for which you want to see members." - }, - { - "name": "actions", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The actions for which to return permissions on a member. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "include_inherited", - "type": "Boolean", - "description": "Whether to include members who only have access from a parent shared folder. The default for this field is True." - }, - { - "name": "limit", - "type": "UInt32(min=1, max=300)", - "description": "Number of members to return max per query. Defaults to 100 if no limit is specified. The default for this field is 100." - } - ], - "example": [ - { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "include_inherited": true, - "limit": 100 - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`list_file_members`.", - "typeWrap": "" - }, - "response": { - "name": "SharedFileMembers", - "type": [ - { - "name": "users", - "type": [ - { - "name": "UserFileMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The account information for the membership user." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - }, - { - "name": "time_last_seen", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The UTC timestamp of when the user has last seen the content. Only populated if the user has seen the content and the caller has a plan that includes viewer history. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "platform_type", - "type": [ - { - "name": "PlatformType", - "type": [ - { - "name": "web", - "type": "Void", - "description": "The content was viewed on the web." - }, - { - "name": "desktop", - "type": "Void", - "description": "The content was viewed on a desktop client." - }, - { - "name": "mobile_ios", - "type": "Void", - "description": "The content was viewed on a mobile iOS client." - }, - { - "name": "mobile_android", - "type": "Void", - "description": "The content was viewed on a mobile android client." - }, - { - "name": "api", - "type": "Void", - "description": "The content was viewed from an API client." - }, - { - "name": "unknown", - "type": "Void", - "description": "The content was viewed on an unknown platform." - }, - { - "name": "mobile", - "type": "Void", - "description": "The content was viewed on a mobile client. DEPRECATED: Use mobile_ios or mobile_android instead." - } - ], - "description": "Possible platforms on which a user may view content.", - "importedNamespace": "seen_state", - "typeWrap": "{} (open union)" - } - ], - "description": "The platform on which the user has last seen the content, or unknown. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The information about a user member of the shared content with an appended last seen timestamp.", - "typeWrap": "" - } - ], - "description": "The list of user members of the shared file.", - "typeWrap": "List of ({})" - }, - { - "name": "groups", - "type": [ - { - "name": "GroupMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "group", - "type": [ - { - "name": "GroupInfo", - "type": [ - { - "name": "group_name", - "type": "String" - }, - { - "name": "group_id", - "type": "String" - }, - { - "name": "group_management_type", - "type": [ - { - "name": "GroupManagementType", - "type": [ - { - "name": "user_managed", - "type": "Void", - "description": "A group which is managed by selected users." - }, - { - "name": "company_managed", - "type": "Void", - "description": "A group which is managed by team admins only." - }, - { - "name": "system_managed", - "type": "Void", - "description": "A group which is managed automatically by Dropbox." - } - ], - "description": "The group type determines how a group is managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Who is allowed to manage the group." - }, - { - "name": "group_type", - "type": [ - { - "name": "GroupType", - "type": [ - { - "name": "team", - "type": "Void", - "description": "A group to which team members are automatically added. Applicable to :link:`team folders https://www.dropbox.com/help/986` only." - }, - { - "name": "user_managed", - "type": "Void", - "description": "A group is created and managed by a user." - } - ], - "description": "The group type determines how a group is created and managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Field is deprecated. The type of group.", - "isDeprecated": true - }, - { - "name": "is_member", - "type": "Boolean", - "description": "If the current user is a member of the group." - }, - { - "name": "is_owner", - "type": "Boolean", - "description": "If the current user is an owner of the group." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the group is owned by the current user's team." - }, - { - "name": "group_external_id", - "type": "String", - "description": "External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "member_count", - "type": "UInt32", - "description": "The number of members in the group. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.", - "typeWrap": "" - } - ], - "description": "The information about the membership group." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - } - ], - "description": "The information about a group member of the shared content.", - "typeWrap": "" - } - ], - "description": "The list of group members of the shared file.", - "typeWrap": "List of ({})" - }, - { - "name": "invitees", - "type": [ - { - "name": "InviteeMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "invitee", - "type": [ - { - "name": "InviteeInfo", - "type": [ - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of invited user." - } - ], - "description": "Information about the recipient of a shared content invitation.", - "typeWrap": "{} (open union)" - } - ], - "description": "Recipient of the invitation." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The user this invitation is tied to, if available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about an invited member of a shared content.", - "typeWrap": "" - } - ], - "description": "The list of invited members of a file, but have not logged in and claimed this.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Present if there are additional shared file members that have not been returned yet. Pass the cursor into :route:`list_file_members/continue` to list additional members. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "bob@example.com", - "display_name": "Robert Smith", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - }, - "permissions": [], - "is_inherited": false, - "time_last_seen": "2016-01-20T00:00:00Z", - "platform_type": { - ".tag": "unknown" - } - } - ], - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_name": "Test group", - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "same_team": true, - "member_count": 10 - }, - "permissions": [], - "is_inherited": false - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "permissions": [], - "is_inherited": false - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": "Shared file user, group, and invitee membership.\nUsed for the results of :route:`list_file_members` and :route:`list_file_members/continue`, and used as part of the results for :route:`list_file_members/batch`.", - "typeWrap": "" - }, - "error": { - "name": "ListFileMembersError", - "type": [ - { - "name": "user_error", - "type": [ - { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error for :route:`list_file_members`.", - "typeWrap": "{} (open union)" - } - }, - "sharing/list_file_members/batch": { - "key": "sharing/list_file_members/batch", - "name": "list_file_members/batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Get members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint.\nInherited users and groups are not included in the result, and permissions are not returned for this endpoint.", - "request": { - "name": "ListFileMembersBatchArg", - "type": [ - { - "name": "files", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "Files for which to return members.", - "typeWrap": "List of ({}, max_items=100)" - }, - { - "name": "limit", - "type": "UInt32(max=20)", - "description": "Number of members to return max per query. Defaults to 10 if no limit is specified. The default for this field is 10." - } - ], - "example": [ - { - "value": { - "files": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ], - "limit": 10 - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`list_file_members/batch`.", - "typeWrap": "" - }, - "response": { - "name": "ListFileMembersBatchResult", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "This is the input file identifier, whether an ID or a path." - }, - { - "name": "result", - "type": [ - { - "name": "ListFileMembersIndividualResult", - "type": [ - { - "name": "result", - "type": [ - { - "name": "ListFileMembersCountResult", - "type": [ - { - "name": "members", - "type": [ - { - "name": "SharedFileMembers", - "type": [ - { - "name": "users", - "type": [ - { - "name": "UserFileMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The account information for the membership user." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - }, - { - "name": "time_last_seen", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The UTC timestamp of when the user has last seen the content. Only populated if the user has seen the content and the caller has a plan that includes viewer history. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "platform_type", - "type": [ - { - "name": "PlatformType", - "type": [ - { - "name": "web", - "type": "Void", - "description": "The content was viewed on the web." - }, - { - "name": "desktop", - "type": "Void", - "description": "The content was viewed on a desktop client." - }, - { - "name": "mobile_ios", - "type": "Void", - "description": "The content was viewed on a mobile iOS client." - }, - { - "name": "mobile_android", - "type": "Void", - "description": "The content was viewed on a mobile android client." - }, - { - "name": "api", - "type": "Void", - "description": "The content was viewed from an API client." - }, - { - "name": "unknown", - "type": "Void", - "description": "The content was viewed on an unknown platform." - }, - { - "name": "mobile", - "type": "Void", - "description": "The content was viewed on a mobile client. DEPRECATED: Use mobile_ios or mobile_android instead." - } - ], - "description": "Possible platforms on which a user may view content.", - "importedNamespace": "seen_state", - "typeWrap": "{} (open union)" - } - ], - "description": "The platform on which the user has last seen the content, or unknown. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The information about a user member of the shared content with an appended last seen timestamp.", - "typeWrap": "" - } - ], - "description": "The list of user members of the shared file.", - "typeWrap": "List of ({})" - }, - { - "name": "groups", - "type": [ - { - "name": "GroupMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "group", - "type": [ - { - "name": "GroupInfo", - "type": [ - { - "name": "group_name", - "type": "String" - }, - { - "name": "group_id", - "type": "String" - }, - { - "name": "group_management_type", - "type": [ - { - "name": "GroupManagementType", - "type": [ - { - "name": "user_managed", - "type": "Void", - "description": "A group which is managed by selected users." - }, - { - "name": "company_managed", - "type": "Void", - "description": "A group which is managed by team admins only." - }, - { - "name": "system_managed", - "type": "Void", - "description": "A group which is managed automatically by Dropbox." - } - ], - "description": "The group type determines how a group is managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Who is allowed to manage the group." - }, - { - "name": "group_type", - "type": [ - { - "name": "GroupType", - "type": [ - { - "name": "team", - "type": "Void", - "description": "A group to which team members are automatically added. Applicable to :link:`team folders https://www.dropbox.com/help/986` only." - }, - { - "name": "user_managed", - "type": "Void", - "description": "A group is created and managed by a user." - } - ], - "description": "The group type determines how a group is created and managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Field is deprecated. The type of group.", - "isDeprecated": true - }, - { - "name": "is_member", - "type": "Boolean", - "description": "If the current user is a member of the group." - }, - { - "name": "is_owner", - "type": "Boolean", - "description": "If the current user is an owner of the group." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the group is owned by the current user's team." - }, - { - "name": "group_external_id", - "type": "String", - "description": "External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "member_count", - "type": "UInt32", - "description": "The number of members in the group. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.", - "typeWrap": "" - } - ], - "description": "The information about the membership group." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - } - ], - "description": "The information about a group member of the shared content.", - "typeWrap": "" - } - ], - "description": "The list of group members of the shared file.", - "typeWrap": "List of ({})" - }, - { - "name": "invitees", - "type": [ - { - "name": "InviteeMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "invitee", - "type": [ - { - "name": "InviteeInfo", - "type": [ - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of invited user." - } - ], - "description": "Information about the recipient of a shared content invitation.", - "typeWrap": "{} (open union)" - } - ], - "description": "Recipient of the invitation." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The user this invitation is tied to, if available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about an invited member of a shared content.", - "typeWrap": "" - } - ], - "description": "The list of invited members of a file, but have not logged in and claimed this.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Present if there are additional shared file members that have not been returned yet. Pass the cursor into :route:`list_file_members/continue` to list additional members. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Shared file user, group, and invitee membership.\nUsed for the results of :route:`list_file_members` and :route:`list_file_members/continue`, and used as part of the results for :route:`list_file_members/batch`.", - "typeWrap": "" - } - ], - "description": "A list of members on this file." - }, - { - "name": "member_count", - "type": "UInt32", - "description": "The number of members on this file. This does not include inherited members." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The results of the query for this file if it was successful." - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ], - "description": "The result of the query for this file if it was an error." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The result for this particular file." - } - ], - "description": "Per-file result for :route:`list_file_members/batch`.", - "typeWrap": "List of ({})" - }, - "error": { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "example": [ - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - }, - "sharing/list_file_members/continue": { - "key": "sharing/list_file_members/continue", - "name": "list_file_members/continue", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Once a cursor has been retrieved from :route:`list_file_members` or :route:`list_file_members/batch`, use this to paginate through all shared file members.", - "request": { - "name": "ListFileMembersContinueArg", - "type": [ - { - "name": "cursor", - "type": "String", - "description": "The cursor returned by your last call to :route:`list_file_members`, :route:`list_file_members/continue`, or :route:`list_file_members/batch`." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`list_file_members/continue`.", - "typeWrap": "" - }, - "response": { - "name": "SharedFileMembers", - "type": [ - { - "name": "users", - "type": [ - { - "name": "UserFileMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The account information for the membership user." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - }, - { - "name": "time_last_seen", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The UTC timestamp of when the user has last seen the content. Only populated if the user has seen the content and the caller has a plan that includes viewer history. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "platform_type", - "type": [ - { - "name": "PlatformType", - "type": [ - { - "name": "web", - "type": "Void", - "description": "The content was viewed on the web." - }, - { - "name": "desktop", - "type": "Void", - "description": "The content was viewed on a desktop client." - }, - { - "name": "mobile_ios", - "type": "Void", - "description": "The content was viewed on a mobile iOS client." - }, - { - "name": "mobile_android", - "type": "Void", - "description": "The content was viewed on a mobile android client." - }, - { - "name": "api", - "type": "Void", - "description": "The content was viewed from an API client." - }, - { - "name": "unknown", - "type": "Void", - "description": "The content was viewed on an unknown platform." - }, - { - "name": "mobile", - "type": "Void", - "description": "The content was viewed on a mobile client. DEPRECATED: Use mobile_ios or mobile_android instead." - } - ], - "description": "Possible platforms on which a user may view content.", - "importedNamespace": "seen_state", - "typeWrap": "{} (open union)" - } - ], - "description": "The platform on which the user has last seen the content, or unknown. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The information about a user member of the shared content with an appended last seen timestamp.", - "typeWrap": "" - } - ], - "description": "The list of user members of the shared file.", - "typeWrap": "List of ({})" - }, - { - "name": "groups", - "type": [ - { - "name": "GroupMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "group", - "type": [ - { - "name": "GroupInfo", - "type": [ - { - "name": "group_name", - "type": "String" - }, - { - "name": "group_id", - "type": "String" - }, - { - "name": "group_management_type", - "type": [ - { - "name": "GroupManagementType", - "type": [ - { - "name": "user_managed", - "type": "Void", - "description": "A group which is managed by selected users." - }, - { - "name": "company_managed", - "type": "Void", - "description": "A group which is managed by team admins only." - }, - { - "name": "system_managed", - "type": "Void", - "description": "A group which is managed automatically by Dropbox." - } - ], - "description": "The group type determines how a group is managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Who is allowed to manage the group." - }, - { - "name": "group_type", - "type": [ - { - "name": "GroupType", - "type": [ - { - "name": "team", - "type": "Void", - "description": "A group to which team members are automatically added. Applicable to :link:`team folders https://www.dropbox.com/help/986` only." - }, - { - "name": "user_managed", - "type": "Void", - "description": "A group is created and managed by a user." - } - ], - "description": "The group type determines how a group is created and managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Field is deprecated. The type of group.", - "isDeprecated": true - }, - { - "name": "is_member", - "type": "Boolean", - "description": "If the current user is a member of the group." - }, - { - "name": "is_owner", - "type": "Boolean", - "description": "If the current user is an owner of the group." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the group is owned by the current user's team." - }, - { - "name": "group_external_id", - "type": "String", - "description": "External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "member_count", - "type": "UInt32", - "description": "The number of members in the group. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.", - "typeWrap": "" - } - ], - "description": "The information about the membership group." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - } - ], - "description": "The information about a group member of the shared content.", - "typeWrap": "" - } - ], - "description": "The list of group members of the shared file.", - "typeWrap": "List of ({})" - }, - { - "name": "invitees", - "type": [ - { - "name": "InviteeMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "invitee", - "type": [ - { - "name": "InviteeInfo", - "type": [ - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of invited user." - } - ], - "description": "Information about the recipient of a shared content invitation.", - "typeWrap": "{} (open union)" - } - ], - "description": "Recipient of the invitation." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The user this invitation is tied to, if available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about an invited member of a shared content.", - "typeWrap": "" - } - ], - "description": "The list of invited members of a file, but have not logged in and claimed this.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Present if there are additional shared file members that have not been returned yet. Pass the cursor into :route:`list_file_members/continue` to list additional members. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "bob@example.com", - "display_name": "Robert Smith", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - }, - "permissions": [], - "is_inherited": false, - "time_last_seen": "2016-01-20T00:00:00Z", - "platform_type": { - ".tag": "unknown" - } - } - ], - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_name": "Test group", - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "same_team": true, - "member_count": 10 - }, - "permissions": [], - "is_inherited": false - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "permissions": [], - "is_inherited": false - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": "Shared file user, group, and invitee membership.\nUsed for the results of :route:`list_file_members` and :route:`list_file_members/continue`, and used as part of the results for :route:`list_file_members/batch`.", - "typeWrap": "" - }, - "error": { - "name": "ListFileMembersContinueError", - "type": [ - { - "name": "user_error", - "type": [ - { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "invalid_cursor", - "type": "Void", - "description": ":field:`ListFileMembersContinueArg.cursor` is invalid." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_cursor" - }, - "text": null, - "label": "invalid_cursor" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error for :route:`list_file_members/continue`.", - "typeWrap": "{} (open union)" - } - }, - "sharing/list_folder_members": { - "key": "sharing/list_folder_members", - "name": "list_folder_members", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Returns shared folder membership by its folder ID.", - "selectAdminMode": "whole_team", - "request": { - "name": "ListFolderMembersArgs", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "actions", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "This is a list indicating whether each returned member will include a boolean value :field:`MemberPermission.allow` that describes whether the current user can perform the MemberAction on the member. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "limit", - "type": "UInt32(min=1, max=1000)", - "description": "The maximum number of results that include members, groups and invitees to return per request. The default for this field is 1000." - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "actions": [], - "limit": 10 - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SharedFolderMembers", - "type": [ - { - "name": "users", - "type": [ - { - "name": "UserMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The account information for the membership user." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - } - ], - "description": "The information about a user member of the shared content.", - "typeWrap": "" - } - ], - "description": "The list of user members of the shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "groups", - "type": [ - { - "name": "GroupMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "group", - "type": [ - { - "name": "GroupInfo", - "type": [ - { - "name": "group_name", - "type": "String" - }, - { - "name": "group_id", - "type": "String" - }, - { - "name": "group_management_type", - "type": [ - { - "name": "GroupManagementType", - "type": [ - { - "name": "user_managed", - "type": "Void", - "description": "A group which is managed by selected users." - }, - { - "name": "company_managed", - "type": "Void", - "description": "A group which is managed by team admins only." - }, - { - "name": "system_managed", - "type": "Void", - "description": "A group which is managed automatically by Dropbox." - } - ], - "description": "The group type determines how a group is managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Who is allowed to manage the group." - }, - { - "name": "group_type", - "type": [ - { - "name": "GroupType", - "type": [ - { - "name": "team", - "type": "Void", - "description": "A group to which team members are automatically added. Applicable to :link:`team folders https://www.dropbox.com/help/986` only." - }, - { - "name": "user_managed", - "type": "Void", - "description": "A group is created and managed by a user." - } - ], - "description": "The group type determines how a group is created and managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Field is deprecated. The type of group.", - "isDeprecated": true - }, - { - "name": "is_member", - "type": "Boolean", - "description": "If the current user is a member of the group." - }, - { - "name": "is_owner", - "type": "Boolean", - "description": "If the current user is an owner of the group." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the group is owned by the current user's team." - }, - { - "name": "group_external_id", - "type": "String", - "description": "External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "member_count", - "type": "UInt32", - "description": "The number of members in the group. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.", - "typeWrap": "" - } - ], - "description": "The information about the membership group." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - } - ], - "description": "The information about a group member of the shared content.", - "typeWrap": "" - } - ], - "description": "The list of group members of the shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "invitees", - "type": [ - { - "name": "InviteeMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "invitee", - "type": [ - { - "name": "InviteeInfo", - "type": [ - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of invited user." - } - ], - "description": "Information about the recipient of a shared content invitation.", - "typeWrap": "{} (open union)" - } - ], - "description": "Recipient of the invitation." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The user this invitation is tied to, if available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about an invited member of a shared content.", - "typeWrap": "" - } - ], - "description": "The list of invitees to the shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Present if there are additional shared folder members that have not been returned yet. Pass the cursor into :route:`list_folder_members/continue` to list additional members. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "bob@example.com", - "display_name": "Robert Smith", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - }, - "permissions": [], - "is_inherited": false - } - ], - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_name": "Test group", - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "same_team": true, - "member_count": 10 - }, - "permissions": [], - "is_inherited": false - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "permissions": [], - "is_inherited": false - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": "Shared folder user and group membership.", - "typeWrap": "" - }, - "error": { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_id" - }, - "text": null, - "label": "invalid_id" - }, - { - "value": { - ".tag": "not_a_member" - }, - "text": null, - "label": "not_a_member" - }, - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "unmounted" - }, - "text": null, - "label": "unmounted" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - }, - "sharing/list_folder_members/continue": { - "key": "sharing/list_folder_members/continue", - "name": "list_folder_members/continue", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Once a cursor has been retrieved from :route:`list_folder_members`, use this to paginate through all shared folder members.", - "selectAdminMode": "whole_team", - "request": { - "name": "ListFolderMembersContinueArg", - "type": [ - { - "name": "cursor", - "type": "String", - "description": "The cursor returned by your last call to :route:`list_folder_members` or :route:`list_folder_members/continue`." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SharedFolderMembers", - "type": [ - { - "name": "users", - "type": [ - { - "name": "UserMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The account information for the membership user." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - } - ], - "description": "The information about a user member of the shared content.", - "typeWrap": "" - } - ], - "description": "The list of user members of the shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "groups", - "type": [ - { - "name": "GroupMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "group", - "type": [ - { - "name": "GroupInfo", - "type": [ - { - "name": "group_name", - "type": "String" - }, - { - "name": "group_id", - "type": "String" - }, - { - "name": "group_management_type", - "type": [ - { - "name": "GroupManagementType", - "type": [ - { - "name": "user_managed", - "type": "Void", - "description": "A group which is managed by selected users." - }, - { - "name": "company_managed", - "type": "Void", - "description": "A group which is managed by team admins only." - }, - { - "name": "system_managed", - "type": "Void", - "description": "A group which is managed automatically by Dropbox." - } - ], - "description": "The group type determines how a group is managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Who is allowed to manage the group." - }, - { - "name": "group_type", - "type": [ - { - "name": "GroupType", - "type": [ - { - "name": "team", - "type": "Void", - "description": "A group to which team members are automatically added. Applicable to :link:`team folders https://www.dropbox.com/help/986` only." - }, - { - "name": "user_managed", - "type": "Void", - "description": "A group is created and managed by a user." - } - ], - "description": "The group type determines how a group is created and managed.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "Field is deprecated. The type of group.", - "isDeprecated": true - }, - { - "name": "is_member", - "type": "Boolean", - "description": "If the current user is a member of the group." - }, - { - "name": "is_owner", - "type": "Boolean", - "description": "If the current user is an owner of the group." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the group is owned by the current user's team." - }, - { - "name": "group_external_id", - "type": "String", - "description": "External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "member_count", - "type": "UInt32", - "description": "The number of members in the group. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.", - "typeWrap": "" - } - ], - "description": "The information about the membership group." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - } - ], - "description": "The information about a group member of the shared content.", - "typeWrap": "" - } - ], - "description": "The list of group members of the shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "invitees", - "type": [ - { - "name": "InviteeMembershipInfo", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder." - }, - { - "name": "invitee", - "type": [ - { - "name": "InviteeInfo", - "type": [ - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of invited user." - } - ], - "description": "Information about the recipient of a shared content invitation.", - "typeWrap": "{} (open union)" - } - ], - "description": "Recipient of the invitation." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "initials", - "type": "String", - "description": "Field is deprecated. Never set. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "is_inherited", - "type": "Boolean", - "description": "True if the member has access from a parent folder. The default for this field is False." - }, - { - "name": "user", - "type": [ - { - "name": "UserInfo", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The account ID of the user." - }, - { - "name": "email", - "type": "String", - "description": "Email address of user." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "same_team", - "type": "Boolean", - "description": "If the user is in the same team as current user." - }, - { - "name": "team_member_id", - "type": "String", - "description": "The team member ID of the shared folder member. Only present if :field:`same_team` is true. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about a user. Use :route:`users.get_account` and :route:`users.get_account_batch` to obtain more detailed information.", - "typeWrap": "" - } - ], - "description": "The user this invitation is tied to, if available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about an invited member of a shared content.", - "typeWrap": "" - } - ], - "description": "The list of invitees to the shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Present if there are additional shared folder members that have not been returned yet. Pass the cursor into :route:`list_folder_members/continue` to list additional members. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "bob@example.com", - "display_name": "Robert Smith", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - }, - "permissions": [], - "is_inherited": false - } - ], - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_name": "Test group", - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "same_team": true, - "member_count": 10 - }, - "permissions": [], - "is_inherited": false - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "permissions": [], - "is_inherited": false - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": "Shared folder user and group membership.", - "typeWrap": "" - }, - "error": { - "name": "ListFolderMembersContinueError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "invalid_cursor", - "type": "Void", - "description": ":field:`ListFolderMembersContinueArg.cursor` is invalid." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_cursor" - }, - "text": null, - "label": "invalid_cursor" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/list_folders": { - "key": "sharing/list_folders", - "name": "list_folders", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Return the list of all shared folders the current user has access to.", - "request": { - "name": "ListFoldersArgs", - "type": [ - { - "name": "limit", - "type": "UInt32(min=1, max=1000)", - "description": "The maximum number of results to return per request. The default for this field is 1000." - }, - { - "name": "actions", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's :field:`SharedFolderMetadata.permissions` field describing the actions the authenticated user can perform on the folder. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "limit": 100, - "actions": [] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListFoldersResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - } - ], - "description": "List of all shared folders the authenticated user has access to.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either :route:`list_folders/continue` or :route:`list_mountable_folders/continue`) to list additional folders. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`list_folders` or :route:`list_mountable_folders`, depending on which endpoint was requested.\nUnmounted shared folders can be identified by the absence of :field:`SharedFolderMetadata.path_lower`.", - "typeWrap": "" - } - }, - "sharing/list_folders/continue": { - "key": "sharing/list_folders/continue", - "name": "list_folders/continue", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Once a cursor has been retrieved from :route:`list_folders`, use this to paginate through all shared folders. The cursor must come from a previous call to :route:`list_folders` or :route:`list_folders/continue`.", - "request": { - "name": "ListFoldersContinueArg", - "type": [ - { - "name": "cursor", - "type": "String", - "description": "The cursor returned by the previous API call specified in the endpoint description." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListFoldersResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - } - ], - "description": "List of all shared folders the authenticated user has access to.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either :route:`list_folders/continue` or :route:`list_mountable_folders/continue`) to list additional folders. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`list_folders` or :route:`list_mountable_folders`, depending on which endpoint was requested.\nUnmounted shared folders can be identified by the absence of :field:`SharedFolderMetadata.path_lower`.", - "typeWrap": "" - }, - "error": { - "name": "ListFoldersContinueError", - "type": [ - { - "name": "invalid_cursor", - "type": "Void", - "description": ":field:`ListFoldersContinueArg.cursor` is invalid." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_cursor" - }, - "text": null, - "label": "invalid_cursor" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/list_mountable_folders": { - "key": "sharing/list_mountable_folders", - "name": "list_mountable_folders", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Return the list of all shared folders the current user can mount or unmount.", - "request": { - "name": "ListFoldersArgs", - "type": [ - { - "name": "limit", - "type": "UInt32(min=1, max=1000)", - "description": "The maximum number of results to return per request. The default for this field is 1000." - }, - { - "name": "actions", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's :field:`SharedFolderMetadata.permissions` field describing the actions the authenticated user can perform on the folder. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "limit": 100, - "actions": [] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListFoldersResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - } - ], - "description": "List of all shared folders the authenticated user has access to.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either :route:`list_folders/continue` or :route:`list_mountable_folders/continue`) to list additional folders. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`list_folders` or :route:`list_mountable_folders`, depending on which endpoint was requested.\nUnmounted shared folders can be identified by the absence of :field:`SharedFolderMetadata.path_lower`.", - "typeWrap": "" - } - }, - "sharing/list_mountable_folders/continue": { - "key": "sharing/list_mountable_folders/continue", - "name": "list_mountable_folders/continue", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Once a cursor has been retrieved from :route:`list_mountable_folders`, use this to paginate through all mountable shared folders. The cursor must come from a previous call to :route:`list_mountable_folders` or :route:`list_mountable_folders/continue`.", - "request": { - "name": "ListFoldersContinueArg", - "type": [ - { - "name": "cursor", - "type": "String", - "description": "The cursor returned by the previous API call specified in the endpoint description." - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListFoldersResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - } - ], - "description": "List of all shared folders the authenticated user has access to.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either :route:`list_folders/continue` or :route:`list_mountable_folders/continue`) to list additional folders. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - } - ], - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": "Result for :route:`list_folders` or :route:`list_mountable_folders`, depending on which endpoint was requested.\nUnmounted shared folders can be identified by the absence of :field:`SharedFolderMetadata.path_lower`.", - "typeWrap": "" - }, - "error": { - "name": "ListFoldersContinueError", - "type": [ - { - "name": "invalid_cursor", - "type": "Void", - "description": ":field:`ListFoldersContinueArg.cursor` is invalid." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_cursor" - }, - "text": null, - "label": "invalid_cursor" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/list_received_files": { - "key": "sharing/list_received_files", - "name": "list_received_files", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Returns a list of all files shared with current user.\n Does not include files the user has received via shared folders, and does not include unclaimed invitations.", - "selectAdminMode": "team_admin", - "request": { - "name": "ListFilesArg", - "type": [ - { - "name": "limit", - "type": "UInt32(min=1, max=300)", - "description": "Number of files to return max per query. Defaults to 100 if no limit is specified. The default for this field is 100." - }, - { - "name": "actions", - "type": [ - { - "name": "FileAction", - "type": [ - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information on the file." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the file." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the file." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Add a member with view permissions." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Add a member with view permissions but no comment permissions." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Add a member with edit permissions." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this file." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership to the file." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_view_link", - "type": "Void", - "description": "Create a shared link to a file that only allows users to view the content." - }, - { - "name": "create_edit_link", - "type": "Void", - "description": "Create a shared link to a file that allows users to edit the content." - } - ], - "description": "Sharing actions that may be taken on files.", - "typeWrap": "{} (open union)" - } - ], - "description": "A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's :field:`SharedFileMetadata.permissions` field describing the actions the authenticated user can perform on the file. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "limit": 100, - "actions": [] - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`list_received_files`.", - "typeWrap": "" - }, - "response": { - "name": "ListFilesResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "SharedFileMetadata", - "type": [ - { - "name": "id", - "type": "String(min_length=4, pattern=\"id:.+\")", - "description": "The ID of the file." - }, - { - "name": "name", - "type": "String", - "description": "The name of this file." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared file." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared file." - }, - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expected_link_metadata", - "type": [ - { - "name": "ExpectedSharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The expected metadata of a shared link for a file or folder when a link is first created for the content. Absent if the link already exists.", - "typeWrap": "" - } - ], - "description": "The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the file. This field is not present if the file is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the file is contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-case full path of this file. Absent for unmounted files. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FilePermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FileAction", - "type": [ - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information on the file." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the file." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the file." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Add a member with view permissions." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Add a member with view permissions but no comment permissions." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Add a member with edit permissions." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this file." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership to the file." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_view_link", - "type": "Void", - "description": "Create a shared link to a file that only allows users to view the content." - }, - { - "name": "create_edit_link", - "type": "Void", - "description": "Create a shared link to a file that allows users to edit the content." - } - ], - "description": "Sharing actions that may be taken on files.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the file." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the sharing action on the file.", - "typeWrap": "" - } - ], - "description": "The sharing permissions that requesting user has on this file. This corresponds to the entries given in :field:`GetFileMetadataBatchArg.actions` or :field:`GetFileMetadataArg.actions`. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Properties of the shared file.", - "typeWrap": "" - } - ], - "description": "Information about the files shared with current user.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Cursor used to obtain additional shared files. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "access_type": { - ".tag": "viewer" - }, - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "time_invited": "2016-01-20T00:00:00Z" - } - ], - "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ" - }, - "text": null, - "label": "default" - } - ], - "description": "Success results for :route:`list_received_files`.", - "typeWrap": "" - }, - "error": { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "example": [ - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - }, - "sharing/list_received_files/continue": { - "key": "sharing/list_received_files/continue", - "name": "list_received_files/continue", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Get more results with a cursor from :route:`list_received_files`.", - "request": { - "name": "ListFilesContinueArg", - "type": [ - { - "name": "cursor", - "type": "String", - "description": "Cursor in :field:`ListFilesResult.cursor`." - } - ], - "example": [ - { - "value": { - "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`list_received_files/continue`.", - "typeWrap": "" - }, - "response": { - "name": "ListFilesResult", - "type": [ - { - "name": "entries", - "type": [ - { - "name": "SharedFileMetadata", - "type": [ - { - "name": "id", - "type": "String(min_length=4, pattern=\"id:.+\")", - "description": "The ID of the file." - }, - { - "name": "name", - "type": "String", - "description": "The name of this file." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared file." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared file." - }, - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expected_link_metadata", - "type": [ - { - "name": "ExpectedSharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The expected metadata of a shared link for a file or folder when a link is first created for the content. Absent if the link already exists.", - "typeWrap": "" - } - ], - "description": "The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the file. This field is not present if the file is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the file is contained within a shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_display", - "type": "String", - "description": "The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-case full path of this file. Absent for unmounted files. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FilePermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FileAction", - "type": [ - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information on the file." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the file." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the file." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Add a member with view permissions." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Add a member with view permissions but no comment permissions." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Add a member with edit permissions." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this file." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership to the file." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Field is deprecated. Use create_view_link and create_edit_link instead.", - "isDeprecated": true - }, - { - "name": "create_view_link", - "type": "Void", - "description": "Create a shared link to a file that only allows users to view the content." - }, - { - "name": "create_edit_link", - "type": "Void", - "description": "Create a shared link to a file that allows users to edit the content." - } - ], - "description": "Sharing actions that may be taken on files.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the file." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the sharing action on the file.", - "typeWrap": "" - } - ], - "description": "The sharing permissions that requesting user has on this file. This corresponds to the entries given in :field:`GetFileMetadataBatchArg.actions` or :field:`GetFileMetadataArg.actions`. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Properties of the shared file.", - "typeWrap": "" - } - ], - "description": "Information about the files shared with current user.", - "typeWrap": "List of ({})" - }, - { - "name": "cursor", - "type": "String", - "description": "Cursor used to obtain additional shared files. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "entries": [ - { - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "access_type": { - ".tag": "viewer" - }, - "owner_display_names": [ - "Jane Doe" - ], - "owner_team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "path_display": "/dir/file.txt", - "path_lower": "/dir/file.txt", - "permissions": [], - "time_invited": "2016-01-20T00:00:00Z" - } - ], - "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ" - }, - "text": null, - "label": "default" - } - ], - "description": "Success results for :route:`list_received_files`.", - "typeWrap": "" - }, - "error": { - "name": "ListFilesContinueError", - "type": [ - { - "name": "user_error", - "type": [ - { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - ], - "description": "User account had a problem." - }, - { - "name": "invalid_cursor", - "type": "Void", - "description": ":field:`ListFilesContinueArg.cursor` is invalid." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_cursor" - }, - "text": null, - "label": "invalid_cursor" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error results for :route:`list_received_files/continue`.", - "typeWrap": "{} (open union)" - } - }, - "sharing/list_shared_links": { - "key": "sharing/list_shared_links", - "name": "list_shared_links", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "List shared links of this user.\nIf no path is given, returns a list of all shared links for the current user. For members of business teams using team space and member folders, returns all shared links in the team member's home folder unless the team space ID is specified in the request header. For more information, refer to the :link:`Namespace Guide https://www.dropbox.com/developers/reference/namespace-guide`.\nIf a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.", - "allowAppFolderApp": true, - "request": { - "name": "ListSharedLinksArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)\")", - "description": "See :route:`list_shared_links` description. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "cursor", - "type": "String", - "description": "The cursor returned by your last call to :route:`list_shared_links`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "direct_only", - "type": "Boolean", - "description": "See :route:`list_shared_links` description. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": "List all links.", - "label": "default" - }, - { - "value": { - "path": "/Homework/Math" - }, - "text": null, - "label": "path" - }, - { - "value": { - "path": "id:a4ayc_80_OEAAAAAAAAAYa" - }, - "text": null, - "label": "id" - }, - { - "value": { - "path": "rev:a1c10ce0dd78" - }, - "text": null, - "label": "rev" - }, - { - "value": { - "path": "id:a4ayc_80_OEAAAAAAAAAYa", - "direct_only": true - }, - "text": null, - "label": "id_no_parent_links" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ListSharedLinksResult", - "type": [ - { - "name": "links", - "type": [ - { - "name": "SharedLinkMetadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a file shared link.", - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a folder shared link.", - "typeWrap": "" - } - ] - } - ], - "description": "The metadata of a shared link.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Shared links applicable to the path argument.", - "typeWrap": "List of ({})" - }, - { - "name": "has_more", - "type": "Boolean", - "description": "Is true if there are additional shared links that have not been returned yet. Pass the cursor into :route:`list_shared_links` to retrieve them." - }, - { - "name": "cursor", - "type": "String", - "description": "Pass the cursor into :route:`list_shared_links` to obtain the additional links. Cursor is returned only if no path is given. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "links": [ - { - ".tag": "file", - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "name": "Prime_Numbers.txt", - "link_permissions": { - "can_revoke": false, - "visibility_policies": [ - { - "policy": { - ".tag": "public" - }, - "resolved_policy": { - ".tag": "public" - }, - "allowed": true - }, - { - "policy": { - ".tag": "password" - }, - "resolved_policy": { - ".tag": "password" - }, - "allowed": true - } - ], - "can_set_expiry": false, - "can_remove_expiry": false, - "allow_download": true, - "can_allow_download": true, - "can_disallow_download": false, - "allow_comments": true, - "team_restricts_comments": true, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - }, - "audience_options": [ - { - "audience": { - ".tag": "public" - }, - "allowed": true - }, - { - "audience": { - ".tag": "team" - }, - "allowed": false - }, - { - "audience": { - ".tag": "no_one" - }, - "allowed": true - } - ], - "can_set_password": true, - "can_remove_password": true, - "require_password": false, - "can_use_extended_sharing_controls": false - }, - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "path_lower": "/homework/math/prime_numbers.txt", - "team_member_info": { - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234" - } - } - ], - "has_more": true, - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "ListSharedLinksError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "importedNamespace": "files", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "reset", - "type": "Void", - "description": "Indicates that the cursor has been invalidated. Call :route:`list_shared_links` to obtain a new cursor." - } - ], - "example": [ - { - "value": { - ".tag": "reset" - }, - "text": null, - "label": "reset" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/modify_shared_link_settings": { - "key": "sharing/modify_shared_link_settings", - "name": "modify_shared_link_settings", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Modify the shared link's settings.\nIf the requested visibility conflict with the shared links policy of the team or the shared folder (in case the linked file is part of a shared folder) then the :field:`LinkPermissions.resolved_visibility` of the returned :type:`SharedLinkMetadata` will reflect the actual visibility of the shared link and the :field:`LinkPermissions.requested_visibility` will reflect the requested visibility.", - "allowAppFolderApp": true, - "request": { - "name": "ModifySharedLinkSettingsArgs", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link to change its settings." - }, - { - "name": "settings", - "type": [ - { - "name": "SharedLinkSettings", - "type": [ - { - "name": "require_password", - "type": "Boolean", - "description": "Boolean flag to enable or disable password protection. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_password", - "type": "String", - "description": "If :field:`require_password` is true, this is needed to specify the password to access the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time of the shared link. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The new audience who can benefit from the access level specified by the link's access level specified in the `link_access_level` field of `LinkPermissions`. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the `effective_audience` field of `LinkPermissions. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access", - "type": [ - { - "name": "RequestedLinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content. Note not all file types support edit links yet." - }, - { - "name": "max", - "type": "Void", - "description": "Request for the maximum access level you can set the link to." - }, - { - "name": "default", - "type": "Void", - "description": "Request for the default access level the user has set." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "Field is deprecated. Use :field:`audience` instead. The requested access for this shared link. This field is optional.", - "isDeprecated": true, - "typeWrap": "{}?" - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Boolean flag to allow or not download capabilities for shared links. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "Set of settings for the shared link." - }, - { - "name": "remove_expiration", - "type": "Boolean", - "description": "If set to true, removes the expiration of the shared link. The default for this field is False." - } - ], - "example": [ - { - "value": { - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "settings": { - "audience": "public", - "access": "viewer", - "requested_visibility": "public", - "allow_download": true - }, - "remove_expiration": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SharedLinkMetadata", - "type": [ - { - "name": "file", - "type": [ - { - "name": "FileLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "client_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not." - }, - { - "name": "server_modified", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "The last time the file was modified on Dropbox." - }, - { - "name": "rev", - "type": "String(min_length=9, pattern=\"[0-9a-f]+\")", - "description": "A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts." - }, - { - "name": "size", - "type": "UInt64", - "description": "The file size in bytes." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a file shared link.", - "typeWrap": "" - } - ] - }, - { - "name": "folder", - "type": [ - { - "name": "FolderLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "name", - "type": "String", - "description": "The linked file name (including extension). This never contains a slash." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermissions", - "type": [ - { - "name": "can_revoke", - "type": "Boolean", - "description": "Whether the caller can revoke the shared link." - }, - { - "name": "visibility_policies", - "type": [ - { - "name": "VisibilityPolicy", - "type": [ - { - "name": "policy", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "This is the value to submit when saving the visibility setting." - }, - { - "name": "resolved_policy", - "type": [ - { - "name": "AlphaResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "check documentation for ResolvedVisibility.", - "typeWrap": "{} (union)" - } - ], - "description": "This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user is permitted to set the visibility to this policy." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "VisibilityPolicyDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of policies that the user might be able to set for the visibility.", - "typeWrap": "List of ({})" - }, - { - "name": "can_set_expiry", - "type": "Boolean", - "description": "Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry." - }, - { - "name": "can_remove_expiry", - "type": "Boolean", - "description": "Whether the user can remove the expiry of the link." - }, - { - "name": "allow_download", - "type": "Boolean", - "description": "Whether the link can be downloaded or not." - }, - { - "name": "can_allow_download", - "type": "Boolean", - "description": "Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link." - }, - { - "name": "can_disallow_download", - "type": "Boolean", - "description": "Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link." - }, - { - "name": "allow_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether comments are enabled for the linked file. This takes the team commenting policy into account.", - "isDeprecated": true - }, - { - "name": "team_restricts_comments", - "type": "Boolean", - "description": "Field is deprecated. Whether the team has disabled commenting globally.", - "isDeprecated": true - }, - { - "name": "resolved_visibility", - "type": [ - { - "name": "ResolvedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link. Login is required." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder." - }, - { - "name": "only_you", - "type": "Void", - "description": "Only the current user can view this link." - } - ], - "description": "The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the :type:`RequestedVisibility` for more info on the possible visibility values that can be set by the shared link's owner.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "requested_visibility", - "type": [ - { - "name": "RequestedVisibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - } - ], - "description": "The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the :type:`ResolvedVisibility` for more info on the possible resolved visibility values of shared links.", - "typeWrap": "{} (union)" - } - ], - "description": "The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in :field:`resolved_visibility`. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "revoke_failure_reason", - "type": [ - { - "name": "SharedLinkAccessFailureReason", - "type": [ - { - "name": "login_required", - "type": "Void", - "description": "User is not logged in." - }, - { - "name": "email_verify_required", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "password_required", - "type": "Void", - "description": "The link is password protected." - }, - { - "name": "team_only", - "type": "Void", - "description": "Access is allowed for team members only." - }, - { - "name": "owner_only", - "type": "Void", - "description": "Access is allowed for the shared link's owner only." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The failure reason for revoking the link. This field will only be present if the :field:`can_revoke` is :val:`false`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "effective_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience who can benefit from the access level specified by the `link_access_level` field. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_access_level", - "type": [ - { - "name": "LinkAccessLevel", - "type": [ - { - "name": "viewer", - "type": "Void", - "description": "Users who use the link can view and comment on the content." - }, - { - "name": "editor", - "type": "Void", - "description": "Users who use the link can edit, view and comment on the content." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudienceOption", - "type": [ - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Specifies who can access the link." - }, - { - "name": "allowed", - "type": "Boolean", - "description": "Whether the user calling this API can select this audience option." - }, - { - "name": "disallowed_reason", - "type": [ - { - "name": "LinkAudienceDisallowedReason", - "type": [ - { - "name": "delete_and_recreate", - "type": "Void", - "description": "The user needs to delete and recreate the link to change the visibility policy." - }, - { - "name": "restricted_by_shared_folder", - "type": "Void", - "description": "The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The team policy prevents links being shared outside the team." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a team to set this policy." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user is a basic user or is on a limited team." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission." - } - ], - "description": "check documentation for VisibilityPolicyDisallowedReason.", - "typeWrap": "{} (union)" - } - ], - "description": "If :field:`allowed` is :val:`false`, this will provide the reason that the user is not permitted to set the visibility to this policy. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "A list of link audience options the user might be able to set as the new audience. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "can_set_password", - "type": "Boolean", - "description": "Whether the user can set a password for the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_remove_password", - "type": "Boolean", - "description": "Whether the user can remove the password of the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "require_password", - "type": "Boolean", - "description": "Whether the user is required to provide a password to view the link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "can_use_extended_sharing_controls", - "type": "Boolean", - "description": "Whether the user can use extended sharing controls, based on their account type. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The link's access permissions." - }, - { - "name": "id", - "type": "String(min_length=1)", - "description": "A unique identifier for the linked file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_info", - "type": [ - { - "name": "TeamMemberInfo", - "type": [ - { - "name": "team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "Information about the member's team." - }, - { - "name": "display_name", - "type": "String", - "description": "The display name of the user." - }, - { - "name": "member_id", - "type": "String", - "description": "ID of user as a member of a team. This field will only be present if the member is in the same team as current user. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Information about a team member.", - "typeWrap": "" - } - ], - "description": "The team membership information of the link's owner. This field will only be present if the link's owner is a team member. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "content_owner_team_info", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "The metadata of a folder shared link.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "file", - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "name": "Prime_Numbers.txt", - "link_permissions": { - "can_revoke": false, - "visibility_policies": [ - { - "policy": { - ".tag": "public" - }, - "resolved_policy": { - ".tag": "public" - }, - "allowed": true - }, - { - "policy": { - ".tag": "password" - }, - "resolved_policy": { - ".tag": "password" - }, - "allowed": true - } - ], - "can_set_expiry": false, - "can_remove_expiry": false, - "allow_download": true, - "can_allow_download": true, - "can_disallow_download": false, - "allow_comments": true, - "team_restricts_comments": true, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - }, - "audience_options": [ - { - "audience": { - ".tag": "public" - }, - "allowed": true - }, - { - "audience": { - ".tag": "team" - }, - "allowed": false - }, - { - "audience": { - ".tag": "no_one" - }, - "allowed": true - } - ], - "can_set_password": true, - "can_remove_password": true, - "require_password": false, - "can_use_extended_sharing_controls": false - }, - "client_modified": "2015-05-12T15:50:38Z", - "server_modified": "2015-05-12T15:50:38Z", - "rev": "a1c10ce0dd78", - "size": 7212, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "path_lower": "/homework/math/prime_numbers.txt", - "team_member_info": { - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "folder", - "url": "https://www.dropbox.com/sh/s6fvw6ol7rmqo1x/AAAgWRSbjmYDvPpDB30Sykjfa?dl=0", - "name": "Math", - "link_permissions": { - "can_revoke": false, - "visibility_policies": [ - { - "policy": { - ".tag": "public" - }, - "resolved_policy": { - ".tag": "public" - }, - "allowed": true - }, - { - "policy": { - ".tag": "password" - }, - "resolved_policy": { - ".tag": "password" - }, - "allowed": true - } - ], - "can_set_expiry": false, - "can_remove_expiry": false, - "allow_download": true, - "can_allow_download": true, - "can_disallow_download": false, - "allow_comments": true, - "team_restricts_comments": true, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - }, - "audience_options": [ - { - "audience": { - ".tag": "public" - }, - "allowed": true - }, - { - "audience": { - ".tag": "team" - }, - "allowed": false - }, - { - "audience": { - ".tag": "no_one" - }, - "allowed": true - } - ], - "can_set_password": true, - "can_remove_password": true, - "require_password": false, - "can_use_extended_sharing_controls": false - }, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "path_lower": "/homework/math", - "team_member_info": { - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - }, - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234" - } - }, - "text": null, - "label": "default" - } - ], - "description": "The metadata of a shared link.", - "typeWrap": "{} (datatype with subtypes)" - }, - "error": { - "name": "ModifySharedLinkSettingsError", - "type": [ - { - "name": "shared_link_not_found", - "type": "Void", - "description": "The shared link wasn't found." - }, - { - "name": "shared_link_access_denied", - "type": "Void", - "description": "The caller is not allowed to access this shared link." - }, - { - "name": "unsupported_link_type", - "type": "Void", - "description": "This type of link is not supported; use :route:`files.export` instead." - }, - { - "name": "settings_error", - "type": [ - { - "name": "SharedLinkSettingsError", - "type": [ - { - "name": "invalid_settings", - "type": "Void", - "description": "The given settings are invalid (for example, all attributes of the :type:`SharedLinkSettings` are empty, the requested visibility is :field:`RequestedVisibility.password` but the :field:`SharedLinkSettings.link_password` is missing, :field:`SharedLinkSettings.expires` is set to the past, etc.)." - }, - { - "name": "not_authorized", - "type": "Void", - "description": "User is not allowed to modify the settings of this link. Note that basic users can only set :field:`RequestedVisibility.public` as the :field:`SharedLinkSettings.requested_visibility` and cannot set :field:`SharedLinkSettings.expires`." - } - ], - "description": null, - "typeWrap": "{} (union)" - } - ], - "description": "There is an error with the given settings." - }, - { - "name": "email_not_verified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "example": [ - { - "value": { - ".tag": "shared_link_not_found" - }, - "text": null, - "label": "shared_link_not_found" - }, - { - "value": { - ".tag": "shared_link_access_denied" - }, - "text": null, - "label": "shared_link_access_denied" - }, - { - "value": { - ".tag": "unsupported_link_type" - }, - "text": null, - "label": "unsupported_link_type" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "email_not_verified" - }, - "text": null, - "label": "email_not_verified" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "sharing/mount_folder": { - "key": "sharing/mount_folder", - "name": "mount_folder", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "The current user mounts the designated folder.\nMount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox.", - "request": { - "name": "MountFolderArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder to mount." - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "example": [ - { - "value": { - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - }, - "text": null, - "label": "default" - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - }, - "error": { - "name": "MountFolderError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "inside_shared_folder", - "type": "Void", - "description": "Mounting would cause a shared folder to be inside another, which is disallowed." - }, - { - "name": "insufficient_quota", - "type": [ - { - "name": "InsufficientQuotaAmounts", - "type": [ - { - "name": "space_needed", - "type": "UInt64", - "description": "The amount of space needed to add the item (the size of the item)." - }, - { - "name": "space_shortage", - "type": "UInt64", - "description": "The amount of extra space needed to add the item." - }, - { - "name": "space_left", - "type": "UInt64", - "description": "The amount of space left in the user's Dropbox, less than space_needed." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The current user does not have enough space to mount the shared folder." - }, - { - "name": "already_mounted", - "type": "Void", - "description": "The shared folder is already mounted." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "not_mountable", - "type": "Void", - "description": "The shared folder is not mountable. One example where this can occur is when the shared folder belongs within a team folder in the user's Dropbox." - } - ], - "example": [ - { - "value": { - ".tag": "inside_shared_folder" - }, - "text": null, - "label": "inside_shared_folder" - }, - { - "value": { - ".tag": "already_mounted" - }, - "text": null, - "label": "already_mounted" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "not_mountable" - }, - "text": null, - "label": "not_mountable" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/relinquish_file_membership": { - "key": "sharing/relinquish_file_membership", - "name": "relinquish_file_membership", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "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.", - "selectAdminMode": "team_admin", - "request": { - "name": "RelinquishFileMembershipArg", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "The path or id for the file." - } - ], - "example": [ - { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "RelinquishFileMembershipError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "group_access", - "type": "Void", - "description": "The current user has access to the shared file via a group. You can't relinquish membership to a file shared via groups." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - } - ], - "example": [ - { - "value": { - ".tag": "group_access" - }, - "text": null, - "label": "group_access" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/relinquish_folder_membership": { - "key": "sharing/relinquish_folder_membership", - "name": "relinquish_folder_membership", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. A folder owner cannot relinquish membership in their own folder.\nThis will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true.", - "request": { - "name": "RelinquishFolderMembershipArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "leave_a_copy", - "type": "Boolean", - "description": "Keep a copy of the folder's contents upon relinquishing membership. This must be set to false when the folder is within a team folder or another shared folder. The default for this field is False." - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "leave_a_copy": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "LaunchEmptyResult", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": "Void", - "description": "The job finished synchronously and successfully." - } - ], - "example": [ - { - "value": { - ".tag": "complete" - }, - "text": null, - "label": "complete" - }, - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "async_job_id" - } - ], - "description": "Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.", - "importedNamespace": "async", - "typeWrap": "{} (union)" - }, - "error": { - "name": "RelinquishFolderMembershipError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "folder_owner", - "type": "Void", - "description": "The current user is the owner of the shared folder. Owners cannot relinquish membership to their own folders. Try unsharing or transferring ownership first." - }, - { - "name": "mounted", - "type": "Void", - "description": "The shared folder is currently mounted. Unmount the shared folder before relinquishing membership." - }, - { - "name": "group_access", - "type": "Void", - "description": "The current user has access to the shared folder via a group. You can't relinquish membership to folders shared via groups." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "no_explicit_access", - "type": "Void", - "description": "The current user only has inherited access to the shared folder. You can't relinquish inherited membership to folders." - } - ], - "example": [ - { - "value": { - ".tag": "folder_owner" - }, - "text": null, - "label": "folder_owner" - }, - { - "value": { - ".tag": "mounted" - }, - "text": null, - "label": "mounted" - }, - { - "value": { - ".tag": "group_access" - }, - "text": null, - "label": "group_access" - }, - { - "value": { - ".tag": "team_folder" - }, - "text": null, - "label": "team_folder" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "no_explicit_access" - }, - "text": null, - "label": "no_explicit_access" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/remove_file_member_2": { - "key": "sharing/remove_file_member_2", - "name": "remove_file_member_2", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Removes a specified member from the file.", - "selectAdminMode": "team_admin", - "request": { - "name": "RemoveFileMemberArg", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "File from which to remove members." - }, - { - "name": "member", - "type": [ - { - "name": "MemberSelector", - "type": [ - { - "name": "dropbox_id", - "type": "String(min_length=1)", - "description": "Dropbox account, team member, or group ID of member." - }, - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of member." - } - ], - "description": "Includes different ways to identify a member of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "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." - } - ], - "example": [ - { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`remove_file_member_2`.", - "typeWrap": "" - }, - "response": { - "name": "FileMemberRemoveActionResult", - "type": [ - { - "name": "success", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "Member was successfully removed from this file." - }, - { - "name": "member_error", - "type": [ - { - "name": "FileMemberActionError", - "type": [ - { - "name": "invalid_member", - "type": "Void", - "description": "Specified member was not found." - }, - { - "name": "no_permission", - "type": "Void", - "description": "User does not have permission to perform this action on this member." - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ], - "description": "Specified file was invalid or user does not have access." - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "User was not able to remove this member." - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - }, - "error": { - "name": "RemoveFileMemberError", - "type": [ - { - "name": "user_error", - "type": [ - { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "This member does not have explicit access to the file and therefore cannot be removed. The return value is the access that a user might have to the file from a parent folder." - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Errors for :route:`remove_file_member_2`.", - "typeWrap": "{} (open union)" - } - }, - "sharing/remove_folder_member": { - "key": "sharing/remove_folder_member", - "name": "remove_folder_member", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.", - "selectAdminMode": "team_admin", - "request": { - "name": "RemoveFolderMemberArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "member", - "type": [ - { - "name": "MemberSelector", - "type": [ - { - "name": "dropbox_id", - "type": "String(min_length=1)", - "description": "Dropbox account, team member, or group ID of member." - }, - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of member." - } - ], - "description": "Includes different ways to identify a member of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member to remove from the folder." - }, - { - "name": "leave_a_copy", - "type": "Boolean", - "description": "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. This must be set to false when removing a group, or when the folder is within a team folder or another shared folder." - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "leave_a_copy": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "LaunchResultBase", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - } - ], - "example": [ - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "default" - } - ], - "description": "Result returned by methods that launch an asynchronous job.\nA method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response.\nSee :type:`LaunchEmptyResult` for an example.", - "importedNamespace": "async", - "typeWrap": "{} (union)" - }, - "error": { - "name": "RemoveFolderMemberError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "member_error", - "type": [ - { - "name": "SharedFolderMemberError", - "type": [ - { - "name": "invalid_dropbox_id", - "type": "Void", - "description": "The target dropbox_id is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The target dropbox_id is not a member of the shared folder." - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "The target member only has inherited access to the shared folder." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "folder_owner", - "type": "Void", - "description": "The target user is the owner of the shared folder. You can't remove this user until ownership has been transferred to another member." - }, - { - "name": "group_access", - "type": "Void", - "description": "The target user has access to the shared folder via a group." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "This shared folder has too many files for leaving a copy. You can still remove this user without leaving a copy." - } - ], - "example": [ - { - "value": { - ".tag": "folder_owner" - }, - "text": null, - "label": "folder_owner" - }, - { - "value": { - ".tag": "group_access" - }, - "text": null, - "label": "group_access" - }, - { - "value": { - ".tag": "team_folder" - }, - "text": null, - "label": "team_folder" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/revoke_shared_link": { - "key": "sharing/revoke_shared_link", - "name": "revoke_shared_link", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Revoke a shared link.\nNote 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 :route:`list_shared_links` with the file as the :field:`ListSharedLinksArg.path` argument.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "request": { - "name": "RevokeSharedLinkArg", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - } - ], - "example": [ - { - "value": { - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "RevokeSharedLinkError", - "type": [ - { - "name": "shared_link_not_found", - "type": "Void", - "description": "The shared link wasn't found." - }, - { - "name": "shared_link_access_denied", - "type": "Void", - "description": "The caller is not allowed to access this shared link." - }, - { - "name": "unsupported_link_type", - "type": "Void", - "description": "This type of link is not supported; use :route:`files.export` instead." - }, - { - "name": "shared_link_malformed", - "type": "Void", - "description": "Shared link is malformed." - } - ], - "example": [ - { - "value": { - ".tag": "shared_link_not_found" - }, - "text": null, - "label": "shared_link_not_found" - }, - { - "value": { - ".tag": "shared_link_access_denied" - }, - "text": null, - "label": "shared_link_access_denied" - }, - { - "value": { - ".tag": "unsupported_link_type" - }, - "text": null, - "label": "unsupported_link_type" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "shared_link_malformed" - }, - "text": null, - "label": "shared_link_malformed" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "sharing/set_access_inheritance": { - "key": "sharing/set_access_inheritance", - "name": "set_access_inheritance", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Change the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root.\nIf a :field:`ShareFolderLaunch.async_job_id` is returned, you'll need to call :route:`check_share_job_status` until the action completes to get the metadata for the folder.", - "request": { - "name": "SetAccessInheritanceArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access inheritance settings for the folder. The default for this union is inherit." - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "access_inheritance": "inherit" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ShareFolderLaunch", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "SetAccessInheritanceError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Unable to access shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - } - ], - "example": [ - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/share_folder": { - "key": "sharing/share_folder", - "name": "share_folder", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Share a folder with collaborators.\nMost sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set `ShareFolderArg.force_async`.\nIf a :field:`ShareFolderLaunch.async_job_id` is returned, you'll need to call :route:`check_share_job_status` until the action completes to get the metadata for the folder.", - "selectAdminMode": "team_admin", - "request": { - "name": "ShareFolderArg", - "type": [ - { - "name": "path", - "type": "String(pattern=\"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)\")", - "description": "The path to the folder to share. If it does not exist, then a new one is created." - }, - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members of this shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "force_async", - "type": "Boolean", - "description": "Whether to force the share to happen asynchronously. The default for this field is False." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder. Only applicable if the current user is on a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to :field:`SharedLinkPolicy.members`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access inheritance settings for the folder. The default for this union is inherit." - }, - { - "name": "actions", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's :field:`SharedFolderMetadata.permissions` field describing the actions the authenticated user can perform on the folder. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "link_settings", - "type": [ - { - "name": "LinkSettings", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. Currently, it only accepts 'viewer' and 'viewer_no_comment'. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": [ - { - "name": "LinkExpiry", - "type": [ - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the currently set expiry for the link." - }, - { - "name": "set_expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Set a new expiry or change an existing expiry." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "An expiry timestamp to set on a link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "password", - "type": [ - { - "name": "LinkPassword", - "type": [ - { - "name": "remove_password", - "type": "Void", - "description": "Remove the currently set password for the link." - }, - { - "name": "set_password", - "type": "String", - "description": "Set a new password or change an existing password." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The password for the link. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Settings that apply to a link.", - "typeWrap": "" - } - ], - "description": "Settings on the link for this folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/example/workspace", - "acl_update_policy": "editors", - "force_async": false, - "member_policy": "team", - "shared_link_policy": "members", - "access_inheritance": "inherit" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "ShareFolderLaunch", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": [ - { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "complete", - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "ShareFolderError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "bad_path", - "type": [ - { - "name": "SharePathError", - "type": [ - { - "name": "is_file", - "type": "Void", - "description": "A file is at the specified path." - }, - { - "name": "inside_shared_folder", - "type": "Void", - "description": "We do not support sharing a folder inside a shared folder." - }, - { - "name": "contains_shared_folder", - "type": "Void", - "description": "We do not support shared folders that contain shared folders." - }, - { - "name": "contains_app_folder", - "type": "Void", - "description": "We do not support shared folders that contain app folders." - }, - { - "name": "contains_team_folder", - "type": "Void", - "description": "We do not support shared folders that contain team folders." - }, - { - "name": "is_app_folder", - "type": "Void", - "description": "We do not support sharing an app folder." - }, - { - "name": "inside_app_folder", - "type": "Void", - "description": "We do not support sharing a folder inside an app folder." - }, - { - "name": "is_public_folder", - "type": "Void", - "description": "A public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A folder inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "already_shared", - "type": [ - { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - } - ], - "description": "Folder is already shared. Contains metadata about the existing shared folder." - }, - { - "name": "invalid_path", - "type": "Void", - "description": "Path is not valid." - }, - { - "name": "is_osx_package", - "type": "Void", - "description": "We do not support sharing a Mac OS X package." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "We do not support sharing a folder inside a Mac OS X package." - }, - { - "name": "is_vault", - "type": "Void", - "description": "We do not support sharing the Vault folder." - }, - { - "name": "is_vault_locked", - "type": "Void", - "description": "We do not support sharing a folder inside a locked Vault." - }, - { - "name": "is_family", - "type": "Void", - "description": "We do not support sharing the Family folder." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": ":field:`ShareFolderArg.path` is invalid." - }, - { - "name": "team_policy_disallows_member_policy", - "type": "Void", - "description": "Team policy is more restrictive than :field:`ShareFolderArg.member_policy`." - }, - { - "name": "disallowed_shared_link_policy", - "type": "Void", - "description": "The current user's account is not allowed to select the specified :field:`ShareFolderArg.shared_link_policy`." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - } - ], - "example": [ - { - "value": { - ".tag": "email_unverified" - }, - "text": null, - "label": "email_unverified" - }, - { - "value": { - ".tag": "team_policy_disallows_member_policy" - }, - "text": null, - "label": "team_policy_disallows_member_policy" - }, - { - "value": { - ".tag": "disallowed_shared_link_policy" - }, - "text": null, - "label": "disallowed_shared_link_policy" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - } - ], - "description": null, - "typeWrap": "{} (union)" - } - }, - "sharing/transfer_folder": { - "key": "sharing/transfer_folder", - "name": "transfer_folder", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Transfer ownership of a shared folder to a member of the shared folder.\nUser must have :field:`AccessLevel.owner` access to the shared folder to perform a transfer.", - "selectAdminMode": "team_admin", - "request": { - "name": "TransferFolderArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "to_dropbox_id", - "type": "String(min_length=1)", - "description": "A account or team member ID to transfer ownership to." - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "to_dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "TransferFolderError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "invalid_dropbox_id", - "type": "Void", - "description": ":field:`TransferFolderArg.to_dropbox_id` is invalid." - }, - { - "name": "new_owner_not_a_member", - "type": "Void", - "description": "The new designated owner is not currently a member of the shared folder." - }, - { - "name": "new_owner_unmounted", - "type": "Void", - "description": "The new designated owner has not added the folder to their Dropbox." - }, - { - "name": "new_owner_email_unverified", - "type": "Void", - "description": "The new designated owner's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_dropbox_id" - }, - "text": null, - "label": "invalid_dropbox_id" - }, - { - "value": { - ".tag": "new_owner_not_a_member" - }, - "text": null, - "label": "new_owner_not_a_member" - }, - { - "value": { - ".tag": "new_owner_unmounted" - }, - "text": null, - "label": "new_owner_unmounted" - }, - { - "value": { - ".tag": "new_owner_email_unverified" - }, - "text": null, - "label": "new_owner_email_unverified" - }, - { - "value": { - ".tag": "team_folder" - }, - "text": null, - "label": "team_folder" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/unmount_folder": { - "key": "sharing/unmount_folder", - "name": "unmount_folder", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "The current user unmounts the designated folder. They can re-mount the folder at a later time using :route:`mount_folder`.", - "selectAdminMode": "team_admin", - "request": { - "name": "UnmountFolderArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "UnmountFolderError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "not_unmountable", - "type": "Void", - "description": "The shared folder can't be unmounted. One example where this can occur is when the shared folder's parent folder is also a shared folder that resides in the current user's Dropbox." - } - ], - "example": [ - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "not_unmountable" - }, - "text": null, - "label": "not_unmountable" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/unshare_file": { - "key": "sharing/unshare_file", - "name": "unshare_file", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Remove all members from this file. Does not remove inherited members.", - "selectAdminMode": "team_admin", - "request": { - "name": "UnshareFileArg", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "The file to unshare." - } - ], - "example": [ - { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`unshare_file`.", - "typeWrap": "" - }, - "error": { - "name": "UnshareFileError", - "type": [ - { - "name": "user_error", - "type": [ - { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "user_error", - "user_error": { - ".tag": "email_unverified" - } - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Error result for :route:`unshare_file`.", - "typeWrap": "{} (open union)" - } - }, - "sharing/unshare_folder": { - "key": "sharing/unshare_folder", - "name": "unshare_folder", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Allows a shared folder owner to unshare the folder.\nYou'll need to call :route:`check_job_status` to determine if the action has completed successfully.", - "selectAdminMode": "team_admin", - "request": { - "name": "UnshareFolderArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "leave_a_copy", - "type": "Boolean", - "description": "If true, members of this shared folder will get a copy of this folder after it's unshared. Otherwise, it will be removed from their Dropbox. The current user, who is an owner, will always retain their copy. The default for this field is False." - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "leave_a_copy": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "LaunchEmptyResult", - "type": [ - { - "name": "async_job_id", - "type": "String(min_length=1)", - "description": "This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job." - }, - { - "name": "complete", - "type": "Void", - "description": "The job finished synchronously and successfully." - } - ], - "example": [ - { - "value": { - ".tag": "complete" - }, - "text": null, - "label": "complete" - }, - { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - }, - "text": null, - "label": "async_job_id" - } - ], - "description": "Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.", - "importedNamespace": "async", - "typeWrap": "{} (union)" - }, - "error": { - "name": "UnshareFolderError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "too_many_files", - "type": "Void", - "description": "This shared folder has too many files to be unshared." - } - ], - "example": [ - { - "value": { - ".tag": "team_folder" - }, - "text": null, - "label": "team_folder" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "too_many_files" - }, - "text": null, - "label": "too_many_files" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/update_file_member": { - "key": "sharing/update_file_member", - "name": "update_file_member", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Changes a member's access on a shared file.", - "selectAdminMode": "team_admin", - "request": { - "name": "UpdateFileMemberArgs", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "File for which we are changing a member's access." - }, - { - "name": "member", - "type": [ - { - "name": "MemberSelector", - "type": [ - { - "name": "dropbox_id", - "type": "String(min_length=1)", - "description": "Dropbox account, team member, or group ID of member." - }, - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of member." - } - ], - "description": "Includes different ways to identify a member of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member whose access we are changing." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The new access level for the member." - } - ], - "example": [ - { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "access_level": "viewer" - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`update_file_member`.", - "typeWrap": "" - }, - "response": { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": {}, - "text": null, - "label": "default" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - }, - "error": { - "name": "FileMemberActionError", - "type": [ - { - "name": "invalid_member", - "type": "Void", - "description": "Specified member was not found." - }, - { - "name": "no_permission", - "type": "Void", - "description": "User does not have permission to perform this action on this member." - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ], - "description": "Specified file was invalid or user does not have access." - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder." - } - ], - "example": [ - { - "value": { - ".tag": "invalid_member" - }, - "text": null, - "label": "invalid_member" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/update_folder_member": { - "key": "sharing/update_folder_member", - "name": "update_folder_member", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Allows an owner or editor of a shared folder to update another member's permissions.", - "selectAdminMode": "team_admin", - "request": { - "name": "UpdateFolderMemberArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "member", - "type": [ - { - "name": "MemberSelector", - "type": [ - { - "name": "dropbox_id", - "type": "String(min_length=1)", - "description": "Dropbox account, team member, or group ID of member." - }, - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of member." - } - ], - "description": "Includes different ways to identify a member of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member of the shared folder to update. Only the :field:`MemberSelector.dropbox_id` may be set at this time." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The new access level for :field:`member`. :field:`AccessLevel.owner` is disallowed." - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "access_level": "editor" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": {}, - "text": null, - "label": "default" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - }, - "error": { - "name": "UpdateFolderMemberError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "member_error", - "type": [ - { - "name": "SharedFolderMemberError", - "type": [ - { - "name": "invalid_dropbox_id", - "type": "Void", - "description": "The target dropbox_id is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The target dropbox_id is not a member of the shared folder." - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "The target member only has inherited access to the shared folder." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "AddFolderMemberError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Unable to access shared folder." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - }, - { - "name": "banned_member", - "type": "Void", - "description": "The current user has been banned." - }, - { - "name": "bad_member", - "type": [ - { - "name": "AddMemberSelectorError", - "type": [ - { - "name": "automatic_group", - "type": "Void", - "description": "Automatically created groups can only be added to team folders." - }, - { - "name": "invalid_dropbox_id", - "type": "String(min_length=1)", - "description": "The value is the ID that could not be identified." - }, - { - "name": "invalid_email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "The value is the e-email address that is malformed." - }, - { - "name": "unverified_dropbox_id", - "type": "String(min_length=1)", - "description": "The value is the ID of the Dropbox user with an unverified email address. Invite unverified users by email address instead of by their Dropbox ID." - }, - { - "name": "group_deleted", - "type": "Void", - "description": "At least one of the specified groups in :field:`AddFolderMemberArg.members` is deleted." - }, - { - "name": "group_not_on_team", - "type": "Void", - "description": "Sharing to a group that is not on the current user's team." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": ":field:`AddFolderMemberArg.members` contains a bad invitation recipient." - }, - { - "name": "cant_share_outside_team", - "type": "Void", - "description": "Your team policy does not allow sharing outside of the team." - }, - { - "name": "too_many_members", - "type": "UInt64", - "description": "The value is the member limit that was reached." - }, - { - "name": "too_many_pending_invites", - "type": "UInt64", - "description": "The value is the pending invite limit that was reached." - }, - { - "name": "rate_limit", - "type": "Void", - "description": "The current user has hit the limit of invites they can send per day. Try again in 24 hours." - }, - { - "name": "too_many_invitees", - "type": "Void", - "description": "The current user is trying to share with too many people at once." - }, - { - "name": "insufficient_plan", - "type": "Void", - "description": "The current user's account doesn't support this action. An example of this is when adding a read-only member. This action can only be performed by users that have upgraded to a Pro or Business plan." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "invalid_shared_folder", - "type": "Void", - "description": "Field is deprecated. Invalid shared folder error will be returned as an access_error.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "If updating the access type required the member to be added to the shared folder and there was an error when adding the member." - }, - { - "name": "insufficient_plan", - "type": "Void", - "description": "The current user's account doesn't support this action. An example of this is when downgrading a member from editor to viewer. This action can only be performed by users that have upgraded to a Pro or Business plan." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - } - ], - "example": [ - { - "value": { - ".tag": "insufficient_plan" - }, - "text": null, - "label": "insufficient_plan" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/update_folder_policy": { - "key": "sharing/update_folder_policy", - "name": "update_folder_policy", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Update the sharing policies for a shared folder.\nUser must have :field:`AccessLevel.owner` access to the shared folder to update its policies.", - "selectAdminMode": "team_admin", - "request": { - "name": "UpdateFolderPolicyArg", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID for the shared folder." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder. Only applicable if the current user is on a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members of this shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to :field:`SharedLinkPolicy.members`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_settings", - "type": [ - { - "name": "LinkSettings", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. Currently, it only accepts 'viewer' and 'viewer_no_comment'. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The type of audience on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": [ - { - "name": "LinkExpiry", - "type": [ - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the currently set expiry for the link." - }, - { - "name": "set_expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Set a new expiry or change an existing expiry." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "An expiry timestamp to set on a link. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "password", - "type": [ - { - "name": "LinkPassword", - "type": [ - { - "name": "remove_password", - "type": "Void", - "description": "Remove the currently set password for the link." - }, - { - "name": "set_password", - "type": "String", - "description": "Set a new password or change an existing password." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The password for the link. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Settings that apply to a link.", - "typeWrap": "" - } - ], - "description": "Settings on the link for this folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "actions", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's :field:`SharedFolderMetadata.permissions` field describing the actions the authenticated user can perform on the folder. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "example": [ - { - "value": { - "shared_folder_id": "84528192421", - "member_policy": "team", - "acl_update_policy": "owner", - "shared_link_policy": "members" - }, - "text": null, - "label": "default" - } - ], - "description": "If any of the policies are unset, then they retain their current setting.", - "typeWrap": "" - }, - "response": { - "name": "SharedFolderMetadata", - "type": [ - { - "name": "access_type", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The current user's access level for this shared folder." - }, - { - "name": "is_inside_team_folder", - "type": "Boolean", - "description": "Whether this folder is inside of a team folder." - }, - { - "name": "is_team_folder", - "type": "Boolean", - "description": "Whether this folder is a :link:`team folder https://www.dropbox.com/en/help/986`." - }, - { - "name": "name", - "type": "String", - "description": "The name of the this shared folder." - }, - { - "name": "policy", - "type": [ - { - "name": "FolderPolicy", - "type": [ - { - "name": "acl_update_policy", - "type": [ - { - "name": "AclUpdatePolicy", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "Only the owner can update the ACL." - }, - { - "name": "editors", - "type": "Void", - "description": "Any editor can update the ACL. This may be further restricted to editors on the same team." - } - ], - "description": "Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can add and remove members from this shared folder." - }, - { - "name": "shared_link_policy", - "type": [ - { - "name": "SharedLinkPolicy", - "type": [ - { - "name": "anyone", - "type": "Void", - "description": "Links can be shared with anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Field is deprecated. Links can be shared with anyone on the same team as the owner.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Links can only be shared among members of the shared folder." - } - ], - "description": "Who can view shared links in this folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who links can be shared with." - }, - { - "name": "member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "resolved_member_policy", - "type": [ - { - "name": "MemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can become a member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can become a member." - } - ], - "description": "Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "viewer_info_policy", - "type": [ - { - "name": "ViewerInfoPolicy", - "type": [ - { - "name": "enabled", - "type": "Void", - "description": "Viewer information is available on this file." - }, - { - "name": "disabled", - "type": "Void", - "description": "Viewer information is disabled on this file." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "Who can enable/disable viewer info for this shared folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "A set of policies governing membership and privileges for a shared folder.", - "typeWrap": "" - } - ], - "description": "Policies governing this shared folder." - }, - { - "name": "preview_url", - "type": "String", - "description": "URL for displaying a web preview of the shared folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "time_invited", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Timestamp indicating when the current user was invited to this shared folder." - }, - { - "name": "owner_display_names", - "type": "String", - "description": "The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "owner_team", - "type": [ - { - "name": "Team", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - } - ], - "description": "Information about a team.", - "importedNamespace": "users", - "typeWrap": "" - } - ], - "description": "The team that owns the folder. This field is not present if the folder is not owned by a team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "path_lower", - "type": "String", - "description": "The lower-cased full path of this shared folder. Absent for unmounted folders. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "parent_folder_name", - "type": "String", - "description": "Display name for the parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "link_metadata", - "type": [ - { - "name": "SharedContentLinkMetadata", - "type": [ - { - "name": "audience_options", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.", - "typeWrap": "List of ({})" - }, - { - "name": "current_audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The current audience of the link." - }, - { - "name": "link_permissions", - "type": [ - { - "name": "LinkPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "LinkAction", - "type": [ - { - "name": "change_access_level", - "type": "Void", - "description": "Change the access level of the link." - }, - { - "name": "change_audience", - "type": "Void", - "description": "Change the audience of the link." - }, - { - "name": "remove_expiry", - "type": "Void", - "description": "Remove the expiry date of the link." - }, - { - "name": "remove_password", - "type": "Void", - "description": "Remove the password of the link." - }, - { - "name": "set_expiry", - "type": "Void", - "description": "Create or modify the expiry date of the link." - }, - { - "name": "set_password", - "type": "Void", - "description": "Create or modify the password of the link." - } - ], - "description": "Actions that can be performed on a link.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "allow", - "type": "Boolean" - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Permissions for actions that can be performed on a link.", - "typeWrap": "" - } - ], - "description": "A list of permissions for actions you can perform on the link.", - "typeWrap": "List of ({})" - }, - { - "name": "password_protected", - "type": "Boolean", - "description": "Whether the link is protected by a password." - }, - { - "name": "url", - "type": "String", - "description": "The URL of the link." - }, - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The access level on the link for this file. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_restricting_shared_folder", - "type": [ - { - "name": "AudienceRestrictingSharedFolder", - "type": [ - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The ID of the shared folder." - }, - { - "name": "name", - "type": "String", - "description": "The name of the shared folder." - }, - { - "name": "audience", - "type": [ - { - "name": "LinkAudience", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Link is accessible by anyone." - }, - { - "name": "team", - "type": "Void", - "description": "Link is accessible only by team members." - }, - { - "name": "no_one", - "type": "Void", - "description": "The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights." - }, - { - "name": "password", - "type": "Void", - "description": "Field is deprecated. Use `require_password` instead. A link-specific password is required to access the link. Login is not required.", - "isDeprecated": true - }, - { - "name": "members", - "type": "Void", - "description": "Field is deprecated. Link is accessible only by members of the content.", - "isDeprecated": true - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "The link audience of the shared folder." - } - ], - "description": "Information about the shared folder that prevents the link audience for this link from being more restrictive.", - "typeWrap": "" - } - ], - "description": "The shared folder that prevents the link audience for this link from being more restrictive. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "expiry", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "audience_exceptions", - "type": [ - { - "name": "AudienceExceptions", - "type": [ - { - "name": "count", - "type": "UInt32" - }, - { - "name": "exceptions", - "type": [ - { - "name": "AudienceExceptionContentInfo", - "type": [ - { - "name": "name", - "type": "String", - "description": "The name of the content, which is either a file or a folder." - } - ], - "description": "Information about the content that has a link audience different than that of this folder.", - "typeWrap": "" - } - ], - "description": "A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.", - "typeWrap": "List of ({})" - } - ], - "description": "The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.", - "typeWrap": "" - } - ], - "description": "The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata of a shared link for a file or folder.", - "typeWrap": "" - } - ], - "description": "The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "permissions", - "type": [ - { - "name": "FolderPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "FolderAction", - "type": [ - { - "name": "change_options", - "type": "Void", - "description": "Change folder options, such as who can be invited to join the folder." - }, - { - "name": "disable_viewer_info", - "type": "Void", - "description": "Disable viewer information for this folder." - }, - { - "name": "edit_contents", - "type": "Void", - "description": "Change or edit contents of the folder." - }, - { - "name": "enable_viewer_info", - "type": "Void", - "description": "Enable viewer information on the folder." - }, - { - "name": "invite_editor", - "type": "Void", - "description": "Invite a user or group to join the folder with read and write permission." - }, - { - "name": "invite_viewer", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission." - }, - { - "name": "invite_viewer_no_comment", - "type": "Void", - "description": "Invite a user or group to join the folder with read permission but no comment permissions." - }, - { - "name": "relinquish_membership", - "type": "Void", - "description": "Relinquish one's own membership in the folder." - }, - { - "name": "unmount", - "type": "Void", - "description": "Unmount the folder." - }, - { - "name": "unshare", - "type": "Void", - "description": "Stop sharing this folder." - }, - { - "name": "leave_a_copy", - "type": "Void", - "description": "Keep a copy of the contents upon leaving or being kicked from the folder." - }, - { - "name": "share_link", - "type": "Void", - "description": "Field is deprecated. Use create_link instead.", - "isDeprecated": true - }, - { - "name": "create_link", - "type": "Void", - "description": "Create a shared link for folder." - }, - { - "name": "set_access_inheritance", - "type": "Void", - "description": "Set whether the folder inherits permissions from its parent." - } - ], - "description": "Actions that may be taken on shared folders.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the folder." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the shared folder.", - "typeWrap": "" - } - ], - "description": "Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. This field is optional.", - "typeWrap": "List of ({})?" - }, - { - "name": "access_inheritance", - "type": [ - { - "name": "AccessInheritance", - "type": [ - { - "name": "inherit", - "type": "Void", - "description": "The shared folder inherits its members from the parent folder." - }, - { - "name": "no_inherit", - "type": "Void", - "description": "The shared folder does not inherit its members from the parent folder." - } - ], - "description": "Information about the inheritance policy of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "Whether the folder inherits its members from its parent. The default for this union is inherit." - } - ], - "example": [ - { - "value": { - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "name": "dir", - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z", - "path_lower": "/dir", - "link_metadata": { - "audience_options": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ], - "current_audience": { - ".tag": "public" - }, - "link_permissions": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ], - "password_protected": false, - "url": "" - }, - "permissions": [], - "access_inheritance": { - ".tag": "inherit" - } - }, - "text": null, - "label": "default" - } - ], - "description": "The metadata which includes basic information about the shared folder.", - "typeWrap": "" - }, - "error": { - "name": "UpdateFolderPolicyError", - "type": [ - { - "name": "access_error", - "type": [ - { - "name": "SharedFolderAccessError", - "type": [ - { - "name": "invalid_id", - "type": "Void", - "description": "This shared folder ID is invalid." - }, - { - "name": "not_a_member", - "type": "Void", - "description": "The user is not a member of the shared folder thus cannot access it." - }, - { - "name": "email_unverified", - "type": "Void", - "description": "Field is deprecated. Never set.", - "isDeprecated": true - }, - { - "name": "unmounted", - "type": "Void", - "description": "The shared folder is unmounted." - } - ], - "description": "There is an error accessing the shared folder.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "not_on_team", - "type": "Void", - "description": ":field:`UpdateFolderPolicyArg.member_policy` was set even though user is not on a team." - }, - { - "name": "team_policy_disallows_member_policy", - "type": "Void", - "description": "Team policy is more restrictive than :field:`ShareFolderArg.member_policy`." - }, - { - "name": "disallowed_shared_link_policy", - "type": "Void", - "description": "The current account is not allowed to select the specified :field:`ShareFolderArg.shared_link_policy`." - }, - { - "name": "no_permission", - "type": "Void", - "description": "The current user does not have permission to perform this action." - }, - { - "name": "team_folder", - "type": "Void", - "description": "This action cannot be performed on a team shared folder." - } - ], - "example": [ - { - "value": { - ".tag": "not_on_team" - }, - "text": null, - "label": "not_on_team" - }, - { - "value": { - ".tag": "team_policy_disallows_member_policy" - }, - "text": null, - "label": "team_policy_disallows_member_policy" - }, - { - "value": { - ".tag": "disallowed_shared_link_policy" - }, - "text": null, - "label": "disallowed_shared_link_policy" - }, - { - "value": { - ".tag": "no_permission" - }, - "text": null, - "label": "no_permission" - }, - { - "value": { - ".tag": "team_folder" - }, - "text": null, - "label": "team_folder" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/create_shared_link": { - "key": "sharing/create_shared_link", - "name": "create_shared_link", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Create a shared link.\nIf a shared link already exists for the given path, that link is returned.\nPreviously, it was technically possible to break a shared link by moving or renaming the corresponding file or folder. In the future, this will no longer be the case, so your app shouldn't rely on this behavior. Instead, if your app needs to revoke a shared link, use :route:`revoke_shared_link`.", - "selectAdminMode": "team_admin", - "allowAppFolderApp": true, - "deprecated": { - "route": "create_shared_link_with_settings" - }, - "request": { - "name": "CreateSharedLinkArg", - "type": [ - { - "name": "path", - "type": "String", - "description": "The path to share." - }, - { - "name": "short_url", - "type": "Boolean", - "description": "Field is deprecated. None The default for this field is False.", - "isDeprecated": true - }, - { - "name": "pending_upload", - "type": [ - { - "name": "PendingUploadMode", - "type": [ - { - "name": "file", - "type": "Void", - "description": "Assume pending uploads are files." - }, - { - "name": "folder", - "type": "Void", - "description": "Assume pending uploads are folders." - } - ], - "description": "Flag to indicate pending upload default (for linking to not-yet-existing paths).", - "typeWrap": "{} (union)" - } - ], - "description": "If it's okay to share a path that does not yet exist, set this to either :field:`PendingUploadMode.file` or :field:`PendingUploadMode.folder` to indicate whether to assume it's a file or folder. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "/Homework/Math/Prime_Numbers.txt", - "short_url": false - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "PathLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "visibility", - "type": [ - { - "name": "Visibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - } - ], - "description": "Who can access a shared link. The most open visibility is :field:`public`. The default depends on many aspects, such as team and user preferences and shared folder settings.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can access the link." - }, - { - "name": "path", - "type": "String", - "description": "Path in user's Dropbox." - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "visibility": { - ".tag": "public" - }, - "path": "/Homework/Math/Prime_Numbers.txt" - }, - "text": null, - "label": "default" - } - ], - "description": "Metadata for a path-based shared link.", - "typeWrap": "" - }, - "error": { - "name": "CreateSharedLinkError", - "type": [ - { - "name": "path", - "type": [ - { - "name": "LookupError", - "type": [ - { - "name": "malformed_path", - "type": "String", - "description": "The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "not_found", - "type": "Void", - "description": "There is nothing at the given path." - }, - { - "name": "not_file", - "type": "Void", - "description": "We were expecting a file, but the given path refers to something that isn't a file." - }, - { - "name": "not_folder", - "type": "Void", - "description": "We were expecting a folder, but the given path refers to something that isn't a folder." - }, - { - "name": "restricted_content", - "type": "Void", - "description": "The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements." - }, - { - "name": "unsupported_content_type", - "type": "Void", - "description": "This operation is not supported for this content type." - }, - { - "name": "locked", - "type": "Void", - "description": "The given path is locked." - } - ], - "description": null, - "importedNamespace": "files", - "typeWrap": "{} (open union)" - } - ] - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/get_shared_links": { - "key": "sharing/get_shared_links", - "name": "get_shared_links", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Returns a list of :type:`LinkMetadata` objects for this user, including collection links.\nIf no path is given, returns a list of all shared links for the current user, including collection links, up to a maximum of 1000 links.\nIf a non-empty path is given, returns a list of all shared links that allow access to the given path. Collection links are never returned in this case.", - "allowAppFolderApp": true, - "deprecated": { - "route": "list_shared_links" - }, - "request": { - "name": "GetSharedLinksArg", - "type": [ - { - "name": "path", - "type": "String", - "description": "See :route:`get_shared_links` description. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "path": "" - }, - "text": "Get all links, including collection links.", - "label": "default" - }, - { - "value": { - "path": "/Homework/Math" - }, - "text": "Get links giving access to /Homework/Math.", - "label": "math_homework_links" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "GetSharedLinksResult", - "type": [ - { - "name": "links", - "type": [ - { - "name": "LinkMetadata", - "type": [ - { - "name": "path", - "type": [ - { - "name": "PathLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "visibility", - "type": [ - { - "name": "Visibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - } - ], - "description": "Who can access a shared link. The most open visibility is :field:`public`. The default depends on many aspects, such as team and user preferences and shared folder settings.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can access the link." - }, - { - "name": "path", - "type": "String", - "description": "Path in user's Dropbox." - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a path-based shared link.", - "typeWrap": "" - } - ] - }, - { - "name": "collection", - "type": [ - { - "name": "CollectionLinkMetadata", - "type": [ - { - "name": "url", - "type": "String", - "description": "URL of the shared link." - }, - { - "name": "visibility", - "type": [ - { - "name": "Visibility", - "type": [ - { - "name": "public", - "type": "Void", - "description": "Anyone who has received the link can access it. No login required." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access the link. Login is required." - }, - { - "name": "password", - "type": "Void", - "description": "A link-specific password is required to access the link. Login is not required." - }, - { - "name": "team_and_password", - "type": "Void", - "description": "Only members of the same team who have the link-specific password can access the link." - }, - { - "name": "shared_folder_only", - "type": "Void", - "description": "Only members of the shared folder containing the linked file can access the link. Login is required." - } - ], - "description": "Who can access a shared link. The most open visibility is :field:`public`. The default depends on many aspects, such as team and user preferences and shared folder settings.", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can access the link." - }, - { - "name": "expires", - "type": "Timestamp(format=\"%Y-%m-%dT%H:%M:%SZ\")", - "description": "Expiration time, if set. By default the link won't expire. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Metadata for a collection-based shared link.", - "typeWrap": "" - } - ] - } - ], - "description": "Metadata for a shared link. This can be either a :type:`PathLinkMetadata` or :type:`CollectionLinkMetadata`.", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "Shared links applicable to the path argument.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "links": [ - { - ".tag": "path", - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0", - "visibility": { - ".tag": "public" - }, - "path": "/Homework/Math/Prime_Numbers.txt" - } - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "GetSharedLinksError", - "type": [ - { - "name": "path", - "type": "String", - "description": " This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "sharing/remove_file_member": { - "key": "sharing/remove_file_member", - "name": "remove_file_member", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.write", - "description": "Identical to remove_file_member_2 but with less information returned.", - "selectAdminMode": "team_admin", - "deprecated": { - "route": "remove_file_member_2" - }, - "request": { - "name": "RemoveFileMemberArg", - "type": [ - { - "name": "file", - "type": "String(min_length=1, pattern=\"((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?\")", - "description": "File from which to remove members." - }, - { - "name": "member", - "type": [ - { - "name": "MemberSelector", - "type": [ - { - "name": "dropbox_id", - "type": "String(min_length=1)", - "description": "Dropbox account, team member, or group ID of member." - }, - { - "name": "email", - "type": "String(max_length=255, pattern=\"^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$\")", - "description": "Email address of member." - } - ], - "description": "Includes different ways to identify a member of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "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." - } - ], - "example": [ - { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - }, - "text": null, - "label": "default" - } - ], - "description": "Arguments for :route:`remove_file_member_2`.", - "typeWrap": "" - }, - "response": { - "name": "FileMemberActionIndividualResult", - "type": [ - { - "name": "success", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "member_error", - "type": [ - { - "name": "FileMemberActionError", - "type": [ - { - "name": "invalid_member", - "type": "Void", - "description": "Specified member was not found." - }, - { - "name": "no_permission", - "type": "Void", - "description": "User does not have permission to perform this action on this member." - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ], - "description": "Specified file was invalid or user does not have access." - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder." - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - ], - "description": "User was not able to perform this action." - } - ], - "example": [ - { - "value": { - ".tag": "success" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "{} (union)" - }, - "error": { - "name": "RemoveFileMemberError", - "type": [ - { - "name": "user_error", - "type": [ - { - "name": "SharingUserError", - "type": [ - { - "name": "email_unverified", - "type": "Void", - "description": "This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address :link:`here https://www.dropbox.com/help/317`." - } - ], - "description": "User account had a problem preventing this action.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "access_error", - "type": [ - { - "name": "SharingFileAccessError", - "type": [ - { - "name": "no_permission", - "type": "Void", - "description": "Current user does not have sufficient privileges to perform the desired action." - }, - { - "name": "invalid_file", - "type": "Void", - "description": "File specified was not found." - }, - { - "name": "is_folder", - "type": "Void", - "description": "A folder can't be shared this way. Use folder sharing or a shared link instead." - }, - { - "name": "inside_public_folder", - "type": "Void", - "description": "A file inside a public folder can't be shared this way. Use a public link instead." - }, - { - "name": "inside_osx_package", - "type": "Void", - "description": "A Mac OS X package can't be shared this way. Use a shared link instead." - } - ], - "description": "User could not access this file.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "no_explicit_access", - "type": [ - { - "name": "MemberAccessLevelResult", - "type": [ - { - "name": "access_level", - "type": [ - { - "name": "AccessLevel", - "type": [ - { - "name": "owner", - "type": "Void", - "description": "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 :route:`update_folder_policy`." - }, - { - "name": "editor", - "type": "Void", - "description": "The collaborator can both view and edit the shared folder." - }, - { - "name": "viewer", - "type": "Void", - "description": "The collaborator can only view the shared folder." - }, - { - "name": "viewer_no_comment", - "type": "Void", - "description": "The collaborator can only view the shared folder and does not have any access to comments." - }, - { - "name": "traverse", - "type": "Void", - "description": "The collaborator can only view the shared folder that they have access to." - } - ], - "description": "Defines the access levels for collaborators.", - "typeWrap": "{} (open union)" - } - ], - "description": "The member still has this level of access to the content through a parent folder. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "warning", - "type": "String", - "description": "A localized string with additional information about why the user has this access level to the content. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "access_details", - "type": [ - { - "name": "ParentFolderAccessInfo", - "type": [ - { - "name": "folder_name", - "type": "String", - "description": "Display name for the folder." - }, - { - "name": "shared_folder_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The identifier of the parent shared folder." - }, - { - "name": "permissions", - "type": [ - { - "name": "MemberPermission", - "type": [ - { - "name": "action", - "type": [ - { - "name": "MemberAction", - "type": [ - { - "name": "leave_a_copy", - "type": "Void", - "description": "Allow the member to keep a copy of the folder when removing." - }, - { - "name": "make_editor", - "type": "Void", - "description": "Make the member an editor of the folder." - }, - { - "name": "make_owner", - "type": "Void", - "description": "Make the member an owner of the folder." - }, - { - "name": "make_viewer", - "type": "Void", - "description": "Make the member a viewer of the folder." - }, - { - "name": "make_viewer_no_comment", - "type": "Void", - "description": "Make the member a viewer of the folder without commenting permissions." - }, - { - "name": "remove", - "type": "Void", - "description": "Remove the member from the folder." - } - ], - "description": "Actions that may be taken on members of a shared folder.", - "typeWrap": "{} (open union)" - } - ], - "description": "The action that the user may wish to take on the member." - }, - { - "name": "allow", - "type": "Boolean", - "description": "True if the user is allowed to take the action." - }, - { - "name": "reason", - "type": [ - { - "name": "PermissionDeniedReason", - "type": [ - { - "name": "user_not_same_team_as_owner", - "type": "Void", - "description": "User is not on the same team as the folder owner." - }, - { - "name": "user_not_allowed_by_owner", - "type": "Void", - "description": "User is prohibited by the owner from taking the action." - }, - { - "name": "target_is_indirect_member", - "type": "Void", - "description": "Target is indirectly a member of the folder, for example by being part of a group." - }, - { - "name": "target_is_owner", - "type": "Void", - "description": "Target is the owner of the folder." - }, - { - "name": "target_is_self", - "type": "Void", - "description": "Target is the user itself." - }, - { - "name": "target_not_active", - "type": "Void", - "description": "Target is not an active member of the team." - }, - { - "name": "folder_is_limited_team_folder", - "type": "Void", - "description": "Folder is team folder for a limited team." - }, - { - "name": "owner_not_on_team", - "type": "Void", - "description": "The content owner needs to be on a Dropbox team to perform this action." - }, - { - "name": "permission_denied", - "type": "Void", - "description": "The user does not have permission to perform this action on the link." - }, - { - "name": "restricted_by_team", - "type": "Void", - "description": "The user's team policy prevents performing this action on the link." - }, - { - "name": "user_account_type", - "type": "Void", - "description": "The user's account type does not support this action." - }, - { - "name": "user_not_on_team", - "type": "Void", - "description": "The user needs to be on a Dropbox team to perform this action." - }, - { - "name": "folder_is_inside_shared_folder", - "type": "Void", - "description": "Folder is inside of another shared folder." - }, - { - "name": "restricted_by_parent_folder", - "type": "Void", - "description": "Policy cannot be changed due to restrictions from parent folder." - }, - { - "name": "insufficient_plan", - "type": [ - { - "name": "InsufficientPlan", - "type": [ - { - "name": "message", - "type": "String", - "description": "A message to tell the user to upgrade in order to support expected action." - }, - { - "name": "upsell_url", - "type": "String", - "description": "A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": null, - "typeWrap": "" - } - ] - } - ], - "description": "Possible reasons the user is denied a permission.", - "typeWrap": "{} (open union)" - } - ], - "description": "The reason why the user is denied the permission. Not present if the action is allowed. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Whether the user is allowed to take the action on the associated member.", - "typeWrap": "" - } - ], - "description": "The user's permissions for the parent shared folder.", - "typeWrap": "List of ({})" - }, - { - "name": "path", - "type": "String", - "description": "The full path to the parent shared folder relative to the acting user's root." - } - ], - "description": "Contains information about a parent folder that a member has access to.", - "typeWrap": "" - } - ], - "description": "The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access. This field is optional.", - "typeWrap": "List of ({})?" - } - ], - "description": "Contains information about a member's access level to content after an operation.", - "typeWrap": "" - } - ], - "description": "This member does not have explicit access to the file and therefore cannot be removed. The return value is the access that a user might have to the file from a parent folder." - } - ], - "example": [ - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": "Errors for :route:`remove_file_member_2`.", - "typeWrap": "{} (open union)" - } - }, - "users/features/get_values": { - "key": "users/features/get_values", - "name": "features/get_values", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "account_info.read", - "description": "Get a list of feature values that may be configured for the current account.", - "allowAppFolderApp": true, - "request": { - "name": "UserFeaturesGetValuesBatchArg", - "type": [ - { - "name": "features", - "type": [ - { - "name": "UserFeature", - "type": [ - { - "name": "paper_as_files", - "type": "Void", - "description": "This feature contains information about how the user's Paper files are stored." - }, - { - "name": "file_locking", - "type": "Void", - "description": "This feature allows users to lock files in order to restrict other users from editing them." - } - ], - "description": "A set of features that a Dropbox User account may have configured.", - "typeWrap": "{} (open union)" - } - ], - "description": "A list of features in :type:`UserFeature`. If the list is empty, this route will return :type:`UserFeaturesGetValuesBatchError`.", - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "features": [ - { - ".tag": "paper_as_files" - }, - { - ".tag": "file_locking" - } - ] - }, - "text": null, - "label": "listOfFeatures" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "UserFeaturesGetValuesBatchResult", - "type": [ - { - "name": "values", - "type": [ - { - "name": "UserFeatureValue", - "type": [ - { - "name": "paper_as_files", - "type": [ - { - "name": "PaperAsFilesValue", - "type": [ - { - "name": "enabled", - "type": "Boolean", - "description": "When this value is true, the user's Paper docs are accessible in Dropbox with the .paper extension and must be accessed via the /files endpoints. When this value is false, the user's Paper docs are stored separate from Dropbox files and folders and should be accessed via the /paper endpoints." - } - ], - "description": "The value for :field:`UserFeature.paper_as_files`.", - "typeWrap": "{} (open union)" - } - ] - }, - { - "name": "file_locking", - "type": [ - { - "name": "FileLockingValue", - "type": [ - { - "name": "enabled", - "type": "Boolean", - "description": "When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others." - } - ], - "description": "The value for :field:`UserFeature.file_locking`.", - "typeWrap": "{} (open union)" - } - ] - } - ], - "description": "Values that correspond to entries in :type:`UserFeature`.", - "typeWrap": "{} (open union)" - } - ], - "typeWrap": "List of ({})" - } - ], - "example": [ - { - "value": { - "values": [ - { - ".tag": "paper_as_files", - "paper_as_files": { - ".tag": "enabled", - "enabled": true - } - } - ] - }, - "text": null, - "label": "listOfValues" - } - ], - "description": null, - "typeWrap": "" - }, - "error": { - "name": "UserFeaturesGetValuesBatchError", - "type": [ - { - "name": "empty_features_list", - "type": "Void", - "description": "At least one :type:`UserFeature` must be included in the :type:`UserFeaturesGetValuesBatchArg`.features list." - } - ], - "example": [ - { - "value": { - ".tag": "empty_features_list" - }, - "text": null, - "label": "empty_features_list" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "users/get_account": { - "key": "users/get_account", - "name": "get_account", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Get information about a user's account.", - "allowAppFolderApp": true, - "request": { - "name": "GetAccountArg", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "A user's account identifier." - } - ], - "example": [ - { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "BasicAccount", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The user's unique Dropbox ID." - }, - { - "name": "name", - "type": [ - { - "name": "Name", - "type": [ - { - "name": "given_name", - "type": "String", - "description": "Also known as a first name." - }, - { - "name": "surname", - "type": "String", - "description": "Also known as a last name or family name." - }, - { - "name": "familiar_name", - "type": "String", - "description": "Locale-dependent name. In the US, a person's familiar name is their :field:`given_name`, but elsewhere, it could be any combination of a person's :field:`given_name` and :field:`surname`." - }, - { - "name": "display_name", - "type": "String", - "description": "A name that can be used directly to represent the name of a user's Dropbox account." - }, - { - "name": "abbreviated_name", - "type": "String", - "description": "An abbreviated form of the person's name. Their initials in most locales." - } - ], - "description": "Representations for a person's name to assist with internationalization.", - "typeWrap": "" - } - ], - "description": "Details of a user's name." - }, - { - "name": "email", - "type": "String", - "description": "The user's email address. Do not rely on this without checking the :field:`email_verified` field. Even then, it's possible that the user has since lost access to their email." - }, - { - "name": "email_verified", - "type": "Boolean", - "description": "Whether the user has verified their email address." - }, - { - "name": "disabled", - "type": "Boolean", - "description": "Whether the user has been disabled." - }, - { - "name": "is_teammate", - "type": "Boolean", - "description": "Whether this user is a teammate of the current user. If this account is the current user's account, then this will be :val:`true`." - }, - { - "name": "profile_photo_url", - "type": "String", - "description": "URL for the photo representing the user, if one is set. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_id", - "type": "String", - "description": "The user's unique team member id. This field will only be present if the user is part of a team and :field:`is_teammate` is :val:`true`. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "name": { - "given_name": "Franz", - "surname": "Ferdinand", - "familiar_name": "Franz", - "display_name": "Franz Ferdinand (Personal)", - "abbreviated_name": "FF" - }, - "email": "franz@dropbox.com", - "email_verified": true, - "disabled": false, - "is_teammate": false, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "text": null, - "label": "default" - }, - { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "name": { - "given_name": "Franz", - "surname": "Ferdinand", - "familiar_name": "Franz", - "display_name": "Franz Ferdinand (Personal)", - "abbreviated_name": "FF" - }, - "email": "franz@dropbox.com", - "email_verified": true, - "disabled": false, - "is_teammate": true, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - }, - "text": null, - "label": "team" - } - ], - "description": "Basic information about any account.", - "typeWrap": "" - }, - "error": { - "name": "GetAccountError", - "type": [ - { - "name": "no_account", - "type": "Void", - "description": "The specified :field:`GetAccountArg.account_id` does not exist." - } - ], - "example": [ - { - "value": { - ".tag": "no_account" - }, - "text": null, - "label": "no_account" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "users/get_account_batch": { - "key": "users/get_account_batch", - "name": "get_account_batch", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "sharing.read", - "description": "Get information about multiple user accounts. At most 300 accounts may be queried per request.", - "allowAppFolderApp": true, - "request": { - "name": "GetAccountBatchArg", - "type": [ - { - "name": "account_ids", - "type": "String(min_length=40, max_length=40)", - "description": "List of user account identifiers. Should not contain any duplicate account IDs.", - "typeWrap": "List of ({}, min_items=1)" - } - ], - "example": [ - { - "value": { - "account_ids": [ - "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ" - ] - }, - "text": null, - "label": "default" - } - ], - "description": null, - "typeWrap": "" - }, - "response": { - "name": "BasicAccount", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The user's unique Dropbox ID." - }, - { - "name": "name", - "type": [ - { - "name": "Name", - "type": [ - { - "name": "given_name", - "type": "String", - "description": "Also known as a first name." - }, - { - "name": "surname", - "type": "String", - "description": "Also known as a last name or family name." - }, - { - "name": "familiar_name", - "type": "String", - "description": "Locale-dependent name. In the US, a person's familiar name is their :field:`given_name`, but elsewhere, it could be any combination of a person's :field:`given_name` and :field:`surname`." - }, - { - "name": "display_name", - "type": "String", - "description": "A name that can be used directly to represent the name of a user's Dropbox account." - }, - { - "name": "abbreviated_name", - "type": "String", - "description": "An abbreviated form of the person's name. Their initials in most locales." - } - ], - "description": "Representations for a person's name to assist with internationalization.", - "typeWrap": "" - } - ], - "description": "Details of a user's name." - }, - { - "name": "email", - "type": "String", - "description": "The user's email address. Do not rely on this without checking the :field:`email_verified` field. Even then, it's possible that the user has since lost access to their email." - }, - { - "name": "email_verified", - "type": "Boolean", - "description": "Whether the user has verified their email address." - }, - { - "name": "disabled", - "type": "Boolean", - "description": "Whether the user has been disabled." - }, - { - "name": "is_teammate", - "type": "Boolean", - "description": "Whether this user is a teammate of the current user. If this account is the current user's account, then this will be :val:`true`." - }, - { - "name": "profile_photo_url", - "type": "String", - "description": "URL for the photo representing the user, if one is set. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_id", - "type": "String", - "description": "The user's unique team member id. This field will only be present if the user is part of a team and :field:`is_teammate` is :val:`true`. This field is optional.", - "typeWrap": "{}?" - } - ], - "description": "Basic information about any account.", - "typeWrap": "List of ({})" - }, - "error": { - "name": "GetAccountBatchError", - "type": [ - { - "name": "no_account", - "type": "String(min_length=40, max_length=40)", - "description": "The value is an account ID specified in :field:`GetAccountBatchArg.account_ids` that does not exist." - } - ], - "example": [ - { - "value": { - ".tag": "no_account", - "no_account": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "text": null, - "label": "default" - }, - { - "value": { - ".tag": "other" - }, - "text": null, - "label": "other" - } - ], - "description": null, - "typeWrap": "{} (open union)" - } - }, - "users/get_current_account": { - "key": "users/get_current_account", - "name": "get_current_account", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "account_info.read", - "description": "Get information about the current user's account.", - "selectAdminMode": "whole_team", - "allowAppFolderApp": true, - "response": { - "name": "FullAccount", - "type": [ - { - "name": "account_id", - "type": "String(min_length=40, max_length=40)", - "description": "The user's unique Dropbox ID." - }, - { - "name": "name", - "type": [ - { - "name": "Name", - "type": [ - { - "name": "given_name", - "type": "String", - "description": "Also known as a first name." - }, - { - "name": "surname", - "type": "String", - "description": "Also known as a last name or family name." - }, - { - "name": "familiar_name", - "type": "String", - "description": "Locale-dependent name. In the US, a person's familiar name is their :field:`given_name`, but elsewhere, it could be any combination of a person's :field:`given_name` and :field:`surname`." - }, - { - "name": "display_name", - "type": "String", - "description": "A name that can be used directly to represent the name of a user's Dropbox account." - }, - { - "name": "abbreviated_name", - "type": "String", - "description": "An abbreviated form of the person's name. Their initials in most locales." - } - ], - "description": "Representations for a person's name to assist with internationalization.", - "typeWrap": "" - } - ], - "description": "Details of a user's name." - }, - { - "name": "email", - "type": "String", - "description": "The user's email address. Do not rely on this without checking the :field:`email_verified` field. Even then, it's possible that the user has since lost access to their email." - }, - { - "name": "email_verified", - "type": "Boolean", - "description": "Whether the user has verified their email address." - }, - { - "name": "disabled", - "type": "Boolean", - "description": "Whether the user has been disabled." - }, - { - "name": "locale", - "type": "String(min_length=2)", - "description": "The language that the user specified. Locale tags will be :link:`IETF language tags http://en.wikipedia.org/wiki/IETF_language_tag`." - }, - { - "name": "referral_link", - "type": "String", - "description": "The user's :link:`referral link https://www.dropbox.com/referrals`." - }, - { - "name": "is_paired", - "type": "Boolean", - "description": "Whether the user has a personal and work account. If the current account is personal, then :field:`team` will always be :val:`null`, but :field:`is_paired` will indicate if a work account is linked." - }, - { - "name": "account_type", - "type": [ - { - "name": "AccountType", - "type": [ - { - "name": "basic", - "type": "Void", - "description": "The basic account type." - }, - { - "name": "pro", - "type": "Void", - "description": "The Dropbox Pro account type." - }, - { - "name": "business", - "type": "Void", - "description": "The Dropbox Business account type." - } - ], - "description": "What type of account this user has.", - "importedNamespace": "users_common", - "typeWrap": "{} (union)" - } - ], - "description": "What type of account this user has." - }, - { - "name": "root_info", - "type": [ - { - "name": "RootInfo", - "type": [ - { - "name": "team", - "type": [ - { - "name": "TeamRootInfo", - "type": [ - { - "name": "root_namespace_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as :field:`RootInfo.home_namespace_id`." - }, - { - "name": "home_namespace_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The namespace ID for user's home namespace." - }, - { - "name": "home_path", - "type": "String", - "description": "The path for user's home directory under the shared team root." - } - ], - "description": "Root info when user is member of a team with a separate root namespace ID.", - "importedNamespace": "common", - "typeWrap": "" - } - ] - }, - { - "name": "user", - "type": [ - { - "name": "UserRootInfo", - "type": [ - { - "name": "root_namespace_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as :field:`RootInfo.home_namespace_id`." - }, - { - "name": "home_namespace_id", - "type": "String(pattern=\"[-_0-9a-zA-Z:]+\")", - "description": "The namespace ID for user's home namespace." - } - ], - "description": "Root info when user is not member of a team or the user is a member of a team and the team does not have a separate root namespace.", - "importedNamespace": "common", - "typeWrap": "" - } - ] - } - ], - "description": "Information about current user's root.", - "importedNamespace": "common", - "typeWrap": "{} (datatype with subtypes)" - } - ], - "description": "The root info for this account." - }, - { - "name": "profile_photo_url", - "type": "String", - "description": "URL for the photo representing the user, if one is set. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "country", - "type": "String(min_length=2, max_length=2)", - "description": "The user's two-letter country code, if available. Country codes are based on :link:`ISO 3166-1 http://en.wikipedia.org/wiki/ISO_3166-1`. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team", - "type": [ - { - "name": "FullTeam", - "type": [ - { - "name": "id", - "type": "String", - "description": "The team's unique ID." - }, - { - "name": "name", - "type": "String", - "description": "The name of the team." - }, - { - "name": "sharing_policies", - "type": [ - { - "name": "TeamSharingPolicies", - "type": [ - { - "name": "shared_folder_member_policy", - "type": [ - { - "name": "SharedFolderMemberPolicy", - "type": [ - { - "name": "team", - "type": "Void", - "description": "Only a teammate can be a member of a folder shared by a team member." - }, - { - "name": "anyone", - "type": "Void", - "description": "Anyone can be a member of a folder shared by a team member." - } - ], - "description": "Policy governing who can be a member of a folder shared by a team member.", - "importedNamespace": "team_policies", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can join folders shared by team members." - }, - { - "name": "shared_folder_join_policy", - "type": [ - { - "name": "SharedFolderJoinPolicy", - "type": [ - { - "name": "from_team_only", - "type": "Void", - "description": "Team members can only join folders shared by teammates." - }, - { - "name": "from_anyone", - "type": "Void", - "description": "Team members can join any shared folder, including those shared by users outside the team." - } - ], - "description": "Policy governing which shared folders a team member can join.", - "importedNamespace": "team_policies", - "typeWrap": "{} (open union)" - } - ], - "description": "Which shared folders team members can join." - }, - { - "name": "shared_link_create_policy", - "type": [ - { - "name": "SharedLinkCreatePolicy", - "type": [ - { - "name": "default_public", - "type": "Void", - "description": "By default, anyone can access newly created shared links. No login will be required to access the shared links unless overridden." - }, - { - "name": "default_team_only", - "type": "Void", - "description": "By default, only members of the same team can access newly created shared links. Login will be required to access the shared links unless overridden." - }, - { - "name": "team_only", - "type": "Void", - "description": "Only members of the same team can access all shared links. Login will be required to access all shared links." - }, - { - "name": "default_no_one", - "type": "Void", - "description": "Only people invited can access newly created links. Login will be required to access the shared links unless overridden." - } - ], - "description": "Policy governing the visibility of shared links. This policy can apply to newly created shared links, or all shared links.", - "importedNamespace": "team_policies", - "typeWrap": "{} (open union)" - } - ], - "description": "Who can view shared links owned by team members." - }, - { - "name": "group_creation_policy", - "type": [ - { - "name": "GroupCreation", - "type": [ - { - "name": "admins_and_members", - "type": "Void", - "description": "Team admins and members can create groups." - }, - { - "name": "admins_only", - "type": "Void", - "description": "Only team admins can create groups." - } - ], - "description": null, - "importedNamespace": "team_policies", - "typeWrap": "{} (union)" - } - ], - "description": "Who can create groups." - } - ], - "description": "Policies governing sharing within and outside of the team.", - "importedNamespace": "team_policies", - "typeWrap": "" - } - ], - "description": "Team policies governing sharing." - }, - { - "name": "office_addin_policy", - "type": [ - { - "name": "OfficeAddInPolicy", - "type": [ - { - "name": "disabled", - "type": "Void", - "description": "Office Add-In is disabled." - }, - { - "name": "enabled", - "type": "Void", - "description": "Office Add-In is enabled." - } - ], - "description": null, - "importedNamespace": "team_policies", - "typeWrap": "{} (open union)" - } - ], - "description": "Team policy governing the use of the Office Add-In." - } - ], - "description": "Detailed information about a team.", - "typeWrap": "" - } - ], - "description": "If this account is a member of a team, information about that team. This field is optional.", - "typeWrap": "{}?" - }, - { - "name": "team_member_id", - "type": "String", - "description": "This account's unique team member id. This field will only be present if :field:`team` is present. This field is optional.", - "typeWrap": "{}?" - } - ], - "example": [ - { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "name": { - "given_name": "Franz", - "surname": "Ferdinand", - "familiar_name": "Franz", - "display_name": "Franz Ferdinand (Personal)", - "abbreviated_name": "FF" - }, - "email": "franz@dropbox.com", - "email_verified": true, - "disabled": false, - "locale": "en", - "referral_link": "https://db.tt/ZITNuhtI", - "is_paired": true, - "account_type": { - ".tag": "business" - }, - "root_info": { - ".tag": "user", - "root_namespace_id": "3235641", - "home_namespace_id": "3235641" - }, - "country": "US", - "team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc.", - "sharing_policies": { - "shared_folder_member_policy": { - ".tag": "team" - }, - "shared_folder_join_policy": { - ".tag": "from_anyone" - }, - "shared_link_create_policy": { - ".tag": "team_only" - }, - "group_creation_policy": { - ".tag": "admins_only" - } - }, - "office_addin_policy": { - ".tag": "disabled" - } - }, - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - }, - "text": "Paired account.", - "label": "default" - }, - { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "name": { - "given_name": "Franz", - "surname": "Ferdinand", - "familiar_name": "Franz", - "display_name": "Franz Ferdinand (Personal)", - "abbreviated_name": "FF" - }, - "email": "franz@gmail.com", - "email_verified": false, - "disabled": false, - "locale": "en", - "referral_link": "https://db.tt/ZITNuhtI", - "is_paired": false, - "account_type": { - ".tag": "basic" - }, - "root_info": { - ".tag": "user", - "root_namespace_id": "3235641", - "home_namespace_id": "3235641" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "country": "US" - }, - "text": "A personal account that is not paired with a team.", - "label": "unpaired" - } - ], - "description": "Detailed information about the current user's account.", - "typeWrap": "" - } - }, - "users/get_space_usage": { - "key": "users/get_space_usage", - "name": "get_space_usage", - "version": 1, - "subdomain": "api", - "format": "rpc", - "auth": "user", - "scope": "account_info.read", - "description": "Get the space usage information for the current user's account.", - "allowAppFolderApp": true, - "response": { - "name": "SpaceUsage", - "type": [ - { - "name": "used", - "type": "UInt64", - "description": "The user's total space usage (bytes)." - }, - { - "name": "allocation", - "type": [ - { - "name": "SpaceAllocation", - "type": [ - { - "name": "individual", - "type": [ - { - "name": "IndividualSpaceAllocation", - "type": [ - { - "name": "allocated", - "type": "UInt64", - "description": "The total space allocated to the user's account (bytes)." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The user's space allocation applies only to their individual account." - }, - { - "name": "team", - "type": [ - { - "name": "TeamSpaceAllocation", - "type": [ - { - "name": "used", - "type": "UInt64", - "description": "The total space currently used by the user's team (bytes)." - }, - { - "name": "allocated", - "type": "UInt64", - "description": "The total space allocated to the user's team (bytes)." - }, - { - "name": "user_within_team_space_allocated", - "type": "UInt64", - "description": "The total space allocated to the user within its team allocated space (0 means that no restriction is imposed on the user's quota within its team)." - }, - { - "name": "user_within_team_space_limit_type", - "type": [ - { - "name": "MemberSpaceLimitType", - "type": [ - { - "name": "off", - "type": "Void", - "description": "The team member does not have imposed space limit." - }, - { - "name": "alert_only", - "type": "Void", - "description": "The team member has soft imposed space limit - the limit is used for display and for notifications." - }, - { - "name": "stop_sync", - "type": "Void", - "description": "The team member has hard imposed space limit - Dropbox file sync will stop after the limit is reached." - } - ], - "description": "The type of the space limit imposed on a team member.", - "importedNamespace": "team_common", - "typeWrap": "{} (open union)" - } - ], - "description": "The type of the space limit imposed on the team member (off, alert_only, stop_sync)." - }, - { - "name": "user_within_team_space_used_cached", - "type": "UInt64", - "description": "An accurate cached calculation of a team member's total space usage (bytes)." - } - ], - "description": null, - "typeWrap": "" - } - ], - "description": "The user shares space with other members of their team." - } - ], - "description": "Space is allocated differently based on the type of account.", - "typeWrap": "{} (open union)" - } - ], - "description": "The user's space allocation." - } - ], - "example": [ - { - "value": { - "used": 314159265, - "allocation": { - ".tag": "individual", - "allocated": 10000000000 - } - }, - "text": null, - "label": "default" - } - ], - "description": "Information about a user's space usage and quota.", - "typeWrap": "" - } - } -} \ No newline at end of file diff --git a/example/package-lock.json b/example/package-lock.json new file mode 100644 index 0000000..c35c149 --- /dev/null +++ b/example/package-lock.json @@ -0,0 +1,396 @@ +{ + "name": "example", + "version": "1.0.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "requires": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "asn1": { + "version": "0.2.6", + "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.6.tgz", + "integrity": "sha512-ix/FxPn0MDjeyJ7i/yoHGFt/EX6LyNbxSEhPPXODPL+KB0VPk86UYfL0lMdy+KCnv+fmvIzySwaK5COwqVbWTQ==", + "requires": { + "safer-buffer": "~2.1.0" + } + }, + "assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha512-NfJ4UzBCcQGLDlQq7nHxH+tv3kyZ0hHQqF5BO6J7tNJeP5do1llPr8dZ8zHonfhAu0PHAdMkSo+8o0wxg9lZWw==" + }, + "asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" + }, + "aws-sign2": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", + "integrity": "sha512-08kcGqnYf/YmjoRhfxyu+CLxBjUtHLXLXX/vUfx9l2LYzG3c1m61nrpyFUZI6zeS+Li/wWMMidD9KgrqtGq3mA==" + }, + "aws4": { + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.11.0.tgz", + "integrity": "sha512-xh1Rl34h6Fi1DC2WWKfxUTVqRsNnr6LsKz2+hfwDxQJWmrx8+c7ylaqBMcHfl1U1r2dsifOvKX3LQuLNZ+XSvA==" + }, + "bcrypt-pbkdf": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", + "integrity": "sha512-qeFIXtP4MSoi6NLqO12WfqARWWuCKi2Rn/9hJLEmtB5yTNr9DqFWkJRCf2qShWzPeAMRnOgCrq0sg/KLv5ES9w==", + "requires": { + "tweetnacl": "^0.14.3" + } + }, + "caseless": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", + "integrity": "sha512-4tYFyifaFfGacoiObjJegolkwSU4xQNGbVgUiNYVUxbQ2x2lUsFvY4hVgVzGiIe6WLOPqycWXA40l+PWsxthUw==" + }, + "combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "requires": { + "delayed-stream": "~1.0.0" + } + }, + "compress-json": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/compress-json/-/compress-json-2.1.2.tgz", + "integrity": "sha512-91247RD8bKQXzRmXUS4zGT250mhw86+J9X8w2L2SGtRE7g0CvzjOETFaFmsDdaXPWv8T7L9iiM7kdcnnH3BH7w==" + }, + "core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha512-3lqz5YjWTYnW6dlDa5TLaTCcShfar1e40rmcJVwCBJC6mWlFuj0eCHIElmG1g5kyuJ/GD+8Wn4FFCcz4gJPfaQ==" + }, + "dashdash": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", + "integrity": "sha512-jRFi8UDGo6j+odZiEpjazZaWqEal3w/basFjQHQEwVtZJGDpxbH1MeYluwCS8Xq5wmLJooDlMgvVarmWfGM44g==", + "requires": { + "assert-plus": "^1.0.0" + } + }, + "data-uri-to-buffer": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.0.tgz", + "integrity": "sha512-Vr3mLBA8qWmcuschSLAOogKgQ/Jwxulv3RNE4FXnYWRGujzrRWQI4m12fQqRkwX06C0KanhLr4hK+GydchZsaA==" + }, + "delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==" + }, + "dropbox-v2-api": { + "version": "2.5.10-next.1", + "resolved": "https://registry.npmjs.org/dropbox-v2-api/-/dropbox-v2-api-2.5.10-next.1.tgz", + "integrity": "sha512-d4rKOxHZ8Roz8TTYFCgRxwY6AaGMBSgyEgxpFfCD26h/RQRjLsrOcK3fVkVuY8kmnwklqc5ZKz2rAF3GpKeCqw==", + "requires": { + "compress-json": "2.1.2", + "node-fetch": "3.3.0", + "request": "2.88.2" + } + }, + "ecc-jsbn": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", + "integrity": "sha512-eh9O+hwRHNbG4BLTjEl3nw044CkGm5X6LoaCf7LPp7UU8Qrt47JYNi6nPX8xjW97TKGKm1ouctg0QSpZe9qrnw==", + "requires": { + "jsbn": "~0.1.0", + "safer-buffer": "^2.1.0" + } + }, + "extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==" + }, + "extsprintf": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", + "integrity": "sha512-11Ndz7Nv+mvAC1j0ktTa7fAb0vLyGGX+rMHNBYQviQDGU0Hw7lhctJANqbPhu9nV9/izT/IntTgZ7Im/9LJs9g==" + }, + "fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" + }, + "fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" + }, + "fetch-blob": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz", + "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==", + "requires": { + "node-domexception": "^1.0.0", + "web-streams-polyfill": "^3.0.3" + } + }, + "forever-agent": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", + "integrity": "sha512-j0KLYPhm6zeac4lz3oJ3o65qvgQCcPubiyotZrXqEaG4hNagNYO8qdlUrX5vwqv9ohqeT/Z3j6+yW067yWWdUw==" + }, + "form-data": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz", + "integrity": "sha512-1lLKB2Mu3aGP1Q/2eCOx0fNbRMe7XdwktwOruhfqqd0rIJWwN4Dh+E3hrPSlDCXnSR7UtZ1N38rVXm+6+MEhJQ==", + "requires": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.6", + "mime-types": "^2.1.12" + } + }, + "formdata-polyfill": { + "version": "4.0.10", + "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz", + "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==", + "requires": { + "fetch-blob": "^3.1.2" + } + }, + "getpass": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", + "integrity": "sha512-0fzj9JxOLfJ+XGLhR8ze3unN0KZCgZwiSSDz168VERjK8Wl8kVSdcu2kspd4s4wtAa1y/qrVRiAA0WclVsu0ng==", + "requires": { + "assert-plus": "^1.0.0" + } + }, + "har-schema": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", + "integrity": "sha512-Oqluz6zhGX8cyRaTQlFMPw80bSJVG2x/cFb8ZPhUILGgHka9SsokCCOQgpveePerqidZOrT14ipqfJb7ILcW5Q==" + }, + "har-validator": { + "version": "5.1.5", + "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.1.5.tgz", + "integrity": "sha512-nmT2T0lljbxdQZfspsno9hgrG3Uir6Ks5afism62poxqBM6sDnMEuPmzTq8XN0OEwqKLLdh1jQI3qyE66Nzb3w==", + "requires": { + "ajv": "^6.12.3", + "har-schema": "^2.0.0" + } + }, + "http-signature": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", + "integrity": "sha512-CAbnr6Rz4CYQkLYUtSNXxQPUH2gK8f3iWexVlsnMeD+GjlsQ0Xsy1cOX+mN3dtxYomRy21CiOzU8Uhw6OwncEQ==", + "requires": { + "assert-plus": "^1.0.0", + "jsprim": "^1.2.2", + "sshpk": "^1.7.0" + } + }, + "is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==" + }, + "isstream": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", + "integrity": "sha512-Yljz7ffyPbrLpLngrMtZ7NduUgVvi6wG9RJ9IUcyCd59YQ911PBJphODUcbOVbqYfxe1wuYf/LJ8PauMRwsM/g==" + }, + "jsbn": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", + "integrity": "sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg==" + }, + "json-schema": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.4.0.tgz", + "integrity": "sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA==" + }, + "json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "json-stringify-safe": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", + "integrity": "sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA==" + }, + "jsprim": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.2.tgz", + "integrity": "sha512-P2bSOMAc/ciLz6DzgjVlGJP9+BrJWu5UDGK70C2iweC5QBIeFf0ZXRvGjEj2uYgrY2MkAAhsSWHDWlFtEroZWw==", + "requires": { + "assert-plus": "1.0.0", + "extsprintf": "1.3.0", + "json-schema": "0.4.0", + "verror": "1.10.0" + } + }, + "mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==" + }, + "mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "requires": { + "mime-db": "1.52.0" + } + }, + "node-domexception": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz", + "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==" + }, + "node-fetch": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.0.tgz", + "integrity": "sha512-BKwRP/O0UvoMKp7GNdwPlObhYGB5DQqwhEDQlNKuoqwVYSxkSZCSbHjnFFmUEtwSKRPU4kNK8PbDYYitwaE3QA==", + "requires": { + "data-uri-to-buffer": "^4.0.0", + "fetch-blob": "^3.1.4", + "formdata-polyfill": "^4.0.10" + } + }, + "oauth-sign": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", + "integrity": "sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==" + }, + "performance-now": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", + "integrity": "sha512-7EAHlyLHI56VEIdK57uwHdHKIaAGbnXPiw0yWbarQZOKaKpvUIgW0jWRVLiatnM+XXlSwsanIBH/hzGMJulMow==" + }, + "psl": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.9.0.tgz", + "integrity": "sha512-E/ZsdU4HLs/68gYzgGTkMicWTLPdAftJLfJFlLUAAKZGkStNU72sZjT66SnMDVOfOWY/YAoiD7Jxa9iHvngcag==" + }, + "punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==" + }, + "qs": { + "version": "6.5.3", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.3.tgz", + "integrity": "sha512-qxXIEh4pCGfHICj1mAJQ2/2XVZkjCDTcEgfoSQxc/fYivUZxTkk7L3bDBJSoNrEzXI17oUO5Dp07ktqE5KzczA==" + }, + "request": { + "version": "2.88.2", + "resolved": "https://registry.npmjs.org/request/-/request-2.88.2.tgz", + "integrity": "sha512-MsvtOrfG9ZcrOwAW+Qi+F6HbD0CWXEh9ou77uOb7FM2WPhwT7smM833PzanhJLsgXjN89Ir6V2PczXNnMpwKhw==", + "requires": { + "aws-sign2": "~0.7.0", + "aws4": "^1.8.0", + "caseless": "~0.12.0", + "combined-stream": "~1.0.6", + "extend": "~3.0.2", + "forever-agent": "~0.6.1", + "form-data": "~2.3.2", + "har-validator": "~5.1.3", + "http-signature": "~1.2.0", + "is-typedarray": "~1.0.0", + "isstream": "~0.1.2", + "json-stringify-safe": "~5.0.1", + "mime-types": "~2.1.19", + "oauth-sign": "~0.9.0", + "performance-now": "^2.1.0", + "qs": "~6.5.2", + "safe-buffer": "^5.1.2", + "tough-cookie": "~2.5.0", + "tunnel-agent": "^0.6.0", + "uuid": "^3.3.2" + } + }, + "safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==" + }, + "safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" + }, + "sshpk": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.17.0.tgz", + "integrity": "sha512-/9HIEs1ZXGhSPE8X6Ccm7Nam1z8KcoCqPdI7ecm1N33EzAetWahvQWVqLZtaZQ+IDKX4IyA2o0gBzqIMkAagHQ==", + "requires": { + "asn1": "~0.2.3", + "assert-plus": "^1.0.0", + "bcrypt-pbkdf": "^1.0.0", + "dashdash": "^1.12.0", + "ecc-jsbn": "~0.1.1", + "getpass": "^0.1.1", + "jsbn": "~0.1.0", + "safer-buffer": "^2.0.2", + "tweetnacl": "~0.14.0" + } + }, + "tough-cookie": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.5.0.tgz", + "integrity": "sha512-nlLsUzgm1kfLXSXfRZMc1KLAugd4hqJHDTvc2hDIwS3mZAfMEuMbc03SujMF+GEcpaX/qboeycw6iO8JwVv2+g==", + "requires": { + "psl": "^1.1.28", + "punycode": "^2.1.1" + } + }, + "tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha512-McnNiV1l8RYeY8tBgEpuodCC1mLUdbSN+CYBL7kJsJNInOP8UjDDEwdk6Mw60vdLLrr5NHKZhMAOSrR2NZuQ+w==", + "requires": { + "safe-buffer": "^5.0.1" + } + }, + "tweetnacl": { + "version": "0.14.5", + "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", + "integrity": "sha512-KXXFFdAbFXY4geFIwoyNK+f5Z1b7swfXABfL7HXCmoIWMKU3dmS26672A4EeQtDzLKy7SXmfBu51JolvEKwtGA==" + }, + "uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "requires": { + "punycode": "^2.1.0" + } + }, + "uuid": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", + "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==" + }, + "verror": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", + "integrity": "sha512-ZZKSmDAEFOijERBLkmYfJ+vmk3w+7hOLYDNkRCuRuMJGEmqYNCNLyBBFwWKVMhfwaEF3WOd0Zlw86U/WC/+nYw==", + "requires": { + "assert-plus": "^1.0.0", + "core-util-is": "1.0.2", + "extsprintf": "^1.2.0" + } + }, + "web-streams-polyfill": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.2.1.tgz", + "integrity": "sha512-e0MO3wdXWKrLbL0DgGnUV7WHVuw9OUvL4hjgnPkIeEvESk74gAITi5G606JtZPp39cd8HA9VQzCIvA49LpPN5Q==" + } + } +} diff --git a/example/package.json b/example/package.json new file mode 100644 index 0000000..e6809f8 --- /dev/null +++ b/example/package.json @@ -0,0 +1,15 @@ +{ + "name": "example", + "version": "1.0.0", + "description": "", + "main": "oauth2-flow.js", + "type2": "module", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "dependencies": { + "dropbox-v2-api": "2.5.10-next.1" + } +} diff --git a/example/test.js b/example/test.js new file mode 100644 index 0000000..9e178b9 --- /dev/null +++ b/example/test.js @@ -0,0 +1,4 @@ +// import dropboxV2Api from "dropbox-v2-api"; +const dropboxV2Api = require("dropbox-v2-api"); + +console.log(dropboxV2Api); \ No newline at end of file diff --git a/fixup b/fixup new file mode 100755 index 0000000..7307016 --- /dev/null +++ b/fixup @@ -0,0 +1,11 @@ +cat >dist/cjs/package.json <dist/mjs/package.json < { + await generate(); +})() diff --git a/index.js b/index.js index 380a118..a2ee8a4 100644 --- a/index.js +++ b/index.js @@ -1 +1,3 @@ -module.exports = require('./src/dropbox-api.js'); \ No newline at end of file +import api from './src/dropbox-api.js'; + +export default api; \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 299ab6e..556445d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,8 +1,3037 @@ { "name": "dropbox-v2-api", - "version": "2.5.8", - "lockfileVersion": 1, + "version": "2.5.10-next.2", + "lockfileVersion": 2, "requires": true, + "packages": { + "": { + "version": "2.5.10-next.2", + "hasInstallScript": true, + "license": "ISC", + "dependencies": { + "compress-json": "2.1.2", + "node-fetch": "3.3.0", + "request": "2.88.2" + }, + "devDependencies": { + "@hapi/hapi": "19.1.1", + "async": "1.5.0", + "cheerio": "0.22.0", + "ejs": "2.5.6", + "expect.js": "0.3.1", + "js-beautify": "1.14.0", + "md5": "2.3.0", + "mocha": "^7.1.2", + "nconf": "0.11.3", + "opn": "3.0.3", + "should": "8.0.2", + "stream-spec": "0.3.6", + "stream-tester": "0.0.5", + "typescript": "4.9.4", + "underscore": "^1.13.1" + } + }, + "node_modules/@hapi/accept": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/@hapi/accept/-/accept-5.0.2.tgz", + "integrity": "sha512-CmzBx/bXUR8451fnZRuZAJRlzgm0Jgu5dltTX/bszmR2lheb9BpyN47Q1RbaGTsvFzn0PXAEs+lXDKfshccYZw==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x", + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/address": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@hapi/address/-/address-4.1.0.tgz", + "integrity": "sha512-SkszZf13HVgGmChdHo/PxchnSaCJ6cetVqLzyciudzZRT0jcOouIF/Q93mgjw8cce+D+4F4C1Z/WrfFN+O3VHQ==", + "deprecated": "Moved to 'npm install @sideway/address'", + "dev": true, + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, + "node_modules/@hapi/ammo": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/@hapi/ammo/-/ammo-5.0.1.tgz", + "integrity": "sha512-FbCNwcTbnQP4VYYhLNGZmA76xb2aHg9AMPiy18NZyWMG310P5KdFGyA9v2rm5ujrIny77dEEIkMOwl0Xv+fSSA==", + "dev": true, + "dependencies": { + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/b64": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@hapi/b64/-/b64-5.0.0.tgz", + "integrity": "sha512-ngu0tSEmrezoiIaNGG6rRvKOUkUuDdf4XTPnONHGYfSGRmDqPZX5oJL6HAdKTo1UQHECbdB4OzhWrfgVppjHUw==", + "dev": true, + "dependencies": { + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/boom": { + "version": "9.1.3", + "resolved": "https://registry.npmjs.org/@hapi/boom/-/boom-9.1.3.tgz", + "integrity": "sha512-RlrGyZ603hE/eRTZtTltocRm50HHmrmL3kGOP0SQ9MasazlW1mt/fkv4C5P/6rnpFXjwld/POFX1C8tMZE3ldg==", + "dev": true, + "dependencies": { + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/bounce": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@hapi/bounce/-/bounce-2.0.0.tgz", + "integrity": "sha512-JesW92uyzOOyuzJKjoLHM1ThiOvHPOLDHw01YV8yh5nCso7sDwJho1h0Ad2N+E62bZyz46TG3xhAi/78Gsct6A==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x", + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/bourne": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@hapi/bourne/-/bourne-2.0.0.tgz", + "integrity": "sha512-WEezM1FWztfbzqIUbsDzFRVMxSoLy3HugVcux6KDDtTqzPsLE8NDRHfXvev66aH1i2oOKKar3/XDjbvh/OUBdg==", + "dev": true + }, + "node_modules/@hapi/call": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/@hapi/call/-/call-8.0.1.tgz", + "integrity": "sha512-bOff6GTdOnoe5b8oXRV3lwkQSb/LAWylvDMae6RgEWWntd0SHtkYbQukDHKlfaYtVnSAgIavJ0kqszF/AIBb6g==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x", + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/catbox": { + "version": "11.1.1", + "resolved": "https://registry.npmjs.org/@hapi/catbox/-/catbox-11.1.1.tgz", + "integrity": "sha512-u/8HvB7dD/6X8hsZIpskSDo4yMKpHxFd7NluoylhGrL6cUfYxdQPnvUp9YU2C6F9hsyBVLGulBd9vBN1ebfXOQ==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x", + "@hapi/hoek": "9.x.x", + "@hapi/podium": "4.x.x", + "@hapi/validate": "1.x.x" + } + }, + "node_modules/@hapi/catbox-memory": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/@hapi/catbox-memory/-/catbox-memory-5.0.1.tgz", + "integrity": "sha512-QWw9nOYJq5PlvChLWV8i6hQHJYfvdqiXdvTupJFh0eqLZ64Xir7mKNi96d5/ZMUAqXPursfNDIDxjFgoEDUqeQ==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x", + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/content": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/@hapi/content/-/content-5.0.2.tgz", + "integrity": "sha512-mre4dl1ygd4ZyOH3tiYBrOUBzV7Pu/EOs8VLGf58vtOEECWed8Uuw6B4iR9AN/8uQt42tB04qpVaMyoMQh0oMw==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x" + } + }, + "node_modules/@hapi/cryptiles": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@hapi/cryptiles/-/cryptiles-5.1.0.tgz", + "integrity": "sha512-fo9+d1Ba5/FIoMySfMqPBR/7Pa29J2RsiPrl7bkwo5W5o+AN1dAYQRi4SPrPwwVxVGKjgLOEWrsvt1BonJSfLA==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/@hapi/file": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@hapi/file/-/file-2.0.0.tgz", + "integrity": "sha512-WSrlgpvEqgPWkI18kkGELEZfXr0bYLtr16iIN4Krh9sRnzBZN6nnWxHFxtsnP684wueEySBbXPDg/WfA9xJdBQ==", + "dev": true + }, + "node_modules/@hapi/formula": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@hapi/formula/-/formula-2.0.0.tgz", + "integrity": "sha512-V87P8fv7PI0LH7LiVi8Lkf3x+KCO7pQozXRssAHNXXL9L1K+uyu4XypLXwxqVDKgyQai6qj3/KteNlrqDx4W5A==", + "deprecated": "Moved to 'npm install @sideway/formula'", + "dev": true + }, + "node_modules/@hapi/hapi": { + "version": "19.1.1", + "resolved": "https://registry.npmjs.org/@hapi/hapi/-/hapi-19.1.1.tgz", + "integrity": "sha512-rpQzSs0XsHSF7usM4qdJJ0Bcmhs9stWhUW3OiamW33bw4qL8q3uEgUKB9KH8ODmluCAkkXOQ0X0Dh9t94E5VIw==", + "deprecated": "This version contains severe security issues and defects and should not be used! Please upgrade to the latest version of @hapi/hapi or consider a commercial license (https://github.com/hapijs/hapi/issues/4114)", + "dev": true, + "dependencies": { + "@hapi/accept": "^5.0.1", + "@hapi/ammo": "^5.0.1", + "@hapi/boom": "9.x.x", + "@hapi/bounce": "2.x.x", + "@hapi/call": "8.x.x", + "@hapi/catbox": "11.x.x", + "@hapi/catbox-memory": "5.x.x", + "@hapi/heavy": "7.x.x", + "@hapi/hoek": "9.x.x", + "@hapi/joi": "17.x.x", + "@hapi/mimos": "5.x.x", + "@hapi/podium": "4.x.x", + "@hapi/shot": "5.x.x", + "@hapi/somever": "3.x.x", + "@hapi/statehood": "^7.0.2", + "@hapi/subtext": "^7.0.3", + "@hapi/teamwork": "4.x.x", + "@hapi/topo": "5.x.x" + } + }, + "node_modules/@hapi/heavy": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/@hapi/heavy/-/heavy-7.0.1.tgz", + "integrity": "sha512-vJ/vzRQ13MtRzz6Qd4zRHWS3FaUc/5uivV2TIuExGTM9Qk+7Zzqj0e2G7EpE6KztO9SalTbiIkTh7qFKj/33cA==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x", + "@hapi/hoek": "9.x.x", + "@hapi/validate": "1.x.x" + } + }, + "node_modules/@hapi/hoek": { + "version": "9.2.0", + "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.2.0.tgz", + "integrity": "sha512-sqKVVVOe5ivCaXDWivIJYVSaEgdQK9ul7a4Kity5Iw7u9+wBAPbX1RMSnLLmp7O4Vzj0WOWwMAJsTL00xwaNug==", + "dev": true + }, + "node_modules/@hapi/iron": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@hapi/iron/-/iron-6.0.0.tgz", + "integrity": "sha512-zvGvWDufiTGpTJPG1Y/McN8UqWBu0k/xs/7l++HVU535NLHXsHhy54cfEMdW7EjwKfbBfM9Xy25FmTiobb7Hvw==", + "dev": true, + "dependencies": { + "@hapi/b64": "5.x.x", + "@hapi/boom": "9.x.x", + "@hapi/bourne": "2.x.x", + "@hapi/cryptiles": "5.x.x", + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/joi": { + "version": "17.1.1", + "resolved": "https://registry.npmjs.org/@hapi/joi/-/joi-17.1.1.tgz", + "integrity": "sha512-p4DKeZAoeZW4g3u7ZeRo+vCDuSDgSvtsB/NpfjXEHTUjSeINAi/RrVOWiVQ1isaoLzMvFEhe8n5065mQq1AdQg==", + "deprecated": "Switch to 'npm install joi'", + "dev": true, + "dependencies": { + "@hapi/address": "^4.0.1", + "@hapi/formula": "^2.0.0", + "@hapi/hoek": "^9.0.0", + "@hapi/pinpoint": "^2.0.0", + "@hapi/topo": "^5.0.0" + } + }, + "node_modules/@hapi/mimos": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@hapi/mimos/-/mimos-5.0.0.tgz", + "integrity": "sha512-EVS6wJYeE73InTlPWt+2e3Izn319iIvffDreci3qDNT+t3lA5ylJ0/SoTaID8e0TPNUkHUSsgJZXEmLHvoYzrA==", + "dev": true, + "dependencies": { + "@hapi/hoek": "9.x.x", + "mime-db": "1.x.x" + } + }, + "node_modules/@hapi/nigel": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@hapi/nigel/-/nigel-4.0.2.tgz", + "integrity": "sha512-ht2KoEsDW22BxQOEkLEJaqfpoKPXxi7tvabXy7B/77eFtOyG5ZEstfZwxHQcqAiZhp58Ae5vkhEqI03kawkYNw==", + "dev": true, + "dependencies": { + "@hapi/hoek": "^9.0.4", + "@hapi/vise": "^4.0.0" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/@hapi/pez": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/@hapi/pez/-/pez-5.0.3.tgz", + "integrity": "sha512-mpikYRJjtrbJgdDHG/H9ySqYqwJ+QU/D7FXsYciS9P7NYBXE2ayKDAy3H0ou6CohOCaxPuTV4SZ0D936+VomHA==", + "dev": true, + "dependencies": { + "@hapi/b64": "5.x.x", + "@hapi/boom": "9.x.x", + "@hapi/content": "^5.0.2", + "@hapi/hoek": "9.x.x", + "@hapi/nigel": "4.x.x" + } + }, + "node_modules/@hapi/pinpoint": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@hapi/pinpoint/-/pinpoint-2.0.0.tgz", + "integrity": "sha512-vzXR5MY7n4XeIvLpfl3HtE3coZYO4raKXW766R6DZw/6aLqR26iuZ109K7a0NtF2Db0jxqh7xz2AxkUwpUFybw==", + "deprecated": "Moved to 'npm install @sideway/pinpoint'", + "dev": true + }, + "node_modules/@hapi/podium": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/@hapi/podium/-/podium-4.1.3.tgz", + "integrity": "sha512-ljsKGQzLkFqnQxE7qeanvgGj4dejnciErYd30dbrYzUOF/FyS/DOF97qcrT3bhoVwCYmxa6PEMhxfCPlnUcD2g==", + "dev": true, + "dependencies": { + "@hapi/hoek": "9.x.x", + "@hapi/teamwork": "5.x.x", + "@hapi/validate": "1.x.x" + } + }, + "node_modules/@hapi/podium/node_modules/@hapi/teamwork": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@hapi/teamwork/-/teamwork-5.1.0.tgz", + "integrity": "sha512-llqoQTrAJDTXxG3c4Kz/uzhBS1TsmSBa/XG5SPcVXgmffHE1nFtyLIK0hNJHCB3EuBKT84adzd1hZNY9GJLWtg==", + "dev": true, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/@hapi/shot": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/@hapi/shot/-/shot-5.0.5.tgz", + "integrity": "sha512-x5AMSZ5+j+Paa8KdfCoKh+klB78otxF+vcJR/IoN91Vo2e5ulXIW6HUsFTCU+4W6P/Etaip9nmdAx2zWDimB2A==", + "dev": true, + "dependencies": { + "@hapi/hoek": "9.x.x", + "@hapi/validate": "1.x.x" + } + }, + "node_modules/@hapi/somever": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@hapi/somever/-/somever-3.0.1.tgz", + "integrity": "sha512-4ZTSN3YAHtgpY/M4GOtHUXgi6uZtG9nEZfNI6QrArhK0XN/RDVgijlb9kOmXwCR5VclDSkBul9FBvhSuKXx9+w==", + "dev": true, + "dependencies": { + "@hapi/bounce": "2.x.x", + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/statehood": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/@hapi/statehood/-/statehood-7.0.3.tgz", + "integrity": "sha512-pYB+pyCHkf2Amh67QAXz7e/DN9jcMplIL7Z6N8h0K+ZTy0b404JKPEYkbWHSnDtxLjJB/OtgElxocr2fMH4G7w==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x", + "@hapi/bounce": "2.x.x", + "@hapi/bourne": "2.x.x", + "@hapi/cryptiles": "5.x.x", + "@hapi/hoek": "9.x.x", + "@hapi/iron": "6.x.x", + "@hapi/validate": "1.x.x" + } + }, + "node_modules/@hapi/subtext": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/@hapi/subtext/-/subtext-7.0.3.tgz", + "integrity": "sha512-CekDizZkDGERJ01C0+TzHlKtqdXZxzSWTOaH6THBrbOHnsr3GY+yiMZC+AfNCypfE17RaIakGIAbpL2Tk1z2+A==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x", + "@hapi/bourne": "2.x.x", + "@hapi/content": "^5.0.2", + "@hapi/file": "2.x.x", + "@hapi/hoek": "9.x.x", + "@hapi/pez": "^5.0.1", + "@hapi/wreck": "17.x.x" + } + }, + "node_modules/@hapi/teamwork": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@hapi/teamwork/-/teamwork-4.0.0.tgz", + "integrity": "sha512-V6xYOrr5aFv/IJqNPneaYCu8vuGTKisamqHVRS3JJnbZr18TrpXdsJOYk9pjPhFti+M2YETPebQLUr820N5NoQ==", + "deprecated": "This version has been deprecated and is no longer supported or maintained", + "dev": true + }, + "node_modules/@hapi/topo": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@hapi/topo/-/topo-5.1.0.tgz", + "integrity": "sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==", + "dev": true, + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, + "node_modules/@hapi/validate": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@hapi/validate/-/validate-1.1.3.tgz", + "integrity": "sha512-/XMR0N0wjw0Twzq2pQOzPBZlDzkekGcoCtzO314BpIEsbXdYGthQUbxgkGDf4nhk1+IPDAsXqWjMohRQYO06UA==", + "dev": true, + "dependencies": { + "@hapi/hoek": "^9.0.0", + "@hapi/topo": "^5.0.0" + } + }, + "node_modules/@hapi/vise": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@hapi/vise/-/vise-4.0.0.tgz", + "integrity": "sha512-eYyLkuUiFZTer59h+SGy7hUm+qE9p+UemePTHLlIWppEd+wExn3Df5jO04bFQTm7nleF5V8CtuYQYb+VFpZ6Sg==", + "dev": true, + "dependencies": { + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/@hapi/wreck": { + "version": "17.1.0", + "resolved": "https://registry.npmjs.org/@hapi/wreck/-/wreck-17.1.0.tgz", + "integrity": "sha512-nx6sFyfqOpJ+EFrHX+XWwJAxs3ju4iHdbB/bwR8yTNZOiYmuhA8eCe7lYPtYmb4j7vyK/SlbaQsmTtUrMvPEBw==", + "dev": true, + "dependencies": { + "@hapi/boom": "9.x.x", + "@hapi/bourne": "2.x.x", + "@hapi/hoek": "9.x.x" + } + }, + "node_modules/abbrev": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", + "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", + "dev": true + }, + "node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ansi-colors": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", + "integrity": "sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/ansi-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", + "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/anymatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.2.tgz", + "integrity": "sha512-P43ePfOAIupkguHUycrc4qJ9kz8ZiuOUijaETwX7THt0Y/GNK7v0aa8rY816xWjZ7rJdA5XdMcpVFTKMq+RvWg==", + "dev": true, + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/asn1": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.4.tgz", + "integrity": "sha512-jxwzQpLQjSmWXgwaCZE9Nz+glAG01yF1QnWgbhGwHI5A6FRIEY6IVqtHhIepHqI7/kyEyQEagBC5mBEFlIYvdg==", + "dependencies": { + "safer-buffer": "~2.1.0" + } + }, + "node_modules/assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", + "engines": { + "node": ">=0.8" + } + }, + "node_modules/assertions": { + "version": "2.3.4", + "resolved": "https://registry.npmjs.org/assertions/-/assertions-2.3.4.tgz", + "integrity": "sha1-qUM87R/OV8yZmvCWXRAI6WwnluY=", + "dev": true, + "dependencies": { + "fomatto": "git://github.com/BonsaiDen/Fomatto.git#468666f600b46f9067e3da7200fd9df428923ea6", + "render": "0.1", + "traverser": "1" + }, + "engines": { + "node": ">= 0.2.0" + } + }, + "node_modules/async": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/async/-/async-1.5.0.tgz", + "integrity": "sha1-J5ZkJyNXOFlWVjP8YnRES+4vjOM=", + "dev": true + }, + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" + }, + "node_modules/aws-sign2": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", + "integrity": "sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg=", + "engines": { + "node": "*" + } + }, + "node_modules/aws4": { + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.11.0.tgz", + "integrity": "sha512-xh1Rl34h6Fi1DC2WWKfxUTVqRsNnr6LsKz2+hfwDxQJWmrx8+c7ylaqBMcHfl1U1r2dsifOvKX3LQuLNZ+XSvA==" + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, + "node_modules/bcrypt-pbkdf": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", + "integrity": "sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4=", + "dependencies": { + "tweetnacl": "^0.14.3" + } + }, + "node_modules/binary-extensions": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.2.0.tgz", + "integrity": "sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/boolbase": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", + "integrity": "sha1-aN/1++YMUes3cl6p4+0xDcwed24=", + "dev": true + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "dependencies": { + "fill-range": "^7.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/browser-stdout": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/browser-stdout/-/browser-stdout-1.3.1.tgz", + "integrity": "sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw==", + "dev": true + }, + "node_modules/call-bind": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", + "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/caseless": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", + "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=" + }, + "node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/chalk/node_modules/supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/charenc": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/charenc/-/charenc-0.0.2.tgz", + "integrity": "sha1-wKHS86cJLgN3S/qD8UwPxXkKhmc=", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/cheerio": { + "version": "0.22.0", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-0.22.0.tgz", + "integrity": "sha1-qbqoYKP5tZWmuBsahocxIe06Jp4=", + "dev": true, + "dependencies": { + "css-select": "~1.2.0", + "dom-serializer": "~0.1.0", + "entities": "~1.1.1", + "htmlparser2": "^3.9.1", + "lodash.assignin": "^4.0.9", + "lodash.bind": "^4.1.4", + "lodash.defaults": "^4.0.1", + "lodash.filter": "^4.4.0", + "lodash.flatten": "^4.2.0", + "lodash.foreach": "^4.3.0", + "lodash.map": "^4.4.0", + "lodash.merge": "^4.4.0", + "lodash.pick": "^4.2.1", + "lodash.reduce": "^4.4.0", + "lodash.reject": "^4.4.0", + "lodash.some": "^4.4.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/chokidar": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.3.0.tgz", + "integrity": "sha512-dGmKLDdT3Gdl7fBUe8XK+gAtGmzy5Fn0XkkWQuYxGIgWVPPse2CxFA5mtrlD0TOHaHjEUqkWNyP1XdHoJES/4A==", + "dev": true, + "dependencies": { + "anymatch": "~3.1.1", + "braces": "~3.0.2", + "glob-parent": "~5.1.0", + "is-binary-path": "~2.1.0", + "is-glob": "~4.0.1", + "normalize-path": "~3.0.0", + "readdirp": "~3.2.0" + }, + "engines": { + "node": ">= 8.10.0" + }, + "optionalDependencies": { + "fsevents": "~2.1.1" + } + }, + "node_modules/cliui": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", + "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", + "dev": true, + "dependencies": { + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" + } + }, + "node_modules/cliui/node_modules/ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/cliui/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/cliui/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "dev": true + }, + "node_modules/compress-json": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/compress-json/-/compress-json-2.1.2.tgz", + "integrity": "sha512-91247RD8bKQXzRmXUS4zGT250mhw86+J9X8w2L2SGtRE7g0CvzjOETFaFmsDdaXPWv8T7L9iiM7kdcnnH3BH7w==" + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "dev": true + }, + "node_modules/config-chain": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", + "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", + "dev": true, + "dependencies": { + "ini": "^1.3.4", + "proto-list": "~1.2.1" + } + }, + "node_modules/core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=" + }, + "node_modules/crypt": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/crypt/-/crypt-0.0.2.tgz", + "integrity": "sha1-iNf/fsDfuG9xPch7u0LQRNPmxBs=", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/css-select": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-1.2.0.tgz", + "integrity": "sha1-KzoRBTnFNV8c2NMUYj6HCxIeyFg=", + "dev": true, + "dependencies": { + "boolbase": "~1.0.0", + "css-what": "2.1", + "domutils": "1.5.1", + "nth-check": "~1.0.1" + } + }, + "node_modules/css-what": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/css-what/-/css-what-2.1.3.tgz", + "integrity": "sha512-a+EPoD+uZiNfh+5fxw2nO9QwFa6nJe2Or35fGY6Ipw1R3R4AGz1d1TEZrCegvw2YTmZ0jXirGYlzxxpYSHwpEg==", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/curry": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/curry/-/curry-0.0.4.tgz", + "integrity": "sha1-F1DVGNkZxE89N/9E7caT3h8NX8s=", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/dashdash": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", + "integrity": "sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA=", + "dependencies": { + "assert-plus": "^1.0.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/data-uri-to-buffer": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.0.tgz", + "integrity": "sha512-Vr3mLBA8qWmcuschSLAOogKgQ/Jwxulv3RNE4FXnYWRGujzrRWQI4m12fQqRkwX06C0KanhLr4hK+GydchZsaA==", + "engines": { + "node": ">= 12" + } + }, + "node_modules/debug": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz", + "integrity": "sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==", + "deprecated": "Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (https://github.com/visionmedia/debug/issues/797)", + "dev": true, + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/decamelize": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", + "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/define-properties": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", + "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "dev": true, + "dependencies": { + "object-keys": "^1.0.12" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/diff": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", + "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", + "dev": true, + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/dom-serializer": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-0.1.1.tgz", + "integrity": "sha512-l0IU0pPzLWSHBcieZbpOKgkIn3ts3vAh7ZuFyXNwJxJXk/c4Gwj9xaTJwIDVQCXawWD0qb3IzMGH5rglQaO0XA==", + "dev": true, + "dependencies": { + "domelementtype": "^1.3.0", + "entities": "^1.1.1" + } + }, + "node_modules/domelementtype": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-1.3.1.tgz", + "integrity": "sha512-BSKB+TSpMpFI/HOxCNr1O8aMOTZ8hT3pM3GQ0w/mWRmkhEDSFJkkyzz4XQsBV44BChwGkrDfMyjVD0eA2aFV3w==", + "dev": true + }, + "node_modules/domhandler": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-2.4.2.tgz", + "integrity": "sha512-JiK04h0Ht5u/80fdLMCEmV4zkNh2BcoMFBmZ/91WtYZ8qVXSKjiw7fXMgFPnHcSZgOo3XdinHvmnDUeMf5R4wA==", + "dev": true, + "dependencies": { + "domelementtype": "1" + } + }, + "node_modules/domutils": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-1.5.1.tgz", + "integrity": "sha1-3NhIiib1Y9YQeeSMn3t+Mjc2gs8=", + "dev": true, + "dependencies": { + "dom-serializer": "0", + "domelementtype": "1" + } + }, + "node_modules/ecc-jsbn": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", + "integrity": "sha1-OoOpBOVDUyh4dMVkt1SThoSamMk=", + "dependencies": { + "jsbn": "~0.1.0", + "safer-buffer": "^2.1.0" + } + }, + "node_modules/editorconfig": { + "version": "0.15.3", + "resolved": "https://registry.npmjs.org/editorconfig/-/editorconfig-0.15.3.tgz", + "integrity": "sha512-M9wIMFx96vq0R4F+gRpY3o2exzb8hEj/n9S8unZtHSvYjibBp/iMufSzvmOcV/laG0ZtuTVGtiJggPOSW2r93g==", + "dev": true, + "dependencies": { + "commander": "^2.19.0", + "lru-cache": "^4.1.5", + "semver": "^5.6.0", + "sigmund": "^1.0.1" + }, + "bin": { + "editorconfig": "bin/editorconfig" + } + }, + "node_modules/ejs": { + "version": "2.5.6", + "resolved": "https://registry.npmjs.org/ejs/-/ejs-2.5.6.tgz", + "integrity": "sha1-R5Y2v6P+Ox3r1SCH8KyyBLTxnIg=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true + }, + "node_modules/entities": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", + "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", + "dev": true + }, + "node_modules/es-abstract": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.18.3.tgz", + "integrity": "sha512-nQIr12dxV7SSxE6r6f1l3DtAeEYdsGpps13dR0TwJg1S8gyp4ZPgy3FZcHBgbiQqnoqSTb+oC+kO4UQ0C/J8vw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "is-callable": "^1.2.3", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.3", + "is-string": "^1.0.6", + "object-inspect": "^1.10.3", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-abstract/node_modules/object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "dependencies": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/escalade": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", + "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/expect.js": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/expect.js/-/expect.js-0.3.1.tgz", + "integrity": "sha1-sKWaDS7/VDdUTr8M6qYBWEHQm1s=", + "dev": true + }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==" + }, + "node_modules/extsprintf": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", + "integrity": "sha1-lpGEQOMEGnpBT4xS48V06zw+HgU=", + "engines": [ + "node >=0.6.0" + ] + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" + }, + "node_modules/fetch-blob": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz", + "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/jimmywarting" + }, + { + "type": "paypal", + "url": "https://paypal.me/jimmywarting" + } + ], + "dependencies": { + "node-domexception": "^1.0.0", + "web-streams-polyfill": "^3.0.3" + }, + "engines": { + "node": "^12.20 || >= 14.13" + } + }, + "node_modules/fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/flat": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/flat/-/flat-4.1.1.tgz", + "integrity": "sha512-FmTtBsHskrU6FJ2VxCnsDb84wu9zhmO3cUX2kGFb5tuwhfXxGciiT0oRY+cck35QmG+NmGh5eLz6lLCpWTqwpA==", + "dev": true, + "dependencies": { + "is-buffer": "~2.0.3" + }, + "bin": { + "flat": "cli.js" + } + }, + "node_modules/flat/node_modules/is-buffer": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.5.tgz", + "integrity": "sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "engines": { + "node": ">=4" + } + }, + "node_modules/fomatto": { + "version": "0.6.0", + "resolved": "git+ssh://git@github.com/BonsaiDen/Fomatto.git#468666f600b46f9067e3da7200fd9df428923ea6", + "integrity": "sha512-2JeZCbUi12tmDJhd9F3mxZ6xL0+2Ym2MamXZHnHh5OVKKA1h/6svVAAzJ2tt5ycFAQ4EwseW3FoAFNUle/opbQ==", + "dev": true, + "engines": { + "node": ">=0.1.5" + } + }, + "node_modules/forever-agent": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", + "integrity": "sha1-+8cfDEGt6zf5bFd60e1C2P2sypE=", + "engines": { + "node": "*" + } + }, + "node_modules/form-data": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz", + "integrity": "sha512-1lLKB2Mu3aGP1Q/2eCOx0fNbRMe7XdwktwOruhfqqd0rIJWwN4Dh+E3hrPSlDCXnSR7UtZ1N38rVXm+6+MEhJQ==", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.6", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 0.12" + } + }, + "node_modules/formdata-polyfill": { + "version": "4.0.10", + "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz", + "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==", + "dependencies": { + "fetch-blob": "^3.1.2" + }, + "engines": { + "node": ">=12.20.0" + } + }, + "node_modules/from": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/from/-/from-0.0.2.tgz", + "integrity": "sha1-f/+sZHovmbINV7jig3lFXLtBidA=", + "dev": true + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "node_modules/fsevents": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.1.3.tgz", + "integrity": "sha512-Auw9a4AxqWpa9GUfj370BMPzzyncfBABW8Mab7BGWBYDj4Isgq+cDKtx0i6u9jcX9pQDnswsaaOTgTmA5pEjuQ==", + "deprecated": "\"Please update to latest v2.3 or v2.2\"", + "dev": true, + "hasInstallScript": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", + "dev": true + }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true, + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, + "node_modules/get-intrinsic": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", + "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/getpass": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", + "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", + "dependencies": { + "assert-plus": "^1.0.0" + } + }, + "node_modules/glob": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", + "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/growl": { + "version": "1.10.5", + "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", + "integrity": "sha512-qBr4OuELkhPenW6goKVXiv47US3clb3/IbuWF9KNKEijAy9oeHxU9IgzjvJhHkUzhaj7rOUD7+YGWqUjLp5oSA==", + "dev": true, + "engines": { + "node": ">=4.x" + } + }, + "node_modules/har-schema": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", + "integrity": "sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI=", + "engines": { + "node": ">=4" + } + }, + "node_modules/har-validator": { + "version": "5.1.5", + "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.1.5.tgz", + "integrity": "sha512-nmT2T0lljbxdQZfspsno9hgrG3Uir6Ks5afism62poxqBM6sDnMEuPmzTq8XN0OEwqKLLdh1jQI3qyE66Nzb3w==", + "deprecated": "this library is no longer supported", + "dependencies": { + "ajv": "^6.12.3", + "har-schema": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/has": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", + "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/has-bigints": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", + "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/he": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", + "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", + "dev": true, + "bin": { + "he": "bin/he" + } + }, + "node_modules/htmlparser2": { + "version": "3.10.1", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-3.10.1.tgz", + "integrity": "sha512-IgieNijUMbkDovyoKObU1DUhm1iwNYE/fuifEoEHfd1oZKZDaONBSkal7Y01shxsM49R4XaMdGez3WnF9UfiCQ==", + "dev": true, + "dependencies": { + "domelementtype": "^1.3.1", + "domhandler": "^2.3.0", + "domutils": "^1.5.1", + "entities": "^1.1.1", + "inherits": "^2.0.1", + "readable-stream": "^3.1.1" + } + }, + "node_modules/http-signature": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", + "integrity": "sha1-muzZJRFHcvPZW2WmCruPfBj7rOE=", + "dependencies": { + "assert-plus": "^1.0.0", + "jsprim": "^1.2.2", + "sshpk": "^1.7.0" + }, + "engines": { + "node": ">=0.8", + "npm": ">=1.3.7" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true + }, + "node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", + "dev": true + }, + "node_modules/is-bigint": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.2.tgz", + "integrity": "sha512-0JV5+SOCQkIdzjBK9buARcV804Ddu7A0Qet6sHi3FimE9ne6m4BGQZfRn+NZiXbBk4F4XmHfDZIipLj9pX8dSA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-binary-path": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", + "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", + "dev": true, + "dependencies": { + "binary-extensions": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-boolean-object": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.1.tgz", + "integrity": "sha512-bXdQWkECBUIAcCkeH1unwJLIpZYaa5VvuygSyS/c2lf719mTKZDU5UdDRlpd01UjADgmW8RfqaP+mRaVPdr/Ng==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-buffer": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", + "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==", + "dev": true + }, + "node_modules/is-callable": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.3.tgz", + "integrity": "sha512-J1DcMe8UYTBSrKezuIUTUwjXsho29693unXM2YhJUTR2txK/eG47bvNa/wipPFmZFgr/N6f1GA66dv0mEyTIyQ==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.4.tgz", + "integrity": "sha512-/b4ZVsG7Z5XVtIxs/h9W8nvfLgSAyKYdtGWQLbqy6jA1icmgjf8WCoTKgeS4wy5tYaPePouzFMANbnj94c2Z+A==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/is-glob": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", + "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", + "dev": true, + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-negative-zero": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.1.tgz", + "integrity": "sha512-2z6JzQvZRa9A2Y7xC6dQQm4FSTSTNWjKIYYTt4246eMTJmIo0Q+ZyOsU66X8lxK1AbB92dFeglPLrhwpeRKO6w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-number-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.5.tgz", + "integrity": "sha512-RU0lI/n95pMoUKu9v1BZP5MBcZuNSVJkMkAG2dJqC4z2GlkGUNeH68SuHuBKBD/XFe+LHZ+f9BKkLET60Niedw==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-regex": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.3.tgz", + "integrity": "sha512-qSVXFz28HM7y+IWX6vLCsexdlvzT1PJNFSBuaQLQ5o0IEw8UDYW6/2+eCMVyIsbM8CNLX2a/QWmSpyxYEHY7CQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-string": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.6.tgz", + "integrity": "sha512-2gdzbKUuqtQ3lYNrUTQYoClPhm7oQu4UdpSZMp1/DGgkHBT8E2Z1l0yMdb6D4zNAxwDiMv8MdulKROJGNl0Q0w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=" + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", + "dev": true + }, + "node_modules/isstream": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", + "integrity": "sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo=" + }, + "node_modules/js-beautify": { + "version": "1.14.0", + "resolved": "https://registry.npmjs.org/js-beautify/-/js-beautify-1.14.0.tgz", + "integrity": "sha512-yuck9KirNSCAwyNJbqW+BxJqJ0NLJ4PwBUzQQACl5O3qHMBXVkXb/rD0ilh/Lat/tn88zSZ+CAHOlk0DsY7GuQ==", + "dev": true, + "dependencies": { + "config-chain": "^1.1.12", + "editorconfig": "^0.15.3", + "glob": "^7.1.3", + "nopt": "^5.0.0" + }, + "bin": { + "css-beautify": "js/bin/css-beautify.js", + "html-beautify": "js/bin/html-beautify.js", + "js-beautify": "js/bin/js-beautify.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsbn": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", + "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=" + }, + "node_modules/json-schema": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", + "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM=" + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "node_modules/json-stringify-safe": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", + "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus=" + }, + "node_modules/jsprim": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", + "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI=", + "engines": [ + "node >=0.6.0" + ], + "dependencies": { + "assert-plus": "1.0.0", + "extsprintf": "1.3.0", + "json-schema": "0.2.3", + "verror": "1.10.0" + } + }, + "node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, + "node_modules/lodash.assignin": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/lodash.assignin/-/lodash.assignin-4.2.0.tgz", + "integrity": "sha1-uo31+4QesKPoBEIysOJjqNxqKKI=", + "dev": true + }, + "node_modules/lodash.bind": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/lodash.bind/-/lodash.bind-4.2.1.tgz", + "integrity": "sha1-euMBfpOWIqwxt9fX3LGzTbFpDTU=", + "dev": true + }, + "node_modules/lodash.defaults": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/lodash.defaults/-/lodash.defaults-4.2.0.tgz", + "integrity": "sha1-0JF4cW/+pN3p5ft7N/bwgCJ0WAw=", + "dev": true + }, + "node_modules/lodash.filter": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/lodash.filter/-/lodash.filter-4.6.0.tgz", + "integrity": "sha1-ZosdSYFgOuHMWm+nYBQ+SAtMSs4=", + "dev": true + }, + "node_modules/lodash.flatten": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/lodash.flatten/-/lodash.flatten-4.4.0.tgz", + "integrity": "sha1-8xwiIlqWMtK7+OSt2+8kCqdlph8=", + "dev": true + }, + "node_modules/lodash.foreach": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.foreach/-/lodash.foreach-4.5.0.tgz", + "integrity": "sha1-Gmo16s5AEoDH8G3d7DUWWrJ+PlM=", + "dev": true + }, + "node_modules/lodash.map": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/lodash.map/-/lodash.map-4.6.0.tgz", + "integrity": "sha1-dx7Hg540c9nEzeKLGTlMNWL09tM=", + "dev": true + }, + "node_modules/lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true + }, + "node_modules/lodash.pick": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/lodash.pick/-/lodash.pick-4.4.0.tgz", + "integrity": "sha1-UvBWEP/53tQiYRRB7R/BI6AwAbM=", + "dev": true + }, + "node_modules/lodash.reduce": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/lodash.reduce/-/lodash.reduce-4.6.0.tgz", + "integrity": "sha1-8atrg5KZrUj3hKu/R2WW8DuRTTs=", + "dev": true + }, + "node_modules/lodash.reject": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/lodash.reject/-/lodash.reject-4.6.0.tgz", + "integrity": "sha1-gNZJLcFHCGS79YNTO2UfQqn1JBU=", + "dev": true + }, + "node_modules/lodash.some": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/lodash.some/-/lodash.some-4.6.0.tgz", + "integrity": "sha1-G7nzFO9ri63tE7VJFpsqlF62jk0=", + "dev": true + }, + "node_modules/log-symbols": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-3.0.0.tgz", + "integrity": "sha512-dSkNGuI7iG3mfvDzUuYZyvk5dD9ocYCYzNU6CYDE6+Xqd+gwme6Z00NS3dUh8mq/73HaEtT7m6W+yUPtU6BZnQ==", + "dev": true, + "dependencies": { + "chalk": "^2.4.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/lru-cache": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.5.tgz", + "integrity": "sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==", + "dev": true, + "dependencies": { + "pseudomap": "^1.0.2", + "yallist": "^2.1.2" + } + }, + "node_modules/macgyver": { + "version": "1.10.1", + "resolved": "https://registry.npmjs.org/macgyver/-/macgyver-1.10.1.tgz", + "integrity": "sha1-sJ0VmdizbtWxb1lYlRXZ0UvC/Yg=", + "dev": true + }, + "node_modules/md5": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/md5/-/md5-2.3.0.tgz", + "integrity": "sha512-T1GITYmFaKuO91vxyoQMFETst+O71VUPEU3ze5GNzDm0OWdP8v1ziTaAEPUr/3kLsY3Sftgz242A1SetQiDL7g==", + "dev": true, + "dependencies": { + "charenc": "0.0.2", + "crypt": "0.0.2", + "is-buffer": "~1.1.6" + } + }, + "node_modules/mime-db": { + "version": "1.48.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.48.0.tgz", + "integrity": "sha512-FM3QwxV+TnZYQ2aRqhlKBMHxk10lTbMt3bBkMAp54ddrNeVSfcQYOOKuGuy3Ddrm38I04If834fOUSq1yzslJQ==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.33", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.33.tgz", + "integrity": "sha512-plLElXp7pRDd0bNZHw+nMd52vRYjLwQjygaNg7ddJ2uJtTlmnTCjWuPKxVu6//AdaRuME84SvLW91sIkBqGT0g==", + "dependencies": { + "mime-db": "1.50.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types/node_modules/mime-db": { + "version": "1.50.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.50.0.tgz", + "integrity": "sha512-9tMZCDlYHqeERXEHO9f/hKfNXhre5dK2eE/krIvUjZbS2KPcqGDfNShIWS1uW9XOTKQKqK6qbeOci18rbfW77A==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", + "dev": true + }, + "node_modules/mocha": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-7.2.0.tgz", + "integrity": "sha512-O9CIypScywTVpNaRrCAgoUnJgozpIofjKUYmJhiCIJMiuYnLI6otcb1/kpW9/n/tJODHGZ7i8aLQoDVsMtOKQQ==", + "dev": true, + "dependencies": { + "ansi-colors": "3.2.3", + "browser-stdout": "1.3.1", + "chokidar": "3.3.0", + "debug": "3.2.6", + "diff": "3.5.0", + "escape-string-regexp": "1.0.5", + "find-up": "3.0.0", + "glob": "7.1.3", + "growl": "1.10.5", + "he": "1.2.0", + "js-yaml": "3.13.1", + "log-symbols": "3.0.0", + "minimatch": "3.0.4", + "mkdirp": "0.5.5", + "ms": "2.1.1", + "node-environment-flags": "1.0.6", + "object.assign": "4.1.0", + "strip-json-comments": "2.0.1", + "supports-color": "6.0.0", + "which": "1.3.1", + "wide-align": "1.1.3", + "yargs": "13.3.2", + "yargs-parser": "13.1.2", + "yargs-unparser": "1.6.0" + }, + "bin": { + "_mocha": "bin/_mocha", + "mocha": "bin/mocha" + }, + "engines": { + "node": ">= 8.10.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/mochajs" + } + }, + "node_modules/mocha/node_modules/glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + } + }, + "node_modules/mocha/node_modules/mkdirp": { + "version": "0.5.5", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.5.tgz", + "integrity": "sha512-NKmAlESf6jMGym1++R0Ra7wvhV+wFW63FaSOFPwRahvea0gMUcGUhVeAg/0BC0wiv9ih5NYPB1Wn1UEI1/L+xQ==", + "dev": true, + "dependencies": { + "minimist": "^1.2.5" + }, + "bin": { + "mkdirp": "bin/cmd.js" + } + }, + "node_modules/ms": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", + "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", + "dev": true + }, + "node_modules/nconf": { + "version": "0.11.3", + "resolved": "https://registry.npmjs.org/nconf/-/nconf-0.11.3.tgz", + "integrity": "sha512-iYsAuDS9pzjVMGIzJrGE0Vk3Eh8r/suJanRAnWGBd29rVS2XtSgzcAo5l6asV3e4hH2idVONHirg1efoBOslBg==", + "dev": true, + "dependencies": { + "async": "^1.4.0", + "ini": "^2.0.0", + "secure-keys": "^1.0.0", + "yargs": "^16.1.1" + }, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/nconf/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/nconf/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/nconf/node_modules/cliui": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", + "integrity": "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==", + "dev": true, + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" + } + }, + "node_modules/nconf/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/nconf/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/nconf/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true + }, + "node_modules/nconf/node_modules/ini": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz", + "integrity": "sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/nconf/node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/nconf/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/nconf/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/nconf/node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/nconf/node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/nconf/node_modules/yargs": { + "version": "16.2.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", + "integrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==", + "dev": true, + "dependencies": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/nconf/node_modules/yargs-parser": { + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/node-domexception": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz", + "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/jimmywarting" + }, + { + "type": "github", + "url": "https://paypal.me/jimmywarting" + } + ], + "engines": { + "node": ">=10.5.0" + } + }, + "node_modules/node-environment-flags": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.6.tgz", + "integrity": "sha512-5Evy2epuL+6TM0lCQGpFIj6KwiEsGh1SrHUhTbNX+sLbBtjidPZFAnVK9y5yU1+h//RitLbRHTIMyxQPtxMdHw==", + "dev": true, + "dependencies": { + "object.getownpropertydescriptors": "^2.0.3", + "semver": "^5.7.0" + } + }, + "node_modules/node-fetch": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.0.tgz", + "integrity": "sha512-BKwRP/O0UvoMKp7GNdwPlObhYGB5DQqwhEDQlNKuoqwVYSxkSZCSbHjnFFmUEtwSKRPU4kNK8PbDYYitwaE3QA==", + "dependencies": { + "data-uri-to-buffer": "^4.0.0", + "fetch-blob": "^3.1.4", + "formdata-polyfill": "^4.0.10" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/node-fetch" + } + }, + "node_modules/nopt": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/nopt/-/nopt-5.0.0.tgz", + "integrity": "sha512-Tbj67rffqceeLpcRXrT7vKAN8CwfPeIBgM7E6iBkmKLV7bEMwpGgYLGv0jACUsECaa/vuxP0IjEont6umdMgtQ==", + "dev": true, + "dependencies": { + "abbrev": "1" + }, + "bin": { + "nopt": "bin/nopt.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/nth-check": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-1.0.2.tgz", + "integrity": "sha512-WeBOdju8SnzPN5vTUJYxYUxLeXpCaVP5i5e0LF8fg7WORF2Wd7wFX/pk0tYZk7s8T+J7VLy0Da6J1+wCT0AtHg==", + "dev": true, + "dependencies": { + "boolbase": "~1.0.0" + } + }, + "node_modules/oauth-sign": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", + "integrity": "sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==", + "engines": { + "node": "*" + } + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.11.0.tgz", + "integrity": "sha512-jp7ikS6Sd3GxQfZJPyH3cjcbJF6GZPClgdV+EFygjFLQ5FmW/dRUnTd9PQ9k0JhoNDabWFbpF1yCdSWCC6gexg==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.0.tgz", + "integrity": "sha512-exHJeq6kBKj58mqGyTQ9DFvrZC/eR6OwxzoM9YRoGBqrXYonaFyGiFMuc9VZrXf7DarreEwMpurG3dd+CNyW5w==", + "dev": true, + "dependencies": { + "define-properties": "^1.1.2", + "function-bind": "^1.1.1", + "has-symbols": "^1.0.0", + "object-keys": "^1.0.11" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.getownpropertydescriptors": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.1.2.tgz", + "integrity": "sha512-WtxeKSzfBjlzL+F9b7M7hewDzMwy+C8NRssHd1YrNlzHzIDrXcXiNOMrezdAEM4UXixgV+vvnyBeN7Rygl2ttQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.18.0-next.2" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/opn": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/opn/-/opn-3.0.3.tgz", + "integrity": "sha1-ttmec5n3jWXDuq/+8fsojpuFJDo=", + "dev": true, + "dependencies": { + "object-assign": "^4.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/performance-now": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", + "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=" + }, + "node_modules/picomatch": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.0.tgz", + "integrity": "sha512-lY1Q/PiJGC2zOv/z391WOTD+Z02bCgsFfvxoXXf6h7kv9o+WmsmzYqrAwY63sNgOxE4xEdq0WyUnXfKeBrSvYw==", + "dev": true, + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/proto-list": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", + "integrity": "sha1-IS1b/hMYMGpCD2QCuOJv85ZHqEk=", + "dev": true + }, + "node_modules/pseudomap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz", + "integrity": "sha1-8FKijacOYYkX7wqKw0wa5aaChrM=", + "dev": true + }, + "node_modules/psl": { + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.8.0.tgz", + "integrity": "sha512-RIdOzyoavK+hA18OGGWDqUTsCLhtA7IcZ/6NCs4fFJaHBDab+pDDmDIByWFRQJq2Cd7r1OoQxBGKOaztq+hjIQ==" + }, + "node_modules/punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "engines": { + "node": ">=6" + } + }, + "node_modules/qs": { + "version": "6.5.2", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", + "integrity": "sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/readable-stream": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz", + "integrity": "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==", + "dev": true, + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/readdirp": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.2.0.tgz", + "integrity": "sha512-crk4Qu3pmXwgxdSgGhgA/eXiJAPQiX4GMOZZMXnqKxHX7TaoL+3gQVo/WeuAiogr07DpnfjIMpXXa+PAIvwPGQ==", + "dev": true, + "dependencies": { + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/render": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/render/-/render-0.1.4.tgz", + "integrity": "sha1-z7M6NOJgaFkdQYRp4j2Mxc4c7/U=", + "dev": true, + "dependencies": { + "traverser": "0.0.x" + } + }, + "node_modules/render/node_modules/traverser": { + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/traverser/-/traverser-0.0.5.tgz", + "integrity": "sha1-xm84xFagwhqIAUsSI1gMfr4GMes=", + "dev": true, + "dependencies": { + "curry": "0.0.x" + }, + "engines": { + "node": "*" + } + }, + "node_modules/request": { + "version": "2.88.2", + "resolved": "https://registry.npmjs.org/request/-/request-2.88.2.tgz", + "integrity": "sha512-MsvtOrfG9ZcrOwAW+Qi+F6HbD0CWXEh9ou77uOb7FM2WPhwT7smM833PzanhJLsgXjN89Ir6V2PczXNnMpwKhw==", + "deprecated": "request has been deprecated, see https://github.com/request/request/issues/3142", + "dependencies": { + "aws-sign2": "~0.7.0", + "aws4": "^1.8.0", + "caseless": "~0.12.0", + "combined-stream": "~1.0.6", + "extend": "~3.0.2", + "forever-agent": "~0.6.1", + "form-data": "~2.3.2", + "har-validator": "~5.1.3", + "http-signature": "~1.2.0", + "is-typedarray": "~1.0.0", + "isstream": "~0.1.2", + "json-stringify-safe": "~5.0.1", + "mime-types": "~2.1.19", + "oauth-sign": "~0.9.0", + "performance-now": "^2.1.0", + "qs": "~6.5.2", + "safe-buffer": "^5.1.2", + "tough-cookie": "~2.5.0", + "tunnel-agent": "^0.6.0", + "uuid": "^3.3.2" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-main-filename": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz", + "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", + "dev": true + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" + }, + "node_modules/secure-keys": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/secure-keys/-/secure-keys-1.0.0.tgz", + "integrity": "sha1-8MgtmKOxOah3aogIBQuCRDEIf8o=", + "dev": true + }, + "node_modules/semver": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", + "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", + "dev": true, + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/set-blocking": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", + "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", + "dev": true + }, + "node_modules/should": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/should/-/should-8.0.2.tgz", + "integrity": "sha1-2UvEWazsiCMLK8c2GtA6s4eyM8Y=", + "dev": true, + "dependencies": { + "should-equal": "0.6.0", + "should-format": "0.3.2", + "should-type": "0.2.0" + } + }, + "node_modules/should-equal": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/should-equal/-/should-equal-0.6.0.tgz", + "integrity": "sha1-W0cDA6iPW5YKfRCRciS0VU2rRww=", + "dev": true, + "dependencies": { + "should-type": "0.2.0" + } + }, + "node_modules/should-format": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/should-format/-/should-format-0.3.2.tgz", + "integrity": "sha1-pZgx4Bot3uFJkRvHFIvlyAMZ4f8=", + "dev": true, + "dependencies": { + "should-type": "0.2.0" + } + }, + "node_modules/should-type": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/should-type/-/should-type-0.2.0.tgz", + "integrity": "sha1-ZwfvlVKdmJ3MCY/gdTqx+RNrt/Y=", + "dev": true + }, + "node_modules/sigmund": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/sigmund/-/sigmund-1.0.1.tgz", + "integrity": "sha1-P/IfGYytIXX587eBhT/ZTQ0ZtZA=", + "dev": true + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", + "dev": true + }, + "node_modules/sshpk": { + "version": "1.16.1", + "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.16.1.tgz", + "integrity": "sha512-HXXqVUq7+pcKeLqqZj6mHFUMvXtOJt1uoUx09pFW6011inTMxqI8BA8PM95myrIyyKwdnzjdFjLiE6KBPVtJIg==", + "dependencies": { + "asn1": "~0.2.3", + "assert-plus": "^1.0.0", + "bcrypt-pbkdf": "^1.0.0", + "dashdash": "^1.12.0", + "ecc-jsbn": "~0.1.1", + "getpass": "^0.1.1", + "jsbn": "~0.1.0", + "safer-buffer": "^2.0.2", + "tweetnacl": "~0.14.0" + }, + "bin": { + "sshpk-conv": "bin/sshpk-conv", + "sshpk-sign": "bin/sshpk-sign", + "sshpk-verify": "bin/sshpk-verify" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stream-spec": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/stream-spec/-/stream-spec-0.3.6.tgz", + "integrity": "sha1-L92sSge/Pp+JY8Z3prWmzCEVJV4=", + "dev": true, + "dependencies": { + "macgyver": "~1.10" + } + }, + "node_modules/stream-tester": { + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/stream-tester/-/stream-tester-0.0.5.tgz", + "integrity": "sha1-T4byUxFJra9t1LP/Ji7fZK6aFxo=", + "dev": true, + "dependencies": { + "assertions": "~2.3.0", + "from": "~0.0.2", + "through": "~0.0.3" + } + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "dev": true, + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/string-width": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", + "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", + "dev": true, + "dependencies": { + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^4.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/string.prototype.trimend": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", + "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimstart": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", + "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/strip-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", + "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", + "dev": true, + "dependencies": { + "ansi-regex": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/supports-color": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", + "integrity": "sha512-on9Kwidc1IUQo+bQdhi8+Tijpo0e1SS6RoGo2guUwn5vdaxw8RXOF9Vb2ws+ihWOmh4JnCJOvaziZWP1VABaLg==", + "dev": true, + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/through": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/through/-/through-0.0.4.tgz", + "integrity": "sha1-C/Lw//r6rEusvFM2Z+mKrQC1iMg=", + "dev": true + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/tough-cookie": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.5.0.tgz", + "integrity": "sha512-nlLsUzgm1kfLXSXfRZMc1KLAugd4hqJHDTvc2hDIwS3mZAfMEuMbc03SujMF+GEcpaX/qboeycw6iO8JwVv2+g==", + "dependencies": { + "psl": "^1.1.28", + "punycode": "^2.1.1" + }, + "engines": { + "node": ">=0.8" + } + }, + "node_modules/traverser": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/traverser/-/traverser-1.0.0.tgz", + "integrity": "sha1-b1nlgTdZruqzZGuPRRP9SmLk/iA=", + "dev": true, + "dependencies": { + "curry": "0.0.x" + }, + "engines": { + "node": "*" + } + }, + "node_modules/tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0=", + "dependencies": { + "safe-buffer": "^5.0.1" + }, + "engines": { + "node": "*" + } + }, + "node_modules/tweetnacl": { + "version": "0.14.5", + "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", + "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=" + }, + "node_modules/typescript": { + "version": "4.9.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.4.tgz", + "integrity": "sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/unbox-primitive": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", + "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "has-bigints": "^1.0.1", + "has-symbols": "^1.0.2", + "which-boxed-primitive": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/underscore": { + "version": "1.13.1", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.1.tgz", + "integrity": "sha512-hzSoAVtJF+3ZtiFX0VgfFPHEDRm7Y/QPjGyNo4TVdnDTdft3tr8hEkD25a1jC+TjTuE7tkHGKkhwCgs9dgBB2g==", + "dev": true + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=", + "dev": true + }, + "node_modules/uuid": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", + "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==", + "deprecated": "Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.", + "bin": { + "uuid": "bin/uuid" + } + }, + "node_modules/verror": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", + "integrity": "sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA=", + "engines": [ + "node >=0.6.0" + ], + "dependencies": { + "assert-plus": "^1.0.0", + "core-util-is": "1.0.2", + "extsprintf": "^1.2.0" + } + }, + "node_modules/web-streams-polyfill": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.2.1.tgz", + "integrity": "sha512-e0MO3wdXWKrLbL0DgGnUV7WHVuw9OUvL4hjgnPkIeEvESk74gAITi5G606JtZPp39cd8HA9VQzCIvA49LpPN5Q==", + "engines": { + "node": ">= 8" + } + }, + "node_modules/which": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", + "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "which": "bin/which" + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "dependencies": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-module": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", + "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=", + "dev": true + }, + "node_modules/wide-align": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.3.tgz", + "integrity": "sha512-QGkOQc8XL6Bt5PwnsExKBPuMKBxnGxWWW3fU55Xt4feHozMUhdUMaBCk290qpm/wG5u/RSKzwdAC4i51YigihA==", + "dev": true, + "dependencies": { + "string-width": "^1.0.2 || 2" + } + }, + "node_modules/wrap-ansi": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", + "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", + "dev": true, + "dependencies": { + "ansi-styles": "^3.2.0", + "string-width": "^3.0.0", + "strip-ansi": "^5.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrap-ansi/node_modules/ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrap-ansi/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrap-ansi/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "node_modules/y18n": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", + "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", + "dev": true + }, + "node_modules/yallist": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", + "integrity": "sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=", + "dev": true + }, + "node_modules/yargs": { + "version": "13.3.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.2.tgz", + "integrity": "sha512-AX3Zw5iPruN5ie6xGRIDgqkT+ZhnRlZMLMHAs8tg7nRruy2Nb+i5o9bwghAogtM08q1dpr2LVoS8KSTMYpWXUw==", + "dev": true, + "dependencies": { + "cliui": "^5.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^13.1.2" + } + }, + "node_modules/yargs-parser": { + "version": "13.1.2", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz", + "integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==", + "dev": true, + "dependencies": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + } + }, + "node_modules/yargs-unparser": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/yargs-unparser/-/yargs-unparser-1.6.0.tgz", + "integrity": "sha512-W9tKgmSn0DpSatfri0nx52Joq5hVXgeLiqR/5G0sZNDoLZFOr/xjBUDcShCOGNsBnEMNo1KAMBkTej1Hm62HTw==", + "dev": true, + "dependencies": { + "flat": "^4.1.0", + "lodash": "^4.17.15", + "yargs": "^13.3.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + } + }, "dependencies": { "@hapi/accept": { "version": "5.0.2", @@ -426,7 +3455,7 @@ "integrity": "sha1-qUM87R/OV8yZmvCWXRAI6WwnluY=", "dev": true, "requires": { - "fomatto": "fomatto@git://github.com/BonsaiDen/Fomatto.git#468666f600b46f9067e3da7200fd9df428923ea6", + "fomatto": "git://github.com/BonsaiDen/Fomatto.git#468666f600b46f9067e3da7200fd9df428923ea6", "render": "0.1", "traverser": "1" } @@ -724,6 +3753,11 @@ "assert-plus": "^1.0.0" } }, + "data-uri-to-buffer": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.0.tgz", + "integrity": "sha512-Vr3mLBA8qWmcuschSLAOogKgQ/Jwxulv3RNE4FXnYWRGujzrRWQI4m12fQqRkwX06C0KanhLr4hK+GydchZsaA==" + }, "debug": { "version": "3.2.6", "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz", @@ -926,6 +3960,15 @@ "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" }, + "fetch-blob": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz", + "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==", + "requires": { + "node-domexception": "^1.0.0", + "web-streams-polyfill": "^3.0.3" + } + }, "fill-range": { "version": "7.0.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", @@ -963,8 +4006,9 @@ }, "fomatto": { "version": "git+ssh://git@github.com/BonsaiDen/Fomatto.git#468666f600b46f9067e3da7200fd9df428923ea6", - "from": "fomatto@git://github.com/BonsaiDen/Fomatto.git#468666f600b46f9067e3da7200fd9df428923ea6", - "dev": true + "integrity": "sha512-2JeZCbUi12tmDJhd9F3mxZ6xL0+2Ym2MamXZHnHh5OVKKA1h/6svVAAzJ2tt5ycFAQ4EwseW3FoAFNUle/opbQ==", + "dev": true, + "from": "fomatto@git://github.com/BonsaiDen/Fomatto.git#468666f600b46f9067e3da7200fd9df428923ea6" }, "forever-agent": { "version": "0.6.1", @@ -981,6 +4025,14 @@ "mime-types": "^2.1.12" } }, + "formdata-polyfill": { + "version": "4.0.10", + "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz", + "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==", + "requires": { + "fetch-blob": "^3.1.2" + } + }, "from": { "version": "0.0.2", "resolved": "https://registry.npmjs.org/from/-/from-0.0.2.tgz", @@ -1682,6 +4734,11 @@ } } }, + "node-domexception": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz", + "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==" + }, "node-environment-flags": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.6.tgz", @@ -1692,6 +4749,16 @@ "semver": "^5.7.0" } }, + "node-fetch": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.0.tgz", + "integrity": "sha512-BKwRP/O0UvoMKp7GNdwPlObhYGB5DQqwhEDQlNKuoqwVYSxkSZCSbHjnFFmUEtwSKRPU4kNK8PbDYYitwaE3QA==", + "requires": { + "data-uri-to-buffer": "^4.0.0", + "fetch-blob": "^3.1.4", + "formdata-polyfill": "^4.0.10" + } + }, "nopt": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/nopt/-/nopt-5.0.0.tgz", @@ -2044,6 +5111,15 @@ "through": "~0.0.3" } }, + "string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "dev": true, + "requires": { + "safe-buffer": "~5.2.0" + } + }, "string-width": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", @@ -2074,15 +5150,6 @@ "define-properties": "^1.1.3" } }, - "string_decoder": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", - "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", - "dev": true, - "requires": { - "safe-buffer": "~5.2.0" - } - }, "strip-ansi": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", @@ -2153,6 +5220,12 @@ "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=" }, + "typescript": { + "version": "4.9.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.4.tgz", + "integrity": "sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg==", + "dev": true + }, "unbox-primitive": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", @@ -2200,6 +5273,11 @@ "extsprintf": "^1.2.0" } }, + "web-streams-polyfill": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.2.1.tgz", + "integrity": "sha512-e0MO3wdXWKrLbL0DgGnUV7WHVuw9OUvL4hjgnPkIeEvESk74gAITi5G606JtZPp39cd8HA9VQzCIvA49LpPN5Q==" + }, "which": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", diff --git a/package.json b/package.json index 32d7db9..f57c965 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,19 @@ { "name": "dropbox-v2-api", - "version": "2.5.9", + "version": "2.5.10-next.2", "description": "NodeJS Dropbox v2 API wrapper", - "main": "index.js", + "main": "dist/cjs/index-cjs.js", + "module": "dist/mjs/index-mjs.js", + "exports": { + ".": { + "import": "./dist/mjs/index-mjs.js", + "require": "./dist/cjs/index-cjs.js" + } + }, + "type": "module", "scripts": { + "postinstall": "npm run build", + "build": "rm -fr dist/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && ./fixup", "generate": "node generate.js", "test": "mocha test/**/*.js" }, @@ -22,6 +32,7 @@ "license": "ISC", "dependencies": { "compress-json": "2.1.2", + "node-fetch": "3.3.0", "request": "2.88.2" }, "devDependencies": { @@ -38,6 +49,7 @@ "should": "8.0.2", "stream-spec": "0.3.6", "stream-tester": "0.0.5", + "typescript": "4.9.4", "underscore": "^1.13.1" } -} \ No newline at end of file +} diff --git a/src/dropbox-api-test.js b/src/dropbox-api-test.js index 46d76c3..8c2aed5 100644 --- a/src/dropbox-api-test.js +++ b/src/dropbox-api-test.js @@ -1,6 +1,5 @@ -let TEST_LIB_NAME; +import dropboxV2Api from './dropbox-api.js'; + +export default dropboxV2Api; -TEST_LIB_NAME = './dropbox-api.js'; -// TEST_LIB_NAME = 'dropbox-v2-api'; -module.exports = require(TEST_LIB_NAME); \ No newline at end of file diff --git a/src/dropbox-api.js b/src/dropbox-api.js index 961fa69..2327365 100644 --- a/src/dropbox-api.js +++ b/src/dropbox-api.js @@ -1,7 +1,10 @@ -const request = require('request'); -const stream = require('stream'); -const {decompress} = require("compress-json"); -const apiJSON = require('./api.json'); +import request from 'request'; +import stream from 'stream'; +import {decompress} from "compress-json"; +import { readFile } from 'fs/promises'; + +import { dirname, join } from 'path' +import { fileURLToPath } from 'url' const RPC_RESOURCE_CATEGORY = 'rpc'; const UPLOAD_RESOURCE_CATEGORY = 'upload'; @@ -56,7 +59,7 @@ const updateRequestOptsFnList = [ } ]; -const resourcesDescriptionList = loadResourcesDescriptionList(); + //------------------------------------------------------------------------------------ @@ -147,7 +150,10 @@ function generateResourcesHandlingFunctions(resourcesDescriptionList, config) { return resourcesHandlingFunctions; } -module.exports = { +export default function init(apiDesc) { + let resourcesDescriptionList = loadResourcesDescriptionList(apiDesc); + + return { authenticate: function (config) { const resourceHandlingFunctions = generateResourcesHandlingFunctions(resourcesDescriptionList, config); const clientSession = function (userOpt, cb) { @@ -212,6 +218,7 @@ module.exports = { return clientSession; } } +} function throwError(content) { throw content; @@ -226,7 +233,7 @@ function createTransformStream() { return streamInstance; } -function loadResourcesDescriptionList() { +function loadResourcesDescriptionList(apiJSON) { return decompress(apiJSON); } diff --git a/src/generate-api-description.js b/src/generate-api-description.js index 7960c66..1c076b6 100644 --- a/src/generate-api-description.js +++ b/src/generate-api-description.js @@ -1,34 +1,10 @@ -var cheerio = require('cheerio'); -var request = require('request'); -var fs = require('fs'); -var async = require('async'); -var _ = require('underscore'); -const compressor = require('compress-json'); +import request from 'request'; +import fs from 'fs'; +import compressor from 'compress-json'; //------------------------------------------- +export default generateApiDescription; -var $, - HEADER_AUTH = '--header \"Authorization: Bearer', - HEADER_CT_OCTET_STREAM = '--header \"Content-Type: application/octet-stream', - ENDPOINT_RPC = 'api.dropboxapi.com', - ENDPOINT_CONTENT = 'content.dropboxapi.com', - utils = { - contains: function (text, sub) { - return (text.indexOf(sub) > -1); - }, - hasClass: function (className, classText) { - return classText.trim().split(' ').indexOf(className) > -1; - }, - getTextNode: function (arr) { - var node = _.filter(arr, function (item) { - return item.type === 'text'; - }); - return _.pluck(node, 'data').join(' ').trim(); - } - }; - -module.exports = generateApiDescription2 - -async function generateApiDescription2(cb) { +async function generateApiDescription(cb) { const NAMESPACES = ['account', 'auth', 'check', 'contacts', 'file_properties', 'file_requests', 'files', 'sharing', 'users'] let error = null; const apiExamples = {}; @@ -50,14 +26,11 @@ async function generateApiDescription2(cb) { console.log(error) } - if (cb) { cb(error, apiExamples); } else { - // fs.writeFileSync('./dist/api.json', JSON.stringify(apiExamples, null, '\t')); fs.writeFileSync('./src/api.json', JSON.stringify(compressor.compress(apiExamples))); } - } function fetchNamespace(NAMESPACE) { @@ -81,221 +54,4 @@ function fetchNamespace(NAMESPACE) { resolve(body.route_groups.map(a => a.routeVersions).flat()); }) }) -} - -//------------------------------------------- - -function getAPIDescriptionElems() { - var resp = $('.documentation__routes'); - var namespaces = _.map(resp.children(), function (sectionChild) { - var namespace = { - name: sectionChild.attribs.id.replace(/\s/, ''), - }; - var methodDescWrapElems = _.map(sectionChild.children, function (child, i) { - if (child.attribs && child.attribs.class && utils.hasClass('toc-el', child.attribs.class)) { - return child; - } - }); - namespace.el = _.compact(methodDescWrapElems); - return namespace; - }); - return namespaces; -} - -function getTextByElem(el) { - el.find('br').replaceWith('\n'); - const links = el.find('a'); - let text = el.text(); - if (links.length > 0) { - _.each(links, (link, i) => { - link = links.eq(i); - const linkText = link.text(); - const linkHref = link.attr('href').replace(/-/g, ''); - if ('#' + linkText === linkHref || linkHref[0] !== '#') return; - link.text(`[${linkText}](${linkHref}-see-docs)`); - }); - } - text = el.text(); - return text.replace(/\n/g, ' ').trim(); -} - -function getTextByElem2(el) { - return el.text().trim().replace(/\\s+/g, ' '); -} - -function getExampleData(el) { - return el.find('pre').text(); -} - -function getReturns(el) { - const parametersExample = el.find('.literal-block').eq(0).text(); - let parametersExampleObject = null; - if (parametersExample.length > 0) { - parametersExampleObject = JSON.parse(parametersExample); - } - return parametersExampleObject; -} - -function getParameterList(el) { - - const parametersExample = el.find('.literal-block').eq(0).text(); - let parametersExampleObject = null; - if (parametersExample.length > 0) { - parametersExampleObject = JSON.parse(parametersExample); - } - - return { - list: getParameterListInner(el), - example: parametersExampleObject - }; - - function getParameterListInner(el) { - return _.map(el.find('.field'), function (item) { - var desc = utils.getTextNode(item.children); - item = $(item); - var nestedWrap = item.find('.nested-child'); - if (!!nestedWrap.length) { - const name = item.find('b code').eq(0).text(); - return { - name, - type: item.find('.type').eq(0).text(), - desc: desc, - parameters: _.flatten(_.map(nestedWrap, function (item) { - return getParameterList($(item)) - })) - }; - } else { - const name = item.find('b code').text(); - return { - name, - type: item.find('.type').text(), - desc: desc - }; - } - - }); - } -} - -function parseMethodElement(wrap) { - var parsers = { - 'Description': getTextByElem, - 'URL Structure': getTextByElem2, - 'Parameters': getParameterList, - 'Returns': getReturns, - 'Endpoint format': function (elem) { - const endpointCategory = elem.text().trim().toLowerCase(); - const categories = { - 'rpc': 'RPC', - 'content-upload': 'UPLOAD', - 'content-download': 'DOWNLOAD' - }; - return categories[endpointCategory] || null; - }, - 'Example': getExampleData - }; - - var h3 = wrap.find('h3'); - var dl = wrap.find('dl'); - - var dts = $(dl).find('dt'); - - var apiMethod = { - name: h3.text() - }; - _.each(dts, function (dt, i) { - var name = $(dts[i]).text(); - var valueEl = $(dt.nextSibling.nextSibling); - if (parsers[name]) { - var value = parsers[name](valueEl); - apiMethod[name] = value - } else { - // console.log('no parser for', name); - } - }); - return apiMethod; -} - -function generateApiDescription(cb) { - request('https://www.dropbox.com/developers/documentation/http/documentation', function (err, resp, body) { - if (err) { - console.log('could not retrive documentaion page...'); - return cb ? cb(err) : err; - } - parseBody(body); - }); - - function parseBody(body) { - $ = cheerio.load(body); - var fullApi = _.map(getAPIDescriptionElems(), function (section) { - return { - name: section.name, - methods: _.map(section.el, function (el) { - var methodDescription = parseMethodElement($(el)); - return methodDescription; - }) - }; - }); - const fullApiObject = parseApiDescription(fullApi); - const fullApiContent = JSON.stringify(fullApiObject, null, '\t'); - - const apiObject = createApiObject(fullApiObject); - const apiContent = JSON.stringify(apiObject, null, '\t'); - - if (cb) { - cb(null, fullApiContent); - } else { - fs.writeFileSync('./dist/api.json', apiContent); - fs.writeFileSync('./dist/api-examples.json', fullApiContent); - } - - console.log('api description has been generated...'); - - } -} - -function createApiObject(fullApiObject) { - Object.keys(fullApiObject).forEach((name => { - const apiDescription = fullApiObject[name]; - delete apiDescription.description; - delete apiDescription.returnParameters; - delete apiDescription.parameters.example; - apiDescription.parameters.available = apiDescription.parameters.list.length > 0; - delete apiDescription.parameters.list; - - })); - return fullApiObject; -} - -function parseApiDescription(apiDescription) { - var parsedApiDescription = {}; - _.each(apiDescription, function (namespace) { - var namespaceName = namespace.name; - _.each(namespace.methods, function (method) { - - var methodName = method.name.substr(1); - var resourceName = [namespaceName, methodName].join('/'); - - var methodUri = method['URL Structure']; - var methodExample = method['Example'] || null; - var methodParameters = method['Parameters'] || []; - var returnParameters = method['Returns'] || null; - var endpointFormat = method['Endpoint format'] || null; - var description = method['Description'] || null; - - var requiresAuthHeader = methodExample === null ? true : utils.contains(methodExample, HEADER_AUTH); - var requiresReadableStream = methodExample === null ? false : utils.contains(methodExample, HEADER_CT_OCTET_STREAM); - - parsedApiDescription[resourceName] = { - uri: methodUri, - requiresAuthHeader: requiresAuthHeader, - requiresReadableStream: requiresReadableStream, - category: endpointFormat, - description: description, - parameters: methodParameters, - returnParameters: returnParameters - }; - }); - }); - return parsedApiDescription; -} +} \ No newline at end of file diff --git a/src/generate-api-examples.js b/src/generate-api-examples.js index e2293bf..ef79521 100644 --- a/src/generate-api-examples.js +++ b/src/generate-api-examples.js @@ -1,9 +1,15 @@ -const fs = require('fs'); -const path = require('path'); -const ejs = require('ejs'); -const beautify = require('js-beautify').js_beautify; +import fs from 'fs'; +import path from 'path'; +import ejs from 'ejs'; +import beautify from 'js-beautify'; -var parsedApiDescription = JSON.parse(fs.readFileSync(path.join(__dirname, '../dist/api.json'))); +import { fileURLToPath } from 'url'; +import {decompress} from "compress-json"; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = path.dirname(__filename); + +var parsedApiDescription = decompress(JSON.parse(fs.readFileSync(path.join(__dirname, './api.json')))); const options = {}; const apiNameList = Object.keys(parsedApiDescription); @@ -28,7 +34,6 @@ ${example.code} fs.writeFileSync('EXAMPLES.md', mdContent.join('\n')); - function prepareExampleByApiDescription(apiDescription, apiName){ function prepareUrl() { @@ -66,7 +71,7 @@ parameters: <%- JSON.stringify(request.example[0].value, null, '') %> <% } %>}, } const template = ejs.compile(templates[apiDescription.format], options); - const code = beautify(template(apiDescription), { indent_size: 4 }).replace(/\"/g, '\''); + const code = beautify.js_beautify(template(apiDescription), { indent_size: 4 }).replace(/\"/g, '\''); return { docs: prepareUrl(), diff --git a/src/index-cjs.js b/src/index-cjs.js new file mode 100644 index 0000000..c35a2f1 --- /dev/null +++ b/src/index-cjs.js @@ -0,0 +1,7 @@ +import { readFileSync } from 'fs'; +import { join } from 'path'; +import init from './dropbox-api.js' + +const apiDescription = JSON.parse(readFileSync(join(__dirname, 'api.json')).toString()); + +export const authenticate = init(apiDescription).authenticate; diff --git a/src/index-mjs.js b/src/index-mjs.js new file mode 100644 index 0000000..ac2a29b --- /dev/null +++ b/src/index-mjs.js @@ -0,0 +1,11 @@ +import { readFile } from 'fs/promises'; +import init from './dropbox-api.js' + +const apiJSON = JSON.parse( + await readFile( + new URL('./api.json', import.meta.url) + ) +); + +export default init(apiJSON) + diff --git a/src/utils.js b/src/utils.js index 372b0c9..0cdc658 100644 --- a/src/utils.js +++ b/src/utils.js @@ -1,4 +1,4 @@ -const tester = require('stream-tester'); +import tester from 'stream-tester'; /** * Creates read stream, which generates length-sized stream of characters (sign) @@ -10,6 +10,6 @@ function createMockedReadStream(sign, length){ }, length); } -module.exports = { +export default { createMockedReadStream -}; \ No newline at end of file +} \ No newline at end of file diff --git a/test/config.js b/test/config.js index 253b7ee..3c1c795 100644 --- a/test/config.js +++ b/test/config.js @@ -1,5 +1,6 @@ -const config = require('nconf'); +import config from 'nconf'; + config.env().file({ file: './config.json' }); config.required(['DROPBOX_TOKEN']); -module.exports = config; \ No newline at end of file +export default config; \ No newline at end of file diff --git a/test/docs/docs-change-detection.js b/test/docs/docs-change-detection.js index 08b1b05..e31ec70 100644 --- a/test/docs/docs-change-detection.js +++ b/test/docs/docs-change-detection.js @@ -1,12 +1,17 @@ -const should = require('should'); -const fs = require('fs'); -const md5 = require('md5'); -const path = require('path'); -const request = require('request'); -const expect = require('expect.js'); -const generate = require('../../src/generate-api-description.js'); +import should from 'should'; +import fs from 'fs'; +import md5 from 'md5'; +import path from 'path'; +import request from 'request'; +import expect from 'expect.js'; +import generate from '../../src/generate-api-description.js'; +import { fileURLToPath } from 'url'; +import {decompress} from "compress-json"; -const API_DESC_FILE_PATH = path.join(__dirname, '../../dist/api.json'); +const __filename = fileURLToPath(import.meta.url); +const __dirname = path.dirname(__filename); + +const API_DESC_FILE_PATH = path.join(__dirname, '../../src/api.json'); describe('Docs change detection', function() { this.timeout(16000); @@ -19,14 +24,20 @@ describe('Docs change detection', function() { } }) it('contains equal content', function (done) { - const currentDocsDescription = normalizeString(fs.readFileSync(API_DESC_FILE_PATH).toString()); - generate((err, retrievedDocsDescription) => { - expect(err).to.be(null); + try { + const currentDocsDescription = normalizeString(JSON.stringify(decompress(JSON.parse(fs.readFileSync(API_DESC_FILE_PATH).toString())), null, '\t')) + generate((err, retrievedDocsDescription) => { + expect(err).to.be(null); + + retrievedDocsDescription = normalizeString(JSON.stringify(retrievedDocsDescription, null, '\t')); + expect(md5(retrievedDocsDescription)).to.be(md5(currentDocsDescription)); + done(); + }); + } catch(err) { + console.log(err); + throw err; + } - retrievedDocsDescription = normalizeString(JSON.stringify(retrievedDocsDescription, null, '\t')); - expect(md5(retrievedDocsDescription)).to.be(md5(currentDocsDescription)); - done(); - }); }); function normalizeString(str) { return str.replace(/\s+/g, ''); diff --git a/test/files/files.js b/test/files/files.js index f9ab10d..3cc3609 100644 --- a/test/files/files.js +++ b/test/files/files.js @@ -1,18 +1,11 @@ -const should = require('should'); -const spec = require('stream-spec'); - -const dropboxV2Api = require('../../src/dropbox-api-test.js'); -const utils = require('../../src/utils.js'); -const config = require('./../config.js'); +import should from 'should'; +import spec from 'stream-spec'; +import dropboxV2Api from '../../src/dropbox-api-test.js'; +import utils from '../../src/utils.js'; +import config from '../config.js'; let dropbox; -const sleep = async ms => { - return new Promise(resolve => { - setTimeout(resolve, ms); - }); -}; - describe('Namespace', function() { this.timeout(6000); before(function() { diff --git a/test/files/upload_session.js b/test/files/upload_session.js index 4c44bdc..f7b8ecd 100644 --- a/test/files/upload_session.js +++ b/test/files/upload_session.js @@ -1,9 +1,8 @@ -const should = require('should'); -const expect = require('expect.js'); - -const dropboxV2Api = require('../../src/dropbox-api-test.js'); -const utils = require('../../src/utils.js'); -const config = require('./../config.js'); +import should from 'should'; +import expect from 'expect.js'; +import dropboxV2Api from '../../src/dropbox-api-test.js'; +import utils from '../../src/utils.js'; +import config from '../config.js'; const CHUNK_LENGTH = 100; const firstUploadChunkStream = () => utils.createMockedReadStream('1', CHUNK_LENGTH); @@ -12,7 +11,7 @@ const secondUploadChunkStream = () => utils.createMockedReadStream('2', CHUNK_LE let dropbox; describe('Namespace ', function() { - this.timeout(10 * 000); + this.timeout(10 * 1000); before(function() { dropbox = dropboxV2Api.authenticate({ token: config.get('DROPBOX_TOKEN') diff --git a/test/users/users.js b/test/users/users.js index 240db8c..890b5a8 100644 --- a/test/users/users.js +++ b/test/users/users.js @@ -1,6 +1,7 @@ -const should = require('should'); -const dropboxV2Api = require('../../src/dropbox-api-test.js'); -const config = require('./../config.js'); +import should from 'should'; +import spec from 'stream-spec'; +import dropboxV2Api from '../../src/dropbox-api-test.js'; +import config from '../config.js'; let dropbox, dropboxMalformed; diff --git a/tsconfig-base.json b/tsconfig-base.json new file mode 100644 index 0000000..f077000 --- /dev/null +++ b/tsconfig-base.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "allowJs": true, + "allowSyntheticDefaultImports": true, + "baseUrl": "src", + "declaration": true, + "esModuleInterop": true, + "inlineSourceMap": false, + "lib": ["esnext"], + "listEmittedFiles": false, + "listFiles": false, + "moduleResolution": "node", + "noFallthroughCasesInSwitch": true, + "pretty": true, + "resolveJsonModule": true, + "rootDir": "src", + "skipLibCheck": true, + "strict": true, + "traceResolution": false + }, + "compileOnSave": false, + "exclude": ["node_modules", "dist"], + "include": ["src", "src/api.json"] +} \ No newline at end of file diff --git a/tsconfig-cjs.json b/tsconfig-cjs.json new file mode 100644 index 0000000..13a7594 --- /dev/null +++ b/tsconfig-cjs.json @@ -0,0 +1,8 @@ +{ + "extends": "./tsconfig-base.json", + "compilerOptions": { + "module": "commonjs", + "outDir": "dist/cjs", + "target": "es2015" + } +} \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..382b9c4 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "./tsconfig-base.json", + "compilerOptions": { + "module": "esnext", + "outDir": "dist/mjs", + "target": "esnext" + } +} \ No newline at end of file