diff --git a/ballerina/client.bal b/ballerina/client.bal index 62ac88f..d5453bb 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -109,7 +109,7 @@ public isolated client class Client { return; } - resource isolated function post 'check/app(check_app_body payload, AppHeaders headers = {}) returns inline_response_200_2|error { + resource isolated function post 'check/app(CheckAppRequest payload, AppHeaders headers = {}) returns inline_response_200|error { string resourcePath = string `/check/app`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -118,7 +118,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post 'check/user(check_user_body payload, UserHeaders headers = {}) returns inline_response_200_2|error { + resource isolated function post 'check/user(CheckUserRequest payload, UserHeaders headers = {}) returns inline_response_200|error { string resourcePath = string `/check/user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -131,7 +131,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - set_profile_photo response - resource isolated function post account/set_profile_photo(account_set_profile_photo_body payload, SetProfilePhotoHeaders headers = {}) returns inline_response_200|error { + resource isolated function post account/set_profile_photo(SetProfilePhotoRequest payload, SetProfilePhotoHeaders headers = {}) returns SetProfilePhotoResponse|error { string resourcePath = string `/account/set_profile_photo`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -144,7 +144,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - token/from_oauth1 response - resource isolated function post auth/token/from_oauth1(token_from_oauth1_body payload, TokenFromOauth1Headers headers = {}) returns inline_response_200_1|error { + resource isolated function post auth/token/from_oauth1(TokenFromOauth1Request payload, TokenFromOauth1Headers headers = {}) returns TokenFromOauth1Response|error { string resourcePath = string `/auth/token/from_oauth1`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -176,7 +176,7 @@ public isolated client class Client { # delete_manual_contacts_batch # # + headers - Headers to be sent with the request - resource isolated function post contacts/delete_manual_contacts_batch(contacts_delete_manual_contacts_batch_body payload, DeleteManualContactsBatchHeaders headers = {}) returns error? { + resource isolated function post contacts/delete_manual_contacts_batch(DeleteManualContactsBatchRequest payload, DeleteManualContactsBatchHeaders headers = {}) returns error? { string resourcePath = string `/contacts/delete_manual_contacts_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -188,7 +188,7 @@ public isolated client class Client { # properties/add # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/add(properties_add_body payload, PropertiesAddHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/add(AddPropertiesRequest payload, PropertiesAddHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/add`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -200,7 +200,7 @@ public isolated client class Client { # properties/overwrite # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/overwrite(properties_overwrite_body payload, PropertiesOverwriteHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/overwrite(OverwritePropertiesRequest payload, PropertiesOverwriteHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/overwrite`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -212,7 +212,7 @@ public isolated client class Client { # properties/remove # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/remove(properties_remove_body payload, PropertiesRemoveHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/remove(RemovePropertiesRequest payload, PropertiesRemoveHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/remove`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -225,7 +225,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - properties/search response - resource isolated function post file_properties/properties/search(properties_search_body payload, PropertiesSearchHeaders headers = {}) returns inline_response_200_3|error { + resource isolated function post file_properties/properties/search(SearchPropertiesRequest payload, PropertiesSearchHeaders headers = {}) returns inline_response_200_1|error { string resourcePath = string `/file_properties/properties/search`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -234,7 +234,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post file_properties/properties/search/'continue(search_continue_body payload, PropertiesSearchContinueHeaders headers = {}) returns inline_response_200_3|error { + resource isolated function post file_properties/properties/search/'continue(SearchPropertiesContinueRequest payload, PropertiesSearchContinueHeaders headers = {}) returns inline_response_200_1|error { string resourcePath = string `/file_properties/properties/search/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -246,7 +246,7 @@ public isolated client class Client { # properties/update # # + headers - Headers to be sent with the request - resource isolated function post file_properties/properties/update(properties_update_body payload, PropertiesUpdateHeaders headers = {}) returns error? { + resource isolated function post file_properties/properties/update(UpdatePropertiesRequest payload, PropertiesUpdateHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/properties/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -259,7 +259,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/add_for_team response - resource isolated function post file_properties/templates/add_for_team(templates_add_for_team_body payload, map headers = {}) returns inline_response_200_4|error { + resource isolated function post file_properties/templates/add_for_team(AddTemplateForTeam payload, map headers = {}) returns inline_response_200_2|error { string resourcePath = string `/file_properties/templates/add_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -271,7 +271,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/add_for_user response - resource isolated function post file_properties/templates/add_for_user(templates_add_for_user_body payload, TemplatesAddForUserHeaders headers = {}) returns inline_response_200_4|error { + resource isolated function post file_properties/templates/add_for_user(AddTemplateForUser payload, TemplatesAddForUserHeaders headers = {}) returns inline_response_200_2|error { string resourcePath = string `/file_properties/templates/add_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -284,7 +284,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/get_for_team response - resource isolated function post file_properties/templates/get_for_team(templates_get_for_team_body payload, map headers = {}) returns inline_response_200_5|error { + resource isolated function post file_properties/templates/get_for_team(GetTemplateForTeam payload, map headers = {}) returns inline_response_200_3|error { string resourcePath = string `/file_properties/templates/get_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -296,7 +296,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/get_for_user response - resource isolated function post file_properties/templates/get_for_user(templates_get_for_user_body payload, TemplatesGetForUserHeaders headers = {}) returns inline_response_200_5|error { + resource isolated function post file_properties/templates/get_for_user(GetTemplateForUserRequest payload, TemplatesGetForUserHeaders headers = {}) returns inline_response_200_3|error { string resourcePath = string `/file_properties/templates/get_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -309,7 +309,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/list_for_team response - resource isolated function post file_properties/templates/list_for_team(map headers = {}) returns inline_response_200_6|error { + resource isolated function post file_properties/templates/list_for_team(map headers = {}) returns inline_response_200_4|error { string resourcePath = string `/file_properties/templates/list_for_team`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -319,7 +319,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/list_for_user response - resource isolated function post file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns inline_response_200_6|error { + resource isolated function post file_properties/templates/list_for_user(TemplatesListForUserHeaders headers = {}) returns inline_response_200_4|error { string resourcePath = string `/file_properties/templates/list_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -329,7 +329,7 @@ public isolated client class Client { # templates/remove_for_team # # + headers - Headers to be sent with the request - resource isolated function post file_properties/templates/remove_for_team(templates_remove_for_team_body payload, map headers = {}) returns error? { + resource isolated function post file_properties/templates/remove_for_team(RemoveTemplateForTeamRequest payload, map headers = {}) returns error? { string resourcePath = string `/file_properties/templates/remove_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -340,7 +340,7 @@ public isolated client class Client { # templates/remove_for_user # # + headers - Headers to be sent with the request - resource isolated function post file_properties/templates/remove_for_user(templates_remove_for_user_body payload, TemplatesRemoveForUserHeaders headers = {}) returns error? { + resource isolated function post file_properties/templates/remove_for_user(TemplateId payload, TemplatesRemoveForUserHeaders headers = {}) returns error? { string resourcePath = string `/file_properties/templates/remove_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -353,7 +353,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/update_for_team response - resource isolated function post file_properties/templates/update_for_team(templates_update_for_team_body payload, map headers = {}) returns templates_remove_for_user_body|error { + resource isolated function post file_properties/templates/update_for_team(templates_update_for_team_body payload, map headers = {}) returns TemplateId|error { string resourcePath = string `/file_properties/templates/update_for_team`; http:Request request = new; json jsonBody = payload.toJson(); @@ -365,7 +365,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - templates/update_for_user response - resource isolated function post file_properties/templates/update_for_user(templates_update_for_user_body payload, TemplatesUpdateForUserHeaders headers = {}) returns templates_remove_for_user_body|error { + resource isolated function post file_properties/templates/update_for_user(templates_update_for_user_body payload, TemplatesUpdateForUserHeaders headers = {}) returns TemplateId|error { string resourcePath = string `/file_properties/templates/update_for_user`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -378,7 +378,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - count response - resource isolated function post file_requests/count(CountHeaders headers = {}) returns inline_response_200_7|error { + resource isolated function post file_requests/count(CountHeaders headers = {}) returns inline_response_200_5|error { string resourcePath = string `/file_requests/count`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -389,7 +389,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create response - resource isolated function post file_requests/create(file_requests_create_body payload, CreateHeaders headers = {}) returns inline_response_200_8|error { + resource isolated function post file_requests/create(file_requests_create_body payload, CreateHeaders headers = {}) returns inline_response_200_6|error { string resourcePath = string `/file_requests/create`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -402,7 +402,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete response - resource isolated function post file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns inline_response_200_9|error { + resource isolated function post file_requests/delete(file_requests_delete_body payload, DeleteHeaders headers = {}) returns inline_response_200_7|error { string resourcePath = string `/file_requests/delete`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -415,7 +415,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete_all_closed response - resource isolated function post file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns inline_response_200_9|error { + resource isolated function post file_requests/delete_all_closed(DeleteAllClosedHeaders headers = {}) returns inline_response_200_7|error { string resourcePath = string `/file_requests/delete_all_closed`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -426,7 +426,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get response - resource isolated function post file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns inline_response_200_8|error { + resource isolated function post file_requests/get(file_requests_get_body payload, GetHeaders headers = {}) returns inline_response_200_6|error { string resourcePath = string `/file_requests/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -435,7 +435,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns inline_response_200_10|error { + resource isolated function post file_requests/list/'continue(list_continue_body payload, ListContinueHeaders headers = {}) returns inline_response_200_8|error { string resourcePath = string `/file_requests/list/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -448,7 +448,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list response - resource isolated function post file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns inline_response_200_10|error { + resource isolated function post file_requests/list_v2(file_requests_list_v2_body payload, ListHeaders headers = {}) returns inline_response_200_8|error { string resourcePath = string `/file_requests/list_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -461,7 +461,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update response - resource isolated function post file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns inline_response_200_8|error { + resource isolated function post file_requests/update(file_requests_update_body payload, UpdateHeaders headers = {}) returns inline_response_200_6|error { string resourcePath = string `/file_requests/update`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -474,7 +474,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_batch/check response - resource isolated function post files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/copy_batch/check_v2(copy_batch_check_v2_body payload, CopyBatchCheckHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/files/copy_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -487,7 +487,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_batch response - resource isolated function post files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/copy_batch_v2(files_copy_batch_v2_body payload, CopyBatchHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/files/copy_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -500,7 +500,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_reference/get response - resource isolated function post files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns inline_response_200_13|error { + resource isolated function post files/copy_reference/get(copy_reference_get_body payload, CopyReferenceGetHeaders headers = {}) returns inline_response_200_11|error { string resourcePath = string `/files/copy_reference/get`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -513,7 +513,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy_reference/save response - resource isolated function post files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns inline_response_200_11|error { + resource isolated function post files/copy_reference/save(copy_reference_save_body payload, CopyReferenceSaveHeaders headers = {}) returns inline_response_200_9|error { string resourcePath = string `/files/copy_reference/save`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -526,7 +526,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - copy response - resource isolated function post files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns inline_response_200_11|error { + resource isolated function post files/copy_v2(files_copy_v2_body payload, CopyHeaders headers = {}) returns inline_response_200_9|error { string resourcePath = string `/files/copy_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -539,7 +539,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create_folder_batch response - resource isolated function post files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns inline_response_200_15|error { + resource isolated function post files/create_folder_batch(files_create_folder_batch_body payload, CreateFolderBatchHeaders headers = {}) returns inline_response_200_13|error { string resourcePath = string `/files/create_folder_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -548,7 +548,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns inline_response_200_15|error { + resource isolated function post files/create_folder_batch/'check(create_folder_batch_check_body payload, CreateFolderBatchCheckHeaders headers = {}) returns inline_response_200_13|error { string resourcePath = string `/files/create_folder_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -561,7 +561,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - create_folder response - resource isolated function post files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns inline_response_200_14|error { + resource isolated function post files/create_folder_v2(files_create_folder_v2_body payload, CreateFolderHeaders headers = {}) returns inline_response_200_12|error { string resourcePath = string `/files/create_folder_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -574,7 +574,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete_batch response - resource isolated function post files/delete_batch(files_delete_batch_body payload, DeleteBatchHeaders headers = {}) returns inline_response_200_16|error { + resource isolated function post files/delete_batch(files_delete_batch_body payload, DeleteBatchHeaders headers = {}) returns inline_response_200_14|error { string resourcePath = string `/files/delete_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -583,7 +583,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns inline_response_200_16|error { + resource isolated function post files/delete_batch/'check(delete_batch_check_body payload, DeleteBatchCheckHeaders headers = {}) returns inline_response_200_14|error { string resourcePath = string `/files/delete_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -596,7 +596,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - delete response - resource isolated function post files/delete_v2(files_delete_v2_body payload, Delete1Headers headers = {}) returns inline_response_200_11|error { + resource isolated function post files/delete_v2(files_delete_v2_body payload, Delete1Headers headers = {}) returns inline_response_200_9|error { string resourcePath = string `/files/delete_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -609,7 +609,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - download response - resource isolated function post files/download(DownloadHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/download(DownloadHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/download`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -620,7 +620,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - download_zip response - resource isolated function post files/download_zip(DownloadZipHeaders headers = {}) returns inline_response_200_14|error { + resource isolated function post files/download_zip(DownloadZipHeaders headers = {}) returns inline_response_200_12|error { string resourcePath = string `/files/download_zip`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -631,7 +631,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - export response - resource isolated function post files/export(ExportHeaders headers = {}) returns inline_response_200_18|error { + resource isolated function post files/export(ExportHeaders headers = {}) returns inline_response_200_16|error { string resourcePath = string `/files/export`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -642,7 +642,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_lock_batch response - resource isolated function post files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns inline_response_200_19|error { + resource isolated function post files/get_file_lock_batch(files_get_file_lock_batch_body payload, GetFileLockBatchHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/files/get_file_lock_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -655,7 +655,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_metadata response - resource isolated function post files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns inline_response_200_20|error { + resource isolated function post files/get_metadata(files_get_metadata_body payload, GetMetadataHeaders headers = {}) returns inline_response_200_18|error { string resourcePath = string `/files/get_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -668,7 +668,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_preview response - resource isolated function post files/get_preview(GetPreviewHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/get_preview(GetPreviewHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/get_preview`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -679,7 +679,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_temporary_link response - resource isolated function post files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns inline_response_200_21|error { + resource isolated function post files/get_temporary_link(files_get_temporary_link_body payload, GetTemporaryLinkHeaders headers = {}) returns inline_response_200_19|error { string resourcePath = string `/files/get_temporary_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -692,7 +692,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_temporary_upload_link response - resource isolated function post files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns inline_response_200_22|error { + resource isolated function post files/get_temporary_upload_link(files_get_temporary_upload_link_body payload, GetTemporaryUploadLinkHeaders headers = {}) returns inline_response_200_20|error { string resourcePath = string `/files/get_temporary_upload_link`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -705,7 +705,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_thumbnail_batch response - resource isolated function post files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns inline_response_200_24|error { + resource isolated function post files/get_thumbnail_batch(files_get_thumbnail_batch_body payload, GetThumbnailBatchHeaders headers = {}) returns inline_response_200_22|error { string resourcePath = string `/files/get_thumbnail_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -718,7 +718,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_thumbnail response - resource isolated function post files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns inline_response_200_23|error { + resource isolated function post files/get_thumbnail_v2(GetThumbnailHeaders headers = {}) returns inline_response_200_21|error { string resourcePath = string `/files/get_thumbnail_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -729,7 +729,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folder response - resource isolated function post files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns inline_response_200_25|error { + resource isolated function post files/list_folder(files_list_folder_body payload, ListFolderHeaders headers = {}) returns inline_response_200_23|error { string resourcePath = string `/files/list_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -738,7 +738,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns inline_response_200_25|error { + resource isolated function post files/list_folder/'continue(list_folder_continue_body payload, ListFolderContinueHeaders headers = {}) returns inline_response_200_23|error { string resourcePath = string `/files/list_folder/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -764,7 +764,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folder/longpoll response - resource isolated function post files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns inline_response_200_26|error { + resource isolated function post files/list_folder/longpoll(list_folder_longpoll_body payload, ListFolderLongpollHeaders headers = {}) returns inline_response_200_24|error { string resourcePath = string `/files/list_folder/longpoll`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -777,7 +777,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_revisions response - resource isolated function post files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns inline_response_200_27|error { + resource isolated function post files/list_revisions(files_list_revisions_body payload, ListRevisionsHeaders headers = {}) returns inline_response_200_25|error { string resourcePath = string `/files/list_revisions`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -790,7 +790,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - lock_file_batch response - resource isolated function post files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns inline_response_200_19|error { + resource isolated function post files/lock_file_batch(files_lock_file_batch_body payload, LockFileBatchHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/files/lock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -803,7 +803,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move_batch/check response - resource isolated function post files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/move_batch/check_v2(move_batch_check_v2_body payload, MoveBatchCheckHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/files/move_batch/check_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -816,7 +816,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move_batch response - resource isolated function post files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns inline_response_200_12|error { + resource isolated function post files/move_batch_v2(files_move_batch_v2_body payload, MoveBatchHeaders headers = {}) returns inline_response_200_10|error { string resourcePath = string `/files/move_batch_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -829,7 +829,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - move response - resource isolated function post files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns inline_response_200_11|error { + resource isolated function post files/move_v2(files_move_v2_body payload, MoveHeaders headers = {}) returns inline_response_200_9|error { string resourcePath = string `/files/move_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -854,7 +854,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - restore response - resource isolated function post files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/restore(files_restore_body payload, RestoreHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/restore`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -867,7 +867,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - save_url response - resource isolated function post files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns inline_response_200_28|error { + resource isolated function post files/save_url(files_save_url_body payload, SaveUrlHeaders headers = {}) returns inline_response_200_26|error { string resourcePath = string `/files/save_url`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -880,7 +880,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - save_url/check_job_status response - resource isolated function post files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { + resource isolated function post files/save_url/check_job_status(save_url_check_job_status_body payload, SaveUrlCheckJobStatusHeaders headers = {}) returns inline_response_200_27|error { string resourcePath = string `/files/save_url/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -893,7 +893,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - search/continue response - resource isolated function post files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns inline_response_200_30|error { + resource isolated function post files/search/continue_v2(search_continue_v2_body payload, SearchContinueHeaders headers = {}) returns inline_response_200_28|error { string resourcePath = string `/files/search/continue_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -906,7 +906,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - search response - resource isolated function post files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns inline_response_200_30|error { + resource isolated function post files/search_v2(files_search_v2_body payload, SearchHeaders headers = {}) returns inline_response_200_28|error { string resourcePath = string `/files/search_v2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -919,7 +919,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - unlock_file_batch response - resource isolated function post files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns inline_response_200_19|error { + resource isolated function post files/unlock_file_batch(files_unlock_file_batch_body payload, UnlockFileBatchHeaders headers = {}) returns inline_response_200_17|error { string resourcePath = string `/files/unlock_file_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -932,14 +932,14 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload response - resource isolated function post files/upload(UploadHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/upload(UploadHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/upload`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/upload_session/'start(UploadSessionStartHeaders headers = {}) returns inline_response_200_32|error { + resource isolated function post files/upload_session/'start(UploadSessionStartHeaders headers = {}) returns inline_response_200_30|error { string resourcePath = string `/files/upload_session/start`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -960,7 +960,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload_session/finish response - resource isolated function post files/upload_session/finish(UploadSessionFinishHeaders headers = {}) returns inline_response_200_17|error { + resource isolated function post files/upload_session/finish(UploadSessionFinishHeaders headers = {}) returns inline_response_200_15|error { string resourcePath = string `/files/upload_session/finish`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -971,7 +971,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - upload_session/finish_batch response - resource isolated function post files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns inline_response_200_31|error { + resource isolated function post files/upload_session/finish_batch(upload_session_finish_batch_body payload, UploadSessionFinishBatchHeaders headers = {}) returns inline_response_200_29|error { string resourcePath = string `/files/upload_session/finish_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -980,7 +980,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns inline_response_200_31|error { + resource isolated function post files/upload_session/finish_batch/'check(finish_batch_check_body payload, UploadSessionFinishBatchCheckHeaders headers = {}) returns inline_response_200_29|error { string resourcePath = string `/files/upload_session/finish_batch/check`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -993,7 +993,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - add_file_member response - resource isolated function post sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns inline_response_200_33[]|error { + resource isolated function post sharing/add_file_member(sharing_add_file_member_body payload, AddFileMemberHeaders headers = {}) returns inline_response_200_31[]|error { string resourcePath = string `/sharing/add_file_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1018,7 +1018,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_job_status response - resource isolated function post sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns inline_response_200_29|error { + resource isolated function post sharing/check_job_status(sharing_check_job_status_body payload, CheckJobStatusHeaders headers = {}) returns inline_response_200_27|error { string resourcePath = string `/sharing/check_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1031,7 +1031,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_remove_member_job_status response - resource isolated function post sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns inline_response_200_34|error { + resource isolated function post sharing/check_remove_member_job_status(sharing_check_remove_member_job_status_body payload, CheckRemoveMemberJobStatusHeaders headers = {}) returns inline_response_200_32|error { string resourcePath = string `/sharing/check_remove_member_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1044,7 +1044,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - check_share_job_status response - resource isolated function post sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns inline_response_200_35|error { + resource isolated function post sharing/check_share_job_status(sharing_check_share_job_status_body payload, CheckShareJobStatusHeaders headers = {}) returns inline_response_200_33|error { string resourcePath = string `/sharing/check_share_job_status`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1057,7 +1057,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_metadata response - resource isolated function post sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns inline_response_200_36|error { + resource isolated function post sharing/get_file_metadata(sharing_get_file_metadata_body payload, GetFileMetadataHeaders headers = {}) returns inline_response_200_34|error { string resourcePath = string `/sharing/get_file_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1070,7 +1070,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_file_metadata/batch response - resource isolated function post sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns inline_response_200_37[]|error { + resource isolated function post sharing/get_file_metadata/batch(get_file_metadata_batch_body payload, GetFileMetadataBatchHeaders headers = {}) returns inline_response_200_35[]|error { string resourcePath = string `/sharing/get_file_metadata/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1083,7 +1083,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_folder_metadata response - resource isolated function post sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns inline_response_200_38|error { + resource isolated function post sharing/get_folder_metadata(sharing_get_folder_metadata_body payload, GetFolderMetadataHeaders headers = {}) returns inline_response_200_36|error { string resourcePath = string `/sharing/get_folder_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1096,7 +1096,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_shared_link_file response - resource isolated function post sharing/get_shared_link_file(GetSharedLinkFileHeaders headers = {}) returns inline_response_200_39|error { + resource isolated function post sharing/get_shared_link_file(GetSharedLinkFileHeaders headers = {}) returns inline_response_200_37|error { string resourcePath = string `/sharing/get_shared_link_file`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1107,7 +1107,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_shared_link_metadata response - resource isolated function post sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns inline_response_200_39|error { + resource isolated function post sharing/get_shared_link_metadata(sharing_get_shared_link_metadata_body payload, GetSharedLinkMetadataHeaders headers = {}) returns inline_response_200_37|error { string resourcePath = string `/sharing/get_shared_link_metadata`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1120,7 +1120,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_file_members response - resource isolated function post sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns inline_response_200_40|error { + resource isolated function post sharing/list_file_members(sharing_list_file_members_body payload, ListFileMembersHeaders headers = {}) returns inline_response_200_38|error { string resourcePath = string `/sharing/list_file_members`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1129,7 +1129,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns inline_response_200_40|error { + resource isolated function post sharing/list_file_members/'continue(list_file_members_continue_body payload, ListFileMembersContinueHeaders headers = {}) returns inline_response_200_38|error { string resourcePath = string `/sharing/list_file_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1142,7 +1142,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_file_members/batch response - resource isolated function post sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns inline_response_200_41[]|error { + resource isolated function post sharing/list_file_members/batch(list_file_members_batch_body payload, ListFileMembersBatchHeaders headers = {}) returns inline_response_200_39[]|error { string resourcePath = string `/sharing/list_file_members/batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1151,7 +1151,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns inline_response_200_42|error { + resource isolated function post sharing/list_folder_members/'continue(list_folder_members_continue_body payload, ListFolderMembersContinueHeaders headers = {}) returns inline_response_200_40|error { string resourcePath = string `/sharing/list_folder_members/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1164,7 +1164,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_folders response - resource isolated function post sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns inline_response_200_43|error { + resource isolated function post sharing/list_folders(sharing_list_folders_body payload, ListFoldersHeaders headers = {}) returns inline_response_200_41|error { string resourcePath = string `/sharing/list_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1173,7 +1173,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { + resource isolated function post sharing/list_folders/'continue(list_folders_continue_body payload, ListFoldersContinueHeaders headers = {}) returns inline_response_200_41|error { string resourcePath = string `/sharing/list_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1186,7 +1186,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_mountable_folders response - resource isolated function post sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns inline_response_200_43|error { + resource isolated function post sharing/list_mountable_folders(sharing_list_mountable_folders_body payload, ListMountableFoldersHeaders headers = {}) returns inline_response_200_41|error { string resourcePath = string `/sharing/list_mountable_folders`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1195,7 +1195,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns inline_response_200_43|error { + resource isolated function post sharing/list_mountable_folders/'continue(list_mountable_folders_continue_body payload, ListMountableFoldersContinueHeaders headers = {}) returns inline_response_200_41|error { string resourcePath = string `/sharing/list_mountable_folders/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1208,7 +1208,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_received_files response - resource isolated function post sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns inline_response_200_44|error { + resource isolated function post sharing/list_received_files(sharing_list_received_files_body payload, ListReceivedFilesHeaders headers = {}) returns inline_response_200_42|error { string resourcePath = string `/sharing/list_received_files`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1217,7 +1217,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, httpHeaders); } - resource isolated function post sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns inline_response_200_44|error { + resource isolated function post sharing/list_received_files/'continue(list_received_files_continue_body payload, ListReceivedFilesContinueHeaders headers = {}) returns inline_response_200_42|error { string resourcePath = string `/sharing/list_received_files/continue`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1230,7 +1230,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - list_shared_links response - resource isolated function post sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns inline_response_200_45|error { + resource isolated function post sharing/list_shared_links(sharing_list_shared_links_body payload, ListSharedLinksHeaders headers = {}) returns inline_response_200_43|error { string resourcePath = string `/sharing/list_shared_links`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1243,7 +1243,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - modify_shared_link_settings response - resource isolated function post sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns inline_response_200_39|error { + resource isolated function post sharing/modify_shared_link_settings(sharing_modify_shared_link_settings_body payload, ModifySharedLinkSettingsHeaders headers = {}) returns inline_response_200_37|error { string resourcePath = string `/sharing/modify_shared_link_settings`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1256,7 +1256,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - mount_folder response - resource isolated function post sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns inline_response_200_38|error { + resource isolated function post sharing/mount_folder(sharing_mount_folder_body payload, MountFolderHeaders headers = {}) returns inline_response_200_36|error { string resourcePath = string `/sharing/mount_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1281,7 +1281,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - relinquish_folder_membership response - resource isolated function post sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns inline_response_200_34|error { + resource isolated function post sharing/relinquish_folder_membership(sharing_relinquish_folder_membership_body payload, RelinquishFolderMembershipHeaders headers = {}) returns inline_response_200_32|error { string resourcePath = string `/sharing/relinquish_folder_membership`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1294,7 +1294,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - remove_file_member_2 response - resource isolated function post sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns inline_response_200_46|error { + resource isolated function post sharing/remove_file_member_2(sharing_remove_file_member_2_body payload, RemoveFileMember2Headers headers = {}) returns inline_response_200_44|error { string resourcePath = string `/sharing/remove_file_member_2`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1307,7 +1307,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - remove_folder_member response - resource isolated function post sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns inline_response_200_47|error { + resource isolated function post sharing/remove_folder_member(sharing_remove_folder_member_body payload, RemoveFolderMemberHeaders headers = {}) returns inline_response_200_45|error { string resourcePath = string `/sharing/remove_folder_member`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1332,7 +1332,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - set_access_inheritance response - resource isolated function post sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns inline_response_200_35|error { + resource isolated function post sharing/set_access_inheritance(sharing_set_access_inheritance_body payload, SetAccessInheritanceHeaders headers = {}) returns inline_response_200_33|error { string resourcePath = string `/sharing/set_access_inheritance`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1345,7 +1345,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - share_folder response - resource isolated function post sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns inline_response_200_35|error { + resource isolated function post sharing/share_folder(sharing_share_folder_body payload, ShareFolderHeaders headers = {}) returns inline_response_200_33|error { string resourcePath = string `/sharing/share_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1394,7 +1394,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - unshare_folder response - resource isolated function post sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns inline_response_200_34|error { + resource isolated function post sharing/unshare_folder(sharing_unshare_folder_body payload, UnshareFolderHeaders headers = {}) returns inline_response_200_32|error { string resourcePath = string `/sharing/unshare_folder`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1433,7 +1433,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - update_folder_policy response - resource isolated function post sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns inline_response_200_38|error { + resource isolated function post sharing/update_folder_policy(sharing_update_folder_policy_body payload, UpdateFolderPolicyHeaders headers = {}) returns inline_response_200_36|error { string resourcePath = string `/sharing/update_folder_policy`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -1489,7 +1489,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - features/get_values response - resource isolated function post team/features/get_values(features_get_values_body payload, map headers = {}) returns inline_response_200_70|error { + resource isolated function post team/features/get_values(features_get_values_body payload, map headers = {}) returns inline_response_200_68|error { string resourcePath = string `/team/features/get_values`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1501,7 +1501,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_info response - resource isolated function post team/get_info(map headers = {}) returns inline_response_200_71|error { + resource isolated function post team/get_info(map headers = {}) returns inline_response_200_69|error { string resourcePath = string `/team/get_info`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -1511,7 +1511,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/create response - resource isolated function post team/groups/create(groups_create_body payload, map headers = {}) returns inline_response_200_48|error { + resource isolated function post team/groups/create(groups_create_body payload, map headers = {}) returns inline_response_200_46|error { string resourcePath = string `/team/groups/create`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1523,7 +1523,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/delete response - resource isolated function post team/groups/delete(groups_delete_body payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/groups/delete(groups_delete_body payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/groups/delete`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1535,7 +1535,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/get_info response - resource isolated function post team/groups/get_info(groups_get_info_body payload, map headers = {}) returns inline_response_200_49[]|error { + resource isolated function post team/groups/get_info(groups_get_info_body payload, map headers = {}) returns inline_response_200_47[]|error { string resourcePath = string `/team/groups/get_info`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1547,7 +1547,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/job_status/get response - resource isolated function post team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/groups/job_status/get(job_status_get_body payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/groups/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1559,7 +1559,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/list response - resource isolated function post team/groups/list(groups_list_body payload, map headers = {}) returns inline_response_200_50|error { + resource isolated function post team/groups/list(groups_list_body payload, map headers = {}) returns inline_response_200_48|error { string resourcePath = string `/team/groups/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1567,7 +1567,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns inline_response_200_50|error { + resource isolated function post team/groups/list/'continue(list_continue_body_1 payload, map headers = {}) returns inline_response_200_48|error { string resourcePath = string `/team/groups/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1579,7 +1579,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/add response - resource isolated function post team/groups/members/add(members_add_body payload, map headers = {}) returns inline_response_200_51|error { + resource isolated function post team/groups/members/add(members_add_body payload, map headers = {}) returns inline_response_200_49|error { string resourcePath = string `/team/groups/members/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1591,7 +1591,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/list response - resource isolated function post team/groups/members/list(members_list_body payload, map headers = {}) returns inline_response_200_52|error { + resource isolated function post team/groups/members/list(members_list_body payload, map headers = {}) returns inline_response_200_50|error { string resourcePath = string `/team/groups/members/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1599,7 +1599,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns inline_response_200_52|error { + resource isolated function post team/groups/members/list/'continue(list_continue_body_2 payload, map headers = {}) returns inline_response_200_50|error { string resourcePath = string `/team/groups/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1611,7 +1611,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/remove response - resource isolated function post team/groups/members/remove(members_remove_body payload, map headers = {}) returns inline_response_200_51|error { + resource isolated function post team/groups/members/remove(members_remove_body payload, map headers = {}) returns inline_response_200_49|error { string resourcePath = string `/team/groups/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1623,7 +1623,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/members/set_access_type response - resource isolated function post team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns inline_response_200_49[]|error { + resource isolated function post team/groups/members/set_access_type(members_set_access_type_body payload, map headers = {}) returns inline_response_200_47[]|error { string resourcePath = string `/team/groups/members/set_access_type`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1635,7 +1635,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - groups/update response - resource isolated function post team/groups/update(groups_update_body payload, map headers = {}) returns inline_response_200_48|error { + resource isolated function post team/groups/update(groups_update_body payload, map headers = {}) returns inline_response_200_46|error { string resourcePath = string `/team/groups/update`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1647,7 +1647,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/create_policy response - resource isolated function post team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns inline_response_200_53|error { + resource isolated function post team/legal_holds/create_policy(legal_holds_create_policy_body payload, map headers = {}) returns inline_response_200_51|error { string resourcePath = string `/team/legal_holds/create_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1659,7 +1659,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/get_policy response - resource isolated function post team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns inline_response_200_53|error { + resource isolated function post team/legal_holds/get_policy(legal_holds_get_policy_body payload, map headers = {}) returns inline_response_200_51|error { string resourcePath = string `/team/legal_holds/get_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1671,7 +1671,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_held_revisions response - resource isolated function post team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns inline_response_200_54|error { + resource isolated function post team/legal_holds/list_held_revisions(legal_holds_list_held_revisions_body payload, map headers = {}) returns inline_response_200_52|error { string resourcePath = string `/team/legal_holds/list_held_revisions`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1683,7 +1683,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_held_revisions_continue response - resource isolated function post team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns inline_response_200_54|error { + resource isolated function post team/legal_holds/list_held_revisions_continue(legal_holds_list_held_revisions_continue_body payload, map headers = {}) returns inline_response_200_52|error { string resourcePath = string `/team/legal_holds/list_held_revisions_continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1695,7 +1695,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/list_policies response - resource isolated function post team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns inline_response_200_55|error { + resource isolated function post team/legal_holds/list_policies(legal_holds_list_policies_body payload, map headers = {}) returns inline_response_200_53|error { string resourcePath = string `/team/legal_holds/list_policies`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1718,7 +1718,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - legal_holds/update_policy response - resource isolated function post team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns inline_response_200_53|error { + resource isolated function post team/legal_holds/update_policy(legal_holds_update_policy_body payload, map headers = {}) returns inline_response_200_51|error { string resourcePath = string `/team/legal_holds/update_policy`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1771,7 +1771,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/add response - resource isolated function post team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns inline_response_200_56|error { + resource isolated function post team/member_space_limits/excluded_users/add(excluded_users_add_body payload, map headers = {}) returns inline_response_200_54|error { string resourcePath = string `/team/member_space_limits/excluded_users/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1783,7 +1783,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/list response - resource isolated function post team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns inline_response_200_57|error { + resource isolated function post team/member_space_limits/excluded_users/list(excluded_users_list_body payload, map headers = {}) returns inline_response_200_55|error { string resourcePath = string `/team/member_space_limits/excluded_users/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1791,7 +1791,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns inline_response_200_57|error { + resource isolated function post team/member_space_limits/excluded_users/list/'continue(list_continue_body_3 payload, map headers = {}) returns inline_response_200_55|error { string resourcePath = string `/team/member_space_limits/excluded_users/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1803,7 +1803,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/excluded_users/remove response - resource isolated function post team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns inline_response_200_56|error { + resource isolated function post team/member_space_limits/excluded_users/remove(excluded_users_remove_body payload, map headers = {}) returns inline_response_200_54|error { string resourcePath = string `/team/member_space_limits/excluded_users/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1815,7 +1815,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/get_custom_quota response - resource isolated function post team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { + resource isolated function post team/member_space_limits/get_custom_quota(member_space_limits_get_custom_quota_body payload, map headers = {}) returns inline_response_200_44[]|error { string resourcePath = string `/team/member_space_limits/get_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1827,7 +1827,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/remove_custom_quota response - resource isolated function post team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { + resource isolated function post team/member_space_limits/remove_custom_quota(member_space_limits_remove_custom_quota_body payload, map headers = {}) returns inline_response_200_44[]|error { string resourcePath = string `/team/member_space_limits/remove_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1839,7 +1839,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - member_space_limits/set_custom_quota response - resource isolated function post team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns inline_response_200_46[]|error { + resource isolated function post team/member_space_limits/set_custom_quota(member_space_limits_set_custom_quota_body payload, map headers = {}) returns inline_response_200_44[]|error { string resourcePath = string `/team/member_space_limits/set_custom_quota`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1851,7 +1851,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/add response - resource isolated function post team/members/add(members_add_body_1 payload, map headers = {}) returns inline_response_200_58|error { + resource isolated function post team/members/add(members_add_body_1 payload, map headers = {}) returns inline_response_200_56|error { string resourcePath = string `/team/members/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1863,7 +1863,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/add/job_status/get response - resource isolated function post team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns inline_response_200_58|error { + resource isolated function post team/members/add/job_status/get(job_status_get_body_1 payload, map headers = {}) returns inline_response_200_56|error { string resourcePath = string `/team/members/add/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1875,7 +1875,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/delete_profile_photo response - resource isolated function post team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { + resource isolated function post team/members/delete_profile_photo(members_delete_profile_photo_body payload, map headers = {}) returns inline_response_200_57|error { string resourcePath = string `/team/members/delete_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1887,7 +1887,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/get_info response - resource isolated function post team/members/get_info(members_get_info_body payload, map headers = {}) returns inline_response_200_60[]|error { + resource isolated function post team/members/get_info(members_get_info_body payload, map headers = {}) returns inline_response_200_58[]|error { string resourcePath = string `/team/members/get_info`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1899,7 +1899,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/list response - resource isolated function post team/members/list(members_list_body_1 payload, map headers = {}) returns inline_response_200_61|error { + resource isolated function post team/members/list(members_list_body_1 payload, map headers = {}) returns inline_response_200_59|error { string resourcePath = string `/team/members/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1907,7 +1907,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns inline_response_200_61|error { + resource isolated function post team/members/list/'continue(list_continue_body_4 payload, map headers = {}) returns inline_response_200_59|error { string resourcePath = string `/team/members/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1919,7 +1919,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/move_former_member_files response - resource isolated function post team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/members/move_former_member_files(members_move_former_member_files_body payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/members/move_former_member_files`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1927,7 +1927,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/members/move_former_member_files/job_status/'check(job_status_check_body payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/members/move_former_member_files/job_status/check`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1950,7 +1950,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/remove response - resource isolated function post team/members/remove(members_remove_body_1 payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/members/remove(members_remove_body_1 payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/members/remove`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1962,7 +1962,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/remove/job_status/get response - resource isolated function post team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns inline_response_200_34|error { + resource isolated function post team/members/remove/job_status/get(job_status_get_body_2 payload, map headers = {}) returns inline_response_200_32|error { string resourcePath = string `/team/members/remove/job_status/get`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1974,7 +1974,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/add response - resource isolated function post team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns inline_response_200_62|error { + resource isolated function post team/members/secondary_emails/add(secondary_emails_add_body payload, map headers = {}) returns inline_response_200_60|error { string resourcePath = string `/team/members/secondary_emails/add`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1986,7 +1986,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/delete response - resource isolated function post team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns inline_response_200_63|error { + resource isolated function post team/members/secondary_emails/delete(secondary_emails_delete_body payload, map headers = {}) returns inline_response_200_61|error { string resourcePath = string `/team/members/secondary_emails/delete`; http:Request request = new; json jsonBody = payload.toJson(); @@ -1998,7 +1998,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/secondary_emails/resend_verification_emails response - resource isolated function post team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns inline_response_200_64|error { + resource isolated function post team/members/secondary_emails/resend_verification_emails(secondary_emails_resend_verification_emails_body payload, map headers = {}) returns inline_response_200_62|error { string resourcePath = string `/team/members/secondary_emails/resend_verification_emails`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2021,7 +2021,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_admin_permissions response - resource isolated function post team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns inline_response_200_65|error { + resource isolated function post team/members/set_admin_permissions(members_set_admin_permissions_body payload, map headers = {}) returns inline_response_200_63|error { string resourcePath = string `/team/members/set_admin_permissions`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2033,7 +2033,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_profile response - resource isolated function post team/members/set_profile(members_set_profile_body payload, map headers = {}) returns inline_response_200_59|error { + resource isolated function post team/members/set_profile(members_set_profile_body payload, map headers = {}) returns inline_response_200_57|error { string resourcePath = string `/team/members/set_profile`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2045,7 +2045,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - members/set_profile_photo response - resource isolated function post team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns inline_response_200_59|error { + resource isolated function post team/members/set_profile_photo(members_set_profile_photo_body payload, map headers = {}) returns inline_response_200_57|error { string resourcePath = string `/team/members/set_profile_photo`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2079,7 +2079,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - namespaces/list response - resource isolated function post team/namespaces/list(namespaces_list_body payload, map headers = {}) returns inline_response_200_66|error { + resource isolated function post team/namespaces/list(namespaces_list_body payload, map headers = {}) returns inline_response_200_64|error { string resourcePath = string `/team/namespaces/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2087,7 +2087,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns inline_response_200_66|error { + resource isolated function post team/namespaces/list/'continue(list_continue_body_5 payload, map headers = {}) returns inline_response_200_64|error { string resourcePath = string `/team/namespaces/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2139,7 +2139,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/activate response - resource isolated function post team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/activate(team_folder_activate_body payload, map headers = {}) returns inline_response_200_65|error { string resourcePath = string `/team/team_folder/activate`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2151,7 +2151,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/archive response - resource isolated function post team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns inline_response_200_68|error { + resource isolated function post team/team_folder/archive(team_folder_archive_body payload, map headers = {}) returns inline_response_200_66|error { string resourcePath = string `/team/team_folder/archive`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2159,7 +2159,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns inline_response_200_68|error { + resource isolated function post team/team_folder/archive/'check(archive_check_body payload, map headers = {}) returns inline_response_200_66|error { string resourcePath = string `/team/team_folder/archive/check`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2171,7 +2171,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/create response - resource isolated function post team/team_folder/create(team_folder_create_body payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/create(team_folder_create_body payload, map headers = {}) returns inline_response_200_65|error { string resourcePath = string `/team/team_folder/create`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2194,7 +2194,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/list response - resource isolated function post team/team_folder/list(team_folder_list_body payload, map headers = {}) returns inline_response_200_69|error { + resource isolated function post team/team_folder/list(team_folder_list_body payload, map headers = {}) returns inline_response_200_67|error { string resourcePath = string `/team/team_folder/list`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2202,7 +2202,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns inline_response_200_69|error { + resource isolated function post team/team_folder/list/'continue(list_continue_body_6 payload, map headers = {}) returns inline_response_200_67|error { string resourcePath = string `/team/team_folder/list/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2225,7 +2225,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/rename response - resource isolated function post team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/rename(team_folder_rename_body payload, map headers = {}) returns inline_response_200_65|error { string resourcePath = string `/team/team_folder/rename`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2237,7 +2237,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - team_folder/update_sync_settings response - resource isolated function post team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns inline_response_200_67|error { + resource isolated function post team/team_folder/update_sync_settings(team_folder_update_sync_settings_body payload, map headers = {}) returns inline_response_200_65|error { string resourcePath = string `/team/team_folder/update_sync_settings`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2249,7 +2249,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - token/get_authenticated_admin response - resource isolated function post team/token/get_authenticated_admin(map headers = {}) returns inline_response_200_72|error { + resource isolated function post team/token/get_authenticated_admin(map headers = {}) returns inline_response_200_70|error { string resourcePath = string `/team/token/get_authenticated_admin`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); @@ -2259,7 +2259,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_events response - resource isolated function post team_log/get_events(team_log_get_events_body payload, map headers = {}) returns inline_response_200_73|error { + resource isolated function post team_log/get_events(team_log_get_events_body payload, map headers = {}) returns inline_response_200_71|error { string resourcePath = string `/team_log/get_events`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2267,7 +2267,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns inline_response_200_73|error { + resource isolated function post team_log/get_events/'continue(get_events_continue_body payload, map headers = {}) returns inline_response_200_71|error { string resourcePath = string `/team_log/get_events/continue`; http:Request request = new; json jsonBody = payload.toJson(); @@ -2279,7 +2279,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - features/get_values response - resource isolated function post users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns inline_response_200_74|error { + resource isolated function post users/features/get_values(features_get_values_body_1 payload, FeaturesGetValues1Headers headers = {}) returns inline_response_200_72|error { string resourcePath = string `/users/features/get_values`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2292,7 +2292,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_account response - resource isolated function post users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns inline_response_200_75|error { + resource isolated function post users/get_account(users_get_account_body payload, GetAccountHeaders headers = {}) returns inline_response_200_73|error { string resourcePath = string `/users/get_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2305,7 +2305,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_account_batch response - resource isolated function post users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns inline_response_200_76[]|error { + resource isolated function post users/get_account_batch(users_get_account_batch_body payload, GetAccountBatchHeaders headers = {}) returns inline_response_200_74[]|error { string resourcePath = string `/users/get_account_batch`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2318,7 +2318,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_current_account response - resource isolated function post users/get_current_account(GetCurrentAccountHeaders headers = {}) returns inline_response_200_77|error { + resource isolated function post users/get_current_account(GetCurrentAccountHeaders headers = {}) returns inline_response_200_75|error { string resourcePath = string `/users/get_current_account`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; @@ -2329,7 +2329,7 @@ public isolated client class Client { # # + headers - Headers to be sent with the request # + return - get_space_usage response - resource isolated function post users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns inline_response_200_78|error { + resource isolated function post users/get_space_usage(GetSpaceUsageHeaders headers = {}) returns inline_response_200_76|error { string resourcePath = string `/users/get_space_usage`; map httpHeaders = getMapForHeaders(headers); http:Request request = new; diff --git a/ballerina/types.bal b/ballerina/types.bal index 540ae23..b4d8831 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -26,10 +26,30 @@ public type CreateFolderBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type PropertyGroup record { + PropertyField[] fields?; + string template_id?; +}; + public type finish_batch_check_body record { string async_job_id?; }; +public type inline_response_200_41_entries record { + inline_response_200_33_access_inheritance access_inheritance?; + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inside_team_folder?; + boolean is_team_folder?; + inline_response_200_33_link_metadata link_metadata?; + string name?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string shared_folder_id?; + string time_invited?; +}; + # Represents the Headers record for the operation: checkRemoveMemberJobStatus public type CheckRemoveMemberJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -51,22 +71,15 @@ public type sharinglist_file_membersbatch_result_members_user record { string team_member_id?; }; -public type inline_response_200_30_matches record { - inline_response_200_30_metadata metadata?; -}; - public type list_folder_longpoll_body record { string cursor?; decimal timeout?; }; -public type inline_response_200_73_event_category record { - string \.tag?; -}; - -public type file_propertiespropertiessearch_mode record { - string \.tag?; - string field_name?; +public type inline_response_200_9_metadata_file_lock_info record { + string created?; + boolean is_lockholder?; + string lockholder_name?; }; public type sharingget_file_metadatabatch_result_policy record { @@ -76,23 +89,26 @@ public type sharingget_file_metadatabatch_result_policy record { sharingget_file_metadatabatch_result_policy_member_policy shared_link_policy?; }; -public type inline_response_200_8_deadline record { - inline_response_200_8_deadline_allow_late_uploads allow_late_uploads?; - string deadline?; -}; - -public type inline_response_200_39_team_member_info record { - string display_name?; - string member_id?; - sharingget_file_metadatabatch_result_owner_team team_info?; -}; - public type groups_create_body record { boolean add_creator_as_owner?; string group_external_id?; string group_name?; }; +public type inline_response_200_43_links record { + string \.tag?; + string client_modified?; + string id?; + inline_response_200_37_link_permissions link_permissions?; + string name?; + string path_lower?; + string rev?; + string server_modified?; + decimal size?; + inline_response_200_37_team_member_info team_member_info?; + string url?; +}; + public type legal_holds_update_policy_body record { string id?; string[] members?; @@ -102,16 +118,21 @@ public type delete_batch_check_body record { string async_job_id?; }; -public type inline_response_200_73_path record { - string contextual?; - inline_response_200_73_path_namespace_relative namespace_relative?; -}; - public type teammemberssecondary_emailsadd_new_secondary_emails record { string[] secondary_emails?; teamgroupsmembersadd_user user?; }; +public type inline_response_200_72_values record { + string \.tag?; + inline_response_200_72_paper_as_files paper_as_files?; +}; + +public type inline_response_200_59_members record { + teammembersget_info_profile profile?; + teammembersget_info_role role?; +}; + public type sharingadd_file_member_result record { string \.tag?; }; @@ -173,21 +194,22 @@ public type SetProfilePhotoHeaders record { string? dropbox\-api\-select\-user?; }; -public type templates_remove_for_team_body record { - string template_id?; -}; - public type file_requests_get_body record { string id?; }; public type templates_update_for_user_body record { - file_propertiestemplatesadd_for_team_fields[] add_fields?; + PropertyFieldTemplate[] add_fields?; string description?; string name?; string template_id?; }; +public type inline_response_200_71_origin record { + inline_response_200_71_origin_access_method access_method?; + inline_response_200_71_origin_geo_location geo_location?; +}; + public type team_folder_permanently_delete_body record { string team_folder_id?; }; @@ -210,7 +232,7 @@ public type files_list_folder_body record { }; public type templates_update_for_team_body record { - file_propertiestemplatesadd_for_team_fields[] add_fields?; + PropertyFieldTemplate[] add_fields?; string description?; string name?; string template_id?; @@ -226,14 +248,16 @@ public type PropertiesRemoveHeaders record { string? dropbox\-api\-select\-user?; }; -public type templates_remove_for_user_body record { - string template_id?; -}; - public type list_folders_continue_body record { string cursor?; }; +public type inline_response_200_16_export_metadata record { + string export_hash?; + string name?; + decimal size?; +}; + # Provides settings related to HTTP/1.x protocol. public type ClientHttp1Settings record {| # Specifies whether to reuse a connection for multiple requests @@ -249,11 +273,22 @@ public type sharingadd_file_member_members record { string email?; }; -public type inline_response_200_42_users record { - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inherited?; - anydata[] permissions?; - sharinglist_file_membersbatch_result_members_user user?; +public type inline_response_200_29_entries record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; public type teamteam_folderupdate_sync_settings_content_sync_settings record { @@ -261,18 +296,41 @@ public type teamteam_folderupdate_sync_settings_content_sync_settings record { string sync_setting?; }; +public type inline_response_200_71_actor_user_team record { + string display_name?; +}; + # Represents the Headers record for the operation: getTemporaryLink public type GetTemporaryLinkHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type AddTemplateForTeam record { + string description?; + PropertyFieldTemplate[] fields?; + string name?; +}; + +public type inline_response_200_61_results_1 record { + string \.tag?; + inline_response_200_61_results[] results?; + members_send_welcome_email_body user?; +}; + public type sharing_update_folder_member_body record { string access_level?; sharingadd_file_member_members member?; string shared_folder_id?; }; +public type inline_response_200_71_details record { + string \.tag?; + inline_response_200_71_details_shared_content_access_level shared_content_access_level?; + string shared_content_link?; + inline_response_200_71_actor_user shared_content_owner?; +}; + # Represents the Headers record for the operation: getThumbnailBatch public type GetThumbnailBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -280,6 +338,10 @@ public type GetThumbnailBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type DeleteManualContactsBatchRequest record { + string[] email_addresses?; +}; + public type sharingadd_folder_member_members record { string access_level?; sharingadd_folder_member_member member?; @@ -291,18 +353,17 @@ public type ListFileMembersContinueHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_62_results record { + string \.tag?; + string success?; +}; + # Represents the Headers record for the operation: getTemporaryUploadLink public type GetTemporaryUploadLinkHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type inline_response_200_62_results record { - string \.tag?; - teamgroupsget_info_profile_secondary_emails success?; - string unavailable?; -}; - public type file_requests_update_body record { file_requestsupdate_deadline deadline?; string destination?; @@ -332,10 +393,6 @@ public type sharingget_file_metadatabatch_result_policy_acl_update_policy record string \.tag?; }; -public type inline_response_200_8_deadline_allow_late_uploads record { - string \.tag?; -}; - # Represents the Headers record for the operation: permanentlyDelete public type PermanentlyDeleteHeaders record { string? dropbox\-api\-path\-root?; @@ -353,6 +410,11 @@ public type sharinglist_file_membersbatch_result_members record { sharinglist_file_membersbatch_result_members_users[] users?; }; +public type inline_response_200_33_link_metadata_link_permissions record { + inline_response_200_33_link_metadata_action action?; + boolean allow?; +}; + public type team_folder_list_body record { decimal 'limit?; }; @@ -366,6 +428,12 @@ public type list_folder_continue_body record { string cursor?; }; +public type inline_response_200_56_complete record { + string \.tag?; + teammembersget_info_profile profile?; + teammembersget_info_role role?; +}; + # Represents the Headers record for the operation: listMountableFolders public type ListMountableFoldersHeaders record { string? dropbox\-api\-path\-root?; @@ -377,20 +445,6 @@ public type sharing_get_file_metadata_body record { string file?; }; -public type inline_response_200_14_metadata record { - string id?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - inline_response_200_14_metadata_sharing_info sharing_info?; -}; - -public type inline_response_200_67_content_sync_settings record { - string id?; - inline_response_200_67_sync_setting sync_setting?; -}; - public type file_requests_delete_body record { string[] ids?; }; @@ -407,13 +461,6 @@ public type members_set_profile_body record { members_send_welcome_email_body user?; }; -public type inline_response_200_73_origin_geo_location record { - string city?; - string country?; - string ip_address?; - string region?; -}; - # Represents the Headers record for the operation: transferFolder public type TransferFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -421,8 +468,8 @@ public type TransferFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type contacts_delete_manual_contacts_batch_body record { - string[] email_addresses?; +public type inline_response_200_69_policies_sharing_shared_link_create_policy record { + string \.tag?; }; public type filesget_file_lock_batch_entries record { @@ -433,11 +480,6 @@ public type files_get_temporary_link_body record { string path?; }; -public type inline_response_200_74_paper_as_files record { - string \.tag?; - boolean enabled?; -}; - public type teamgroupsmembersadd_user record { string \.tag?; string team_member_id?; @@ -463,12 +505,6 @@ public type sharinglist_file_membersbatch_result_members_group record { boolean same_team?; }; -public type inline_response_200_11_metadata_sharing_info record { - string modified_by?; - string parent_shared_folder_id?; - boolean read_only?; -}; - public type excluded_users_list_body record { decimal 'limit?; }; @@ -498,6 +534,33 @@ public type list_continue_body record { string cursor?; }; +public type inline_response_200_67_team_folders record { + inline_response_200_65_content_sync_settings[] content_sync_settings?; + boolean is_team_shared_dropbox?; + string name?; + teamgroupsget_info_profile_status status?; + inline_response_200_65_sync_setting sync_setting?; + string team_folder_id?; +}; + +public type inline_response_200_23_entries record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_23_sharing_info sharing_info?; + decimal size?; +}; + public type sharing_get_folder_metadata_body record { anydata[] actions?; string shared_folder_id?; @@ -521,16 +584,6 @@ public type AddFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_77_account_type record { - string \.tag?; -}; - -public type inline_response_200_19_entries record { - string \.tag?; - inline_response_200_19_lock 'lock?; - inline_response_200_11_metadata metadata?; -}; - # Represents the Headers record for the operation: checkJobStatus public type CheckJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -538,13 +591,11 @@ public type CheckJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_66_namespace_type record { - string \.tag?; -}; - -public type inline_response_200_53_members record { - decimal permanently_deleted_users?; - string[] team_member_ids?; +public type inline_response_200_75_team record { + string id?; + string name?; + inline_response_200_69_policies_emm_state office_addin_policy?; + inline_response_200_69_policies_sharing sharing_policies?; }; public type members_suspend_body record { @@ -565,12 +616,6 @@ public type legal_holds_create_policy_body record { string start_date?; }; -public type inline_response_200_11_metadata_file_lock_info record { - string created?; - boolean is_lockholder?; - string lockholder_name?; -}; - # Represents the Headers record for the operation: move public type MoveHeaders record { string? dropbox\-api\-path\-root?; @@ -578,25 +623,36 @@ public type MoveHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_44_entries record { - sharingget_file_metadatabatch_result_access_type access_type?; - string id?; - string name?; - string[] owner_display_names?; - sharingget_file_metadatabatch_result_owner_team owner_team?; - string path_display?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string time_invited?; -}; - public type sharing_relinquish_folder_membership_body record { boolean leave_a_copy?; string shared_folder_id?; }; +public type inline_response_200_23_sharing_info record { + string modified_by?; + boolean no_access?; + string parent_shared_folder_id?; + boolean read_only?; + boolean traverse_only?; +}; + +public type inline_response_200_9_metadata_sharing_info record { + string modified_by?; + string parent_shared_folder_id?; + boolean read_only?; +}; + +public type SearchPropertiesMode record { + string \.tag?; + string field_name?; +}; + +public type inline_response_200_75_root_info record { + string \.tag?; + string home_namespace_id?; + string root_namespace_id?; +}; + # Represents the Headers record for the operation: getAccountBatch public type GetAccountBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -611,18 +667,20 @@ public type filesget_temporary_upload_link_commit_info record { boolean strict_conflict?; }; +public type TokenFromOauth1Response record { + string oauth2_token?; +}; + public type members_add_body record { groups_delete_body group?; teamgroupsmembersadd_members[] members?; boolean return_members?; }; -public type templates_get_for_team_body record { - string template_id?; -}; - -public type inline_response_200_73_actor_user_team record { +public type inline_response_200_37_team_member_info record { string display_name?; + string member_id?; + sharingget_file_metadatabatch_result_owner_team team_info?; }; # Represents the Headers record for the operation: deleteBatch @@ -639,10 +697,6 @@ public type UnmountFolderHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_5_type record { - string \.tag?; -}; - public type files_get_file_lock_batch_body record { filesget_file_lock_batch_entries[] entries?; }; @@ -658,6 +712,10 @@ public type PropertiesAddHeaders record { string? dropbox\-api\-select\-user?; }; +public type CheckAppRequest record { + string query?; +}; + # Represents the Headers record for the operation: copyReferenceGet public type CopyReferenceGetHeaders record { string? dropbox\-api\-path\-root?; @@ -690,17 +748,16 @@ public type groups_update_body record { boolean return_members?; }; -public type inline_response_200_54_entries record { - string author_email?; - string author_member_id?; - teamgroupsget_info_profile_status author_member_status?; - string content_hash?; - string file_type?; - string new_filename?; - string original_file_path?; - string original_revision_id?; - string server_modified?; - decimal size?; +public type PropertyFieldTemplate record { + string description?; + string name?; + string 'type?; +}; + +public type inline_response_200_3_fields record { + string description?; + string name?; + inline_response_200_3_type 'type?; }; public type team_folder_activate_body record { @@ -712,10 +769,17 @@ public type members_add_body_1 record { teammembersadd_new_members[] new_members?; }; -# Represents the Headers record for the operation: templatesGetForUser -public type TemplatesGetForUserHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-user?; +public type inline_response_200_40_users record { + sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; + boolean is_inherited?; + anydata[] permissions?; + sharinglist_file_membersbatch_result_members_user user?; +}; + +# Represents the Headers record for the operation: templatesGetForUser +public type TemplatesGetForUserHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-user?; }; public type sharing_list_received_files_body record { @@ -742,35 +806,6 @@ public type LockFileBatchHeaders record { string? dropbox\-api\-select\-user?; }; -public type file_propertiespropertiesadd_fields record { - string name?; - string value?; -}; - -public type inline_response_200_64_results_1 record { - string \.tag?; - inline_response_200_64_results[] results?; - members_send_welcome_email_body user?; -}; - -public type inline_response_200_31_entries record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; -}; - # Represents the Headers record for the operation: getFileMetadataBatch public type GetFileMetadataBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -795,38 +830,45 @@ public type sharingadd_folder_member_member record { string email?; }; -public type inline_response_200_25_entries record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_25_sharing_info sharing_info?; - decimal size?; -}; - # Represents the Headers record for the operation: templatesUpdateForUser public type TemplatesUpdateForUserHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; +public type inline_response_200_42_entries record { + sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; +}; + public type list_mountable_folders_continue_body record { string cursor?; }; -public type file_propertiestemplatesadd_for_team_fields record { - string description?; - string name?; - string 'type?; +public type OverwritePropertiesRequest record { + string path?; + PropertyGroup[] property_groups?; +}; + +public type inline_response_200_69_policies record { + inline_response_200_69_policies_emm_state emm_state?; + inline_response_200_69_policies_emm_state office_addin?; + inline_response_200_69_policies_sharing sharing?; +}; + +public type inline_response_200_61_results record { + string \.tag?; + string not_found?; + string success?; }; public type sharinglist_file_membersbatch_result_members_invitees record { @@ -836,8 +878,8 @@ public type sharinglist_file_membersbatch_result_members_invitees record { anydata[] permissions?; }; -public type search_continue_body record { - string cursor?; +public type GetTemplateForTeam record { + string template_id?; }; public type member_space_limits_get_custom_quota_body record { @@ -850,7 +892,6 @@ public type legal_holds_list_policies_body record { public type inline_response_200_62_results_1 record { string \.tag?; - members_send_welcome_email_body invalid_user?; inline_response_200_62_results[] results?; members_send_welcome_email_body user?; }; @@ -874,10 +915,28 @@ public type RelinquishFolderMembershipHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_71_events record { + inline_response_200_71_actor actor?; + inline_response_200_71_assets[] assets?; + inline_response_200_71_actor_user context?; + inline_response_200_71_details details?; + inline_response_200_71_event_category event_category?; + inline_response_200_71_event_type event_type?; + boolean involve_non_team_member?; + inline_response_200_71_origin origin?; + inline_response_200_71_participants[] participants?; + string timestamp?; +}; + public type teammembersget_info_role record { string \.tag?; }; +public type PropertyField record { + string name?; + string value?; +}; + # Represents the Headers record for the operation: listFolderLongpoll public type ListFolderLongpollHeaders record { string? dropbox\-api\-path\-root?; @@ -885,6 +944,11 @@ public type ListFolderLongpollHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_13_entries record { + string \.tag?; + inline_response_200_12_metadata metadata?; +}; + public type team_folder_create_body record { string name?; string sync_setting?; @@ -909,39 +973,20 @@ public type secondary_emails_delete_body record { teammemberssecondary_emailsadd_new_secondary_emails[] emails_to_delete?; }; -public type inline_response_200_73_user record { - string \.tag?; - string account_id?; - string display_name?; - string email?; - string member_external_id?; - inline_response_200_73_actor_user_team team?; - string team_member_id?; -}; - # Represents the Headers record for the operation: list public type ListHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type inline_response_200_35_link_metadata_action record { - string \.tag?; +public type inline_response_200_71_path_namespace_relative record { + boolean is_shared_namespace?; + string ns_id?; + string relative_path?; }; -public type inline_response_200_43_entries record { - inline_response_200_35_access_inheritance access_inheritance?; - sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; - boolean is_inside_team_folder?; - boolean is_team_folder?; - inline_response_200_35_link_metadata link_metadata?; - string name?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string shared_folder_id?; - string time_invited?; +public type inline_response_200_64_namespace_type record { + string \.tag?; }; # Represents the Headers record for the operation: uploadSessionStart @@ -952,9 +997,15 @@ public type UploadSessionStartHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_73_origin_access_method record { - string \.tag?; - inline_response_200_73_origin_access_method_end_user end_user?; +public type SearchPropertiesContinueRequest record { + string cursor?; +}; + +public type inline_response_200_1_matches record { + string id?; + boolean is_deleted?; + string path?; + PropertyGroup[] property_groups?; }; public type members_remove_body record { @@ -970,20 +1021,6 @@ public type UpdateFileMemberHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_73_actor_user record { - string \.tag?; - string account_id?; - string display_name?; - string email?; - string member_external_id?; - inline_response_200_73_actor_user_team team?; - string team_member_id?; -}; - -public type inline_response_200_71_policies_sharing_shared_link_create_policy record { - string \.tag?; -}; - public type sharing_unshare_file_body record { string file?; }; @@ -994,12 +1031,6 @@ public type ListReceivedFilesContinueHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_24_entries record { - string \.tag?; - inline_response_200_18_file_metadata metadata?; - string thumbnail?; -}; - public type sharing_add_file_member_body record { string access_level?; boolean add_message_as_comment?; @@ -1009,6 +1040,12 @@ public type sharing_add_file_member_body record { boolean quiet?; }; +public type inline_response_200_69_policies_sharing record { + inline_response_200_69_policies_sharing_shared_folder_join_policy shared_folder_join_policy?; + sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; + inline_response_200_69_policies_sharing_shared_link_create_policy shared_link_create_policy?; +}; + # Represents the Headers record for the operation: removeFileMember2 public type RemoveFileMember2Headers record { string? dropbox\-api\-path\-root?; @@ -1027,7 +1064,7 @@ public type sharing_modify_shared_link_settings_body record { }; public type inline_response_200_9 record { - inline_response_200_9_file_requests[] file_requests?; + inline_response_200_9_metadata metadata?; }; public type teamfeaturesget_values_features record { @@ -1035,22 +1072,17 @@ public type teamfeaturesget_values_features record { }; public type inline_response_200_5 record { - string description?; - inline_response_200_5_fields[] fields?; - string name?; -}; - -public type inline_response_200_6 record { - string[] template_ids?; + decimal file_request_count?; }; -public type inline_response_200_7 record { - decimal file_request_count?; +public type inline_response_200_72_paper_as_files record { + string \.tag?; + boolean enabled?; }; -public type inline_response_200_8 record { +public type inline_response_200_6 record { string created?; - inline_response_200_8_deadline deadline?; + inline_response_200_6_deadline deadline?; string destination?; decimal file_count?; string id?; @@ -1059,6 +1091,16 @@ public type inline_response_200_8 record { string url?; }; +public type inline_response_200_7 record { + inline_response_200_7_file_requests[] file_requests?; +}; + +public type inline_response_200_8 record { + string cursor?; + inline_response_200_7_file_requests[] file_requests?; + boolean has_more?; +}; + # Represents the Headers record for the operation: updateFolderPolicy public type UpdateFolderPolicyHeaders record { string? dropbox\-api\-path\-root?; @@ -1066,21 +1108,8 @@ public type UpdateFolderPolicyHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_77_root_info record { - string \.tag?; - string home_namespace_id?; - string root_namespace_id?; -}; - -public type inline_response_200_39_link_permissions record { - boolean can_revoke?; - inline_response_200_35_link_metadata_audience_options resolved_visibility?; - inline_response_200_39_link_permissions_revoke_failure_reason revoke_failure_reason?; -}; - -public type properties_overwrite_body record { - string path?; - file_propertiespropertiesadd_property_groups[] property_groups?; +public type GetTemplateForUserRequest record { + string template_id?; }; public type sharing_update_folder_policy_body record { @@ -1102,20 +1131,12 @@ public type sharing_list_file_members_body record { decimal 'limit?; }; -public type inline_response_200_67_sync_setting record { - string \.tag?; -}; - # Represents the Headers record for the operation: saveUrl public type SaveUrlHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; -public type account_set_profile_photo_body record { - Photo photo?; -}; - public type sharing_update_file_member_body record { string access_level?; string file?; @@ -1128,15 +1149,17 @@ public type teamgroupsget_info_profile_secondary_emails record { }; public type inline_response_200_1 record { - string oauth2_token?; + inline_response_200_1_matches[] matches?; }; public type inline_response_200_2 record { - string result?; + string template_id?; }; public type inline_response_200_3 record { - inline_response_200_3_matches[] matches?; + string description?; + inline_response_200_3_fields[] fields?; + string name?; }; public type files_copy_batch_v2_body record { @@ -1145,7 +1168,7 @@ public type files_copy_batch_v2_body record { }; public type inline_response_200_4 record { - string template_id?; + string[] template_ids?; }; public type members_set_profile_photo_body record { @@ -1154,32 +1177,48 @@ public type members_set_profile_photo_body record { }; public type inline_response_200_11 record { - inline_response_200_11_metadata metadata?; + string copy_reference?; + string expires?; + inline_response_200_9_metadata metadata?; +}; + +public type members_recover_body record { + teamgroupsmembersadd_user user?; }; public type inline_response_200_10 record { - string cursor?; - inline_response_200_9_file_requests[] file_requests?; - boolean has_more?; + string \.tag?; + inline_response_200_10_entries[] entries?; }; -public type members_recover_body record { - teamgroupsmembersadd_user user?; +public type inline_response_200_64_namespaces record { + string name?; + string namespace_id?; + inline_response_200_64_namespace_type namespace_type?; + string team_member_id?; }; public type inline_response_200_13 record { - string copy_reference?; - string expires?; - inline_response_200_11_metadata metadata?; + string \.tag?; + inline_response_200_13_entries[] entries?; }; public type inline_response_200_12 record { + inline_response_200_12_metadata metadata?; +}; + +public type inline_response_200_68_upload_api_rate_limit record { + string \.tag?; + decimal 'limit?; +}; + +public type inline_response_200_33_access_inheritance record { string \.tag?; - inline_response_200_12_entries[] entries?; }; public type inline_response_200_19 record { - inline_response_200_19_entries[] entries?; + string link?; + inline_response_200_16_file_metadata metadata?; }; public type files_list_revisions_body record { @@ -1188,9 +1227,22 @@ public type files_list_revisions_body record { string path?; }; -public type inline_response_200_61_members record { - teammembersget_info_profile profile?; - teammembersget_info_role role?; +public type inline_response_200_18 record { + string \.tag?; + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; # Represents the Headers record for the operation: user @@ -1199,14 +1251,21 @@ public type UserHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_18 record { - inline_response_200_18_export_metadata export_metadata?; - inline_response_200_18_file_metadata file_metadata?; -}; - -public type inline_response_200_12_entries record { - string \.tag?; - inline_response_200_11_metadata success?; +public type inline_response_200_15 record { + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; public type teammembersget_info_profile_secondary_emails record { @@ -1214,11 +1273,6 @@ public type teammembersget_info_profile_secondary_emails record { boolean is_verified?; }; -public type inline_response_200_15 record { - string \.tag?; - inline_response_200_15_entries[] entries?; -}; - # Represents the Headers record for the operation: createFolder public type CreateFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -1227,39 +1281,35 @@ public type CreateFolderHeaders record { }; public type inline_response_200_14 record { - inline_response_200_14_metadata metadata?; + string \.tag?; + inline_response_200_14_entries[] entries?; }; public type inline_response_200_17 record { - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; + inline_response_200_17_entries[] entries?; +}; + +public type AddTemplateForUser record { + string description?; + PropertyFieldTemplate[] fields?; string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; }; public type inline_response_200_16 record { - string \.tag?; - inline_response_200_16_entries[] entries?; + inline_response_200_16_export_metadata export_metadata?; + inline_response_200_16_file_metadata file_metadata?; }; -public type inline_response_200_35_access_inheritance record { - string \.tag?; +public type inline_response_200_48_groups record { + string group_id?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; }; -public type inline_response_200_63_results_1 record { +public type inline_response_200_71_origin_access_method_end_user record { string \.tag?; - inline_response_200_63_results[] results?; - members_send_welcome_email_body user?; + string session_id?; }; # Represents the Headers record for the operation: deleteManualContacts @@ -1280,17 +1330,9 @@ public type SearchHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_78_allocation record { - string \.tag?; - decimal allocated?; -}; - -public type inline_response_200_25_sharing_info record { - string modified_by?; - boolean no_access?; - string parent_shared_folder_id?; - boolean read_only?; - boolean traverse_only?; +public type TokenFromOauth1Request record { + string oauth1_token?; + string oauth1_token_secret?; }; public type sharing_check_remove_member_job_status_body record { @@ -1326,6 +1368,10 @@ public type sharingget_file_metadatabatch_result record { string time_invited?; }; +public type inline_response_200_71_event_category record { + string \.tag?; +}; + # Represents the Headers record for the operation: unshareFolder public type UnshareFolderHeaders record { string? dropbox\-api\-path\-root?; @@ -1333,6 +1379,14 @@ public type UnshareFolderHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_71_assets record { + string \.tag?; + string display_name?; + string file_id?; + decimal file_size?; + inline_response_200_71_path path?; +}; + # Represents the Headers record for the operation: listFileMembers public type ListFileMembersHeaders record { string? dropbox\-api\-path\-root?; @@ -1348,33 +1402,18 @@ public type teamgroupsget_info_access_type record { string \.tag?; }; -public type inline_response_200_71_policies record { - inline_response_200_71_policies_emm_state emm_state?; - inline_response_200_71_policies_emm_state office_addin?; - inline_response_200_71_policies_sharing sharing?; -}; - public type filesupload_sessionfinish_batch_entries record { filesget_temporary_upload_link_commit_info 'commit?; filesupload_sessionfinish_batch_cursor cursor?; }; public type inline_response_200_33 record { - sharingadd_file_member_members member?; - sharingadd_file_member_result result?; -}; - -public type inline_response_200_32 record { - string session_id?; -}; - -public type inline_response_200_35 record { string \.tag?; - inline_response_200_35_access_inheritance access_inheritance?; + inline_response_200_33_access_inheritance access_inheritance?; sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inside_team_folder?; boolean is_team_folder?; - inline_response_200_35_link_metadata link_metadata?; + inline_response_200_33_link_metadata link_metadata?; string name?; string path_lower?; anydata[] permissions?; @@ -1384,13 +1423,37 @@ public type inline_response_200_35 record { string time_invited?; }; +public type inline_response_200_32 record { + string \.tag?; +}; + +public type inline_response_200_35 record { + string file?; + sharingget_file_metadatabatch_result result?; +}; + public type groups_delete_body record { string \.tag?; string group_id?; }; -public type inline_response_200_34 record { +public type inline_response_200_71_participants record { string \.tag?; + inline_response_200_71_user user?; +}; + +public type inline_response_200_34 record { + sharingget_file_metadatabatch_result_access_type access_type?; + string id?; + string name?; + string[] owner_display_names?; + sharingget_file_metadatabatch_result_owner_team owner_team?; + string path_display?; + string path_lower?; + anydata[] permissions?; + sharingget_file_metadatabatch_result_policy policy?; + string preview_url?; + string time_invited?; }; public type members_get_info_body record { @@ -1402,20 +1465,12 @@ public type secondary_emails_resend_verification_emails_body record { }; public type inline_response_200_31 record { - string \.tag?; - inline_response_200_31_entries[] entries?; -}; - -public type inline_response_200_50_groups record { - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - decimal member_count?; + sharingadd_file_member_members member?; + sharingadd_file_member_result result?; }; public type inline_response_200_30 record { - boolean has_more?; - inline_response_200_30_matches[] matches?; + string session_id?; }; # Represents the Headers record for the operation: deleteBatchCheck @@ -1429,22 +1484,8 @@ public type sharing_check_job_status_body record { string async_job_id?; }; -public type inline_response_200_11_metadata record { +public type inline_response_200_69_policies_sharing_shared_folder_join_policy record { string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; }; # Represents the Headers record for the operation: getSpaceUsage @@ -1453,65 +1494,39 @@ public type GetSpaceUsageHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_73_details record { - string \.tag?; - inline_response_200_73_details_shared_content_access_level shared_content_access_level?; - string shared_content_link?; - inline_response_200_73_actor_user shared_content_owner?; -}; - public type team_folder_update_sync_settings_body record { teamteam_folderupdate_sync_settings_content_sync_settings[] content_sync_settings?; string sync_setting?; string team_folder_id?; }; -# Represents the Headers record for the operation: shareFolder -public type ShareFolderHeaders record { - string? dropbox\-api\-path\-root?; - string? dropbox\-api\-select\-admin?; - string? dropbox\-api\-select\-user?; -}; - public type inline_response_200_37 record { - string file?; - sharingget_file_metadatabatch_result result?; -}; - -public type inline_response_200_36 record { - sharingget_file_metadatabatch_result_access_type access_type?; - string id?; - string name?; - string[] owner_display_names?; - sharingget_file_metadatabatch_result_owner_team owner_team?; - string path_display?; - string path_lower?; - anydata[] permissions?; - sharingget_file_metadatabatch_result_policy policy?; - string preview_url?; - string time_invited?; -}; - -public type inline_response_200_39 record { string \.tag?; string client_modified?; string id?; - inline_response_200_39_link_permissions link_permissions?; + inline_response_200_37_link_permissions link_permissions?; string name?; string path_lower?; string rev?; string server_modified?; decimal size?; - inline_response_200_39_team_member_info team_member_info?; + inline_response_200_37_team_member_info team_member_info?; string url?; }; -public type inline_response_200_38 record { - inline_response_200_35_access_inheritance access_inheritance?; +# Represents the Headers record for the operation: shareFolder +public type ShareFolderHeaders record { + string? dropbox\-api\-path\-root?; + string? dropbox\-api\-select\-admin?; + string? dropbox\-api\-select\-user?; +}; + +public type inline_response_200_36 record { + inline_response_200_33_access_inheritance access_inheritance?; sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inside_team_folder?; boolean is_team_folder?; - inline_response_200_35_link_metadata link_metadata?; + inline_response_200_33_link_metadata link_metadata?; string name?; string path_lower?; anydata[] permissions?; @@ -1521,18 +1536,19 @@ public type inline_response_200_38 record { string time_invited?; }; -public type properties_remove_body record { - string path?; - string[] property_template_ids?; +public type inline_response_200_39 record { + string file?; + sharinglist_file_membersbatch_result result?; }; -public type legal_holds_list_held_revisions_body record { - string id?; +public type inline_response_200_38 record { + sharinglist_file_membersbatch_result_members_groups[] groups?; + sharinglist_file_membersbatch_result_members_invitees[] invitees?; + sharinglist_file_membersbatch_result_members_users[] users?; }; -public type inline_response_200_74_values record { - string \.tag?; - inline_response_200_74_paper_as_files paper_as_files?; +public type legal_holds_list_held_revisions_body record { + string id?; }; public type files_create_folder_batch_body record { @@ -1551,6 +1567,12 @@ public type files_lock_file_batch_body record { filesget_file_lock_batch_entries[] entries?; }; +public type inline_response_200_60_results record { + string \.tag?; + teamgroupsget_info_profile_secondary_emails success?; + string unavailable?; +}; + public type groups_get_info_body record { string \.tag?; string[] group_ids?; @@ -1592,38 +1614,25 @@ public type ConnectionConfig record {| |}; public type inline_response_200_22 record { - string link?; + inline_response_200_22_entries[] entries?; }; public type inline_response_200_21 record { - string link?; - inline_response_200_18_file_metadata metadata?; + inline_response_200_16_file_metadata file_metadata?; }; public type inline_response_200_24 record { - inline_response_200_24_entries[] entries?; + boolean changes?; }; public type inline_response_200_23 record { - inline_response_200_18_file_metadata file_metadata?; + string cursor?; + inline_response_200_23_entries[] entries?; + boolean has_more?; }; public type inline_response_200_20 record { - string \.tag?; - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; + string link?; }; public type file_requestscreate_deadline record { @@ -1631,12 +1640,6 @@ public type file_requestscreate_deadline record { string deadline?; }; -public type inline_response_200_70_values record { - string \.tag?; - inline_response_200_70_has_team_shared_dropbox has_team_shared_dropbox?; - inline_response_200_70_upload_api_rate_limit upload_api_rate_limit?; -}; - public type files_delete_batch_body record { files_delete_v2_body[] entries?; }; @@ -1656,6 +1659,7 @@ public type Delete1Headers record { public type inline_response_200_29 record { string \.tag?; + inline_response_200_29_entries[] entries?; }; public type files_get_metadata_body record { @@ -1666,41 +1670,35 @@ public type files_get_metadata_body record { }; public type inline_response_200_26 record { - boolean changes?; -}; - -public type inline_response_200_25 record { - string cursor?; - inline_response_200_25_entries[] entries?; - boolean has_more?; -}; - -public type inline_response_200_28 record { string \.tag?; string client_modified?; string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; boolean has_explicit_shared_members?; string id?; boolean is_downloadable?; string name?; string path_display?; string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; + PropertyGroup[] property_groups?; string rev?; string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; + inline_response_200_9_metadata_sharing_info sharing_info?; decimal size?; }; -public type inline_response_200_27 record { - inline_response_200_18_file_metadata[] entries?; +public type inline_response_200_25 record { + inline_response_200_16_file_metadata[] entries?; boolean is_deleted?; }; -public type inline_response_200_73_event_type record { +public type inline_response_200_28 record { + boolean has_more?; + inline_response_200_28_matches[] matches?; +}; + +public type inline_response_200_27 record { string \.tag?; - string description?; }; public type files_get_temporary_upload_link_body record { @@ -1708,11 +1706,6 @@ public type files_get_temporary_upload_link_body record { decimal duration?; }; -public type inline_response_200_73_actor record { - string \.tag?; - inline_response_200_73_actor_user user?; -}; - public type members_delete_profile_photo_body record { teamgroupsmembersadd_user user?; }; @@ -1742,54 +1735,48 @@ public type sharingget_file_metadatabatch_result_policy_resolved_member_policy r string \.tag?; }; -public type inline_response_200_55 record { - inline_response_200_55_policies[] policies?; -}; - -public type inline_response_200_54 record { - inline_response_200_54_entries[] entries?; - boolean has_more?; +public type inline_response_200_65_sync_setting record { + string \.tag?; }; -public type inline_response_200_57 record { +public type inline_response_200_55 record { string cursor?; boolean has_more?; anydata[] users?; }; -public type file_propertiespropertiessearch_queries record { - string logical_operator?; - file_propertiespropertiessearch_mode mode?; - string query?; +public type inline_response_200_54 record { + sharingadd_file_member_result status?; }; -public type inline_response_200_56 record { - sharingadd_file_member_result status?; +public type inline_response_200_57 record { + teammembersget_info_profile profile?; + teammembersget_info_role role?; }; -public type inline_response_200_71_policies_sharing_shared_folder_join_policy record { +public type inline_response_200_56 record { string \.tag?; + inline_response_200_56_complete[] complete?; }; public type inline_response_200_51 record { - string async_job_id?; - inline_response_200_51_group_info group_info?; + string activation_time?; + string end_date?; + string id?; + inline_response_200_51_members members?; + string name?; + string start_date?; + teamgroupsget_info_profile_status status?; }; public type inline_response_200_50 record { string cursor?; - inline_response_200_50_groups[] groups?; boolean has_more?; + anydata[] members?; }; public type inline_response_200_53 record { - string activation_time?; - string end_date?; - string id?; - inline_response_200_53_members members?; - string name?; - string start_date?; - teamgroupsget_info_profile_status status?; + inline_response_200_53_policies[] policies?; }; public type file_requestsupdate_deadline record { @@ -1799,9 +1786,13 @@ public type file_requestsupdate_deadline record { }; public type inline_response_200_52 record { - string cursor?; + inline_response_200_52_entries[] entries?; boolean has_more?; - anydata[] members?; +}; + +public type AddPropertiesRequest record { + string path?; + PropertyGroup[] property_groups?; }; public type sharing_revoke_shared_link_body record { @@ -1815,21 +1806,20 @@ public type UnshareFileHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_77_team record { - string id?; - string name?; - inline_response_200_71_policies_emm_state office_addin_policy?; - inline_response_200_71_policies_sharing sharing_policies?; +public type inline_response_200_59 record { + string cursor?; + boolean has_more?; + inline_response_200_59_members[] members?; }; -public type inline_response_200_59 record { +public type inline_response_200_58 record { + string \.tag?; teammembersget_info_profile profile?; teammembersget_info_role role?; }; -public type inline_response_200_58 record { +public type inline_response_200_33_link_metadata_action record { string \.tag?; - inline_response_200_58_complete[] complete?; }; public type files_permanently_delete_body record { @@ -1840,17 +1830,6 @@ public type list_folder_members_continue_body record { string cursor?; }; -public type inline_response_200_9_file_requests record { - string created?; - inline_response_200_8_deadline deadline?; - string destination?; - decimal file_count?; - string id?; - boolean is_open?; - string title?; - string url?; -}; - # Represents the Headers record for the operation: checkShareJobStatus public type CheckShareJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -1858,10 +1837,12 @@ public type CheckShareJobStatusHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_60 record { +public type inline_response_200_69_policies_emm_state record { string \.tag?; - teammembersget_info_profile profile?; - teammembersget_info_role role?; +}; + +public type inline_response_200_60 record { + inline_response_200_60_results_1[] results?; }; public type team_log_get_events_body record { @@ -1874,23 +1855,27 @@ public type sharingget_file_metadatabatch_result_policy_member_policy record { }; public type inline_response_200_44 record { - string cursor?; - inline_response_200_44_entries[] entries?; + string \.tag?; }; public type inline_response_200_43 record { string cursor?; - inline_response_200_43_entries[] entries?; + boolean has_more?; + inline_response_200_43_links[] links?; }; public type inline_response_200_46 record { - string \.tag?; + decimal created?; + string group_id?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; + teamgroupsget_info_members[] members?; }; public type inline_response_200_45 record { - string cursor?; - boolean has_more?; - inline_response_200_45_links[] links?; + string \.tag?; + string async_job_id?; }; public type members_send_welcome_email_body record { @@ -1899,24 +1884,34 @@ public type members_send_welcome_email_body record { }; public type inline_response_200_40 record { + string cursor?; sharinglist_file_membersbatch_result_members_groups[] groups?; sharinglist_file_membersbatch_result_members_invitees[] invitees?; - sharinglist_file_membersbatch_result_members_users[] users?; + inline_response_200_40_users[] users?; }; public type inline_response_200_42 record { string cursor?; - sharinglist_file_membersbatch_result_members_groups[] groups?; - sharinglist_file_membersbatch_result_members_invitees[] invitees?; - inline_response_200_42_users[] users?; + inline_response_200_42_entries[] entries?; }; public type inline_response_200_41 record { - string file?; - sharinglist_file_membersbatch_result result?; + string cursor?; + inline_response_200_41_entries[] entries?; }; public type inline_response_200_48 record { + string cursor?; + inline_response_200_48_groups[] groups?; + boolean has_more?; +}; + +public type inline_response_200_17_lock record { + inline_response_200_17_lock_content content?; +}; + +public type inline_response_200_47 record { + string \.tag?; decimal created?; string group_id?; sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; @@ -1925,32 +1920,43 @@ public type inline_response_200_48 record { teamgroupsget_info_members[] members?; }; -public type inline_response_200_47 record { +public type inline_response_200_17_entries record { string \.tag?; - string async_job_id?; + inline_response_200_17_lock 'lock?; + inline_response_200_9_metadata metadata?; }; public type inline_response_200_49 record { - string \.tag?; - decimal created?; - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - decimal member_count?; - teamgroupsget_info_members[] members?; + string async_job_id?; + inline_response_200_49_group_info group_info?; }; -public type properties_search_body record { - file_propertiespropertiessearch_queries[] queries?; - string template_filter?; +public type inline_response_200_51_members record { + decimal permanently_deleted_users?; + string[] team_member_ids?; }; -public type inline_response_200_73_assets record { - string \.tag?; - string display_name?; - string file_id?; - decimal file_size?; - inline_response_200_73_path path?; +public type inline_response_200_53_policies record { + string activation_time?; + string end_date?; + string id?; + inline_response_200_51_members members?; + string name?; + string start_date?; + teamgroupsget_info_profile_status status?; +}; + +public type inline_response_200_71_path record { + string contextual?; + inline_response_200_71_path_namespace_relative namespace_relative?; +}; + +public type inline_response_200_33_link_metadata record { + inline_response_200_33_link_metadata_audience_options[] audience_options?; + inline_response_200_33_link_metadata_audience_options current_audience?; + inline_response_200_33_link_metadata_link_permissions[] link_permissions?; + boolean password_protected?; + string url?; }; public type file_requests_create_body record { @@ -1960,35 +1966,9 @@ public type file_requests_create_body record { string title?; }; -public type inline_response_200_73_participants record { - string \.tag?; - inline_response_200_73_user user?; -}; - -public type inline_response_200_77 record { - string account_id?; - inline_response_200_77_account_type account_type?; - string country?; - boolean disabled?; - string email?; - boolean email_verified?; - boolean is_paired?; - string locale?; - teamgroupsget_info_profile_name name?; - string referral_link?; - inline_response_200_77_root_info root_info?; - inline_response_200_77_team team?; - string team_member_id?; -}; - public type inline_response_200_76 record { - string account_id?; - boolean disabled?; - string email?; - boolean email_verified?; - boolean is_teammate?; - teamgroupsget_info_profile_name name?; - string profile_photo_url?; + inline_response_200_76_allocation allocation?; + decimal used?; }; # Represents the Headers record for the operation: tokenFromOauth1 @@ -1997,22 +1977,23 @@ public type TokenFromOauth1Headers record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_78 record { - inline_response_200_78_allocation allocation?; - decimal used?; -}; - -public type inline_response_200_73 record { - string cursor?; - inline_response_200_73_events[] events?; - boolean has_more?; +public type inline_response_200_7_file_requests record { + string created?; + inline_response_200_6_deadline deadline?; + string destination?; + decimal file_count?; + string id?; + boolean is_open?; + string title?; + string url?; }; -public type inline_response_200_72 record { - teammembersget_info_profile admin_profile?; +public type SearchPropertiesRequest record { + SearchPropertiesQuery[] queries?; + string template_filter?; }; -public type inline_response_200_75 record { +public type inline_response_200_73 record { string account_id?; boolean disabled?; string email?; @@ -2022,16 +2003,38 @@ public type inline_response_200_75 record { string profile_photo_url?; }; +public type inline_response_200_72 record { + inline_response_200_72_values[] values?; +}; + public type file_requests_list_v2_body record { decimal 'limit?; }; -public type inline_response_200_74 record { - inline_response_200_74_values[] values?; +public type inline_response_200_75 record { + string account_id?; + inline_response_200_75_account_type account_type?; + string country?; + boolean disabled?; + string email?; + boolean email_verified?; + boolean is_paired?; + string locale?; + teamgroupsget_info_profile_name name?; + string referral_link?; + inline_response_200_75_root_info root_info?; + inline_response_200_75_team team?; + string team_member_id?; }; -public type inline_response_200_73_details_shared_content_access_level record { - string \.tag?; +public type inline_response_200_74 record { + string account_id?; + boolean disabled?; + string email?; + boolean email_verified?; + boolean is_teammate?; + teamgroupsget_info_profile_name name?; + string profile_photo_url?; }; # Represents the Headers record for the operation: propertiesSearchContinue @@ -2057,13 +2060,11 @@ public type ExportHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_51_group_info record { - decimal created?; - string group_id?; - sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; - string group_name?; - decimal member_count?; - teamgroupsget_info_members[] members?; +public type inline_response_200_17_lock_content record { + string \.tag?; + string created?; + string lock_holder_account_id?; + string lock_holder_team_id?; }; public type users_get_account_body record { @@ -2100,9 +2101,13 @@ public type GetMetadataHeaders record { }; public type inline_response_200_66 record { - string cursor?; - boolean has_more?; - inline_response_200_66_namespaces[] namespaces?; + string \.tag?; + inline_response_200_65_content_sync_settings[] content_sync_settings?; + boolean is_team_shared_dropbox?; + string name?; + teamgroupsget_info_profile_status status?; + inline_response_200_65_sync_setting sync_setting?; + string team_folder_id?; }; public type team_folder_rename_body record { @@ -2111,84 +2116,71 @@ public type team_folder_rename_body record { }; public type inline_response_200_65 record { - teammembersget_info_role role?; - string team_member_id?; -}; - -public type inline_response_200_68 record { - string \.tag?; - inline_response_200_67_content_sync_settings[] content_sync_settings?; + inline_response_200_65_content_sync_settings[] content_sync_settings?; boolean is_team_shared_dropbox?; string name?; teamgroupsget_info_profile_status status?; - inline_response_200_67_sync_setting sync_setting?; + inline_response_200_65_sync_setting sync_setting?; string team_folder_id?; }; +public type inline_response_200_68 record { + inline_response_200_68_values[] values?; +}; + public type inline_response_200_67 record { - inline_response_200_67_content_sync_settings[] content_sync_settings?; - boolean is_team_shared_dropbox?; - string name?; - teamgroupsget_info_profile_status status?; - inline_response_200_67_sync_setting sync_setting?; - string team_folder_id?; + string cursor?; + boolean has_more?; + inline_response_200_67_team_folders[] team_folders?; }; public type inline_response_200_62 record { inline_response_200_62_results_1[] results?; }; -public type inline_response_200_61 record { - string cursor?; - boolean has_more?; - inline_response_200_61_members[] members?; -}; - public type sharing_list_mountable_folders_body record { anydata[] actions?; decimal 'limit?; }; +public type inline_response_200_61 record { + inline_response_200_61_results_1[] results?; +}; + public type inline_response_200_64 record { - inline_response_200_64_results_1[] results?; + string cursor?; + boolean has_more?; + inline_response_200_64_namespaces[] namespaces?; }; public type inline_response_200_63 record { - inline_response_200_63_results_1[] results?; + teammembersget_info_role role?; + string team_member_id?; }; -public type inline_response_200_70_upload_api_rate_limit record { +public type inline_response_200_60_results_1 record { string \.tag?; - decimal 'limit?; -}; - -public type file_propertiespropertiesupdate_update_property_groups record { - file_propertiespropertiesadd_fields[] add_or_update_fields?; - anydata[] remove_fields?; - string template_id?; + members_send_welcome_email_body invalid_user?; + inline_response_200_60_results[] results?; + members_send_welcome_email_body user?; }; public type inline_response_200_69 record { - string cursor?; - boolean has_more?; - inline_response_200_69_team_folders[] team_folders?; + string name?; + decimal num_licensed_users?; + decimal num_provisioned_users?; + inline_response_200_69_policies policies?; + string team_id?; }; public type copy_reference_get_body record { string path?; }; -public type token_from_oauth1_body record { - string oauth1_token?; - string oauth1_token_secret?; -}; - public type inline_response_200_71 record { - string name?; - decimal num_licensed_users?; - decimal num_provisioned_users?; - inline_response_200_71_policies policies?; - string team_id?; + string cursor?; + inline_response_200_71_events[] events?; + boolean has_more?; }; public type save_url_check_job_status_body record { @@ -2196,7 +2188,12 @@ public type save_url_check_job_status_body record { }; public type inline_response_200_70 record { - inline_response_200_70_values[] values?; + teammembersget_info_profile admin_profile?; +}; + +public type inline_response_200_14_entries record { + string \.tag?; + inline_response_200_9_metadata metadata?; }; public type list_folder_get_latest_cursor_body record { @@ -2209,10 +2206,6 @@ public type list_folder_get_latest_cursor_body record { boolean recursive?; }; -public type inline_response_200_71_policies_emm_state record { - string \.tag?; -}; - public type sharinglist_file_membersbatch_result_members_users record { sharingget_file_metadatabatch_result_policy_acl_update_policy access_type?; boolean is_inherited?; @@ -2222,6 +2215,18 @@ public type sharinglist_file_membersbatch_result_members_users record { sharinglist_file_membersbatch_result_members_user user?; }; +public type SearchPropertiesQuery record { + string logical_operator?; + SearchPropertiesMode mode?; + string query?; +}; + +public type inline_response_200_37_link_permissions record { + boolean can_revoke?; + inline_response_200_33_link_metadata_audience_options resolved_visibility?; + inline_response_200_37_link_permissions_revoke_failure_reason revoke_failure_reason?; +}; + public type job_status_get_body record { string async_job_id?; }; @@ -2239,6 +2244,11 @@ public type sharinglist_file_membersbatch_result record { sharinglist_file_membersbatch_result_members members?; }; +public type UpdatePropertiesRequest record { + string path?; + PropertyGroupsUpdate[] update_property_groups?; +}; + public type sharinglist_file_membersbatch_result_members_access_type record { string \.tag?; }; @@ -2247,16 +2257,25 @@ public type groups_list_body record { decimal 'limit?; }; +public type inline_response_200_71_user record { + string \.tag?; + string account_id?; + string display_name?; + string email?; + string member_external_id?; + inline_response_200_71_actor_user_team team?; + string team_member_id?; +}; + +public type inline_response_200_3_type record { + string \.tag?; +}; + public type members_list_body_1 record { boolean include_removed?; decimal 'limit?; }; -public type inline_response_200_73_origin record { - inline_response_200_73_origin_access_method access_method?; - inline_response_200_73_origin_geo_location geo_location?; -}; - # Represents the Headers record for the operation: getAccount public type GetAccountHeaders record { string? dropbox\-api\-path\-root?; @@ -2280,6 +2299,10 @@ public type users_get_account_batch_body record { string[] account_ids?; }; +public type SetProfilePhotoResponse record { + string profile_photo_url?; +}; + public type legal_holds_release_policy_body record { string id?; }; @@ -2290,25 +2313,16 @@ public type members_move_former_member_files_body record { teamgroupsmembersadd_user user?; }; -public type templates_add_for_user_body record { - string description?; - file_propertiestemplatesadd_for_team_fields[] fields?; - string name?; -}; - -public type sharing_unmount_folder_body record { - string shared_folder_id?; +public type inline_response_200_71_details_shared_content_access_level record { + string \.tag?; }; -public type templates_add_for_team_body record { - string description?; - file_propertiestemplatesadd_for_team_fields[] fields?; - string name?; +public type inline_response_200_6_deadline_allow_late_uploads record { + string \.tag?; }; -public type properties_update_body record { - string path?; - file_propertiespropertiesupdate_update_property_groups[] update_property_groups?; +public type sharing_unmount_folder_body record { + string shared_folder_id?; }; # Represents the Headers record for the operation: templatesAddForUser @@ -2327,25 +2341,13 @@ public type members_list_body record { decimal 'limit?; }; -public type inline_response_200_35_link_metadata_link_permissions record { - inline_response_200_35_link_metadata_action action?; - boolean allow?; -}; - -public type inline_response_200_64_results record { - string \.tag?; - string success?; -}; - -public type inline_response_200_19_lock_content record { - string \.tag?; - string created?; - string lock_holder_account_id?; - string lock_holder_team_id?; -}; - -public type inline_response_200_35_link_metadata_audience_options record { - string \.tag?; +public type inline_response_200_49_group_info record { + decimal created?; + string group_id?; + sharinglist_file_membersbatch_result_members_group_group_management_type group_management_type?; + string group_name?; + decimal member_count?; + teamgroupsget_info_members[] members?; }; public type sharing_remove_file_member_2_body record { @@ -2369,17 +2371,14 @@ public type teammembersget_info_profile record { string team_member_id?; }; -public type inline_response_200_5_fields record { - string description?; - string name?; - inline_response_200_5_type 'type?; +public type SetProfilePhotoRequest record { + Photo photo?; }; -public type inline_response_200_3_matches record { - string id?; - boolean is_deleted?; - string path?; - file_propertiespropertiesadd_property_groups[] property_groups?; +public type inline_response_200_22_entries record { + string \.tag?; + inline_response_200_16_file_metadata metadata?; + string thumbnail?; }; public type list_file_members_batch_body record { @@ -2391,6 +2390,16 @@ public type features_get_values_body_1 record { usersfeaturesget_values_features[] features?; }; +public type PropertyGroupsUpdate record { + PropertyField[] add_or_update_fields?; + anydata[] remove_fields?; + string template_id?; +}; + +public type RemoveTemplateForTeamRequest record { + string template_id?; +}; + # Represents the Headers record for the operation: listRevisions public type ListRevisionsHeaders record { string? dropbox\-api\-path\-root?; @@ -2407,15 +2416,8 @@ public type filesupload_sessionfinish_batch_cursor record { string session_id?; }; -public type inline_response_200_73_origin_access_method_end_user record { - string \.tag?; - string session_id?; -}; - -public type inline_response_200_73_path_namespace_relative record { - boolean is_shared_namespace?; - string ns_id?; - string relative_path?; +public type inline_response_200_28_matches record { + inline_response_200_28_metadata metadata?; }; public type copy_reference_save_body record { @@ -2436,20 +2438,6 @@ public type PropertiesOverwriteHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_45_links record { - string \.tag?; - string client_modified?; - string id?; - inline_response_200_39_link_permissions link_permissions?; - string name?; - string path_lower?; - string rev?; - string server_modified?; - decimal size?; - inline_response_200_39_team_member_info team_member_info?; - string url?; -}; - # Represents the Headers record for the operation: unlockFileBatch public type UnlockFileBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2457,6 +2445,11 @@ public type UnlockFileBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_68_has_team_shared_dropbox record { + string \.tag?; + boolean has_team_shared_dropbox?; +}; + # Represents the Headers record for the operation: listFileMembersBatch public type ListFileMembersBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2482,11 +2475,6 @@ public type teamgroupsget_info_profile_name record { string surname?; }; -public type inline_response_200_16_entries record { - string \.tag?; - inline_response_200_11_metadata metadata?; -}; - public type teamgroupsget_info_profile record { string account_id?; string email?; @@ -2517,10 +2505,6 @@ public type team_folder_archive_body record { string team_folder_id?; }; -public type inline_response_200_39_link_permissions_revoke_failure_reason record { - string \.tag?; -}; - # Represents the Headers record for the operation: removeFolderMember public type RemoveFolderMemberHeaders record { string? dropbox\-api\-path\-root?; @@ -2528,23 +2512,46 @@ public type RemoveFolderMemberHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_10_entries record { + string \.tag?; + inline_response_200_9_metadata success?; +}; + public type sharing_unshare_folder_body record { boolean leave_a_copy?; string shared_folder_id?; }; -public type inline_response_200_35_link_metadata record { - inline_response_200_35_link_metadata_audience_options[] audience_options?; - inline_response_200_35_link_metadata_audience_options current_audience?; - inline_response_200_35_link_metadata_link_permissions[] link_permissions?; - boolean password_protected?; - string url?; +public type CheckUserRequest record { + string query?; +}; + +public type inline_response_200_12_metadata_sharing_info record { + boolean no_access?; + string parent_shared_folder_id?; + boolean read_only?; + boolean traverse_only?; +}; + +public type inline_response_200_71_actor_user record { + string \.tag?; + string account_id?; + string display_name?; + string email?; + string member_external_id?; + inline_response_200_71_actor_user_team team?; + string team_member_id?; }; public type legal_holds_list_held_revisions_continue_body record { string id?; }; +public type inline_response_200_71_actor record { + string \.tag?; + inline_response_200_71_actor_user user?; +}; + public type list_received_files_continue_body record { string cursor?; }; @@ -2559,6 +2566,12 @@ public type members_set_admin_permissions_body record { members_send_welcome_email_body user?; }; +public type inline_response_200_68_values record { + string \.tag?; + inline_response_200_68_has_team_shared_dropbox has_team_shared_dropbox?; + inline_response_200_68_upload_api_rate_limit upload_api_rate_limit?; +}; + public type teamgroupsget_info_profile_status record { string \.tag?; }; @@ -2589,10 +2602,6 @@ public type devices_list_member_devices_body record { string team_member_id?; }; -public type check_app_body record { - string query?; -}; - # Represents the Headers record for the operation: copyBatchCheck public type CopyBatchCheckHeaders record { string? dropbox\-api\-path\-root?; @@ -2618,22 +2627,10 @@ public type files_copy_v2_body record { string to_path?; }; -public type inline_response_200_14_metadata_sharing_info record { - boolean no_access?; - string parent_shared_folder_id?; - boolean read_only?; - boolean traverse_only?; -}; - public type job_status_check_body record { string async_job_id?; }; -public type inline_response_200_30_metadata record { - string \.tag?; - inline_response_200_11_metadata metadata?; -}; - # Represents the Headers record for the operation: createFolderBatchCheck public type CreateFolderBatchCheckHeaders record { string? dropbox\-api\-path\-root?; @@ -2641,6 +2638,13 @@ public type CreateFolderBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_71_origin_geo_location record { + string city?; + string country?; + string ip_address?; + string region?; +}; + # Represents the Headers record for the operation: get public type GetHeaders record { string? dropbox\-api\-path\-root?; @@ -2662,25 +2666,21 @@ public type UploadSessionAppendHeaders record { string? dropbox\-api\-select\-user?; }; -public type properties_add_body record { - string path?; - file_propertiespropertiesadd_property_groups[] property_groups?; -}; - public type sharing_relinquish_file_membership_body record { string file?; }; -public type check_user_body record { - string query?; -}; - public type devices_revoke_device_session_body record { string \.tag?; string session_id?; string team_member_id?; }; +public type inline_response_200_71_origin_access_method record { + string \.tag?; + inline_response_200_71_origin_access_method_end_user end_user?; +}; + # Represents the Headers record for the operation: saveUrlCheckJobStatus public type SaveUrlCheckJobStatusHeaders record { string? dropbox\-api\-path\-root?; @@ -2732,20 +2732,23 @@ public type GetSharedLinkMetadataHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_55_policies record { - string activation_time?; - string end_date?; - string id?; - inline_response_200_53_members members?; - string name?; - string start_date?; - teamgroupsget_info_profile_status status?; -}; - public type sharing_check_share_job_status_body record { string async_job_id?; }; +public type inline_response_200_52_entries record { + string author_email?; + string author_member_id?; + teamgroupsget_info_profile_status author_member_status?; + string content_hash?; + string file_type?; + string new_filename?; + string original_file_path?; + string original_revision_id?; + string server_modified?; + decimal size?; +}; + public type create_folder_batch_check_body record { string async_job_id?; }; @@ -2757,6 +2760,11 @@ public type MoveBatchCheckHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_71_event_type record { + string \.tag?; + string description?; +}; + public type sharing_share_folder_body record { string access_inheritance?; string acl_update_policy?; @@ -2789,13 +2797,6 @@ public type UploadSessionFinishHeaders record { string? dropbox\-api\-select\-user?; }; -public type inline_response_200_66_namespaces record { - string name?; - string namespace_id?; - inline_response_200_66_namespace_type namespace_type?; - string team_member_id?; -}; - public type sharinglist_file_membersbatch_result_members_invitee record { string \.tag?; string email?; @@ -2805,23 +2806,6 @@ public type files_delete_v2_body record { string path?; }; -public type inline_response_200_18_file_metadata record { - string client_modified?; - string content_hash?; - inline_response_200_11_metadata_file_lock_info file_lock_info?; - boolean has_explicit_shared_members?; - string id?; - boolean is_downloadable?; - string name?; - string path_display?; - string path_lower?; - file_propertiespropertiesadd_property_groups[] property_groups?; - string rev?; - string server_modified?; - inline_response_200_11_metadata_sharing_info sharing_info?; - decimal size?; -}; - # Represents the Headers record for the operation: copyBatch public type CopyBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2829,6 +2813,10 @@ public type CopyBatchHeaders record { string? dropbox\-api\-select\-user?; }; +public type inline_response_200_37_link_permissions_revoke_failure_reason record { + string \.tag?; +}; + # Represents the Headers record for the operation: relinquishFileMembership public type RelinquishFileMembershipHeaders record { string? dropbox\-api\-path\-root?; @@ -2836,31 +2824,22 @@ public type RelinquishFileMembershipHeaders record { string? dropbox\-api\-select\-user?; }; -public type file_propertiespropertiesadd_property_groups record { - file_propertiespropertiesadd_fields[] fields?; - string template_id?; -}; - -public type templates_get_for_user_body record { - string template_id?; -}; - -public type inline_response_200_19_lock record { - inline_response_200_19_lock_content content?; -}; - public type list_continue_body_1 record { string cursor?; }; -public type inline_response_200_63_results record { +public type usersfeaturesget_values_features record { string \.tag?; - string not_found?; - string success?; }; -public type usersfeaturesget_values_features record { +public type inline_response_200_6_deadline record { + inline_response_200_6_deadline_allow_late_uploads allow_late_uploads?; + string deadline?; +}; + +public type inline_response_200_76_allocation record { string \.tag?; + decimal allocated?; }; public type filescopy_batch_v2_entries record { @@ -2872,12 +2851,6 @@ public type list_continue_body_5 record { string cursor?; }; -public type inline_response_200_18_export_metadata record { - string export_hash?; - string name?; - decimal size?; -}; - public type list_continue_body_4 record { string cursor?; }; @@ -2890,6 +2863,11 @@ public type list_continue_body_2 record { string cursor?; }; +public type inline_response_200_28_metadata record { + string \.tag?; + inline_response_200_9_metadata metadata?; +}; + # Represents the Headers record for the operation: getFolderMetadata public type GetFolderMetadataHeaders record { string? dropbox\-api\-path\-root?; @@ -2907,6 +2885,11 @@ public type sharingmodify_shared_link_settings_settings record { string requested_visibility?; }; +public type inline_response_200_65_content_sync_settings record { + string id?; + inline_response_200_65_sync_setting sync_setting?; +}; + # Represents the Headers record for the operation: uploadSessionFinishBatch public type UploadSessionFinishBatchHeaders record { string? dropbox\-api\-path\-root?; @@ -2915,7 +2898,7 @@ public type UploadSessionFinishBatchHeaders record { }; public type inline_response_200 record { - string profile_photo_url?; + string result?; }; # Represents the Headers record for the operation: templatesListForUser @@ -2944,24 +2927,47 @@ public type devices_revoke_device_session_batch_body record { devices_revoke_device_session_body[] revoke_devices?; }; -public type inline_response_200_58_complete record { +public type TemplateId record { + string template_id?; +}; + +public type inline_response_200_75_account_type record { string \.tag?; - teammembersget_info_profile profile?; - teammembersget_info_role role?; }; -public type inline_response_200_70_has_team_shared_dropbox record { +public type RemovePropertiesRequest record { + string path?; + string[] property_template_ids?; +}; + +public type inline_response_200_12_metadata record { + string id?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + inline_response_200_12_metadata_sharing_info sharing_info?; +}; + +public type inline_response_200_33_link_metadata_audience_options record { string \.tag?; - boolean has_team_shared_dropbox?; }; -public type inline_response_200_69_team_folders record { - inline_response_200_67_content_sync_settings[] content_sync_settings?; - boolean is_team_shared_dropbox?; +public type inline_response_200_16_file_metadata record { + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; string name?; - teamgroupsget_info_profile_status status?; - inline_response_200_67_sync_setting sync_setting?; - string team_folder_id?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; public type filesget_thumbnail_batch_entries record { @@ -2992,9 +2998,22 @@ public type ProxyConfig record {| string password = ""; |}; -public type inline_response_200_15_entries record { +public type inline_response_200_9_metadata record { string \.tag?; - inline_response_200_14_metadata metadata?; + string client_modified?; + string content_hash?; + inline_response_200_9_metadata_file_lock_info file_lock_info?; + boolean has_explicit_shared_members?; + string id?; + boolean is_downloadable?; + string name?; + string path_display?; + string path_lower?; + PropertyGroup[] property_groups?; + string rev?; + string server_modified?; + inline_response_200_9_metadata_sharing_info sharing_info?; + decimal size?; }; public type copy_batch_check_v2_body record { @@ -3015,27 +3034,8 @@ public type sharing_transfer_folder_body record { string to_dropbox_id?; }; -public type inline_response_200_71_policies_sharing record { - inline_response_200_71_policies_sharing_shared_folder_join_policy shared_folder_join_policy?; - sharingget_file_metadatabatch_result_policy_resolved_member_policy shared_folder_member_policy?; - inline_response_200_71_policies_sharing_shared_link_create_policy shared_link_create_policy?; -}; - # Represents the Headers record for the operation: app public type AppHeaders record { string? dropbox\-api\-path\-root?; string? dropbox\-api\-select\-user?; }; - -public type inline_response_200_73_events record { - inline_response_200_73_actor actor?; - inline_response_200_73_assets[] assets?; - inline_response_200_73_actor_user context?; - inline_response_200_73_details details?; - inline_response_200_73_event_category event_category?; - inline_response_200_73_event_type event_type?; - boolean involve_non_team_member?; - inline_response_200_73_origin origin?; - inline_response_200_73_participants[] participants?; - string timestamp?; -}; diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json deleted file mode 100644 index 4c384d4..0000000 --- a/docs/spec/openapi.json +++ /dev/null @@ -1,33990 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "Dropbox API Reference", - "description": "The powerful, yet simple, Dropbox API allows you to manage and control content and team settings programmatically and extend Dropbox capabilities in new and powerful ways. This is a collection that includes requests to all endpoints in the Dropbox API. \n\nThe Dropbox API is divided in two groups of endpoints: User Endpoints and Business Endpoints. Operations that would most likely be executed by a user, such as file operations, are in the User Endpoints folder. Operations that would most likely be executed by a team administrator, such as adding users to groups, live in the Business Endpoints folder. \n\nIf you are new to Dropbox Business and Team Administration, please have a look at the [Dropobox Admin Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide). \n\nIf you want more information on how to use our API please refer to our [Developer Portal](https://www.dropbox.com/developers). \n\n# What's in the collection?\n\nThe endpoints are organized in the following folders:\n* account\n* auth\n* check\n* contacts\n* file_properties\n* file_requests\n* files\n* sharing\n* team\n* team_log\n* users\n\n# Authorization\n\n## OAuth 2.0 for API Access\nDropbox uses OAuth 2.0, an open specification, to authorize access to data. To get an OAuth token from Dropbox to enable Postman to access your Dropbox account via the API you’ll need to create a new app on the DBX Platform.\n\n## Creating an App on the DBX Platform\nNavigate to https://www.dropbox.com/developers/apps and select “Create app” \n1. Choose an API \n2. Choose the type of access you need \n3. Give your app a name \n4. Choose the Dropbox account that will own your app \n\nFor reference, please use the [Dropbox OAuth guide](https://www.dropbox.com/lp/developers/reference/oauth-guide) \n\n## Generating an Access Token\nOnce you select “Create app” a page will load that displays information about your newly created app. To generate an access token scroll down to “OAuth 2” and click “Generate” beneath “Generated access token.” The token will display as a long string of characters. Copy this token for use with the Postman Collection.\n\n## Adding an Access Token to the requests\nIn the Postman client, click on the three dots to the right of the collection name to \"View more actions.\"\n\n![Screenshot of adding access token](https://www.dropbox.com/s/sfebu9ai76cbq39/Screen%20Shot%202020-10-28%20at%2012.50.56%20AM.png?raw=1)\n\nThen, click \"Edit.\"\n\nClick on the \"Variables\" tab and, in the row for the `access_token` variable, paste your access token in the `CURRENT VALUE` column. The default value is `your-access-token-here`.\n\n![Screenshot of adding access token](https://www.dropbox.com/s/ahnbxwe6oscjues/Screen%20Shot%202020-10-28%20at%2012.51.13%20AM.png?raw=1)\n\nFor information on sessions and variables in Postman see the blog post at https://blog.postman.com/sessions-faq/.\n\n# Notes\n* Dropbox also has a Postman Collection in the API Network to help administrators with team management workflows. It is called [Dropbox Team Admin Workflows](). \n\n", - "version": "1.0.0", - "contact": {} - }, - "servers": [ - { - "url": "https://api.dropboxapi.com/2" - }, - { - "url": "https://content.dropboxapi.com/2" - }, - { - "url": "https://notify.dropboxapi.com/2" - } - ], - "paths": { - "/account/set_profile_photo": { - "post": { - "tags": [ - "account" - ], - "summary": "set_profile_photo", - "description": "[set_profile_photo](https://www.dropbox.com/developers/documentation/http/documentation#account-set_profile_photo)\n\nscope: `account_info.write`\n\nSets a user's profile photo.", - "operationId": "setProfilePhoto", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "photo": { - "$ref": "#/components/schemas/Photo" - } - } - }, - "examples": { - "set_profile_photo": { - "value": { - "photo": { - ".tag": "base64_data", - "base64_data": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "set_profile_photo response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - }, - "examples": { - "set_profile_photo response": { - "value": { - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - } - } - } - } - } - } - }, - "/auth/token/from_oauth1": { - "post": { - "tags": [ - "auth" - ], - "summary": "token/from_oauth1", - "description": "[token/from_oauth1](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-from_oauth1)\n\nscope: `None`\n\nCreates an OAuth 2.0 access token from the supplied OAuth 1.0 access token.", - "operationId": "tokenFromOauth1", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "oauth1_token": { - "type": "string", - "example": "qievr8hamyg6ndck" - }, - "oauth1_token_secret": { - "type": "string", - "example": "qomoftv0472git7" - } - } - }, - "examples": { - "token/from_oauth1": { - "value": { - "oauth1_token": "qievr8hamyg6ndck", - "oauth1_token_secret": "qomoftv0472git7" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "token/from_oauth1 response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "oauth2_token": { - "type": "string", - "example": "9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn" - } - } - }, - "examples": { - "token/from_oauth1 response": { - "value": { - "oauth2_token": "9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn" - } - } - } - } - } - } - } - } - }, - "/auth/token/revoke": { - "post": { - "tags": [ - "auth" - ], - "summary": "token/revoke", - "description": "[token/revoke](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-revoke)\n\nscope: `None`\n\nDisables the access token used to authenticate the call.", - "operationId": "tokenRevoke", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/check/app": { - "post": { - "tags": [ - "check" - ], - "summary": "app", - "description": "[app](https://www.dropbox.com/developers/documentation/http/documentation#check-app)\n\nscope: `None`\n\nThis 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.", - "operationId": "app", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "query": { - "type": "string", - "example": "foo" - } - } - }, - "examples": { - "app": { - "value": { - "query": "foo" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "app response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "foo" - } - } - }, - "examples": { - "app response": { - "value": { - "result": "foo" - } - } - } - } - } - } - } - } - }, - "/check/user": { - "post": { - "tags": [ - "check" - ], - "summary": "user", - "description": "[user](https://www.dropbox.com/developers/documentation/http/documentation#check-user)\n\nscope: `None`\n\nThis 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.", - "operationId": "user", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "query": { - "type": "string", - "example": "foo" - } - } - }, - "examples": { - "user": { - "value": { - "query": "foo" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "foo" - } - } - }, - "examples": { - "user response": { - "value": { - "result": "foo" - } - } - } - } - } - } - } - } - }, - "/contacts/delete_manual_contacts": { - "post": { - "tags": [ - "contacts" - ], - "summary": "delete_manual_contacts", - "description": "[delete_manual_contacts](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts)\n\nscope: `contacts.write`\n\nRemoves 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.", - "operationId": "deleteManualContacts", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/contacts/delete_manual_contacts_batch": { - "post": { - "tags": [ - "contacts" - ], - "summary": "delete_manual_contacts_batch", - "description": "[delete_manual_contacts_batch](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts_batch)\n\nscope: `contacts.write`\n\nRemoves manually added contacts from the given list.", - "operationId": "deleteManualContactsBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "email_addresses": { - "type": "array", - "items": { - "type": "string", - "example": "contactemailaddress1@domain.com" - }, - "example": [ - "contactemailaddress1@domain.com", - "contactemailaddress2@domain.com" - ] - } - } - }, - "examples": { - "delete_manual_contacts_batch": { - "value": { - "email_addresses": [ - "contactemailaddress1@domain.com", - "contactemailaddress2@domain.com" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/properties/add": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/add", - "description": "[properties/add](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-add)\n\nscope: `files.metadata.write`\n\nAdd property groups to a Dropbox file. See `templates/add_for_user` or `templates/add_for_team` to create new templates.", - "operationId": "propertiesAdd", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "examples": { - "properties/add": { - "value": { - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/properties/overwrite": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/overwrite", - "description": "[properties/overwrite](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-overwrite)\n\nscope: `files.metadata.write`\n\nOverwrite property groups associated with a file. This endpoint should be used instead of `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 `properties/update` will only delete fields that are explicitly marked for deletion.", - "operationId": "propertiesOverwrite", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "examples": { - "properties/overwrite": { - "value": { - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/properties/remove": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/remove", - "description": "[properties/remove](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-remove)\n\nscope: `files.metadata.write`\n\nPermanently removes the specified property group from the file. To remove specific property field key value pairs, see `properties/update`. To update a template, see `templates/update_for_user` or `templates/update_for_team`. To remove a template, see `templates/remove_for_user` or `templates/remove_for_team`.", - "operationId": "propertiesRemove", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_template_ids": { - "type": "array", - "items": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "example": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - }, - "examples": { - "properties/remove": { - "value": { - "path": "/my_awesome/word.docx", - "property_template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/properties/search": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/search", - "description": "[properties/search](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search)\n\nscope: `files.metadata.read`\n\nSearch across property templates for particular property field values.", - "operationId": "propertiesSearch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "logical_operator": { - "type": "string", - "example": "or_operator" - }, - "mode": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "field_name" - }, - "field_name": { - "type": "string", - "example": "Security" - } - } - }, - "query": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "logical_operator": "or_operator", - "mode": { - ".tag": "field_name", - "field_name": "Security" - }, - "query": "Confidential" - } - ] - }, - "template_filter": { - "type": "string", - "example": "filter_none" - } - } - }, - "examples": { - "properties/search": { - "value": { - "queries": [ - { - "logical_operator": "or_operator", - "mode": { - ".tag": "field_name", - "field_name": "Security" - }, - "query": "Confidential" - } - ], - "template_filter": "filter_none" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "properties/search response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "is_deleted": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "is_deleted": false, - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - ] - } - } - }, - "examples": { - "properties/search response": { - "value": { - "matches": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "is_deleted": false, - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - ] - } - } - } - } - } - } - } - } - }, - "/file_properties/properties/search/continue": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/search/continue", - "description": "[properties/search/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search-continue)\n\nscope: `files.metadata.read`\n\nOnce a cursor has been retrieved from `properties/search`, use this to paginate through all search results.", - "operationId": "propertiesSearchContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "properties/search/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "properties/search/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "is_deleted": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "is_deleted": false, - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - ] - } - } - }, - "examples": { - "properties/search/continue response": { - "value": { - "matches": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "is_deleted": false, - "path": "/my_awesome/word.docx", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - ] - } - } - } - } - } - } - } - } - }, - "/file_properties/properties/update": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "properties/update", - "description": "[properties/update](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-update)\n\nscope: `files.metadata.write`\n\nAdd, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of `properties/overwrite` when property groups are being updated via a \"delta\" instead of via a \"snapshot\" . In other words, this endpoint will not delete any omitted fields from a property group, whereas `properties/overwrite` will delete any fields that are omitted from a property group.", - "operationId": "propertiesUpdate", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/my_awesome/word.docx" - }, - "update_property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "add_or_update_fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "remove_fields": { - "type": "array", - "items": {}, - "example": [] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "add_or_update_fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "remove_fields": [], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - }, - "examples": { - "properties/update": { - "value": { - "path": "/my_awesome/word.docx", - "update_property_groups": [ - { - "add_or_update_fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "remove_fields": [], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/templates/add_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/add_for_team", - "description": "[templates/add_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-add_for_team)\n\nscope: `files.team_metadata.write`\n\nAdd a template associated with a team. See `properties/add` to add properties to a file or folder.\nNote: this endpoint will create team-owned templates.", - "operationId": "templatesAddForTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "These properties describe how confidential this file or folder is." - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "string", - "example": "string" - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ] - }, - "name": { - "type": "string", - "example": "Security" - } - } - }, - "examples": { - "templates/add_for_team": { - "value": { - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ], - "name": "Security" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/add_for_team response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/add_for_team response": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/add_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/add_for_user", - "description": "[templates/add_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-add_for_user)\n\nscope: `files.metadata.write`\n\nAdd a template associated with a user. See `properties/add` to add properties to a file. This endpoint can't be called on a team member or admin's behalf.", - "operationId": "templatesAddForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "These properties describe how confidential this file or folder is." - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "string", - "example": "string" - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ] - }, - "name": { - "type": "string", - "example": "Security" - } - } - }, - "examples": { - "templates/add_for_user": { - "value": { - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ], - "name": "Security" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/add_for_user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/add_for_user response": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - } - } - } - }, - "/file_properties/templates/get_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/get_for_team", - "description": "[templates/get_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-get_for_team)\n\nscope: `files.team_metadata.write`\n\nGet the schema for a specified template.", - "operationId": "templatesGetForTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/get_for_team": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/get_for_team response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "These properties describe how confidential this file or folder is." - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "string" - } - } - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": { - ".tag": "string" - } - } - ] - }, - "name": { - "type": "string", - "example": "Security" - } - } - }, - "examples": { - "templates/get_for_team response": { - "value": { - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": { - ".tag": "string" - } - } - ], - "name": "Security" - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/get_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/get_for_user", - "description": "[templates/get_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-get_for_user)\n\nscope: `files.metadata.read`\n\nGet the schema for a specified template. This endpoint can't be called on a team member or admin's behalf.", - "operationId": "templatesGetForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/get_for_user": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/get_for_user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "These properties describe how confidential this file or folder is." - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "string" - } - } - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": { - ".tag": "string" - } - } - ] - }, - "name": { - "type": "string", - "example": "Security" - } - } - }, - "examples": { - "templates/get_for_user response": { - "value": { - "description": "These properties describe how confidential this file or folder is.", - "fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": { - ".tag": "string" - } - } - ], - "name": "Security" - } - } - } - } - } - } - } - } - }, - "/file_properties/templates/list_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/list_for_team", - "description": "[templates/list_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-list_for_team)\n\nscope: `files.team_metadata.write`\n\nGet the template identifiers for a team. To get the schema of each template use `templates/get_for_team`.", - "operationId": "templatesListForTeam", - "responses": { - "200": { - "description": "templates/list_for_team response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_ids": { - "type": "array", - "items": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "example": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - }, - "examples": { - "templates/list_for_team response": { - "value": { - "template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/list_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/list_for_user", - "description": "[templates/list_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-list_for_user)\n\nscope: `files.metadata.read`\n\nGet the template identifiers for a team. To get the schema of each template use `templates/get_for_user`. This endpoint can't be called on a team member or admin's behalf.", - "operationId": "templatesListForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "templates/list_for_user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_ids": { - "type": "array", - "items": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - }, - "example": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - }, - "examples": { - "templates/list_for_user response": { - "value": { - "template_ids": [ - "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - ] - } - } - } - } - } - } - } - } - }, - "/file_properties/templates/remove_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/remove_for_team", - "description": "[templates/remove_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-remove_for_team)\n\nscope: `files.team_metadata.write`\n\nPermanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone.", - "operationId": "templatesRemoveForTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/remove_for_team": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/remove_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/remove_for_user", - "description": "[templates/remove_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-remove_for_user)\n\nscope: `files.metadata.write`\n\nPermanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone.", - "operationId": "templatesRemoveForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/remove_for_user": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/file_properties/templates/update_for_team": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/update_for_team", - "description": "[templates/update_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-update_for_team)\n\nscope: `files.team_metadata.write`\n\nUpdate a template associated with a team. This route can update the template name, the template description and add optional properties to templates.", - "operationId": "templatesUpdateForTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "add_fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "string", - "example": "string" - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ] - }, - "description": { - "type": "string", - "example": "These properties will describe how confidential this file or folder is." - }, - "name": { - "type": "string", - "example": "New Security Template Name" - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/update_for_team": { - "value": { - "add_fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ], - "description": "These properties will describe how confidential this file or folder is.", - "name": "New Security Template Name", - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/update_for_team response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/update_for_team response": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/file_properties/templates/update_for_user": { - "post": { - "tags": [ - "file_properties" - ], - "summary": "templates/update_for_user", - "description": "[templates/update_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-update_for_user)\n\nscope: `files.metadata.write`\n\nUpdate 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.", - "operationId": "templatesUpdateForUser", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "add_fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal." - }, - "name": { - "type": "string", - "example": "Security Policy" - }, - "type": { - "type": "string", - "example": "string" - } - } - }, - "example": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ] - }, - "description": { - "type": "string", - "example": "These properties will describe how confidential this file or folder is." - }, - "name": { - "type": "string", - "example": "New Security Template Name" - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/update_for_user": { - "value": { - "add_fields": [ - { - "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.", - "name": "Security Policy", - "type": "string" - } - ], - "description": "These properties will describe how confidential this file or folder is.", - "name": "New Security Template Name", - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "templates/update_for_user response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "examples": { - "templates/update_for_user response": { - "value": { - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - } - } - } - } - } - } - }, - "/file_requests/count": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "count", - "description": "[count](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-count)\n\nscope: `file_requests.read`\n\nReturns the total number of file requests owned by this user. Includes both open and closed file requests.", - "operationId": "count", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "count response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file_request_count": { - "type": "number", - "example": 15 - } - } - }, - "examples": { - "count response": { - "value": { - "file_request_count": 15 - } - } - } - } - } - } - } - } - }, - "/file_requests/create": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "create", - "description": "[create](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-create)\n\nscope: `file_requests.write`\n\nCreates a file request for this user.", - "operationId": "create", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "string", - "example": "seven_days" - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - } - } - }, - "examples": { - "create": { - "value": { - "deadline": { - "allow_late_uploads": "seven_days", - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "open": true, - "title": "Homework submission" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "create response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "examples": { - "create response": { - "value": { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - } - } - } - } - } - } - }, - "/file_requests/delete": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "delete", - "description": "[delete](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete)\n\nscope: `file_requests.write`\n\nDelete a batch of closed file requests.", - "operationId": "delete", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ids": { - "type": "array", - "items": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "example": [ - "oaCAVmEyrqYnkZX9955Y", - "BaZmehYoXMPtaRmfTbSG" - ] - } - } - }, - "examples": { - "delete": { - "value": { - "ids": [ - "oaCAVmEyrqYnkZX9955Y", - "BaZmehYoXMPtaRmfTbSG" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "delete response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file_requests": { - "type": "array", - "items": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "example": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - } - } - }, - "examples": { - "delete response": { - "value": { - "file_requests": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - } - } - } - } - } - } - } - } - }, - "/file_requests/delete_all_closed": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "delete_all_closed", - "description": "[delete_all_closed](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete_all_closed)\n\nscope: `file_requests.write`\n\nDelete all closed file requests owned by this user.", - "operationId": "deleteAllClosed", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "delete_all_closed response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file_requests": { - "type": "array", - "items": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "example": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - } - } - }, - "examples": { - "delete_all_closed response": { - "value": { - "file_requests": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - } - } - } - } - } - } - } - } - }, - "/file_requests/get": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "get", - "description": "[get](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-get)\n\nscope: `file_requests.read`\n\nReturns the specified file request.", - "operationId": "get", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - } - } - }, - "examples": { - "get": { - "value": { - "id": "oaCAVmEyrqYnkZX9955Y" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "examples": { - "get response": { - "value": { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - } - } - } - } - } - } - }, - "/file_requests/list_v2": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "list", - "description": "[list](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list)\n\nscope: `file_requests.read`\n\nReturns 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.", - "operationId": "list", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 1000 - } - } - }, - "examples": { - "list": { - "value": { - "limit": 1000 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "file_requests": { - "type": "array", - "items": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "example": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - }, - "has_more": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "file_requests": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ], - "has_more": true - } - } - } - } - } - } - } - } - }, - "/file_requests/list/continue": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "list/continue", - "description": "[list/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list-continue)\n\nscope: `file_requests.read`\n\nOnce a cursor has been retrieved from `list:2`, use this to paginate through all file requests. The cursor must come from a previous call to `list:2` or `list/continue`.", - "operationId": "listContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "file_requests": { - "type": "array", - "items": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "example": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ] - }, - "has_more": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "file_requests": [ - { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - }, - { - "created": "2015-11-02T04:00:00Z", - "deadline": { - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/Photo contest entries", - "file_count": 105, - "id": "BAJ7IrRGicQKGToykQdB", - "is_open": true, - "title": "Photo contest submission", - "url": "https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB" - }, - { - "created": "2015-12-15T13:02:00Z", - "destination": "/Wedding photos", - "file_count": 37, - "id": "rxwMPvK3ATTa0VxOJu5T", - "is_open": true, - "title": "Wedding photo submission", - "url": "https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T" - } - ], - "has_more": true - } - } - } - } - } - } - } - } - }, - "/file_requests/update": { - "post": { - "tags": [ - "file_requests" - ], - "summary": "update", - "description": "[update](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-update)\n\nscope: `file_requests.write`\n\nUpdate a file request.", - "operationId": "update", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "deadline": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "update" - }, - "allow_late_uploads": { - "type": "string", - "example": "seven_days" - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - } - } - }, - "examples": { - "update": { - "value": { - "deadline": { - ".tag": "update", - "allow_late_uploads": "seven_days", - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "id": "oaCAVmEyrqYnkZX9955Y", - "open": true, - "title": "Homework submission" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "update response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-10-05T17:00:00Z" - }, - "deadline": { - "type": "object", - "properties": { - "allow_late_uploads": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "seven_days" - } - } - }, - "deadline": { - "type": "string", - "example": "2020-10-12T17:00:00Z" - } - } - }, - "destination": { - "type": "string", - "example": "/File Requests/Homework" - }, - "file_count": { - "type": "number", - "example": 3 - }, - "id": { - "type": "string", - "example": "oaCAVmEyrqYnkZX9955Y" - }, - "is_open": { - "type": "boolean", - "example": true - }, - "title": { - "type": "string", - "example": "Homework submission" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - }, - "examples": { - "update response": { - "value": { - "created": "2015-10-05T17:00:00Z", - "deadline": { - "allow_late_uploads": { - ".tag": "seven_days" - }, - "deadline": "2020-10-12T17:00:00Z" - }, - "destination": "/File Requests/Homework", - "file_count": 3, - "id": "oaCAVmEyrqYnkZX9955Y", - "is_open": true, - "title": "Homework submission", - "url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y" - } - } - } - } - } - } - } - } - }, - "/files/copy_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "copy", - "description": "[copy](https://www.dropbox.com/developers/documentation/http/documentation#files-copy)\n\nscope: `files.content.write`\n\nCopy 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.", - "operationId": "copy", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "allow_ownership_transfer": { - "type": "boolean", - "example": false - }, - "allow_shared_folder": { - "type": "boolean", - "example": false - }, - "autorename": { - "type": "boolean", - "example": false - }, - "from_path": { - "type": "string", - "example": "/Homework/math" - }, - "to_path": { - "type": "string", - "example": "/Homework/algebra" - } - } - }, - "examples": { - "copy": { - "value": { - "allow_ownership_transfer": false, - "allow_shared_folder": false, - "autorename": false, - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "copy response": { - "value": { - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/copy_batch_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "copy_batch", - "description": "[copy_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch)\n\nscope: `files.content.write`\n\nCopy multiple files or folders to different locations at once in the user's Dropbox.\nThis route will replace `copy_batch:1`. The main difference is this route will return status for each entry, while `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 `copy_batch/check:2` to check the job status.", - "operationId": "copyBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": false - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "from_path": { - "type": "string", - "example": "/Homework/math" - }, - "to_path": { - "type": "string", - "example": "/Homework/algebra" - } - } - }, - "example": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ] - } - } - }, - "examples": { - "copy_batch": { - "value": { - "autorename": false, - "entries": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "copy_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/copy_batch/check_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "copy_batch/check", - "description": "[copy_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `copy_batch:2`. It returns list of results for each entry.", - "operationId": "copyBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "copy_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "copy_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/copy_reference/get": { - "post": { - "tags": [ - "files" - ], - "summary": "copy_reference/get", - "description": "[copy_reference/get](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-get)\n\nscope: `files.content.write`\n\nGet 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 `copy_reference/save`.", - "operationId": "copyReferenceGet", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/video.mp4" - } - } - }, - "examples": { - "copy_reference/get": { - "value": { - "path": "/video.mp4" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy_reference/get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "copy_reference": { - "type": "string", - "example": "z1X6ATl6aWtzOGq0c3g5Ng" - }, - "expires": { - "type": "string", - "example": "2045-05-12T15:50:38Z" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "copy_reference/get response": { - "value": { - "copy_reference": "z1X6ATl6aWtzOGq0c3g5Ng", - "expires": "2045-05-12T15:50:38Z", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/copy_reference/save": { - "post": { - "tags": [ - "files" - ], - "summary": "copy_reference/save", - "description": "[copy_reference/save](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-save)\n\nscope: `files.content.write`\n\nSave a copy reference returned by `copy_reference/get` to the user's Dropbox.", - "operationId": "copyReferenceSave", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "copy_reference": { - "type": "string", - "example": "z1X6ATl6aWtzOGq0c3g5Ng" - }, - "path": { - "type": "string", - "example": "/video.mp4" - } - } - }, - "examples": { - "copy_reference/save": { - "value": { - "copy_reference": "z1X6ATl6aWtzOGq0c3g5Ng", - "path": "/video.mp4" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "copy_reference/save response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "copy_reference/save response": { - "value": { - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/create_folder_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "create_folder", - "description": "[create_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder)\n\nscope: `files.content.write`\n\nCreate a folder at a given path.", - "operationId": "createFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/Homework/math" - } - } - }, - "examples": { - "create_folder": { - "value": { - "autorename": false, - "path": "/Homework/math" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "create_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "name": { - "type": "string", - "example": "math" - }, - "path_display": { - "type": "string", - "example": "/Homework/math" - }, - "path_lower": { - "type": "string", - "example": "/homework/math" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "sharing_info": { - "type": "object", - "properties": { - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": false - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - } - } - } - } - }, - "examples": { - "create_folder response": { - "value": { - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - } - } - } - } - } - } - } - }, - "/files/create_folder_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "create_folder_batch", - "description": "[create_folder_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch)\n\nscope: `files.content.write`\n\nCreate 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 `CreateFolderBatchArg.force_async` flag. Use `create_folder_batch/check` to check the job status.", - "operationId": "createFolderBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": false - }, - "force_async": { - "type": "boolean", - "example": false - }, - "paths": { - "type": "array", - "items": { - "type": "string", - "example": "/Homework/math" - }, - "example": [ - "/Homework/math" - ] - } - } - }, - "examples": { - "create_folder_batch": { - "value": { - "autorename": false, - "force_async": false, - "paths": [ - "/Homework/math" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "create_folder_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "name": { - "type": "string", - "example": "math" - }, - "path_display": { - "type": "string", - "example": "/Homework/math" - }, - "path_lower": { - "type": "string", - "example": "/homework/math" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "sharing_info": { - "type": "object", - "properties": { - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": false - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - ] - } - } - }, - "examples": { - "create_folder_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/create_folder_batch/check": { - "post": { - "tags": [ - "files" - ], - "summary": "create_folder_batch/check", - "description": "[create_folder_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `create_folder_batch`. If success, it returns list of result for each entry.", - "operationId": "createFolderBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "create_folder_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "create_folder_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "name": { - "type": "string", - "example": "math" - }, - "path_display": { - "type": "string", - "example": "/Homework/math" - }, - "path_lower": { - "type": "string", - "example": "/homework/math" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "sharing_info": { - "type": "object", - "properties": { - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": false - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - ] - } - } - }, - "examples": { - "create_folder_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/delete_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "delete", - "description": "[delete](https://www.dropbox.com/developers/documentation/http/documentation#files-delete)\n\nscope: `files.content.write`\n\nDelete 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 `FileMetadata` or `FolderMetadata` for the item at time of deletion, and not a `DeletedMetadata` object.", - "operationId": "delete1", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - } - } - }, - "examples": { - "delete": { - "value": { - "path": "/Homework/math/Prime_Numbers.txt" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "delete response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "delete response": { - "value": { - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/delete_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "delete_batch", - "description": "[delete_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch)\n\nscope: `files.content.write`\n\nDelete multiple files/folders at once.\nThis route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use `delete_batch/check` to check the job status.", - "operationId": "deleteBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - } - } - }, - "example": [ - { - "path": "/Homework/math/Prime_Numbers.txt" - } - ] - } - } - }, - "examples": { - "delete_batch": { - "value": { - "entries": [ - { - "path": "/Homework/math/Prime_Numbers.txt" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "delete_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "delete_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/delete_batch/check": { - "post": { - "tags": [ - "files" - ], - "summary": "delete_batch/check", - "description": "[delete_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `delete_batch`. If success, it returns list of result for each entry.", - "operationId": "deleteBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "delete_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "delete_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "delete_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/download": { - "post": { - "tags": [ - "files" - ], - "summary": "download", - "description": "[download](https://www.dropbox.com/developers/documentation/http/documentation#files-download)\n\nscope: `files.content.read`\n\nDownload a file from a user's Dropbox.", - "operationId": "download", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/Homework/math/Prime_Numbers.txt\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "download response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "download response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/download_zip": { - "post": { - "tags": [ - "files" - ], - "summary": "download_zip", - "description": "[download_zip](https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip)\n\nscope: `files.content.read`\n\nDownload a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size.", - "operationId": "downloadZip", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/Homework/math\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "download_zip response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXz" - }, - "name": { - "type": "string", - "example": "math" - }, - "path_display": { - "type": "string", - "example": "/Homework/math" - }, - "path_lower": { - "type": "string", - "example": "/homework/math" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "sharing_info": { - "type": "object", - "properties": { - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": false - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - } - } - } - } - }, - "examples": { - "download_zip response": { - "value": { - "metadata": { - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - } - } - } - } - } - } - } - } - }, - "/files/export": { - "post": { - "tags": [ - "files" - ], - "summary": "export", - "description": "[export](https://www.dropbox.com/developers/documentation/http/documentation#files-export)\n\nscope: `files.content.read`\n\nExport a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose `ExportResult.file_metadata` has `ExportInfo.export_as` populated.", - "operationId": "export", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/Homework/math/Prime_Numbers.gsheet\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "export response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "export_metadata": { - "type": "object", - "properties": { - "export_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "name": { - "type": "string", - "example": "Prime_Numbers.xlsx" - }, - "size": { - "type": "number", - "example": 7189 - } - } - }, - "file_metadata": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "export response": { - "value": { - "export_metadata": { - "export_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "name": "Prime_Numbers.xlsx", - "size": 7189 - }, - "file_metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/get_file_lock_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "get_file_lock_batch", - "description": "[get_file_lock_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_file_lock_batch)\n\nscope: `files.content.read`\n\nReturn the lock metadata for the given list of paths.", - "operationId": "getFileLockBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/John Doe/sample/test.pdf" - } - } - }, - "example": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - }, - "examples": { - "get_file_lock_batch": { - "value": { - "entries": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_file_lock_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "lock": { - "type": "object", - "properties": { - "content": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "single_user" - }, - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "lock_holder_account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "lock_holder_team_id": { - "type": "string", - "example": "dbtid:1234abcd" - } - } - } - } - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "get_file_lock_batch response": { - "value": { - "entries": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/get_metadata": { - "post": { - "tags": [ - "files" - ], - "summary": "get_metadata", - "description": "[get_metadata](https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata)\n\nscope: `files.metadata.read`\n\nReturns the metadata for a file or folder.\nNote: Metadata for the root folder is unsupported.", - "operationId": "getMetadata", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_deleted": { - "type": "boolean", - "example": false - }, - "include_has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "include_media_info": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/Homework/math" - } - } - }, - "examples": { - "get_metadata": { - "value": { - "include_deleted": false, - "include_has_explicit_shared_members": false, - "include_media_info": false, - "path": "/Homework/math" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_metadata response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "get_metadata response": { - "value": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/get_preview": { - "post": { - "tags": [ - "files" - ], - "summary": "get_preview", - "description": "[get_preview](https://www.dropbox.com/developers/documentation/http/documentation#files-get_preview)\n\nscope: `files.content.read`\n\nGet 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.", - "operationId": "getPreview", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/word.docx\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "get_preview response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "get_preview response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/get_temporary_link": { - "post": { - "tags": [ - "files" - ], - "summary": "get_temporary_link", - "description": "[get_temporary_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link)\n\nscope: `files.content.read`\n\nGet 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.", - "operationId": "getTemporaryLink", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/video.mp4" - } - } - }, - "examples": { - "get_temporary_link": { - "value": { - "path": "/video.mp4" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_temporary_link response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "link": { - "type": "string", - "example": "https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2" - }, - "metadata": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "get_temporary_link response": { - "value": { - "link": "https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2", - "metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/get_temporary_upload_link": { - "post": { - "tags": [ - "files" - ], - "summary": "get_temporary_upload_link", - "description": "[get_temporary_upload_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_upload_link)\n\nscope: `files.content.write`\n\nGet a one-time use temporary upload link to upload a file to a Dropbox location.\n\nThis endpoint acts as a delayed `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 `CommitInfo` previously provided to `get_temporary_upload_link` but evaluated only upon consumption. Hence, errors stemming from invalid `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 succesful 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.", - "operationId": "getTemporaryUploadLink", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "commit_info": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": true - }, - "mode": { - "type": "string", - "example": "add" - }, - "mute": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/Homework/math/Matrices.txt" - }, - "strict_conflict": { - "type": "boolean", - "example": false - } - } - }, - "duration": { - "type": "number", - "example": 3600 - } - } - }, - "examples": { - "get_temporary_upload_link": { - "value": { - "commit_info": { - "autorename": true, - "mode": "add", - "mute": false, - "path": "/Homework/math/Matrices.txt", - "strict_conflict": false - }, - "duration": 3600 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_temporary_upload_link response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "link": { - "type": "string", - "example": "https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND" - } - } - }, - "examples": { - "get_temporary_upload_link response": { - "value": { - "link": "https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND" - } - } - } - } - } - } - } - } - }, - "/files/get_thumbnail_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "get_thumbnail", - "description": "[get_thumbnail](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail)\n\nscope: `files.content.read`\n\nGet a thumbnail for a file.", - "operationId": "getThumbnail", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"resource\": {\n \".tag\": \"path\", \n \"path\": \"/a.docx\"\n }, \n \"format\": \"jpeg\", \n \"size\": \"w64h64\", \n \"mode\": \"strict\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "get_thumbnail response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file_metadata": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "get_thumbnail response": { - "value": { - "file_metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/get_thumbnail_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "get_thumbnail_batch", - "description": "[get_thumbnail_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail_batch)\n\nscope: `files.content.read`\n\nGet 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 and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.", - "operationId": "getThumbnailBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "format": { - "type": "string", - "example": "jpeg" - }, - "mode": { - "type": "string", - "example": "strict" - }, - "path": { - "type": "string", - "example": "/image.jpg" - }, - "size": { - "type": "string", - "example": "w64h64" - } - } - }, - "example": [ - { - "format": "jpeg", - "mode": "strict", - "path": "/image.jpg", - "size": "w64h64" - } - ] - } - } - }, - "examples": { - "get_thumbnail_batch": { - "value": { - "entries": [ - { - "format": "jpeg", - "mode": "strict", - "path": "/image.jpg", - "size": "w64h64" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_thumbnail_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "metadata": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "thumbnail": { - "type": "string", - "example": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" - } - } - }, - "example": [ - { - ".tag": "success", - "metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - "thumbnail": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" - } - ] - } - } - }, - "examples": { - "get_thumbnail_batch response": { - "value": { - "entries": [ - { - ".tag": "success", - "metadata": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - "thumbnail": "iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI=" - } - ] - } - } - } - } - } - } - } - } - }, - "/files/list_folder": { - "post": { - "tags": [ - "files" - ], - "summary": "list_folder", - "description": "[list_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder)\n\nscope: `files.metadata.read`\n\nStarts returning the contents of a folder. If the result's `ListFolderResult.has_more` field is `true`, call `list_folder/continue` with the returned `ListFolderResult.cursor` to retrieve more entries.\nIf you're using `ListFolderArg.recursive` set to `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 `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 `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 `FolderSharingInfo.read_only` and set all its children's read-only statuses to match.\nFor each `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: `auth.RateLimitError` may be returned if multiple `list_folder` or `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.", - "operationId": "listFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_deleted": { - "type": "boolean", - "example": false - }, - "include_has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "include_media_info": { - "type": "boolean", - "example": false - }, - "include_mounted_folders": { - "type": "boolean", - "example": true - }, - "include_non_downloadable_files": { - "type": "boolean", - "example": true - }, - "path": { - "type": "string", - "example": "/Homework/math" - }, - "recursive": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_folder": { - "value": { - "include_deleted": false, - "include_has_explicit_shared_members": false, - "include_media_info": false, - "include_mounted_folders": true, - "include_non_downloadable_files": true, - "path": "/Homework/math", - "recursive": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - { - ".tag": "folder", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_folder response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - { - ".tag": "folder", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/files/list_folder/continue": { - "post": { - "tags": [ - "files" - ], - "summary": "list_folder/continue", - "description": "[list_folder/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue)\n\nscope: `files.metadata.read`\n\nOnce a cursor has been retrieved from `list_folder`, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for `list_folder`.", - "operationId": "listFolderContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_folder/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "no_access": { - "type": "boolean", - "example": false - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - }, - "traverse_only": { - "type": "boolean", - "example": false - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - { - ".tag": "folder", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_folder/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - }, - { - ".tag": "folder", - "id": "id:a4ayc_80_OEAAAAAAAAAXz", - "name": "math", - "path_display": "/Homework/math", - "path_lower": "/homework/math", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "sharing_info": { - "no_access": false, - "parent_shared_folder_id": "84528192421", - "read_only": false, - "traverse_only": false - } - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/files/list_folder/get_latest_cursor": { - "post": { - "tags": [ - "files" - ], - "summary": "list_folder/get_latest_cursor", - "description": "[list_folder/get_latest_cursor](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-get_latest_cursor)\n\nscope: `files.metadata.read`\n\nA way to quickly get a cursor for the folder's state. Unlike `list_folder`, `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.", - "operationId": "listFolderGetLatestCursor", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_deleted": { - "type": "boolean", - "example": false - }, - "include_has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "include_media_info": { - "type": "boolean", - "example": false - }, - "include_mounted_folders": { - "type": "boolean", - "example": true - }, - "include_non_downloadable_files": { - "type": "boolean", - "example": true - }, - "path": { - "type": "string", - "example": "/Homework/math" - }, - "recursive": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_folder/get_latest_cursor": { - "value": { - "include_deleted": false, - "include_has_explicit_shared_members": false, - "include_media_info": false, - "include_mounted_folders": true, - "include_non_downloadable_files": true, - "path": "/Homework/math", - "recursive": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder/get_latest_cursor response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_folder/get_latest_cursor response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - } - } - } - }, - "/files/list_folder/longpoll": { - "post": { - "tags": [ - "files" - ], - "summary": "list_folder/longpoll", - "description": "[list_folder/longpoll](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-longpoll)\n\nscope: `files.metadata.read`\n\nA longpoll endpoint to wait for changes on an account. In conjunction with `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 [webhooks documentation](https://www.dropbox.com/developers/reference/webhooks).", - "operationId": "listFolderLongpoll", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "timeout": { - "type": "number", - "example": 30 - } - } - }, - "examples": { - "list_folder/longpoll": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "timeout": 30 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder/longpoll response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "changes": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "list_folder/longpoll response": { - "value": { - "changes": true - } - } - } - } - } - } - } - } - }, - "/files/list_revisions": { - "post": { - "tags": [ - "files" - ], - "summary": "list_revisions", - "description": "[list_revisions](https://www.dropbox.com/developers/documentation/http/documentation#files-list_revisions)\n\nscope: `files.metadata.read`\n\nReturns 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 `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 `ListRevisionsMode.id`. The `ListRevisionsMode.id` mode is useful to retrieve revisions for a given file across moves or renames.", - "operationId": "listRevisions", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 10 - }, - "mode": { - "type": "string", - "example": "path" - }, - "path": { - "type": "string", - "example": "/root/word.docx" - } - } - }, - "examples": { - "list_revisions": { - "value": { - "limit": 10, - "mode": "path", - "path": "/root/word.docx" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_revisions response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - }, - "is_deleted": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "list_revisions response": { - "value": { - "entries": [ - { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ], - "is_deleted": false - } - } - } - } - } - } - } - } - }, - "/files/lock_file_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "lock_file_batch", - "description": "[lock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-lock_file_batch)\n\nscope: `files.content.write`\n\nLock 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.", - "operationId": "lockFileBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/John Doe/sample/test.pdf" - } - } - }, - "example": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - }, - "examples": { - "lock_file_batch": { - "value": { - "entries": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "lock_file_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "lock": { - "type": "object", - "properties": { - "content": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "single_user" - }, - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "lock_holder_account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "lock_holder_team_id": { - "type": "string", - "example": "dbtid:1234abcd" - } - } - } - } - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "lock_file_batch response": { - "value": { - "entries": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/move_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "move", - "description": "[move](https://www.dropbox.com/developers/documentation/http/documentation#files-move)\n\nscope: `files.content.write`\n\nMove 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.", - "operationId": "move", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "allow_ownership_transfer": { - "type": "boolean", - "example": false - }, - "allow_shared_folder": { - "type": "boolean", - "example": false - }, - "autorename": { - "type": "boolean", - "example": false - }, - "from_path": { - "type": "string", - "example": "/Homework/math" - }, - "to_path": { - "type": "string", - "example": "/Homework/algebra" - } - } - }, - "examples": { - "move": { - "value": { - "allow_ownership_transfer": false, - "allow_shared_folder": false, - "autorename": false, - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "move response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "examples": { - "move response": { - "value": { - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - } - }, - "/files/move_batch_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "move_batch", - "description": "[move_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch)\n\nscope: `files.content.write`\n\nMove 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 `move_batch:1`. The main difference is this route will return status for each entry, while `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 `move_batch/check:2` to check the job status.", - "operationId": "moveBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "allow_ownership_transfer": { - "type": "boolean", - "example": false - }, - "autorename": { - "type": "boolean", - "example": false - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "from_path": { - "type": "string", - "example": "/Homework/math" - }, - "to_path": { - "type": "string", - "example": "/Homework/algebra" - } - } - }, - "example": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ] - } - } - }, - "examples": { - "move_batch": { - "value": { - "allow_ownership_transfer": false, - "autorename": false, - "entries": [ - { - "from_path": "/Homework/math", - "to_path": "/Homework/algebra" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "move_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "move_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/move_batch/check_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "move_batch/check", - "description": "[move_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `move_batch:2`. It returns list of results for each entry.", - "operationId": "moveBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "move_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "move_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "move_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "success": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/permanently_delete": { - "post": { - "tags": [ - "files" - ], - "summary": "permanently_delete", - "description": "[permanently_delete](https://www.dropbox.com/developers/documentation/http/documentation#files-permanently_delete)\n\nscope: `files.permanent_delete`\n\nPermanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40).\nNote: This endpoint is only available for Dropbox Business apps.", - "operationId": "permanentlyDelete", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - } - } - }, - "examples": { - "permanently_delete": { - "value": { - "path": "/Homework/math/Prime_Numbers.txt" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/files/restore": { - "post": { - "tags": [ - "files" - ], - "summary": "restore", - "description": "[restore](https://www.dropbox.com/developers/documentation/http/documentation#files-restore)\n\nscope: `files.content.write`\n\nRestore a specific revision of a file to the given path.", - "operationId": "restore", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/root/word.docx" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - } - } - }, - "examples": { - "restore": { - "value": { - "path": "/root/word.docx", - "rev": "a1c10ce0dd78" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "restore response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "restore response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/save_url": { - "post": { - "tags": [ - "files" - ], - "summary": "save_url", - "description": "[save_url](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url)\n\nscope: `files.content.write`\n\nSave 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).", - "operationId": "saveUrl", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/a.txt" - }, - "url": { - "type": "string", - "example": "http://example.com/a.txt" - } - } - }, - "examples": { - "save_url": { - "value": { - "path": "/a.txt", - "url": "http://example.com/a.txt" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "save_url response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "save_url response": { - "value": { - ".tag": "complete", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/save_url/check_job_status": { - "post": { - "tags": [ - "files" - ], - "summary": "save_url/check_job_status", - "description": "[save_url/check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url-check_job_status)\n\nscope: `files.content.write`\n\nCheck the status of a `save_url` job.", - "operationId": "saveUrlCheckJobStatus", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "save_url/check_job_status": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "save_url/check_job_status response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "in_progress" - } - } - }, - "examples": { - "save_url/check_job_status response": { - "value": { - ".tag": "in_progress" - } - } - } - } - } - } - } - } - }, - "/files/search_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "search", - "description": "[search](https://www.dropbox.com/developers/documentation/http/documentation#files-search)\n\nscope: `files.metadata.read`\n\nSearches for files and folders.\nNote: `search:2` along with `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.", - "operationId": "search", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_highlights": { - "type": "boolean", - "example": false - }, - "query": { - "type": "string", - "example": "cat" - } - } - }, - "examples": { - "search": { - "value": { - "include_highlights": false, - "query": "cat" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "search response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "has_more": { - "type": "boolean", - "example": false - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "metadata" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - } - } - }, - "example": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - ] - } - } - }, - "examples": { - "search response": { - "value": { - "has_more": false, - "matches": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/search/continue_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "search/continue", - "description": "[search/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-search-continue)\n\nscope: `files.metadata.read`\n\nFetches the next page of search results returned from `search:2`.\nNote: `search:2` along with `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.", - "operationId": "searchContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "search/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "search/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "has_more": { - "type": "boolean", - "example": false - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "metadata" - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - } - } - }, - "example": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - ] - } - } - }, - "examples": { - "search/continue response": { - "value": { - "has_more": false, - "matches": [ - { - "metadata": { - ".tag": "metadata", - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/unlock_file_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "unlock_file_batch", - "description": "[unlock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-unlock_file_batch)\n\nscope: `files.content.write`\n\nUnlock 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.", - "operationId": "unlockFileBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/John Doe/sample/test.pdf" - } - } - }, - "example": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - }, - "examples": { - "unlock_file_batch": { - "value": { - "entries": [ - { - "path": "/John Doe/sample/test.pdf" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "unlock_file_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "lock": { - "type": "object", - "properties": { - "content": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "single_user" - }, - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "lock_holder_account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "lock_holder_team_id": { - "type": "string", - "example": "dbtid:1234abcd" - } - } - } - } - }, - "metadata": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - }, - "examples": { - "unlock_file_batch response": { - "value": { - "entries": [ - { - ".tag": "success", - "lock": { - "content": { - ".tag": "single_user", - "created": "2015-05-12T15:50:38Z", - "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "lock_holder_team_id": "dbtid:1234abcd" - } - }, - "metadata": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - ] - } - } - } - } - } - } - } - } - }, - "/files/upload": { - "post": { - "tags": [ - "files" - ], - "summary": "upload", - "description": "[upload](https://www.dropbox.com/developers/documentation/http/documentation#files-upload)\n\nscope: `files.content.write`\n\nCreate 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 `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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "upload", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"path\": \"/Homework/math/Matrices.txt\", \n \"mode\": \"add\", \n \"autorename\": true, \n \"mute\": false, \n \"strict_conflict\": false\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "upload response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "upload response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/upload_session/append_v2": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/append", - "description": "[upload_session/append](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-append)\n\nscope: `files.content.write`\n\nAppend 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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "uploadSessionAppend", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\", \n \"offset\": 0\n }, \n \"close\": false\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/files/upload_session/finish": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/finish", - "description": "[upload_session/finish](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish)\n\nscope: `files.content.write`\n\nFinish 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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "uploadSessionFinish", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\", \n \"offset\": 0\n }, \n \"commit\": {\n \"path\": \"/Homework/math/Matrices.txt\", \n \"mode\": \"add\", \n \"autorename\": true, \n \"mute\": false, \n \"strict_conflict\": false\n }\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "upload_session/finish response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "examples": { - "upload_session/finish response": { - "value": { - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - } - } - } - } - } - } - } - }, - "/files/upload_session/finish_batch": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/finish_batch", - "description": "[upload_session/finish_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch)\n\nscope: `files.content.write`\n\nThis route helps you commit many files at once into a user's Dropbox. Use `upload_session/start` and `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 `upload_session/finish`, use this route to finish all your upload sessions in a single request.\n`UploadSessionStartArg.close` or `UploadSessionAppendArg.close` needs to be true for the last `upload_session/start` or `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 `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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "uploadSessionFinishBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "commit": { - "type": "object", - "properties": { - "autorename": { - "type": "boolean", - "example": true - }, - "mode": { - "type": "string", - "example": "add" - }, - "mute": { - "type": "boolean", - "example": false - }, - "path": { - "type": "string", - "example": "/Homework/math/Matrices.txt" - }, - "strict_conflict": { - "type": "boolean", - "example": false - } - } - }, - "cursor": { - "type": "object", - "properties": { - "offset": { - "type": "number", - "example": 0 - }, - "session_id": { - "type": "string", - "example": "1234faaf0678bcde" - } - } - } - } - }, - "example": [ - { - "commit": { - "autorename": true, - "mode": "add", - "mute": false, - "path": "/Homework/math/Matrices.txt", - "strict_conflict": false - }, - "cursor": { - "offset": 0, - "session_id": "1234faaf0678bcde" - } - } - ] - } - } - }, - "examples": { - "upload_session/finish_batch": { - "value": { - "entries": [ - { - "commit": { - "autorename": true, - "mode": "add", - "mute": false, - "path": "/Homework/math/Matrices.txt", - "strict_conflict": false - }, - "cursor": { - "offset": 0, - "session_id": "1234faaf0678bcde" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "upload_session/finish_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - ".tag": "success", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - } - } - }, - "examples": { - "upload_session/finish_batch response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - } - } - } - } - } - } - } - } - }, - "/files/upload_session/finish_batch/check": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/finish_batch/check", - "description": "[upload_session/finish_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch-check)\n\nscope: `files.content.write`\n\nReturns the status of an asynchronous job for `upload_session/finish_batch`. If success, it returns list of result for each entry.", - "operationId": "uploadSessionFinishBatchCheck", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "upload_session/finish_batch/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "upload_session/finish_batch/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "content_hash": { - "type": "string", - "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" - }, - "file_lock_info": { - "type": "object", - "properties": { - "created": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "is_lockholder": { - "type": "boolean", - "example": true - }, - "lockholder_name": { - "type": "string", - "example": "Imaginary User" - } - } - }, - "has_explicit_shared_members": { - "type": "boolean", - "example": false - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "is_downloadable": { - "type": "boolean", - "example": true - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_display": { - "type": "string", - "example": "/Homework/math/Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "property_groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Security Policy" - }, - "value": { - "type": "string", - "example": "Confidential" - } - } - }, - "example": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ] - }, - "template_id": { - "type": "string", - "example": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - } - }, - "example": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ] - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "sharing_info": { - "type": "object", - "properties": { - "modified_by": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "parent_shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "read_only": { - "type": "boolean", - "example": true - } - } - }, - "size": { - "type": "number", - "example": 7212 - } - } - }, - "example": [ - { - ".tag": "success", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - } - } - }, - "examples": { - "upload_session/finish_batch/check response": { - "value": { - ".tag": "complete", - "entries": [ - { - ".tag": "success", - "client_modified": "2015-05-12T15:50:38Z", - "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", - "file_lock_info": { - "created": "2015-05-12T15:50:38Z", - "is_lockholder": true, - "lockholder_name": "Imaginary User" - }, - "has_explicit_shared_members": false, - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "is_downloadable": true, - "name": "Prime_Numbers.txt", - "path_display": "/Homework/math/Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "property_groups": [ - { - "fields": [ - { - "name": "Security Policy", - "value": "Confidential" - } - ], - "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa" - } - ], - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "sharing_info": { - "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "parent_shared_folder_id": "84528192421", - "read_only": true - }, - "size": 7212 - } - ] - } - } - } - } - } - } - } - } - }, - "/files/upload_session/start": { - "post": { - "tags": [ - "files" - ], - "summary": "upload_session/start", - "description": "[upload_session/start](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-start)\n\nscope: `files.content.write`\n\nUpload 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 `upload_session/append:2` to add more data and `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 48 hours. Attempting to use an `UploadSessionStartResult.session_id` with `upload_session/append:2` or `upload_session/finish` more than 48 hours after its creation will return a `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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit).", - "operationId": "uploadSessionStart", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"close\": false\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "upload_session/start response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "session_id": { - "type": "string", - "example": "1234faaf0678bcde" - } - } - }, - "examples": { - "upload_session/start response": { - "value": { - "session_id": "1234faaf0678bcde" - } - } - } - } - } - } - } - } - }, - "/sharing/add_file_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "add_file_member", - "description": "[add_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member)\n\nscope: `sharing.write`\n\nAdds specified members to a file.", - "operationId": "addFileMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "example": "viewer" - }, - "add_message_as_comment": { - "type": "boolean", - "example": false - }, - "custom_message": { - "type": "string", - "example": "This is a custom message about ACME.doc" - }, - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - }, - "example": [ - { - ".tag": "email", - "email": "justin@example.com" - } - ] - }, - "quiet": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "add_file_member": { - "value": { - "access_level": "viewer", - "add_message_as_comment": false, - "custom_message": "This is a custom message about ACME.doc", - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "members": [ - { - ".tag": "email", - "email": "justin@example.com" - } - ], - "quiet": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "add_file_member response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - }, - "result": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - } - } - } - } - }, - "example": [ - { - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "result": { - ".tag": "success" - } - } - ] - }, - "examples": { - "add_file_member response": { - "value": [ - { - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "result": { - ".tag": "success" - } - } - ] - } - } - } - } - } - } - } - }, - "/sharing/add_folder_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "add_folder_member", - "description": "[add_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_folder_member)\n\nscope: `sharing.write`\n\nAllows 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 `mount_folder` on their behalf.", - "operationId": "addFolderMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "custom_message": { - "type": "string", - "example": "Documentation for launch day" - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "example": "editor" - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "dropbox_id": { - "type": "string", - "example": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - } - } - }, - "example": [ - { - "access_level": "editor", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - }, - { - "access_level": "viewer", - "member": { - ".tag": "dropbox_id", - "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - } - } - ] - }, - "quiet": { - "type": "boolean", - "example": false - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "add_folder_member": { - "value": { - "custom_message": "Documentation for launch day", - "members": [ - { - "access_level": "editor", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - }, - { - "access_level": "viewer", - "member": { - ".tag": "dropbox_id", - "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - } - } - ], - "quiet": false, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/check_job_status": { - "post": { - "tags": [ - "sharing" - ], - "summary": "check_job_status", - "description": "[check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_job_status)\n\nscope: `sharing.write`\n\nReturns the status of an asynchronous job.", - "operationId": "checkJobStatus", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "check_job_status": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "check_job_status response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "in_progress" - } - } - }, - "examples": { - "check_job_status response": { - "value": { - ".tag": "in_progress" - } - } - } - } - } - } - } - } - }, - "/sharing/check_remove_member_job_status": { - "post": { - "tags": [ - "sharing" - ], - "summary": "check_remove_member_job_status", - "description": "[check_remove_member_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_remove_member_job_status)\n\nscope: `sharing.write`\n\nReturns the status of an asynchronous job for sharing a folder.", - "operationId": "checkRemoveMemberJobStatus", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "check_remove_member_job_status": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "check_remove_member_job_status response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "check_remove_member_job_status response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/sharing/check_share_job_status": { - "post": { - "tags": [ - "sharing" - ], - "summary": "check_share_job_status", - "description": "[check_share_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_share_job_status)\n\nscope: `sharing.write`\n\nReturns the status of an asynchronous job for sharing a folder.", - "operationId": "checkShareJobStatus", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "check_share_job_status": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "check_share_job_status response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "check_share_job_status response": { - "value": { - ".tag": "complete", - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/get_file_metadata": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_file_metadata", - "description": "[get_file_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata)\n\nscope: `sharing.read`\n\nReturns shared file metadata.", - "operationId": "getFileMetadata", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - }, - "examples": { - "get_file_metadata": { - "value": { - "actions": [], - "file": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_file_metadata response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "id": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "name": { - "type": "string", - "example": "file.txt" - }, - "owner_display_names": { - "type": "array", - "items": { - "type": "string", - "example": "Jane Doe" - }, - "example": [ - "Jane Doe" - ] - }, - "owner_team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - }, - "path_display": { - "type": "string", - "example": "/dir/file.txt" - }, - "path_lower": { - "type": "string", - "example": "/dir/file.txt" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fi/fir9vjelf" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "get_file_metadata response": { - "value": { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "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": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/get_file_metadata/batch": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_file_metadata/batch", - "description": "[get_file_metadata/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata-batch)\n\nscope: `sharing.read`\n\nReturns shared file metadata.", - "operationId": "getFileMetadataBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "files": { - "type": "array", - "items": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "example": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ] - } - } - }, - "examples": { - "get_file_metadata/batch": { - "value": { - "actions": [], - "files": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_file_metadata/batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "result": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "metadata" - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "id": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "name": { - "type": "string", - "example": "file.txt" - }, - "owner_display_names": { - "type": "array", - "items": { - "type": "string", - "example": "Jane Doe" - }, - "example": [ - "Jane Doe" - ] - }, - "owner_team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - }, - "path_display": { - "type": "string", - "example": "/dir/file.txt" - }, - "path_lower": { - "type": "string", - "example": "/dir/file.txt" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fi/fir9vjelf" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - } - } - }, - "example": [ - { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "result": { - ".tag": "metadata", - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "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": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - } - ] - }, - "examples": { - "get_file_metadata/batch response": { - "value": [ - { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "result": { - ".tag": "metadata", - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "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": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - } - ] - } - } - } - } - } - } - } - }, - "/sharing/get_folder_metadata": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_folder_metadata", - "description": "[get_folder_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_folder_metadata)\n\nscope: `sharing.read`\n\nReturns shared folder metadata by its folder ID.", - "operationId": "getFolderMetadata", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "get_folder_metadata": { - "value": { - "actions": [], - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_folder_metadata response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "get_folder_metadata response": { - "value": { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/get_shared_link_file": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_shared_link_file", - "description": "[get_shared_link_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file)\n\nscope: `sharing.read`\n\nDownload the shared link's file from a user's Dropbox.", - "operationId": "getSharedLinkFile", - "parameters": [ - { - "name": "dropbox-api-arg", - "in": "header", - "schema": { - "type": "string", - "example": "{\n \"url\": \"https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0\", \n \"path\": \"/Prime_Numbers.txt\"\n}" - } - }, - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "get_shared_link_file response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "link_permissions": { - "type": "object", - "properties": { - "can_revoke": { - "type": "boolean", - "example": false - }, - "resolved_visibility": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "revoke_failure_reason": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner_only" - } - } - } - } - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "size": { - "type": "number", - "example": 7212 - }, - "team_member_info": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "Roger Rabbit" - }, - "member_id": { - "type": "string", - "example": "dbmid:abcd1234" - }, - "team_info": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "get_shared_link_file response": { - "value": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - } - } - } - }, - "/sharing/get_shared_link_metadata": { - "post": { - "tags": [ - "sharing" - ], - "summary": "get_shared_link_metadata", - "description": "[get_shared_link_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_metadata)\n\nscope: `sharing.read`\n\nGet the shared link's metadata.", - "operationId": "getSharedLinkMetadata", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "path": { - "type": "string", - "example": "/Prime_Numbers.txt" - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "get_shared_link_metadata": { - "value": { - "path": "/Prime_Numbers.txt", - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_shared_link_metadata response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "link_permissions": { - "type": "object", - "properties": { - "can_revoke": { - "type": "boolean", - "example": false - }, - "resolved_visibility": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "revoke_failure_reason": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner_only" - } - } - } - } - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "size": { - "type": "number", - "example": 7212 - }, - "team_member_info": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "Roger Rabbit" - }, - "member_id": { - "type": "string", - "example": "dbmid:abcd1234" - }, - "team_info": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "get_shared_link_metadata response": { - "value": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - } - } - } - }, - "/sharing/list_file_members": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_file_members", - "description": "[list_file_members](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members)\n\nscope: `sharing.read`\n\nUse to obtain the members who have been invited to a file, both inherited and uninherited members.", - "operationId": "listFileMembers", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "include_inherited": { - "type": "boolean", - "example": true - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "list_file_members": { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "include_inherited": true, - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_file_members response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "editor" - } - } - }, - "group": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "group_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "is_member": { - "type": "boolean", - "example": false - }, - "is_owner": { - "type": "boolean", - "example": false - }, - "member_count": { - "type": "number", - "example": 10 - }, - "same_team": { - "type": "boolean", - "example": true - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "invitees": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "invitee": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "jessica@example.com" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "platform_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "unknown" - } - } - }, - "time_last_seen": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - }, - "user": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "display_name": { - "type": "string", - "example": "Robert Smith" - }, - "email": { - "type": "string", - "example": "bob@example.com" - }, - "same_team": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:abcd1234" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - }, - "examples": { - "list_file_members response": { - "value": { - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_file_members/batch": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_file_members/batch", - "description": "[list_file_members/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-batch)\n\nscope: `sharing.read`\n\nGet 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.", - "operationId": "listFileMembersBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "files": { - "type": "array", - "items": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "example": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ] - }, - "limit": { - "type": "number", - "example": 10 - } - } - }, - "examples": { - "list_file_members/batch": { - "value": { - "files": [ - "id:3kmLmQFnf1AAAAAAAAAAAw", - "id:VvTaJu2VZzAAAAAAAAAADQ" - ], - "limit": 10 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_file_members/batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "result": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "result" - }, - "member_count": { - "type": "number", - "example": 3 - }, - "members": { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "editor" - } - } - }, - "group": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "group_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "is_member": { - "type": "boolean", - "example": false - }, - "is_owner": { - "type": "boolean", - "example": false - }, - "member_count": { - "type": "number", - "example": 10 - }, - "same_team": { - "type": "boolean", - "example": true - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "invitees": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "invitee": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "jessica@example.com" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "platform_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "unknown" - } - } - }, - "time_last_seen": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - }, - "user": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "display_name": { - "type": "string", - "example": "Robert Smith" - }, - "email": { - "type": "string", - "example": "bob@example.com" - }, - "same_team": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:abcd1234" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - } - } - } - }, - "example": [ - { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "result": { - ".tag": "result", - "member_count": 3, - "members": { - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - ] - }, - "examples": { - "list_file_members/batch response": { - "value": [ - { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "result": { - ".tag": "result", - "member_count": 3, - "members": { - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - ] - } - } - } - } - } - } - } - }, - "/sharing/list_file_members/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_file_members/continue", - "description": "[list_file_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_file_members` or `list_file_members/batch`, use this to paginate through all shared file members.", - "operationId": "listFileMembersContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_file_members/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_file_members/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "editor" - } - } - }, - "group": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "group_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "is_member": { - "type": "boolean", - "example": false - }, - "is_owner": { - "type": "boolean", - "example": false - }, - "member_count": { - "type": "number", - "example": 10 - }, - "same_team": { - "type": "boolean", - "example": true - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "invitees": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "invitee": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "jessica@example.com" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "platform_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "unknown" - } - } - }, - "time_last_seen": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - }, - "user": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "display_name": { - "type": "string", - "example": "Robert Smith" - }, - "email": { - "type": "string", - "example": "bob@example.com" - }, - "same_team": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:abcd1234" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - }, - "examples": { - "list_file_members/continue response": { - "value": { - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "platform_type": { - ".tag": "unknown" - }, - "time_last_seen": "2016-01-20T00:00:00Z", - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_folder_members/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_folder_members/continue", - "description": "[list_folder_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_folder_members`, use this to paginate through all shared folder members.", - "operationId": "listFolderMembersContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_folder_members/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folder_members/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "editor" - } - } - }, - "group": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "group_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "is_member": { - "type": "boolean", - "example": false - }, - "is_owner": { - "type": "boolean", - "example": false - }, - "member_count": { - "type": "number", - "example": 10 - }, - "same_team": { - "type": "boolean", - "example": true - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "invitees": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "invitee": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "jessica@example.com" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ] - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inherited": { - "type": "boolean", - "example": false - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "user": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "display_name": { - "type": "string", - "example": "Robert Smith" - }, - "email": { - "type": "string", - "example": "bob@example.com" - }, - "same_team": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:abcd1234" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - }, - "examples": { - "list_folder_members/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "groups": [ - { - "access_type": { - ".tag": "editor" - }, - "group": { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "group_type": { - ".tag": "user_managed" - }, - "is_member": false, - "is_owner": false, - "member_count": 10, - "same_team": true - }, - "is_inherited": false, - "permissions": [] - } - ], - "invitees": [ - { - "access_type": { - ".tag": "viewer" - }, - "invitee": { - ".tag": "email", - "email": "jessica@example.com" - }, - "is_inherited": false, - "permissions": [] - } - ], - "users": [ - { - "access_type": { - ".tag": "owner" - }, - "is_inherited": false, - "permissions": [], - "user": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "display_name": "Robert Smith", - "email": "bob@example.com", - "same_team": true, - "team_member_id": "dbmid:abcd1234" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_folders": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_folders", - "description": "[list_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders)\n\nscope: `sharing.read`\n\nReturn the list of all shared folders the current user has access to.", - "operationId": "listFolders", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "list_folders": { - "value": { - "actions": [], - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folders response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_folders response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_folders/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_folders/continue", - "description": "[list_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_folders`, use this to paginate through all shared folders. The cursor must come from a previous call to `list_folders` or `list_folders/continue`.", - "operationId": "listFoldersContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_folders/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_folders/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_folders/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_mountable_folders": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_mountable_folders", - "description": "[list_mountable_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders)\n\nscope: `sharing.read`\n\nReturn the list of all shared folders the current user can mount or unmount.", - "operationId": "listMountableFolders", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "list_mountable_folders": { - "value": { - "actions": [], - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_mountable_folders response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_mountable_folders response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_mountable_folders/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_mountable_folders/continue", - "description": "[list_mountable_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders-continue)\n\nscope: `sharing.read`\n\nOnce a cursor has been retrieved from `list_mountable_folders`, use this to paginate through all mountable shared folders. The cursor must come from a previous call to `list_mountable_folders` or `list_mountable_folders/continue`.", - "operationId": "listMountableFoldersContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_mountable_folders/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_mountable_folders/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_mountable_folders/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "entries": [ - { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_received_files": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_received_files", - "description": "[list_received_files](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files)\n\nscope: `sharing.read`\n\nReturns 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.", - "operationId": "listReceivedFiles", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": {}, - "example": [] - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "list_received_files": { - "value": { - "actions": [], - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_received_files response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "id": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "name": { - "type": "string", - "example": "file.txt" - }, - "owner_display_names": { - "type": "array", - "items": { - "type": "string", - "example": "Jane Doe" - }, - "example": [ - "Jane Doe" - ] - }, - "owner_team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - }, - "path_display": { - "type": "string", - "example": "/dir/file.txt" - }, - "path_lower": { - "type": "string", - "example": "/dir/file.txt" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fi/fir9vjelf" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "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": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_received_files response": { - "value": { - "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ", - "entries": [ - { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "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": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_received_files/continue": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_received_files/continue", - "description": "[list_received_files/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files-continue)\n\nscope: `sharing.read`\n\nGet more results with a cursor from `list_received_files`.", - "operationId": "listReceivedFilesContinue", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId" - } - } - }, - "examples": { - "list_received_files/continue": { - "value": { - "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_received_files/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ" - }, - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer" - } - } - }, - "id": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "name": { - "type": "string", - "example": "file.txt" - }, - "owner_display_names": { - "type": "array", - "items": { - "type": "string", - "example": "Jane Doe" - }, - "example": [ - "Jane Doe" - ] - }, - "owner_team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - }, - "path_display": { - "type": "string", - "example": "/dir/file.txt" - }, - "path_lower": { - "type": "string", - "example": "/dir/file.txt" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fi/fir9vjelf" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "example": [ - { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "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": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - }, - "examples": { - "list_received_files/continue response": { - "value": { - "cursor": "AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ", - "entries": [ - { - "access_type": { - ".tag": "viewer" - }, - "id": "id:3kmLmQFnf1AAAAAAAAAAAw", - "name": "file.txt", - "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": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf", - "time_invited": "2016-01-20T00:00:00Z" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/list_shared_links": { - "post": { - "tags": [ - "sharing" - ], - "summary": "list_shared_links", - "description": "[list_shared_links](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_shared_links)\n\nscope: `sharing.read`\n\nList shared links of this user.\nIf no path is given, returns a list of all shared links for the current user.\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.", - "operationId": "listSharedLinks", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "list_shared_links": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "list_shared_links response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": true - }, - "links": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "link_permissions": { - "type": "object", - "properties": { - "can_revoke": { - "type": "boolean", - "example": false - }, - "resolved_visibility": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "revoke_failure_reason": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner_only" - } - } - } - } - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "size": { - "type": "number", - "example": 7212 - }, - "team_member_info": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "Roger Rabbit" - }, - "member_id": { - "type": "string", - "example": "dbmid:abcd1234" - }, - "team_info": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "example": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - ] - } - } - }, - "examples": { - "list_shared_links response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": true, - "links": [ - { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - ] - } - } - } - } - } - } - } - } - }, - "/sharing/modify_shared_link_settings": { - "post": { - "tags": [ - "sharing" - ], - "summary": "modify_shared_link_settings", - "description": "[modify_shared_link_settings](https://www.dropbox.com/developers/documentation/http/documentation#sharing-modify_shared_link_settings)\n\nscope: `sharing.write`\n\nModify 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 `LinkPermissions.resolved_visibility` of the returned `SharedLinkMetadata` will reflect the actual visibility of the shared link and the `LinkPermissions.requested_visibility` will reflect the requested visibility.", - "operationId": "modifySharedLinkSettings", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "remove_expiration": { - "type": "boolean", - "example": false - }, - "settings": { - "type": "object", - "properties": { - "access": { - "type": "string", - "example": "viewer" - }, - "audience": { - "type": "string", - "example": "public" - }, - "requested_visibility": { - "type": "string", - "example": "public" - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "modify_shared_link_settings": { - "value": { - "remove_expiration": false, - "settings": { - "access": "viewer", - "audience": "public", - "requested_visibility": "public" - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "modify_shared_link_settings response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "client_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "link_permissions": { - "type": "object", - "properties": { - "can_revoke": { - "type": "boolean", - "example": false - }, - "resolved_visibility": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "revoke_failure_reason": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner_only" - } - } - } - } - }, - "name": { - "type": "string", - "example": "Prime_Numbers.txt" - }, - "path_lower": { - "type": "string", - "example": "/homework/math/prime_numbers.txt" - }, - "rev": { - "type": "string", - "example": "a1c10ce0dd78" - }, - "server_modified": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "size": { - "type": "number", - "example": 7212 - }, - "team_member_info": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "Roger Rabbit" - }, - "member_id": { - "type": "string", - "example": "dbmid:abcd1234" - }, - "team_info": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - } - } - } - } - }, - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "modify_shared_link_settings response": { - "value": { - ".tag": "file", - "client_modified": "2015-05-12T15:50:38Z", - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "link_permissions": { - "can_revoke": false, - "resolved_visibility": { - ".tag": "public" - }, - "revoke_failure_reason": { - ".tag": "owner_only" - } - }, - "name": "Prime_Numbers.txt", - "path_lower": "/homework/math/prime_numbers.txt", - "rev": "a1c10ce0dd78", - "server_modified": "2015-05-12T15:50:38Z", - "size": 7212, - "team_member_info": { - "display_name": "Roger Rabbit", - "member_id": "dbmid:abcd1234", - "team_info": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc." - } - }, - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - } - } - } - }, - "/sharing/mount_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "mount_folder", - "description": "[mount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-mount_folder)\n\nscope: `sharing.write`\n\nThe 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.", - "operationId": "mountFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "mount_folder": { - "value": { - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "mount_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "mount_folder response": { - "value": { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/relinquish_file_membership": { - "post": { - "tags": [ - "sharing" - ], - "summary": "relinquish_file_membership", - "description": "[relinquish_file_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_file_membership)\n\nscope: `sharing.write`\n\nThe 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.", - "operationId": "relinquishFileMembership", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - }, - "examples": { - "relinquish_file_membership": { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/relinquish_folder_membership": { - "post": { - "tags": [ - "sharing" - ], - "summary": "relinquish_folder_membership", - "description": "[relinquish_folder_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_folder_membership)\n\nscope: `sharing.write`\n\nThe 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.", - "operationId": "relinquishFolderMembership", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "leave_a_copy": { - "type": "boolean", - "example": false - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "relinquish_folder_membership": { - "value": { - "leave_a_copy": false, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "relinquish_folder_membership response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "relinquish_folder_membership response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/sharing/remove_file_member_2": { - "post": { - "tags": [ - "sharing" - ], - "summary": "remove_file_member_2", - "description": "[remove_file_member_2](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_file_member_2)\n\nscope: `sharing.write`\n\nRemoves a specified member from the file.", - "operationId": "removeFileMember2", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - } - } - }, - "examples": { - "remove_file_member_2": { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "remove_file_member_2 response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "other" - } - } - }, - "examples": { - "remove_file_member_2 response": { - "value": { - ".tag": "other" - } - } - } - } - } - } - } - } - }, - "/sharing/remove_folder_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "remove_folder_member", - "description": "[remove_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_folder_member)\n\nscope: `sharing.write`\n\nAllows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.", - "operationId": "removeFolderMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "leave_a_copy": { - "type": "boolean", - "example": false - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "remove_folder_member": { - "value": { - "leave_a_copy": false, - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "remove_folder_member response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "async_job_id" - }, - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "remove_folder_member response": { - "value": { - ".tag": "async_job_id", - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - } - } - } - }, - "/sharing/revoke_shared_link": { - "post": { - "tags": [ - "sharing" - ], - "summary": "revoke_shared_link", - "description": "[revoke_shared_link](https://www.dropbox.com/developers/documentation/http/documentation#sharing-revoke_shared_link)\n\nscope: `sharing.write`\n\nRevoke 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 `list_shared_links` with the file as the `ListSharedLinksArg.path` argument.", - "operationId": "revokeSharedLink", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - }, - "examples": { - "revoke_shared_link": { - "value": { - "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/set_access_inheritance": { - "post": { - "tags": [ - "sharing" - ], - "summary": "set_access_inheritance", - "description": "[set_access_inheritance](https://www.dropbox.com/developers/documentation/http/documentation#sharing-set_access_inheritance)\n\nscope: `sharing.write`\n\nChange the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root.\nIf a `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder.", - "operationId": "setAccessInheritance", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "string", - "example": "inherit" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "set_access_inheritance": { - "value": { - "access_inheritance": "inherit", - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "set_access_inheritance response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "set_access_inheritance response": { - "value": { - ".tag": "complete", - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/share_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "share_folder", - "description": "[share_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-share_folder)\n\nscope: `sharing.write`\n\nShare 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 `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder.", - "operationId": "shareFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "string", - "example": "inherit" - }, - "acl_update_policy": { - "type": "string", - "example": "editors" - }, - "force_async": { - "type": "boolean", - "example": false - }, - "member_policy": { - "type": "string", - "example": "team" - }, - "path": { - "type": "string", - "example": "/example/workspace" - }, - "shared_link_policy": { - "type": "string", - "example": "members" - } - } - }, - "examples": { - "share_folder": { - "value": { - "access_inheritance": "inherit", - "acl_update_policy": "editors", - "force_async": false, - "member_policy": "team", - "path": "/example/workspace", - "shared_link_policy": "members" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "share_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "share_folder response": { - "value": { - ".tag": "complete", - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/sharing/transfer_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "transfer_folder", - "description": "[transfer_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-transfer_folder)\n\nscope: `sharing.write`\n\nTransfer ownership of a shared folder to a member of the shared folder.\nUser must have `AccessLevel.owner` access to the shared folder to perform a transfer.", - "operationId": "transferFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "to_dropbox_id": { - "type": "string", - "example": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - } - } - }, - "examples": { - "transfer_folder": { - "value": { - "shared_folder_id": "84528192421", - "to_dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/unmount_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "unmount_folder", - "description": "[unmount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unmount_folder)\n\nscope: `sharing.write`\n\nThe current user unmounts the designated folder. They can re-mount the folder at a later time using `mount_folder`.", - "operationId": "unmountFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "unmount_folder": { - "value": { - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/unshare_file": { - "post": { - "tags": [ - "sharing" - ], - "summary": "unshare_file", - "description": "[unshare_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_file)\n\nscope: `sharing.write`\n\nRemove all members from this file. Does not remove inherited members.", - "operationId": "unshareFile", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - }, - "examples": { - "unshare_file": { - "value": { - "file": "id:3kmLmQFnf1AAAAAAAAAAAw" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/sharing/unshare_folder": { - "post": { - "tags": [ - "sharing" - ], - "summary": "unshare_folder", - "description": "[unshare_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_folder)\n\nscope: `sharing.write`\n\nAllows a shared folder owner to unshare the folder.\nYou'll need to call `check_job_status` to determine if the action has completed successfully.", - "operationId": "unshareFolder", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "leave_a_copy": { - "type": "boolean", - "example": false - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "unshare_folder": { - "value": { - "leave_a_copy": false, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "unshare_folder response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "unshare_folder response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/sharing/update_file_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "update_file_member", - "description": "[update_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_file_member)\n\nscope: `sharing.write`\n\nChanges a member's access on a shared file.", - "operationId": "updateFileMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "example": "viewer" - }, - "file": { - "type": "string", - "example": "id:3kmLmQFnf1AAAAAAAAAAAw" - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - } - } - }, - "examples": { - "update_file_member": { - "value": { - "access_level": "viewer", - "file": "id:3kmLmQFnf1AAAAAAAAAAAw", - "member": { - ".tag": "email", - "email": "justin@example.com" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "update_file_member response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "update_file_member response": { - "value": {} - } - } - } - } - } - } - } - }, - "/sharing/update_folder_member": { - "post": { - "tags": [ - "sharing" - ], - "summary": "update_folder_member", - "description": "[update_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_member)\n\nscope: `sharing.write`\n\nAllows an owner or editor of a shared folder to update another member's permissions.", - "operationId": "updateFolderMember", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "example": "editor" - }, - "member": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "email" - }, - "email": { - "type": "string", - "example": "justin@example.com" - } - } - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - } - } - }, - "examples": { - "update_folder_member": { - "value": { - "access_level": "editor", - "member": { - ".tag": "email", - "email": "justin@example.com" - }, - "shared_folder_id": "84528192421" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "update_folder_member response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - }, - "examples": { - "update_folder_member response": { - "value": {} - } - } - } - } - } - } - } - }, - "/sharing/update_folder_policy": { - "post": { - "tags": [ - "sharing" - ], - "summary": "update_folder_policy", - "description": "[update_folder_policy](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_policy)\n\nscope: `sharing.write`\n\nUpdate the sharing policies for a shared folder.\nUser must have `AccessLevel.owner` access to the shared folder to update its policies.", - "operationId": "updateFolderPolicy", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "string", - "example": "owner" - }, - "member_policy": { - "type": "string", - "example": "team" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "shared_link_policy": { - "type": "string", - "example": "members" - } - } - }, - "examples": { - "update_folder_policy": { - "value": { - "acl_update_policy": "owner", - "member_policy": "team", - "shared_folder_id": "84528192421", - "shared_link_policy": "members" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "update_folder_policy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_inheritance": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "inherit" - } - } - }, - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "is_inside_team_folder": { - "type": "boolean", - "example": false - }, - "is_team_folder": { - "type": "boolean", - "example": false - }, - "link_metadata": { - "type": "object", - "properties": { - "audience_options": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "example": [ - { - ".tag": "public" - }, - { - ".tag": "team" - }, - { - ".tag": "members" - } - ] - }, - "current_audience": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "public" - } - } - }, - "link_permissions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "action": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "change_audience" - } - } - }, - "allow": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "action": { - ".tag": "change_audience" - }, - "allow": true - } - ] - }, - "password_protected": { - "type": "boolean", - "example": false - }, - "url": { - "type": "string", - "example": "" - } - } - }, - "name": { - "type": "string", - "example": "dir" - }, - "path_lower": { - "type": "string", - "example": "/dir" - }, - "permissions": { - "type": "array", - "items": {}, - "example": [] - }, - "policy": { - "type": "object", - "properties": { - "acl_update_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "owner" - } - } - }, - "member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - }, - "resolved_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "anyone" - } - } - } - } - }, - "preview_url": { - "type": "string", - "example": "https://www.dropbox.com/scl/fo/fir9vjelf" - }, - "shared_folder_id": { - "type": "string", - "example": "84528192421" - }, - "time_invited": { - "type": "string", - "example": "2016-01-20T00:00:00Z" - } - } - }, - "examples": { - "update_folder_policy response": { - "value": { - "access_inheritance": { - ".tag": "inherit" - }, - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "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": "" - }, - "name": "dir", - "path_lower": "/dir", - "permissions": [], - "policy": { - "acl_update_policy": { - ".tag": "owner" - }, - "member_policy": { - ".tag": "anyone" - }, - "resolved_member_policy": { - ".tag": "team" - }, - "shared_link_policy": { - ".tag": "anyone" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf", - "shared_folder_id": "84528192421", - "time_invited": "2016-01-20T00:00:00Z" - } - } - } - } - } - } - } - } - }, - "/team/devices/list_member_devices": { - "post": { - "tags": [ - "team", - "devices" - ], - "summary": "devices/list_member_devices", - "description": "[devices/list_member_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_member_devices)\n\nscope: `sessions.list`\n\nList all device sessions of a team's member.", - "operationId": "devicesListMemberDevices", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_desktop_clients": { - "type": "boolean", - "example": true - }, - "include_mobile_clients": { - "type": "boolean", - "example": true - }, - "include_web_sessions": { - "type": "boolean", - "example": true - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - } - } - }, - "examples": { - "devices/list_member_devices": { - "value": { - "include_desktop_clients": true, - "include_mobile_clients": true, - "include_web_sessions": true, - "team_member_id": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/devices/list_members_devices": { - "post": { - "tags": [ - "team", - "devices" - ], - "summary": "devices/list_members_devices", - "description": "[devices/list_members_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_members_devices)\n\nscope: `sessions.list`\n\nList all device sessions of a team.\nPermission : Team member file access.", - "operationId": "devicesListMembersDevices", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "devices/list_members_devices": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/devices/revoke_device_session": { - "post": { - "tags": [ - "team", - "devices" - ], - "summary": "devices/revoke_device_session", - "description": "[devices/revoke_device_session](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session)\n\nscope: `sessions.modify`\n\nRevoke a device session of a team's member.", - "operationId": "devicesRevokeDeviceSession", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "web_session" - }, - "session_id": { - "type": "string", - "example": "1234faaf0678bcde" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - }, - "examples": { - "devices/revoke_device_session": { - "value": { - ".tag": "web_session", - "session_id": "1234faaf0678bcde", - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/devices/revoke_device_session_batch": { - "post": { - "tags": [ - "team", - "devices" - ], - "summary": "devices/revoke_device_session_batch", - "description": "[devices/revoke_device_session_batch](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session_batch)\n\nscope: `sessions.modify`\n\nRevoke a list of device sessions of team members.", - "operationId": "devicesRevokeDeviceSessionBatch", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "revoke_devices": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "web_session" - }, - "session_id": { - "type": "string", - "example": "1234faaf0678bcde" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - }, - "example": [ - { - ".tag": "web_session", - "session_id": "1234faaf0678bcde", - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - ] - } - } - }, - "examples": { - "devices/revoke_device_session_batch": { - "value": { - "revoke_devices": [ - { - ".tag": "web_session", - "session_id": "1234faaf0678bcde", - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/groups/create": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/create", - "description": "[groups/create](https://www.dropbox.com/developers/documentation/http/teams#team-groups-create)\n\nscope: `groups.write`\n\nCreates a new, empty group, with a requested name.\nPermission : Team member management.", - "operationId": "groupsCreate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "add_creator_as_owner": { - "type": "boolean", - "example": false - }, - "group_external_id": { - "type": "string", - "example": "group-134" - }, - "group_name": { - "type": "string", - "example": "Europe sales" - } - } - }, - "examples": { - "groups/create": { - "value": { - "add_creator_as_owner": false, - "group_external_id": "group-134", - "group_name": "Europe sales" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/create response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - }, - "examples": { - "groups/create response": { - "value": { - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/groups/delete": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/delete", - "description": "[groups/delete](https://www.dropbox.com/developers/documentation/http/teams#team-groups-delete)\n\nscope: `groups.write`\n\nDeletes a group.\nThe group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed.\nPermission : Team member management.", - "operationId": "groupsDelete", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "examples": { - "groups/delete": { - "value": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/delete response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "groups/delete response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/groups/get_info": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/get_info", - "description": "[groups/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-groups-get_info)\n\nscope: `groups.read`\n\nRetrieves information about one or more groups. Note that the optional field `GroupFullInfo.members` is not returned for system-managed groups.\nPermission : Team Information.", - "operationId": "groupsGetInfo", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_ids" - }, - "group_ids": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c", - "g:111111147abcd6000000000222222c" - ] - } - } - }, - "examples": { - "groups/get_info": { - "value": { - ".tag": "group_ids", - "group_ids": [ - "g:e2db7665347abcd600000000001a2b3c", - "g:111111147abcd6000000000222222c" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/get_info response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_info" - }, - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - }, - "example": [ - { - ".tag": "group_info", - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - ] - }, - "examples": { - "groups/get_info response": { - "value": [ - { - ".tag": "group_info", - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - ] - } - } - } - } - } - } - } - }, - "/team/groups/job_status/get": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/job_status/get", - "description": "[groups/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-groups-job_status-get)\n\nscope: `groups.write`\n\nOnce an async_job_id is returned from `groups/delete`, `groups/members/add` , or `groups/members/remove` use this method to poll the status of granting/revoking group members' access to group-owned resources.\nPermission : Team member management.", - "operationId": "groupsJobStatusGet", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "groups/job_status/get": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/job_status/get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "groups/job_status/get response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/groups/list": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/list", - "description": "[groups/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list)\n\nscope: `groups.read`\n\nLists groups on a team.\nPermission : Team Information.", - "operationId": "groupsList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "groups/list": { - "value": { - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "member_count": { - "type": "number", - "example": 10 - } - } - }, - "example": [ - { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "member_count": 10 - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "groups/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "groups": [ - { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "member_count": 10 - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/team/groups/list/continue": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/list/continue", - "description": "[groups/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list-continue)\n\nscope: `groups.read`\n\nOnce a cursor has been retrieved from `groups/list`, use this to paginate through all groups.\nPermission : Team Information.", - "operationId": "groupsListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "groups/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "Test group" - }, - "member_count": { - "type": "number", - "example": 10 - } - } - }, - "example": [ - { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "member_count": 10 - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "groups/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "groups": [ - { - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "Test group", - "member_count": 10 - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/team/groups/members/add": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/add", - "description": "[groups/members/add](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-add)\n\nscope: `groups.write`\n\nAdds members to a group.\nThe members are added immediately. However the granting of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed.\nPermission : Team member management.", - "operationId": "groupsMembersAdd", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "string", - "example": "member" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "access_type": "member", - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - }, - "return_members": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "groups/members/add": { - "value": { - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "members": [ - { - "access_type": "member", - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ], - "return_members": true - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/add response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "99988877733388" - }, - "group_info": { - "type": "object", - "properties": { - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - }, - "examples": { - "groups/members/add response": { - "value": { - "async_job_id": "99988877733388", - "group_info": { - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "/team/groups/members/list": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/list", - "description": "[groups/members/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list)\n\nscope: `groups.read`\n\nLists members of a group.\nPermission : Team Information.", - "operationId": "groupsMembersList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "groups/members/list": { - "value": { - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "members": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "examples": { - "groups/members/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "members": [] - } - } - } - } - } - } - } - } - }, - "/team/groups/members/list/continue": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/list/continue", - "description": "[groups/members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list-continue)\n\nscope: `groups.read`\n\nOnce a cursor has been retrieved from `groups/members/list`, use this to paginate through all members of the group.\nPermission : Team information.", - "operationId": "groupsMembersListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "groups/members/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "members": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "examples": { - "groups/members/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "members": [] - } - } - } - } - } - } - } - } - }, - "/team/groups/members/remove": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/remove", - "description": "[groups/members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-remove)\n\nscope: `groups.write`\n\nRemoves members from a group.\nThe members are removed immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed.\nThis method permits removing the only owner of a group, even in cases where this is not possible via the web client.\nPermission : Team member management.", - "operationId": "groupsMembersRemove", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "return_members": { - "type": "boolean", - "example": true - }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "groups/members/remove": { - "value": { - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "return_members": true, - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/remove response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "99988877733388" - }, - "group_info": { - "type": "object", - "properties": { - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - }, - "examples": { - "groups/members/remove response": { - "value": { - "async_job_id": "99988877733388", - "group_info": { - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "/team/groups/members/set_access_type": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/members/set_access_type", - "description": "[groups/members/set_access_type](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-set_access_type)\n\nscope: `groups.write`\n\nSets a member's access type in a group.\nPermission : Team member management.", - "operationId": "groupsMembersSetAccessType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_type": { - "type": "string", - "example": "member" - }, - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "return_members": { - "type": "boolean", - "example": true - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "groups/members/set_access_type": { - "value": { - "access_type": "member", - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "return_members": true, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/members/set_access_type response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_info" - }, - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - }, - "example": [ - { - ".tag": "group_info", - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - ] - }, - "examples": { - "groups/members/set_access_type response": { - "value": [ - { - ".tag": "group_info", - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - ] - } - } - } - } - } - } - } - }, - "/team/groups/update": { - "post": { - "tags": [ - "team", - "groups" - ], - "summary": "groups/update", - "description": "[groups/update](https://www.dropbox.com/developers/documentation/http/teams#team-groups-update)\n\nscope: `groups.write`\n\nUpdates a group's name and/or external ID.\nPermission : Team member management.", - "operationId": "groupsUpdate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "group_id" - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - } - } - }, - "new_group_external_id": { - "type": "string", - "example": "sales-234" - }, - "new_group_management_type": { - "type": "string", - "example": "company_managed" - }, - "new_group_name": { - "type": "string", - "example": "Europe west sales" - }, - "return_members": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "groups/update": { - "value": { - "group": { - ".tag": "group_id", - "group_id": "g:e2db7665347abcd600000000001a2b3c" - }, - "new_group_external_id": "sales-234", - "new_group_management_type": "company_managed", - "new_group_name": "Europe west sales", - "return_members": true - } - } - } - } - } - }, - "responses": { - "200": { - "description": "groups/update response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "created": { - "type": "number", - "example": 1447255518000 - }, - "group_id": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "group_management_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user_managed" - } - } - }, - "group_name": { - "type": "string", - "example": "project launch" - }, - "member_count": { - "type": "number", - "example": 5 - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "access_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member" - } - } - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "mary@lamb.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - } - } - }, - "example": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - }, - "examples": { - "groups/update response": { - "value": { - "created": 1447255518000, - "group_id": "g:e2db7665347abcd600000000001a2b3c", - "group_management_type": { - ".tag": "user_managed" - }, - "group_name": "project launch", - "member_count": 5, - "members": [ - { - "access_type": { - ".tag": "member" - }, - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "mary@lamb.com", - "email_verified": true, - "joined_on": "2015-05-12T15:50:38Z", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "apple@orange.com", - "is_verified": true - }, - { - "email": "banana@honeydew.com", - "is_verified": true - }, - { - "email": "grape@strawberry.com", - "is_verified": false - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:1234567" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/create_policy": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/create_policy", - "description": "[legal_holds/create_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-create_policy)\n\nscope: `team_data.member`\n\nCreates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsCreatePolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "members": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - }, - "example": [ - "dbmid:FDFSVF-DFSDF" - ] - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - } - } - }, - "examples": { - "legal_holds/create_policy": { - "value": { - "end_date": "2017-12-31T00:00:00Z", - "members": [ - "dbmid:FDFSVF-DFSDF" - ], - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/create_policy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "activation_time": { - "type": "string", - "example": "2016-01-20T00:00:10Z" - }, - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "object", - "properties": { - "permanently_deleted_users": { - "type": "number", - "example": 2 - }, - "team_member_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:efgh5678" - }, - "example": [ - "dbmid:efgh5678" - ] - } - } - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - } - } - }, - "examples": { - "legal_holds/create_policy response": { - "value": { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/get_policy": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/get_policy", - "description": "[legal_holds/get_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-get_policy)\n\nscope: `team_data.member`\n\nGets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsGetPolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - } - } - }, - "examples": { - "legal_holds/get_policy": { - "value": { - "id": "pid_dbhid:abcd1234" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/get_policy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "activation_time": { - "type": "string", - "example": "2016-01-20T00:00:10Z" - }, - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "object", - "properties": { - "permanently_deleted_users": { - "type": "number", - "example": 2 - }, - "team_member_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:efgh5678" - }, - "example": [ - "dbmid:efgh5678" - ] - } - } - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - } - } - }, - "examples": { - "legal_holds/get_policy response": { - "value": { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/list_held_revisions": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/list_held_revisions", - "description": "[legal_holds/list_held_revisions](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions)\n\nscope: `team_data.member`\n\nList the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsListHeldRevisions", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - } - } - }, - "examples": { - "legal_holds/list_held_revisions": { - "value": { - "id": "pid_dbhid:abcd1234" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/list_held_revisions response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "author_email": { - "type": "string", - "example": "a@a.com" - }, - "author_member_id": { - "type": "string", - "example": "dbmid:abcd1234abcd1234abcd1234abcd1234a23" - }, - "author_member_status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "content_hash": { - "type": "string", - "example": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234" - }, - "file_type": { - "type": "string", - "example": "Document" - }, - "new_filename": { - "type": "string", - "example": "111_222.pdf" - }, - "original_file_path": { - "type": "string", - "example": "/a.pdf" - }, - "original_revision_id": { - "type": "string", - "example": "ab2rij4i5ojgfd" - }, - "server_modified": { - "type": "string", - "example": "2019-08-12T12:08:52Z" - }, - "size": { - "type": "number", - "example": 3 - } - } - }, - "example": [ - { - "author_email": "a@a.com", - "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", - "author_member_status": { - ".tag": "active" - }, - "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", - "file_type": "Document", - "new_filename": "111_222.pdf", - "original_file_path": "/a.pdf", - "original_revision_id": "ab2rij4i5ojgfd", - "server_modified": "2019-08-12T12:08:52Z", - "size": 3 - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "legal_holds/list_held_revisions response": { - "value": { - "entries": [ - { - "author_email": "a@a.com", - "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", - "author_member_status": { - ".tag": "active" - }, - "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", - "file_type": "Document", - "new_filename": "111_222.pdf", - "original_file_path": "/a.pdf", - "original_revision_id": "ab2rij4i5ojgfd", - "server_modified": "2019-08-12T12:08:52Z", - "size": 3 - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/list_held_revisions_continue": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/list_held_revisions_continue", - "description": "[legal_holds/list_held_revisions_continue](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions_continue)\n\nscope: `team_data.member`\n\nContinue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsListHeldRevisionsContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - } - } - }, - "examples": { - "legal_holds/list_held_revisions_continue": { - "value": { - "id": "pid_dbhid:abcd1234" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/list_held_revisions_continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "author_email": { - "type": "string", - "example": "a@a.com" - }, - "author_member_id": { - "type": "string", - "example": "dbmid:abcd1234abcd1234abcd1234abcd1234a23" - }, - "author_member_status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "content_hash": { - "type": "string", - "example": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234" - }, - "file_type": { - "type": "string", - "example": "Document" - }, - "new_filename": { - "type": "string", - "example": "111_222.pdf" - }, - "original_file_path": { - "type": "string", - "example": "/a.pdf" - }, - "original_revision_id": { - "type": "string", - "example": "ab2rij4i5ojgfd" - }, - "server_modified": { - "type": "string", - "example": "2019-08-12T12:08:52Z" - }, - "size": { - "type": "number", - "example": 3 - } - } - }, - "example": [ - { - "author_email": "a@a.com", - "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", - "author_member_status": { - ".tag": "active" - }, - "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", - "file_type": "Document", - "new_filename": "111_222.pdf", - "original_file_path": "/a.pdf", - "original_revision_id": "ab2rij4i5ojgfd", - "server_modified": "2019-08-12T12:08:52Z", - "size": 3 - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "legal_holds/list_held_revisions_continue response": { - "value": { - "entries": [ - { - "author_email": "a@a.com", - "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23", - "author_member_status": { - ".tag": "active" - }, - "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234", - "file_type": "Document", - "new_filename": "111_222.pdf", - "original_file_path": "/a.pdf", - "original_revision_id": "ab2rij4i5ojgfd", - "server_modified": "2019-08-12T12:08:52Z", - "size": 3 - } - ], - "has_more": false - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/list_policies": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/list_policies", - "description": "[legal_holds/list_policies](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_policies)\n\nscope: `team_data.member`\n\nLists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsListPolicies", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_released": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "legal_holds/list_policies": { - "value": { - "include_released": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/list_policies response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "policies": { - "type": "array", - "items": { - "type": "object", - "properties": { - "activation_time": { - "type": "string", - "example": "2016-01-20T00:00:10Z" - }, - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "object", - "properties": { - "permanently_deleted_users": { - "type": "number", - "example": 2 - }, - "team_member_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:efgh5678" - }, - "example": [ - "dbmid:efgh5678" - ] - } - } - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - } - } - }, - "example": [ - { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - ] - } - } - }, - "examples": { - "legal_holds/list_policies response": { - "value": { - "policies": [ - { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/legal_holds/release_policy": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/release_policy", - "description": "[legal_holds/release_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-release_policy)\n\nscope: `team_data.member`\n\nReleases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsReleasePolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - } - } - }, - "examples": { - "legal_holds/release_policy": { - "value": { - "id": "pid_dbhid:abcd1234" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/legal_holds/update_policy": { - "post": { - "tags": [ - "team", - "legal_holds" - ], - "summary": "legal_holds/update_policy", - "description": "[legal_holds/update_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-update_policy)\n\nscope: `team_data.member`\n\nUpdates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.\nPermission : Team member file access.", - "operationId": "legalHoldsUpdatePolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - }, - "example": [ - "dbmid:FDFSVF-DFSDF" - ] - } - } - }, - "examples": { - "legal_holds/update_policy": { - "value": { - "id": "pid_dbhid:abcd1234", - "members": [ - "dbmid:FDFSVF-DFSDF" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "legal_holds/update_policy response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "activation_time": { - "type": "string", - "example": "2016-01-20T00:00:10Z" - }, - "end_date": { - "type": "string", - "example": "2017-12-31T00:00:00Z" - }, - "id": { - "type": "string", - "example": "pid_dbhid:abcd1234" - }, - "members": { - "type": "object", - "properties": { - "permanently_deleted_users": { - "type": "number", - "example": 2 - }, - "team_member_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbmid:efgh5678" - }, - "example": [ - "dbmid:efgh5678" - ] - } - } - }, - "name": { - "type": "string", - "example": "acme cfo policy" - }, - "start_date": { - "type": "string", - "example": "2016-01-01T00:00:00Z" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - } - } - }, - "examples": { - "legal_holds/update_policy response": { - "value": { - "activation_time": "2016-01-20T00:00:10Z", - "end_date": "2017-12-31T00:00:00Z", - "id": "pid_dbhid:abcd1234", - "members": { - "permanently_deleted_users": 2, - "team_member_ids": [ - "dbmid:efgh5678" - ] - }, - "name": "acme cfo policy", - "start_date": "2016-01-01T00:00:00Z", - "status": { - ".tag": "active" - } - } - } - } - } - } - } - } - } - }, - "/team/linked_apps/list_member_linked_apps": { - "post": { - "tags": [ - "team", - "linked_apps" - ], - "summary": "linked_apps/list_member_linked_apps", - "description": "[linked_apps/list_member_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_member_linked_apps)\n\nscope: `sessions.list`\n\nList all linked applications of the team member.\nNote, this endpoint does not list any team-linked applications.", - "operationId": "linkedAppsListMemberLinkedApps", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "team_member_id": { - "type": "string", - "example": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - } - } - }, - "examples": { - "linked_apps/list_member_linked_apps": { - "value": { - "team_member_id": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/linked_apps/list_members_linked_apps": { - "post": { - "tags": [ - "team", - "linked_apps" - ], - "summary": "linked_apps/list_members_linked_apps", - "description": "[linked_apps/list_members_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_members_linked_apps)\n\nscope: `sessions.list`\n\nList all applications linked to the team members' accounts.\nNote, this endpoint does not list any team-linked applications.", - "operationId": "linkedAppsListMembersLinkedApps", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "linked_apps/list_members_linked_apps": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/linked_apps/revoke_linked_app": { - "post": { - "tags": [ - "team", - "linked_apps" - ], - "summary": "linked_apps/revoke_linked_app", - "description": "[linked_apps/revoke_linked_app](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app)\n\nscope: `sessions.modify`\n\nRevoke a linked application of the team member.", - "operationId": "linkedAppsRevokeLinkedApp", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "linked_apps/revoke_linked_app": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/linked_apps/revoke_linked_app_batch": { - "post": { - "tags": [ - "team", - "linked_apps" - ], - "summary": "linked_apps/revoke_linked_app_batch", - "description": "[linked_apps/revoke_linked_app_batch](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app_batch)\n\nscope: `sessions.modify`\n\nRevoke a list of linked applications of the team members.", - "operationId": "linkedAppsRevokeLinkedAppBatch", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "linked_apps/revoke_linked_app_batch": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/member_space_limits/excluded_users/add": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/excluded_users/add", - "description": "[member_space_limits/excluded_users/add](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-add)\n\nscope: `members.write`\n\nAdd users to member space limits excluded users list.", - "operationId": "memberSpaceLimitsExcludedUsersAdd", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "member_space_limits/excluded_users/add": { - "value": { - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/excluded_users/add response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - } - } - } - } - }, - "examples": { - "member_space_limits/excluded_users/add response": { - "value": { - "status": { - ".tag": "success" - } - } - } - } - } - } - } - } - } - }, - "/team/member_space_limits/excluded_users/list": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/excluded_users/list", - "description": "[member_space_limits/excluded_users/list](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list)\n\nscope: `members.read`\n\nList member space limits excluded users.", - "operationId": "memberSpaceLimitsExcludedUsersList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "member_space_limits/excluded_users/list": { - "value": { - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/excluded_users/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "users": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "examples": { - "member_space_limits/excluded_users/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "users": [] - } - } - } - } - } - } - } - } - }, - "/team/member_space_limits/excluded_users/list/continue": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/excluded_users/list/continue", - "description": "[member_space_limits/excluded_users/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list-continue)\n\nscope: `members.read`\n\nContinue listing member space limits excluded users.", - "operationId": "memberSpaceLimitsExcludedUsersListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "member_space_limits/excluded_users/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/excluded_users/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "users": { - "type": "array", - "items": {}, - "example": [] - } - } - }, - "examples": { - "member_space_limits/excluded_users/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "users": [] - } - } - } - } - } - } - } - } - }, - "/team/member_space_limits/excluded_users/remove": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/excluded_users/remove", - "description": "[member_space_limits/excluded_users/remove](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-remove)\n\nscope: `members.write`\n\nRemove users from member space limits excluded users list.", - "operationId": "memberSpaceLimitsExcludedUsersRemove", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "member_space_limits/excluded_users/remove": { - "value": { - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/excluded_users/remove response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - } - } - } - } - }, - "examples": { - "member_space_limits/excluded_users/remove response": { - "value": { - "status": { - ".tag": "success" - } - } - } - } - } - } - } - } - } - }, - "/team/member_space_limits/get_custom_quota": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/get_custom_quota", - "description": "[member_space_limits/get_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-get_custom_quota)\n\nscope: `members.read`\n\nGet users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.", - "operationId": "memberSpaceLimitsGetCustomQuota", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "member_space_limits/get_custom_quota": { - "value": { - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/get_custom_quota response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "other" - } - } - }, - "example": [ - { - ".tag": "other" - } - ] - }, - "examples": { - "member_space_limits/get_custom_quota response": { - "value": [ - { - ".tag": "other" - } - ] - } - } - } - } - } - } - } - }, - "/team/member_space_limits/remove_custom_quota": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/remove_custom_quota", - "description": "[member_space_limits/remove_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-remove_custom_quota)\n\nscope: `members.write`\n\nRemove users custom quota. A maximum of 1000 members can be specified in a single call.", - "operationId": "memberSpaceLimitsRemoveCustomQuota", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "member_space_limits/remove_custom_quota": { - "value": { - "users": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/remove_custom_quota response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "other" - } - } - }, - "example": [ - { - ".tag": "other" - } - ] - }, - "examples": { - "member_space_limits/remove_custom_quota response": { - "value": [ - { - ".tag": "other" - } - ] - } - } - } - } - } - } - } - }, - "/team/member_space_limits/set_custom_quota": { - "post": { - "tags": [ - "team", - "member_space_limits" - ], - "summary": "member_space_limits/set_custom_quota", - "description": "[member_space_limits/set_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-set_custom_quota)\n\nscope: `members.read`\n\nSet users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.", - "operationId": "memberSpaceLimitsSetCustomQuota", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "users_and_quotas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "quota_gb": { - "type": "number", - "example": 30 - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "quota_gb": 30, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "member_space_limits/set_custom_quota": { - "value": { - "users_and_quotas": [ - { - "quota_gb": 30, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "member_space_limits/set_custom_quota response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "other" - } - } - }, - "example": [ - { - ".tag": "other" - } - ] - }, - "examples": { - "member_space_limits/set_custom_quota response": { - "value": [ - { - ".tag": "other" - } - ] - } - } - } - } - } - } - } - }, - "/team/members/add": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/add", - "description": "[members/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-add)\n\nscope: `members.write`\n\nAdds members to a team.\nPermission : Team member management\nA maximum of 20 members can be specified in a single call.\nIf no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.\nIf a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.\nTeam member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.", - "operationId": "membersAdd", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "force_async": { - "type": "boolean", - "example": false - }, - "new_members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "member_email": { - "type": "string", - "example": "tom.s@company.com" - }, - "member_external_id": { - "type": "string", - "example": "company_id:342432" - }, - "member_given_name": { - "type": "string", - "example": "Tom" - }, - "member_surname": { - "type": "string", - "example": "Silverstone" - }, - "role": { - "type": "string", - "example": "member_only" - }, - "send_welcome_email": { - "type": "boolean", - "example": true - } - } - }, - "example": [ - { - "member_email": "tom.s@company.com", - "member_external_id": "company_id:342432", - "member_given_name": "Tom", - "member_surname": "Silverstone", - "role": "member_only", - "send_welcome_email": true - } - ] - } - } - }, - "examples": { - "members/add": { - "value": { - "force_async": false, - "new_members": [ - { - "member_email": "tom.s@company.com", - "member_external_id": "company_id:342432", - "member_given_name": "Tom", - "member_surname": "Silverstone", - "role": "member_only", - "send_welcome_email": true - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/add response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "complete": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - }, - "examples": { - "members/add response": { - "value": { - ".tag": "complete", - "complete": [ - { - ".tag": "success", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/add/job_status/get": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/add/job_status/get", - "description": "[members/add/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-add-job_status-get)\n\nscope: `members.write`\n\nOnce an async_job_id is returned from `members/add` , use this to poll the status of the asynchronous request.\nPermission : Team member management.", - "operationId": "membersAddJobStatusGet", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "members/add/job_status/get": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/add/job_status/get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "complete": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - }, - "examples": { - "members/add/job_status/get response": { - "value": { - ".tag": "complete", - "complete": [ - { - ".tag": "success", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/delete_profile_photo": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/delete_profile_photo", - "description": "[members/delete_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-delete_profile_photo)\n\nscope: `members.write`\n\nDeletes a team member's profile photo.\nPermission : Team member management.", - "operationId": "membersDeleteProfilePhoto", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/delete_profile_photo": { - "value": { - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/delete_profile_photo response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "examples": { - "members/delete_profile_photo response": { - "value": { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - } - } - } - } - } - } - } - }, - "/team/members/get_info": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/get_info", - "description": "[members/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-members-get_info)\n\nscope: `members.read`\n\nReturns information about multiple team members.\nPermission : Team information\nThis endpoint will return `MembersGetInfoItem.id_not_found`, for IDs (or emails) that cannot be matched to a valid team member.", - "operationId": "membersGetInfo", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "example": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - }, - "examples": { - "members/get_info": { - "value": { - "members": [ - { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/get_info response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_info" - }, - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - ".tag": "member_info", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - }, - "examples": { - "members/get_info response": { - "value": [ - { - ".tag": "member_info", - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - }, - "/team/members/list": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/list", - "description": "[members/list](https://www.dropbox.com/developers/documentation/http/teams#team-members-list)\n\nscope: `members.read`\n\nLists members of a team.\nPermission : Team information.", - "operationId": "membersList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "include_removed": { - "type": "boolean", - "example": false - }, - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "members/list": { - "value": { - "include_removed": false, - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": true - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - }, - "examples": { - "members/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": true, - "members": [ - { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/list/continue": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/list/continue", - "description": "[members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-members-list-continue)\n\nscope: `members.read`\n\nOnce a cursor has been retrieved from `members/list`, use this to paginate through all team members.\nPermission : Team information.", - "operationId": "membersListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "members/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": true - }, - "members": { - "type": "array", - "items": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "example": [ - { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - }, - "examples": { - "members/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": true, - "members": [ - { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/move_former_member_files": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/move_former_member_files", - "description": "[members/move_former_member_files](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files)\n\nscope: `members.write`\n\nMoves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/move_former_member_files/job_status/check`.\nPermission : Team member management.", - "operationId": "membersMoveFormerMemberFiles", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "transfer_admin_id": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "transfer_dest_id": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/move_former_member_files": { - "value": { - "transfer_admin_id": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "transfer_dest_id": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/move_former_member_files response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "members/move_former_member_files response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/members/move_former_member_files/job_status/check": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/move_former_member_files/job_status/check", - "description": "[members/move_former_member_files/job_status/check](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files-job_status-check)\n\nscope: `members.write`\n\nOnce an async_job_id is returned from `members/move_former_member_files` , use this to poll the status of the asynchronous request.\nPermission : Team member management.", - "operationId": "membersMoveFormerMemberFilesJobStatusCheck", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "members/move_former_member_files/job_status/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/move_former_member_files/job_status/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "members/move_former_member_files/job_status/check response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/members/recover": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/recover", - "description": "[members/recover](https://www.dropbox.com/developers/documentation/http/teams#team-members-recover)\n\nscope: `members.delete`\n\nRecover a deleted member.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.", - "operationId": "membersRecover", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/recover": { - "value": { - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/members/remove": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/remove", - "description": "[members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove)\n\nscope: `members.delete`\n\nRemoves a member from a team.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.\nAccounts can be recovered via `members/recover` for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling `members/add` while a user is still recoverable on your team will return with `MemberAddResult.user_already_on_team`.\nAccounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams).\nThis endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/remove/job_status/get`.", - "operationId": "membersRemove", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "keep_account": { - "type": "boolean", - "example": false - }, - "retain_team_shares": { - "type": "boolean", - "example": false - }, - "transfer_admin_id": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "transfer_dest_id": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "wipe_data": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "members/remove": { - "value": { - "keep_account": false, - "retain_team_shares": false, - "transfer_admin_id": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "transfer_dest_id": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "wipe_data": true - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/remove response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "members/remove response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/members/remove/job_status/get": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/remove/job_status/get", - "description": "[members/remove/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove-job_status-get)\n\nscope: `members.delete`\n\nOnce an async_job_id is returned from `members/remove` , use this to poll the status of the asynchronous request.\nPermission : Team member management.", - "operationId": "membersRemoveJobStatusGet", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "members/remove/job_status/get": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/remove/job_status/get response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - } - } - }, - "examples": { - "members/remove/job_status/get response": { - "value": { - ".tag": "complete" - } - } - } - } - } - } - } - } - }, - "/team/members/secondary_emails/add": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/secondary_emails/add", - "description": "[members/secondary_emails/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-add)\n\nscope: `members.write`\n\nAdd secondary emails to users.\nPermission : Team member management.\nEmails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent.", - "operationId": "membersSecondaryEmailsAdd", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "new_secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "secondary_emails": { - "type": "array", - "items": { - "type": "string", - "example": "bob2@hotmail.com" - }, - "example": [ - "bob2@hotmail.com", - "bob@inst.gov" - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/add": { - "value": { - "new_secondary_emails": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/secondary_emails/add response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "invalid_user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "apple@orange.com" - }, - "is_verified": { - "type": "boolean", - "example": true - } - } - }, - "unavailable": { - "type": "string", - "example": "alice@example.com" - } - } - }, - "example": [ - { - ".tag": "success", - "success": { - "email": "apple@orange.com", - "is_verified": true - } - }, - { - ".tag": "unavailable", - "unavailable": "alice@example.com" - } - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": { - "email": "apple@orange.com", - "is_verified": true - } - }, - { - ".tag": "unavailable", - "unavailable": "alice@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - }, - { - ".tag": "invalid_user", - "invalid_user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/add response": { - "value": { - "results": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": { - "email": "apple@orange.com", - "is_verified": true - } - }, - { - ".tag": "unavailable", - "unavailable": "alice@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - }, - { - ".tag": "invalid_user", - "invalid_user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/secondary_emails/delete": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/secondary_emails/delete", - "description": "[members/secondary_emails/delete](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-delete)\n\nscope: `members.write`\n\nDelete secondary emails from users\nPermission : Team member management.\nUsers will be notified of deletions of verified secondary emails at both the secondary email and their primary email.", - "operationId": "membersSecondaryEmailsDelete", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "emails_to_delete": { - "type": "array", - "items": { - "type": "object", - "properties": { - "secondary_emails": { - "type": "array", - "items": { - "type": "string", - "example": "bob2@hotmail.com" - }, - "example": [ - "bob2@hotmail.com", - "bob@inst.gov" - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/delete": { - "value": { - "emails_to_delete": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/secondary_emails/delete response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "not_found": { - "type": "string", - "example": "alic@example.com" - }, - "success": { - "type": "string", - "example": "alice@example.com" - } - } - }, - "example": [ - { - ".tag": "success", - "success": "alice@example.com" - }, - { - ".tag": "not_found", - "not_found": "alic@example.com" - } - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": "alice@example.com" - }, - { - ".tag": "not_found", - "not_found": "alic@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/delete response": { - "value": { - "results": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": "alice@example.com" - }, - { - ".tag": "not_found", - "not_found": "alic@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/secondary_emails/resend_verification_emails": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/secondary_emails/resend_verification_emails", - "description": "[members/secondary_emails/resend_verification_emails](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-resend_verification_emails)\n\nscope: `members.write`\n\nResend secondary email verification emails.\nPermission : Team member management.", - "operationId": "membersSecondaryEmailsResendVerificationEmails", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "emails_to_resend": { - "type": "array", - "items": { - "type": "object", - "properties": { - "secondary_emails": { - "type": "array", - "items": { - "type": "string", - "example": "bob2@hotmail.com" - }, - "example": [ - "bob2@hotmail.com", - "bob@inst.gov" - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/resend_verification_emails": { - "value": { - "emails_to_resend": [ - { - "secondary_emails": [ - "bob2@hotmail.com", - "bob@inst.gov" - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/secondary_emails/resend_verification_emails response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "success" - }, - "success": { - "type": "string", - "example": "alice@example.com" - } - } - }, - "example": [ - { - ".tag": "success", - "success": "alice@example.com" - } - ] - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "example": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": "alice@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - }, - "examples": { - "members/secondary_emails/resend_verification_emails response": { - "value": { - "results": [ - { - ".tag": "success", - "results": [ - { - ".tag": "success", - "success": "alice@example.com" - } - ], - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/members/send_welcome_email": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/send_welcome_email", - "description": "[members/send_welcome_email](https://www.dropbox.com/developers/documentation/http/teams#team-members-send_welcome_email)\n\nscope: `members.write`\n\nSends welcome email to pending team member.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.\nNo-op if team member is not pending.", - "operationId": "membersSendWelcomeEmail", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "examples": { - "members/send_welcome_email": { - "value": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/members/set_admin_permissions": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/set_admin_permissions", - "description": "[members/set_admin_permissions](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_admin_permissions)\n\nscope: `members.write`\n\nUpdates a team member's permissions.\nPermission : Team member management.", - "operationId": "membersSetAdminPermissions", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "new_role": { - "type": "string", - "example": "member_only" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/set_admin_permissions": { - "value": { - "new_role": "member_only", - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/set_admin_permissions response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:9978889" - } - } - }, - "examples": { - "members/set_admin_permissions response": { - "value": { - "role": { - ".tag": "member_only" - }, - "team_member_id": "dbmid:9978889" - } - } - } - } - } - } - } - } - }, - "/team/members/set_profile": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/set_profile", - "description": "[members/set_profile](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile)\n\nscope: `members.write`\n\nUpdates a team member's profile.\nPermission : Team member management.", - "operationId": "membersSetProfile", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "new_email": { - "type": "string", - "example": "t.smith@domain.com" - }, - "new_surname": { - "type": "string", - "example": "Smith" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/set_profile": { - "value": { - "new_email": "t.smith@domain.com", - "new_surname": "Smith", - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/set_profile response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "examples": { - "members/set_profile response": { - "value": { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - } - } - } - } - } - } - } - }, - "/team/members/set_profile_photo": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/set_profile_photo", - "description": "[members/set_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile_photo)\n\nscope: `members.write`\n\nUpdates a team member's profile photo.\nPermission : Team member management.", - "operationId": "membersSetProfilePhoto", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "photo": { - "$ref": "#/components/schemas/Photo" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/set_profile_photo": { - "value": { - "photo": { - ".tag": "base64_data", - "base64_data": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" - }, - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "members/set_profile_photo response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "role": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "member_only" - } - } - } - } - }, - "examples": { - "members/set_profile_photo response": { - "value": { - "profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - }, - "role": { - ".tag": "member_only" - } - } - } - } - } - } - } - } - } - }, - "/team/members/suspend": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/suspend", - "description": "[members/suspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-suspend)\n\nscope: `members.write`\n\nSuspend a member from a team.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.", - "operationId": "membersSuspend", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - }, - "wipe_data": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "members/suspend": { - "value": { - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - }, - "wipe_data": false - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/members/unsuspend": { - "post": { - "tags": [ - "team", - "members" - ], - "summary": "members/unsuspend", - "description": "[members/unsuspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-unsuspend)\n\nscope: `members.write`\n\nUnsuspend a member from a team.\nPermission : Team member management\nExactly one of team_member_id, email, or external_id must be provided to identify the user account.", - "operationId": "membersUnsuspend", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member_id" - }, - "team_member_id": { - "type": "string", - "example": "dbmid:efgh5678" - } - } - } - } - }, - "examples": { - "members/unsuspend": { - "value": { - "user": { - ".tag": "team_member_id", - "team_member_id": "dbmid:efgh5678" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/namespaces/list": { - "post": { - "tags": [ - "team", - "namespaces" - ], - "summary": "namespaces/list", - "description": "[namespaces/list](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list)\n\nscope: `team_data.member`\n\nReturns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.", - "operationId": "namespacesList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 1 - } - } - }, - "examples": { - "namespaces/list": { - "value": { - "limit": 1 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "namespaces/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "namespaces": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Marketing" - }, - "namespace_id": { - "type": "string", - "example": "123456789" - }, - "namespace_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_folder" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - }, - "example": [ - { - "name": "Marketing", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "shared_folder" - } - }, - { - "name": "Franz Ferdinand", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "team_member_folder" - }, - "team_member_id": "dbmid:1234567" - } - ] - } - } - }, - "examples": { - "namespaces/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "namespaces": [ - { - "name": "Marketing", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "shared_folder" - } - }, - { - "name": "Franz Ferdinand", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "team_member_folder" - }, - "team_member_id": "dbmid:1234567" - } - ] - } - } - } - } - } - } - } - } - }, - "/team/namespaces/list/continue": { - "post": { - "tags": [ - "team", - "namespaces" - ], - "summary": "namespaces/list/continue", - "description": "[namespaces/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list-continue)\n\nscope: `team_data.member`\n\nOnce a cursor has been retrieved from `namespaces/list`, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.", - "operationId": "namespacesListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "namespaces/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "namespaces/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "namespaces": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Marketing" - }, - "namespace_id": { - "type": "string", - "example": "123456789" - }, - "namespace_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_folder" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:1234567" - } - } - }, - "example": [ - { - "name": "Marketing", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "shared_folder" - } - }, - { - "name": "Franz Ferdinand", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "team_member_folder" - }, - "team_member_id": "dbmid:1234567" - } - ] - } - } - }, - "examples": { - "namespaces/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "namespaces": [ - { - "name": "Marketing", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "shared_folder" - } - }, - { - "name": "Franz Ferdinand", - "namespace_id": "123456789", - "namespace_type": { - ".tag": "team_member_folder" - }, - "team_member_id": "dbmid:1234567" - } - ] - } - } - } - } - } - } - } - } - }, - "/team/reports/get_activity": { - "post": { - "tags": [ - "team", - "reports" - ], - "summary": "reports/get_activity", - "description": "[reports/get_activity](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_activity)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's user activity.", - "operationId": "reportsGetActivity", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "reports/get_activity": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/reports/get_devices": { - "post": { - "tags": [ - "team", - "reports" - ], - "summary": "reports/get_devices", - "description": "[reports/get_devices](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_devices)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's linked devices.", - "operationId": "reportsGetDevices", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "reports/get_devices": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/reports/get_membership": { - "post": { - "tags": [ - "team", - "reports" - ], - "summary": "reports/get_membership", - "description": "[reports/get_membership](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_membership)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's membership.", - "operationId": "reportsGetMembership", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "reports/get_membership": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/reports/get_storage": { - "post": { - "tags": [ - "team", - "reports" - ], - "summary": "reports/get_storage", - "description": "[reports/get_storage](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_storage)\n\nscope: `team_info.read`\n\nRetrieves reporting data about a team's storage usage.", - "operationId": "reportsGetStorage", - "requestBody": { - "content": { - "text/plain": { - "examples": { - "reports/get_storage": { - "value": "" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/team_folder/activate": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/activate", - "description": "[team_folder/activate](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-activate)\n\nscope: `team_data.team_space`\n\nSets an archived team folder's status to active.\nPermission : Team member file access.", - "operationId": "teamFolderActivate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/activate": { - "value": { - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/activate response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/activate response": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/archive": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/archive", - "description": "[team_folder/archive](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive)\n\nscope: `team_data.team_space`\n\nSets an active team folder's status to archived and removes all folder and file members.\nPermission : Team member file access.", - "operationId": "teamFolderArchive", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "force_async_off": { - "type": "boolean", - "example": false - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/archive": { - "value": { - "force_async_off": false, - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/archive response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/archive response": { - "value": { - ".tag": "complete", - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/archive/check": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/archive/check", - "description": "[team_folder/archive/check](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive-check)\n\nscope: `team_data.team_space`\n\nReturns the status of an asynchronous job for archiving a team folder.\nPermission : Team member file access.", - "operationId": "teamFolderArchiveCheck", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async_job_id": { - "type": "string", - "example": "34g93hh34h04y384084" - } - } - }, - "examples": { - "team_folder/archive/check": { - "value": { - "async_job_id": "34g93hh34h04y384084" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/archive/check response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "complete" - }, - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/archive/check response": { - "value": { - ".tag": "complete", - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/create": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/create", - "description": "[team_folder/create](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-create)\n\nscope: `team_data.team_space`\n\nCreates a new, active, team folder with no members.\nPermission : Team member file access.", - "operationId": "teamFolderCreate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Marketing" - }, - "sync_setting": { - "type": "string", - "example": "not_synced" - } - } - }, - "examples": { - "team_folder/create": { - "value": { - "name": "Marketing", - "sync_setting": "not_synced" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/create response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/create response": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/get_info": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/get_info", - "description": "[team_folder/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-get_info)\n\nscope: `team_data.team_space`\n\nRetrieves metadata for team folders.\nPermission : Team member file access.", - "operationId": "teamFolderGetInfo", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "team_folder_ids": { - "type": "array", - "items": { - "type": "string", - "example": "947182" - }, - "example": [ - "947182", - "5819424", - "852307532" - ] - } - } - }, - "examples": { - "team_folder/get_info": { - "value": { - "team_folder_ids": [ - "947182", - "5819424", - "852307532" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/team_folder/list": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/list", - "description": "[team_folder/list](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list)\n\nscope: `team_data.team_space`\n\nLists all team folders.\nPermission : Team member file access.", - "operationId": "teamFolderList", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 100 - } - } - }, - "examples": { - "team_folder/list": { - "value": { - "limit": 100 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/list response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "team_folders": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "example": [ - { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - ] - } - } - }, - "examples": { - "team_folder/list response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "team_folders": [ - { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - ] - } - } - } - } - } - } - } - } - }, - "/team/team_folder/list/continue": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/list/continue", - "description": "[team_folder/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list-continue)\n\nscope: `team_data.team_space`\n\nOnce a cursor has been retrieved from `team_folder/list`, use this to paginate through all team folders.\nPermission : Team member file access.", - "operationId": "teamFolderListContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "team_folder/list/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/list/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "has_more": { - "type": "boolean", - "example": false - }, - "team_folders": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "example": [ - { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - ] - } - } - }, - "examples": { - "team_folder/list/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "has_more": false, - "team_folders": [ - { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - ] - } - } - } - } - } - } - } - } - }, - "/team/team_folder/permanently_delete": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/permanently_delete", - "description": "[team_folder/permanently_delete](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-permanently_delete)\n\nscope: `team_data.team_space`\n\nPermanently deletes an archived team folder.\nPermission : Team member file access.", - "operationId": "teamFolderPermanentlyDelete", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/permanently_delete": { - "value": { - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/team/team_folder/rename": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/rename", - "description": "[team_folder/rename](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-rename)\n\nscope: `team_data.team_space`\n\nChanges an active team folder's name.\nPermission : Team member file access.", - "operationId": "teamFolderRename", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Sales" - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/rename": { - "value": { - "name": "Sales", - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/rename response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/rename response": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/team_folder/update_sync_settings": { - "post": { - "tags": [ - "team", - "team_folder" - ], - "summary": "team_folder/update_sync_settings", - "description": "[team_folder/update_sync_settings](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-update_sync_settings)\n\nscope: `team_data.team_space`\n\nUpdates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.", - "operationId": "teamFolderUpdateSyncSettings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "string", - "example": "not_synced" - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": "not_synced" - } - ] - }, - "sync_setting": { - "type": "string", - "example": "not_synced" - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/update_sync_settings": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": "not_synced" - } - ], - "sync_setting": "not_synced", - "team_folder_id": "123456789" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "team_folder/update_sync_settings response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content_sync_settings": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "id:a4ayc_80_OEAAAAAAAAAXw" - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - } - } - }, - "example": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ] - }, - "is_team_shared_dropbox": { - "type": "boolean", - "example": false - }, - "name": { - "type": "string", - "example": "Marketing" - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "sync_setting": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "default" - } - } - }, - "team_folder_id": { - "type": "string", - "example": "123456789" - } - } - }, - "examples": { - "team_folder/update_sync_settings response": { - "value": { - "content_sync_settings": [ - { - "id": "id:a4ayc_80_OEAAAAAAAAAXw", - "sync_setting": { - ".tag": "default" - } - } - ], - "is_team_shared_dropbox": false, - "name": "Marketing", - "status": { - ".tag": "active" - }, - "sync_setting": { - ".tag": "default" - }, - "team_folder_id": "123456789" - } - } - } - } - } - } - } - } - }, - "/team/features/get_values": { - "post": { - "tags": [ - "team" - ], - "summary": "features/get_values", - "description": "[features/get_values](https://www.dropbox.com/developers/documentation/http/teams#team-features-get_values)\n\nscope: `team_info.read`\n\nGet the values for one or more featues. This route allows you to check your account's capability for what feature you can access or what value you have for certain features.\nPermission : Team information.", - "operationId": "featuresGetValues", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "features": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "upload_api_rate_limit" - } - } - }, - "example": [ - { - ".tag": "upload_api_rate_limit" - }, - { - ".tag": "has_team_shared_dropbox" - } - ] - } - } - }, - "examples": { - "features/get_values": { - "value": { - "features": [ - { - ".tag": "upload_api_rate_limit" - }, - { - ".tag": "has_team_shared_dropbox" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "features/get_values response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "upload_api_rate_limit" - }, - "has_team_shared_dropbox": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "has_team_shared_dropbox" - }, - "has_team_shared_dropbox": { - "type": "boolean", - "example": false - } - } - }, - "upload_api_rate_limit": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "limit" - }, - "limit": { - "type": "number", - "example": 25000 - } - } - } - } - }, - "example": [ - { - ".tag": "upload_api_rate_limit", - "upload_api_rate_limit": { - ".tag": "limit", - "limit": 25000 - } - }, - { - ".tag": "has_team_shared_dropbox", - "has_team_shared_dropbox": { - ".tag": "has_team_shared_dropbox", - "has_team_shared_dropbox": false - } - } - ] - } - } - }, - "examples": { - "features/get_values response": { - "value": { - "values": [ - { - ".tag": "upload_api_rate_limit", - "upload_api_rate_limit": { - ".tag": "limit", - "limit": 25000 - } - }, - { - ".tag": "has_team_shared_dropbox", - "has_team_shared_dropbox": { - ".tag": "has_team_shared_dropbox", - "has_team_shared_dropbox": false - } - } - ] - } - } - } - } - } - } - } - } - }, - "/team/get_info": { - "post": { - "tags": [ - "team" - ], - "summary": "get_info", - "description": "[get_info](https://www.dropbox.com/developers/documentation/http/teams#team-get_info)\n\nscope: `team_info.read`\n\nRetrieves information about a team.", - "operationId": "getInfo", - "responses": { - "200": { - "description": "get_info response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Dropbox Inc." - }, - "num_licensed_users": { - "type": "number", - "example": 5 - }, - "num_provisioned_users": { - "type": "number", - "example": 2 - }, - "policies": { - "type": "object", - "properties": { - "emm_state": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "disabled" - } - } - }, - "office_addin": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "disabled" - } - } - }, - "sharing": { - "type": "object", - "properties": { - "shared_folder_join_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "from_anyone" - } - } - }, - "shared_folder_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_create_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_only" - } - } - } - } - } - } - }, - "team_id": { - "type": "string", - "example": "dbtid:1234abcd" - } - } - }, - "examples": { - "get_info response": { - "value": { - "name": "Dropbox Inc.", - "num_licensed_users": 5, - "num_provisioned_users": 2, - "policies": { - "emm_state": { - ".tag": "disabled" - }, - "office_addin": { - ".tag": "disabled" - }, - "sharing": { - "shared_folder_join_policy": { - ".tag": "from_anyone" - }, - "shared_folder_member_policy": { - ".tag": "team" - }, - "shared_link_create_policy": { - ".tag": "team_only" - } - } - }, - "team_id": "dbtid:1234abcd" - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/team/token/get_authenticated_admin": { - "post": { - "tags": [ - "team" - ], - "summary": "token/get_authenticated_admin", - "description": "[token/get_authenticated_admin](https://www.dropbox.com/developers/documentation/http/teams#team-token-get_authenticated_admin)\n\nscope: `team_info.read`\n\nReturns the member profile of the admin who generated the team access token used to make the call.", - "operationId": "tokenGetAuthenticatedAdmin", - "responses": { - "200": { - "description": "token/get_authenticated_admin response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "admin_profile": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "email": { - "type": "string", - "example": "tami@seagull.com" - }, - "email_verified": { - "type": "boolean", - "example": false - }, - "external_id": { - "type": "string", - "example": "244423" - }, - "groups": { - "type": "array", - "items": { - "type": "string", - "example": "g:e2db7665347abcd600000000001a2b3c" - }, - "example": [ - "g:e2db7665347abcd600000000001a2b3c" - ] - }, - "joined_on": { - "type": "string", - "example": "2015-05-12T15:50:38Z" - }, - "member_folder_id": { - "type": "string", - "example": "20" - }, - "membership_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "full" - } - } - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - }, - "secondary_emails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "grape@strawberry.com" - }, - "is_verified": { - "type": "boolean", - "example": false - } - } - }, - "example": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ] - }, - "status": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "active" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - } - } - }, - "examples": { - "token/get_authenticated_admin response": { - "value": { - "admin_profile": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "email": "tami@seagull.com", - "email_verified": false, - "external_id": "244423", - "groups": [ - "g:e2db7665347abcd600000000001a2b3c" - ], - "joined_on": "2015-05-12T15:50:38Z", - "member_folder_id": "20", - "membership_type": { - ".tag": "full" - }, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128", - "secondary_emails": [ - { - "email": "grape@strawberry.com", - "is_verified": false - }, - { - "email": "apple@orange.com", - "is_verified": true - } - ], - "status": { - ".tag": "active" - }, - "team_member_id": "dbmid:FDFSVF-DFSDF" - } - } - } - } - } - } - } - } - } - }, - "/team_log/get_events": { - "post": { - "tags": [ - "team_log" - ], - "summary": "get_events", - "description": "[get_events](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events)\n\nscope: `events.read`\n\nRetrieves team events. If the result's `GetTeamEventsResult.has_more` field is `true`, call `get_events/continue` with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll `get_events/continue` for new events.\nMany attributes note 'may be missing due to historical data gap'.\nNote that the file_operations category and & analogous paper events are not available on all Dropbox Business [plans](http://www.dropbox.com/business/plans-comparison). Use [features/get_values](http://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) to check for this feature.\nPermission : Team Auditing.", - "operationId": "getEvents", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "category": { - "type": "string", - "example": "groups" - }, - "limit": { - "type": "number", - "example": 50 - } - } - }, - "examples": { - "get_events": { - "value": { - "category": "groups", - "limit": 50 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_events response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "events": { - "type": "array", - "items": { - "type": "object", - "properties": { - "actor": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "assets": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "display_name": { - "type": "string", - "example": "reports.xls" - }, - "file_id": { - "type": "string", - "example": "id:jQKLsZFQImAAAAAAEZAAQt" - }, - "file_size": { - "type": "number", - "example": 4 - }, - "path": { - "type": "object", - "properties": { - "contextual": { - "type": "string", - "example": "/Contract Work/Draft" - }, - "namespace_relative": { - "type": "object", - "properties": { - "is_shared_namespace": { - "type": "boolean", - "example": false - }, - "ns_id": { - "type": "string", - "example": "1234" - }, - "relative_path": { - "type": "string", - "example": "/Contract Work/Draft" - } - } - } - } - } - } - }, - "example": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ] - }, - "context": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - }, - "details": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_content_download_details" - }, - "shared_content_access_level": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer_no_comment" - } - } - }, - "shared_content_link": { - "type": "string", - "example": "abc" - }, - "shared_content_owner": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "event_category": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "tfa" - } - } - }, - "event_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_content_download" - }, - "description": { - "type": "string", - "example": "(sharing) Downloaded shared file/folder" - } - } - }, - "involve_non_team_member": { - "type": "boolean", - "example": true - }, - "origin": { - "type": "object", - "properties": { - "access_method": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "end_user" - }, - "end_user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "web" - }, - "session_id": { - "type": "string", - "example": "dbwsid:123456789012345678901234567890123456789" - } - } - } - } - }, - "geo_location": { - "type": "object", - "properties": { - "city": { - "type": "string", - "example": "San Francisco" - }, - "country": { - "type": "string", - "example": "US" - }, - "ip_address": { - "type": "string", - "example": "45.56.78.100" - }, - "region": { - "type": "string", - "example": "California" - } - } - } - } - }, - "participants": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw" - }, - "display_name": { - "type": "string", - "example": "Jane Smith" - }, - "email": { - "type": "string", - "example": "jane_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "example": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ] - }, - "timestamp": { - "type": "string", - "example": "2017-01-25T15:51:30Z" - } - } - }, - "example": [ - { - "actor": { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "assets": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ], - "context": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - }, - "details": { - ".tag": "shared_content_download_details", - "shared_content_access_level": { - ".tag": "viewer_no_comment" - }, - "shared_content_link": "abc", - "shared_content_owner": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "event_category": { - ".tag": "tfa" - }, - "event_type": { - ".tag": "shared_content_download", - "description": "(sharing) Downloaded shared file/folder" - }, - "involve_non_team_member": true, - "origin": { - "access_method": { - ".tag": "end_user", - "end_user": { - ".tag": "web", - "session_id": "dbwsid:123456789012345678901234567890123456789" - } - }, - "geo_location": { - "city": "San Francisco", - "country": "US", - "ip_address": "45.56.78.100", - "region": "California" - } - }, - "participants": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ], - "timestamp": "2017-01-25T15:51:30Z" - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "get_events response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "events": [ - { - "actor": { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "assets": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ], - "context": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - }, - "details": { - ".tag": "shared_content_download_details", - "shared_content_access_level": { - ".tag": "viewer_no_comment" - }, - "shared_content_link": "abc", - "shared_content_owner": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "event_category": { - ".tag": "tfa" - }, - "event_type": { - ".tag": "shared_content_download", - "description": "(sharing) Downloaded shared file/folder" - }, - "involve_non_team_member": true, - "origin": { - "access_method": { - ".tag": "end_user", - "end_user": { - ".tag": "web", - "session_id": "dbwsid:123456789012345678901234567890123456789" - } - }, - "geo_location": { - "city": "San Francisco", - "country": "US", - "ip_address": "45.56.78.100", - "region": "California" - } - }, - "participants": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ], - "timestamp": "2017-01-25T15:51:30Z" - } - ], - "has_more": false - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/team_log/get_events/continue": { - "post": { - "tags": [ - "team_log" - ], - "summary": "get_events/continue", - "description": "[get_events/continue](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events-continue)\n\nscope: `events.read`\n\nOnce a cursor has been retrieved from `get_events`, use this to paginate through all events.\nPermission : Team Auditing.", - "operationId": "getEventsContinue", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - }, - "examples": { - "get_events/continue": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_events/continue response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cursor": { - "type": "string", - "example": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu" - }, - "events": { - "type": "array", - "items": { - "type": "object", - "properties": { - "actor": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "assets": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "file" - }, - "display_name": { - "type": "string", - "example": "reports.xls" - }, - "file_id": { - "type": "string", - "example": "id:jQKLsZFQImAAAAAAEZAAQt" - }, - "file_size": { - "type": "number", - "example": 4 - }, - "path": { - "type": "object", - "properties": { - "contextual": { - "type": "string", - "example": "/Contract Work/Draft" - }, - "namespace_relative": { - "type": "object", - "properties": { - "is_shared_namespace": { - "type": "boolean", - "example": false - }, - "ns_id": { - "type": "string", - "example": "1234" - }, - "relative_path": { - "type": "string", - "example": "/Contract Work/Draft" - } - } - } - } - } - } - }, - "example": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ] - }, - "context": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - }, - "details": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_content_download_details" - }, - "shared_content_access_level": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "viewer_no_comment" - } - } - }, - "shared_content_link": { - "type": "string", - "example": "abc" - }, - "shared_content_owner": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho" - }, - "display_name": { - "type": "string", - "example": "John Smith" - }, - "email": { - "type": "string", - "example": "john_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "event_category": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "tfa" - } - } - }, - "event_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "shared_content_download" - }, - "description": { - "type": "string", - "example": "(sharing) Downloaded shared file/folder" - } - } - }, - "involve_non_team_member": { - "type": "boolean", - "example": true - }, - "origin": { - "type": "object", - "properties": { - "access_method": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "end_user" - }, - "end_user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "web" - }, - "session_id": { - "type": "string", - "example": "dbwsid:123456789012345678901234567890123456789" - } - } - } - } - }, - "geo_location": { - "type": "object", - "properties": { - "city": { - "type": "string", - "example": "San Francisco" - }, - "country": { - "type": "string", - "example": "US" - }, - "ip_address": { - "type": "string", - "example": "45.56.78.100" - }, - "region": { - "type": "string", - "example": "California" - } - } - } - } - }, - "participants": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "user": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_member" - }, - "account_id": { - "type": "string", - "example": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw" - }, - "display_name": { - "type": "string", - "example": "Jane Smith" - }, - "email": { - "type": "string", - "example": "jane_smith@acmecorp.com" - }, - "member_external_id": { - "type": "string", - "example": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225" - }, - "team": { - "type": "object", - "properties": { - "display_name": { - "type": "string", - "example": "A Team" - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - } - } - }, - "example": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ] - }, - "timestamp": { - "type": "string", - "example": "2017-01-25T15:51:30Z" - } - } - }, - "example": [ - { - "actor": { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "assets": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ], - "context": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - }, - "details": { - ".tag": "shared_content_download_details", - "shared_content_access_level": { - ".tag": "viewer_no_comment" - }, - "shared_content_link": "abc", - "shared_content_owner": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "event_category": { - ".tag": "tfa" - }, - "event_type": { - ".tag": "shared_content_download", - "description": "(sharing) Downloaded shared file/folder" - }, - "involve_non_team_member": true, - "origin": { - "access_method": { - ".tag": "end_user", - "end_user": { - ".tag": "web", - "session_id": "dbwsid:123456789012345678901234567890123456789" - } - }, - "geo_location": { - "city": "San Francisco", - "country": "US", - "ip_address": "45.56.78.100", - "region": "California" - } - }, - "participants": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ], - "timestamp": "2017-01-25T15:51:30Z" - } - ] - }, - "has_more": { - "type": "boolean", - "example": false - } - } - }, - "examples": { - "get_events/continue response": { - "value": { - "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu", - "events": [ - { - "actor": { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "assets": [ - { - ".tag": "file", - "display_name": "reports.xls", - "file_id": "id:jQKLsZFQImAAAAAAEZAAQt", - "file_size": 4, - "path": { - "contextual": "/Contract Work/Draft", - "namespace_relative": { - "is_shared_namespace": false, - "ns_id": "1234", - "relative_path": "/Contract Work/Draft" - } - } - } - ], - "context": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - }, - "details": { - ".tag": "shared_content_download_details", - "shared_content_access_level": { - ".tag": "viewer_no_comment" - }, - "shared_content_link": "abc", - "shared_content_owner": { - ".tag": "team_member", - "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho", - "display_name": "John Smith", - "email": "john_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - }, - "event_category": { - ".tag": "tfa" - }, - "event_type": { - ".tag": "shared_content_download", - "description": "(sharing) Downloaded shared file/folder" - }, - "involve_non_team_member": true, - "origin": { - "access_method": { - ".tag": "end_user", - "end_user": { - ".tag": "web", - "session_id": "dbwsid:123456789012345678901234567890123456789" - } - }, - "geo_location": { - "city": "San Francisco", - "country": "US", - "ip_address": "45.56.78.100", - "region": "California" - } - }, - "participants": [ - { - ".tag": "user", - "user": { - ".tag": "team_member", - "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw", - "display_name": "Jane Smith", - "email": "jane_smith@acmecorp.com", - "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225", - "team": { - "display_name": "A Team" - }, - "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q" - } - } - ], - "timestamp": "2017-01-25T15:51:30Z" - } - ], - "has_more": false - } - } - } - } - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/users/features/get_values": { - "post": { - "tags": [ - "users" - ], - "summary": "features/get_values", - "description": "[features/get_values](https://www.dropbox.com/developers/documentation/http/documentation#users-features-get_values)\n\nscope: `account_info.read`\n\nGet a list of feature values that may be configured for the current account.", - "operationId": "featuresGetValues1", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "features": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "paper_as_files" - } - } - }, - "example": [ - { - ".tag": "paper_as_files" - }, - { - ".tag": "file_locking" - } - ] - } - } - }, - "examples": { - "features/get_values": { - "value": { - "features": [ - { - ".tag": "paper_as_files" - }, - { - ".tag": "file_locking" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "features/get_values response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "paper_as_files" - }, - "paper_as_files": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "enabled" - }, - "enabled": { - "type": "boolean", - "example": true - } - } - } - } - }, - "example": [ - { - ".tag": "paper_as_files", - "paper_as_files": { - ".tag": "enabled", - "enabled": true - } - } - ] - } - } - }, - "examples": { - "features/get_values response": { - "value": { - "values": [ - { - ".tag": "paper_as_files", - "paper_as_files": { - ".tag": "enabled", - "enabled": true - } - } - ] - } - } - } - } - } - } - } - } - }, - "/users/get_account": { - "post": { - "tags": [ - "users" - ], - "summary": "get_account", - "description": "[get_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account)\n\nscope: `sharing.read`\n\nGet information about a user's account.", - "operationId": "getAccount", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - } - } - }, - "examples": { - "get_account": { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_account response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "disabled": { - "type": "boolean", - "example": false - }, - "email": { - "type": "string", - "example": "franz@dropbox.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "is_teammate": { - "type": "boolean", - "example": false - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - }, - "examples": { - "get_account response": { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "disabled": false, - "email": "franz@dropbox.com", - "email_verified": true, - "is_teammate": false, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - } - } - } - } - } - } - }, - "/users/get_account_batch": { - "post": { - "tags": [ - "users" - ], - "summary": "get_account_batch", - "description": "[get_account_batch](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account_batch)\n\nscope: `sharing.read`\n\nGet information about multiple user accounts. At most 300 accounts may be queried per request.", - "operationId": "getAccountBatch", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_ids": { - "type": "array", - "items": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "example": [ - "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ" - ] - } - } - }, - "examples": { - "get_account_batch": { - "value": { - "account_ids": [ - "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "get_account_batch response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "disabled": { - "type": "boolean", - "example": false - }, - "email": { - "type": "string", - "example": "franz@dropbox.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "is_teammate": { - "type": "boolean", - "example": false - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "profile_photo_url": { - "type": "string", - "example": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - } - }, - "example": [ - { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "disabled": false, - "email": "franz@dropbox.com", - "email_verified": true, - "is_teammate": false, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - ] - }, - "examples": { - "get_account_batch response": { - "value": [ - { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "disabled": false, - "email": "franz@dropbox.com", - "email_verified": true, - "is_teammate": false, - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128" - } - ] - } - } - } - } - } - } - } - }, - "/users/get_current_account": { - "post": { - "tags": [ - "users" - ], - "summary": "get_current_account", - "description": "[get_current_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_current_account)\n\nscope: `account_info.read`\n\nGet information about the current user's account.", - "operationId": "getCurrentAccount", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectAdmin" - } - ], - "responses": { - "200": { - "description": "get_current_account response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "account_id": { - "type": "string", - "example": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc" - }, - "account_type": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "business" - } - } - }, - "country": { - "type": "string", - "example": "US" - }, - "disabled": { - "type": "boolean", - "example": false - }, - "email": { - "type": "string", - "example": "franz@dropbox.com" - }, - "email_verified": { - "type": "boolean", - "example": true - }, - "is_paired": { - "type": "boolean", - "example": true - }, - "locale": { - "type": "string", - "example": "en" - }, - "name": { - "type": "object", - "properties": { - "abbreviated_name": { - "type": "string", - "example": "FF" - }, - "display_name": { - "type": "string", - "example": "Franz Ferdinand (Personal)" - }, - "familiar_name": { - "type": "string", - "example": "Franz" - }, - "given_name": { - "type": "string", - "example": "Franz" - }, - "surname": { - "type": "string", - "example": "Ferdinand" - } - } - }, - "referral_link": { - "type": "string", - "example": "https://db.tt/ZITNuhtI" - }, - "root_info": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "user" - }, - "home_namespace_id": { - "type": "string", - "example": "3235641" - }, - "root_namespace_id": { - "type": "string", - "example": "3235641" - } - } - }, - "team": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I" - }, - "name": { - "type": "string", - "example": "Acme, Inc." - }, - "office_addin_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "disabled" - } - } - }, - "sharing_policies": { - "type": "object", - "properties": { - "shared_folder_join_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "from_anyone" - } - } - }, - "shared_folder_member_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team" - } - } - }, - "shared_link_create_policy": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "team_only" - } - } - } - } - } - } - }, - "team_member_id": { - "type": "string", - "example": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - }, - "examples": { - "get_current_account response": { - "value": { - "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc", - "account_type": { - ".tag": "business" - }, - "country": "US", - "disabled": false, - "email": "franz@dropbox.com", - "email_verified": true, - "is_paired": true, - "locale": "en", - "name": { - "abbreviated_name": "FF", - "display_name": "Franz Ferdinand (Personal)", - "familiar_name": "Franz", - "given_name": "Franz", - "surname": "Ferdinand" - }, - "referral_link": "https://db.tt/ZITNuhtI", - "root_info": { - ".tag": "user", - "home_namespace_id": "3235641", - "root_namespace_id": "3235641" - }, - "team": { - "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I", - "name": "Acme, Inc.", - "office_addin_policy": { - ".tag": "disabled" - }, - "sharing_policies": { - "shared_folder_join_policy": { - ".tag": "from_anyone" - }, - "shared_folder_member_policy": { - ".tag": "team" - }, - "shared_link_create_policy": { - ".tag": "team_only" - } - } - }, - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" - } - } - } - } - } - } - } - } - }, - "/users/get_space_usage": { - "post": { - "tags": [ - "users" - ], - "summary": "get_space_usage", - "description": "[get_space_usage](https://www.dropbox.com/developers/documentation/http/documentation#users-get_space_usage)\n\nscope: `account_info.read`\n\nGet the space usage information for the current user's account.", - "operationId": "getSpaceUsage", - "parameters": [ - { - "$ref": "#/components/parameters/DropboxApiPathRoot" - }, - { - "$ref": "#/components/parameters/DropboxApiSelectUser" - } - ], - "responses": { - "200": { - "description": "get_space_usage response", - "headers": { - "X-Dropbox-Request-Id": { - "schema": { - "type": "string", - "example": "1234" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "allocation": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "individual" - }, - "allocated": { - "type": "number", - "example": 10000000000 - } - } - }, - "used": { - "type": "number", - "example": 314159265 - } - } - }, - "examples": { - "get_space_usage response": { - "value": { - "allocation": { - ".tag": "individual", - "allocated": 10000000000 - }, - "used": 314159265 - } - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "Photo": { - "type": "object", - "properties": { - ".tag": { - "type": "string", - "example": "base64_data" - }, - "base64_data": { - "type": "string", - "example": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=" - } - } - } - }, - "parameters": { - "DropboxApiPathRoot": { - "name": "dropbox-api-path-root", - "in": "header", - "schema": { - "type": "string", - "example": "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" - } - }, - "DropboxApiSelectUser": { - "name": "dropbox-api-select-user", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - }, - "DropboxApiSelectAdmin": { - "name": "dropbox-api-select-admin", - "in": "header", - "schema": { - "type": "string", - "example": "dbmid:FDFSVF-DFSDF" - } - } - }, - "securitySchemes": { - "bearerAuth": { - "type": "http", - "scheme": "bearer" - } - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "tags": [ - { - "name": "account" - }, - { - "name": "auth" - }, - { - "name": "check" - }, - { - "name": "contacts" - }, - { - "name": "file_properties", - "description": "This namespace contains helpers for property and template metadata endpoints.\n\nThese endpoints enable you to tag arbitrary key/value data to Dropbox files.\n\nThe most basic unit in this namespace is the :type:`PropertyField`. These fields encapsulate the actual key/value data.\n\nFields are added to a Dropbox file using a :type:`PropertyGroup`. Property groups contain a reference to a Dropbox file and a :type:`PropertyGroupTemplate`. Property groups are uniquely identified by the combination of their associated Dropbox file and template.\n\nThe :type:`PropertyGroupTemplate` is a way of restricting the possible key names and value types of the data within a property group. The possible key names and value types are explicitly enumerated using :type:`PropertyFieldTemplate` objects.\n\nYou can think of a property group template as a class definition for a particular key/value metadata object, and the property groups themselves as the instantiations of these objects.\n\nTemplates are owned either by a user/app pair or team/app pair. Templates and their associated properties can't be accessed by any app other than the app that created them, and even then, only when the app is linked with the owner of the template (either a user or team).\n\nUser-owned templates are accessed via the user-auth file_properties/templates/*_for_user endpoints, while team-owned templates are accessed via the team-auth file_properties/templates/*_for_team endpoints. Properties associated with either type of template can be accessed via the user-auth properties/* endpoints.\n\nFinally, properties can be accessed from a number of endpoints that return metadata, including `files/get_metadata`, and `files/list_folder`. Properties can also be added during upload, using `files/upload`.\n" - }, - { - "name": "file_requests", - "description": "This namespace contains endpoints and data types for file request operations.\n" - }, - { - "name": "files", - "description": "This namespace contains endpoints and data types for basic file operations.\n" - }, - { - "name": "sharing", - "description": "This namespace contains endpoints and data types for creating and managing shared links and shared folders.\n" - }, - { - "name": "team" - }, - { - "name": "devices" - }, - { - "name": "groups" - }, - { - "name": "legal_holds" - }, - { - "name": "linked_apps" - }, - { - "name": "member_space_limits" - }, - { - "name": "members" - }, - { - "name": "namespaces" - }, - { - "name": "reports" - }, - { - "name": "team_folder" - }, - { - "name": "team_log" - }, - { - "name": "users", - "description": "This namespace contains endpoints and data types for user management.\n" - } - ] -} \ No newline at end of file diff --git a/docs/spec/openapi.yaml b/docs/spec/openapi.yaml new file mode 100644 index 0000000..42dfab8 --- /dev/null +++ b/docs/spec/openapi.yaml @@ -0,0 +1,16368 @@ +openapi: 3.0.3 +info: + title: Dropbox API Reference + description: "The powerful, yet simple, Dropbox API allows you to manage and control\ + \ content and team settings programmatically and extend Dropbox capabilities in\ + \ new and powerful ways. This is a collection that includes requests to all endpoints\ + \ in the Dropbox API. \n\nThe Dropbox API is divided in two groups of endpoints:\ + \ User Endpoints and Business Endpoints. Operations that would most likely be\ + \ executed by a user, such as file operations, are in the User Endpoints folder.\ + \ Operations that would most likely be executed by a team administrator, such\ + \ as adding users to groups, live in the Business Endpoints folder. \n\nIf you\ + \ are new to Dropbox Business and Team Administration, please have a look at the\ + \ [Dropobox Admin Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide).\ + \ \n\nIf you want more information on how to use our API please refer to our [Developer\ + \ Portal](https://www.dropbox.com/developers). \n\n# What's in the collection?\n\ + \nThe endpoints are organized in the following folders:\n* account\n* auth\n*\ + \ check\n* contacts\n* file_properties\n* file_requests\n* files\n* sharing\n\ + * team\n* team_log\n* users\n\n# Authorization\n\n## OAuth 2.0 for API Access\n\ + Dropbox uses OAuth 2.0, an open specification, to authorize access to data. To\ + \ get an OAuth token from Dropbox to enable Postman to access your Dropbox account\ + \ via the API you’ll need to create a new app on the DBX Platform.\n\n## Creating\ + \ an App on the DBX Platform\nNavigate to https://www.dropbox.com/developers/apps\ + \ and select “Create app” \n1. Choose an API \n2. Choose the type of access you\ + \ need \n3. Give your app a name \n4. Choose the Dropbox account that will own\ + \ your app \n\nFor reference, please use the [Dropbox OAuth guide](https://www.dropbox.com/lp/developers/reference/oauth-guide)\ + \ \n\n## Generating an Access Token\nOnce you select “Create app” a page will\ + \ load that displays information about your newly created app. To generate an\ + \ access token scroll down to “OAuth 2” and click “Generate” beneath “Generated\ + \ access token.” The token will display as a long string of characters. Copy this\ + \ token for use with the Postman Collection.\n\n## Adding an Access Token to the\ + \ requests\nIn the Postman client, click on the three dots to the right of the\ + \ collection name to \"View more actions.\"\n\n![Screenshot of adding access token](https://www.dropbox.com/s/sfebu9ai76cbq39/Screen%20Shot%202020-10-28%20at%2012.50.56%20AM.png?raw=1)\n\ + \nThen, click \"Edit.\"\n\nClick on the \"Variables\" tab and, in the row for\ + \ the `access_token` variable, paste your access token in the `CURRENT VALUE`\ + \ column. The default value is `your-access-token-here`.\n\n![Screenshot of adding\ + \ access token](https://www.dropbox.com/s/ahnbxwe6oscjues/Screen%20Shot%202020-10-28%20at%2012.51.13%20AM.png?raw=1)\n\ + \nFor information on sessions and variables in Postman see the blog post at https://blog.postman.com/sessions-faq/.\n\ + \n# Notes\n* Dropbox also has a Postman Collection in the API Network to help\ + \ administrators with team management workflows. It is called [Dropbox Team Admin\ + \ Workflows](). \n\n" + contact: {} + version: 1.0.0 +servers: +- url: https://api.dropboxapi.com/2 +- url: https://content.dropboxapi.com/2 +- url: https://notify.dropboxapi.com/2 +security: +- bearerAuth: [] +tags: +- name: account +- name: auth +- name: check +- name: contacts +- name: file_properties + description: | + This namespace contains helpers for property and template metadata endpoints. + + These endpoints enable you to tag arbitrary key/value data to Dropbox files. + + The most basic unit in this namespace is the :type:`PropertyField`. These fields encapsulate the actual key/value data. + + Fields are added to a Dropbox file using a :type:`PropertyGroup`. Property groups contain a reference to a Dropbox file and a :type:`PropertyGroupTemplate`. Property groups are uniquely identified by the combination of their associated Dropbox file and template. + + The :type:`PropertyGroupTemplate` is a way of restricting the possible key names and value types of the data within a property group. The possible key names and value types are explicitly enumerated using :type:`PropertyFieldTemplate` objects. + + You can think of a property group template as a class definition for a particular key/value metadata object, and the property groups themselves as the instantiations of these objects. + + Templates are owned either by a user/app pair or team/app pair. Templates and their associated properties can't be accessed by any app other than the app that created them, and even then, only when the app is linked with the owner of the template (either a user or team). + + User-owned templates are accessed via the user-auth file_properties/templates/*_for_user endpoints, while team-owned templates are accessed via the team-auth file_properties/templates/*_for_team endpoints. Properties associated with either type of template can be accessed via the user-auth properties/* endpoints. + + Finally, properties can be accessed from a number of endpoints that return metadata, including `files/get_metadata`, and `files/list_folder`. Properties can also be added during upload, using `files/upload`. +- name: file_requests + description: | + This namespace contains endpoints and data types for file request operations. +- name: files + description: | + This namespace contains endpoints and data types for basic file operations. +- name: sharing + description: | + This namespace contains endpoints and data types for creating and managing shared links and shared folders. +- name: team +- name: devices +- name: groups +- name: legal_holds +- name: linked_apps +- name: member_space_limits +- name: members +- name: namespaces +- name: reports +- name: team_folder +- name: team_log +- name: users + description: | + This namespace contains endpoints and data types for user management. +paths: + /account/set_profile_photo: + post: + tags: + - account + summary: set_profile_photo + description: |- + [set_profile_photo](https://www.dropbox.com/developers/documentation/http/documentation#account-set_profile_photo) + + scope: `account_info.write` + + Sets a user's profile photo. + operationId: setProfilePhoto + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetProfilePhotoRequest' + examples: + set_profile_photo: + value: + photo: + ".tag": base64_data + base64_data: SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= + responses: + "200": + description: set_profile_photo response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/SetProfilePhotoResponse' + examples: + set_profile_photo response: + value: + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /auth/token/from_oauth1: + post: + tags: + - auth + summary: token/from_oauth1 + description: |- + [token/from_oauth1](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-from_oauth1) + + scope: `None` + + Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access token. + operationId: tokenFromOauth1 + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TokenFromOauth1Request' + examples: + token/from_oauth1: + value: + oauth1_token: qievr8hamyg6ndck + oauth1_token_secret: qomoftv0472git7 + responses: + "200": + description: token/from_oauth1 response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/TokenFromOauth1Response' + examples: + token/from_oauth1 response: + value: + oauth2_token: 9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn + /auth/token/revoke: + post: + tags: + - auth + summary: token/revoke + description: |- + [token/revoke](https://www.dropbox.com/developers/documentation/http/documentation#auth-token-revoke) + + scope: `None` + + Disables the access token used to authenticate the call. + operationId: tokenRevoke + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: "" + /check/app: + post: + tags: + - check + summary: app + description: |- + [app](https://www.dropbox.com/developers/documentation/http/documentation#check-app) + + scope: `None` + + 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. + operationId: app + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckAppRequest' + examples: + app: + value: + query: foo + responses: + "200": + description: app response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200' + examples: + app response: + value: + result: foo + /check/user: + post: + tags: + - check + summary: user + description: |- + [user](https://www.dropbox.com/developers/documentation/http/documentation#check-user) + + scope: `None` + + 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. + operationId: user + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckUserRequest' + examples: + user: + value: + query: foo + responses: + "200": + description: user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200' + examples: + user response: + value: + result: foo + /contacts/delete_manual_contacts: + post: + tags: + - contacts + summary: delete_manual_contacts + description: |- + [delete_manual_contacts](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts) + + scope: `contacts.write` + + 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. + operationId: deleteManualContacts + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: "" + /contacts/delete_manual_contacts_batch: + post: + tags: + - contacts + summary: delete_manual_contacts_batch + description: |- + [delete_manual_contacts_batch](https://www.dropbox.com/developers/documentation/http/documentation#contacts-delete_manual_contacts_batch) + + scope: `contacts.write` + + Removes manually added contacts from the given list. + operationId: deleteManualContactsBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteManualContactsBatchRequest' + examples: + delete_manual_contacts_batch: + value: + email_addresses: + - contactemailaddress1@domain.com + - contactemailaddress2@domain.com + responses: + "200": + description: "" + /file_properties/properties/add: + post: + tags: + - file_properties + summary: properties/add + description: |- + [properties/add](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-add) + + scope: `files.metadata.write` + + Add property groups to a Dropbox file. See `templates/add_for_user` or `templates/add_for_team` to create new templates. + operationId: propertiesAdd + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddPropertiesRequest' + examples: + properties/add: + value: + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/properties/overwrite: + post: + tags: + - file_properties + summary: properties/overwrite + description: |- + [properties/overwrite](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-overwrite) + + scope: `files.metadata.write` + + Overwrite property groups associated with a file. This endpoint should be used instead of `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 `properties/update` will only delete fields that are explicitly marked for deletion. + operationId: propertiesOverwrite + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OverwritePropertiesRequest' + examples: + properties/overwrite: + value: + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/properties/remove: + post: + tags: + - file_properties + summary: properties/remove + description: |- + [properties/remove](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-remove) + + scope: `files.metadata.write` + + Permanently removes the specified property group from the file. To remove specific property field key value pairs, see `properties/update`. To update a template, see `templates/update_for_user` or `templates/update_for_team`. To remove a template, see `templates/remove_for_user` or `templates/remove_for_team`. + operationId: propertiesRemove + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemovePropertiesRequest' + examples: + properties/remove: + value: + path: /my_awesome/word.docx + property_template_ids: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/properties/search: + post: + tags: + - file_properties + summary: properties/search + description: |- + [properties/search](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search) + + scope: `files.metadata.read` + + Search across property templates for particular property field values. + operationId: propertiesSearch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SearchPropertiesRequest' + examples: + properties/search: + value: + queries: + - logical_operator: or_operator + mode: + ".tag": field_name + field_name: Security + query: Confidential + template_filter: filter_none + responses: + "200": + description: properties/search response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_1' + examples: + properties/search response: + value: + matches: + - id: id:a4ayc_80_OEAAAAAAAAAXz + is_deleted: false + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_properties/properties/search/continue: + post: + tags: + - file_properties + summary: properties/search/continue + description: |- + [properties/search/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search-continue) + + scope: `files.metadata.read` + + Once a cursor has been retrieved from `properties/search`, use this to paginate through all search results. + operationId: propertiesSearchContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SearchPropertiesContinueRequest' + examples: + properties/search/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: properties/search/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_1' + examples: + properties/search/continue response: + value: + matches: + - id: id:a4ayc_80_OEAAAAAAAAAXz + is_deleted: false + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_properties/properties/update: + post: + tags: + - file_properties + summary: properties/update + description: |- + [properties/update](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-update) + + scope: `files.metadata.write` + + Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of `properties/overwrite` when property groups are being updated via a "delta" instead of via a "snapshot" . In other words, this endpoint will not delete any omitted fields from a property group, whereas `properties/overwrite` will delete any fields that are omitted from a property group. + operationId: propertiesUpdate + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePropertiesRequest' + examples: + properties/update: + value: + path: /my_awesome/word.docx + update_property_groups: + - add_or_update_fields: + - name: Security Policy + value: Confidential + remove_fields: [] + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/templates/add_for_team: + post: + tags: + - file_properties + summary: templates/add_for_team + description: |- + [templates/add_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-add_for_team) + + scope: `files.team_metadata.write` + + Add a template associated with a team. See `properties/add` to add properties to a file or folder. + Note: this endpoint will create team-owned templates. + operationId: templatesAddForTeam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddTemplateForTeam' + examples: + templates/add_for_team: + value: + description: These properties describe how confidential this file + or folder is. + fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + name: Security + responses: + "200": + description: templates/add_for_team response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_2' + examples: + templates/add_for_team response: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + security: + - bearerAuth: [] + /file_properties/templates/add_for_user: + post: + tags: + - file_properties + summary: templates/add_for_user + description: |- + [templates/add_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-add_for_user) + + scope: `files.metadata.write` + + Add a template associated with a user. See `properties/add` to add properties to a file. This endpoint can't be called on a team member or admin's behalf. + operationId: templatesAddForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddTemplateForUser' + examples: + templates/add_for_user: + value: + description: These properties describe how confidential this file + or folder is. + fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + name: Security + responses: + "200": + description: templates/add_for_user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_2' + examples: + templates/add_for_user response: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_properties/templates/get_for_team: + post: + tags: + - file_properties + summary: templates/get_for_team + description: |- + [templates/get_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-get_for_team) + + scope: `files.team_metadata.write` + + Get the schema for a specified template. + operationId: templatesGetForTeam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetTemplateForTeam' + examples: + templates/get_for_team: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: templates/get_for_team response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_3' + examples: + templates/get_for_team response: + value: + description: These properties describe how confidential this file + or folder is. + fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: + ".tag": string + name: Security + security: + - bearerAuth: [] + /file_properties/templates/get_for_user: + post: + tags: + - file_properties + summary: templates/get_for_user + description: |- + [templates/get_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-get_for_user) + + scope: `files.metadata.read` + + Get the schema for a specified template. This endpoint can't be called on a team member or admin's behalf. + operationId: templatesGetForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetTemplateForUserRequest' + examples: + templates/get_for_user: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: templates/get_for_user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_3' + examples: + templates/get_for_user response: + value: + description: These properties describe how confidential this file + or folder is. + fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: + ".tag": string + name: Security + /file_properties/templates/list_for_team: + post: + tags: + - file_properties + summary: templates/list_for_team + description: |- + [templates/list_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-list_for_team) + + scope: `files.team_metadata.write` + + Get the template identifiers for a team. To get the schema of each template use `templates/get_for_team`. + operationId: templatesListForTeam + responses: + "200": + description: templates/list_for_team response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_4' + examples: + templates/list_for_team response: + value: + template_ids: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + security: + - bearerAuth: [] + /file_properties/templates/list_for_user: + post: + tags: + - file_properties + summary: templates/list_for_user + description: |- + [templates/list_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-list_for_user) + + scope: `files.metadata.read` + + Get the template identifiers for a team. To get the schema of each template use `templates/get_for_user`. This endpoint can't be called on a team member or admin's behalf. + operationId: templatesListForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: templates/list_for_user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_4' + examples: + templates/list_for_user response: + value: + template_ids: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_properties/templates/remove_for_team: + post: + tags: + - file_properties + summary: templates/remove_for_team + description: |- + [templates/remove_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-remove_for_team) + + scope: `files.team_metadata.write` + + Permanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone. + operationId: templatesRemoveForTeam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveTemplateForTeamRequest' + examples: + templates/remove_for_team: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + security: + - bearerAuth: [] + /file_properties/templates/remove_for_user: + post: + tags: + - file_properties + summary: templates/remove_for_user + description: |- + [templates/remove_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-remove_for_user) + + scope: `files.metadata.write` + + Permanently removes the specified template created from `templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone. + operationId: templatesRemoveForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateId' + examples: + templates/remove_for_user: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: "" + /file_properties/templates/update_for_team: + post: + tags: + - file_properties + summary: templates/update_for_team + description: |- + [templates/update_for_team](https://www.dropbox.com/developers/documentation/http/teams#file_properties-templates-update_for_team) + + scope: `files.team_metadata.write` + + Update a template associated with a team. This route can update the template name, the template description and add optional properties to templates. + operationId: templatesUpdateForTeam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/templates_update_for_team_body' + examples: + templates/update_for_team: + value: + add_fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + description: These properties will describe how confidential this + file or folder is. + name: New Security Template Name + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: templates/update_for_team response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateId' + examples: + templates/update_for_team response: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + security: + - bearerAuth: [] + /file_properties/templates/update_for_user: + post: + tags: + - file_properties + summary: templates/update_for_user + description: |- + [templates/update_for_user](https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-update_for_user) + + scope: `files.metadata.write` + + 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. + operationId: templatesUpdateForUser + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/templates_update_for_user_body' + examples: + templates/update_for_user: + value: + add_fields: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + description: These properties will describe how confidential this + file or folder is. + name: New Security Template Name + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + responses: + "200": + description: templates/update_for_user response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateId' + examples: + templates/update_for_user response: + value: + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + /file_requests/count: + post: + tags: + - file_requests + summary: count + description: |- + [count](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-count) + + scope: `file_requests.read` + + Returns the total number of file requests owned by this user. Includes both open and closed file requests. + operationId: count + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: count response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_5' + examples: + count response: + value: + file_request_count: 15 + /file_requests/create: + post: + tags: + - file_requests + summary: create + description: |- + [create](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-create) + + scope: `file_requests.write` + + Creates a file request for this user. + operationId: create + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_create_body' + examples: + create: + value: + deadline: + allow_late_uploads: seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + open: true + title: Homework submission + responses: + "200": + description: create response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_6' + examples: + create response: + value: + created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + /file_requests/delete: + post: + tags: + - file_requests + summary: delete + description: |- + [delete](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete) + + scope: `file_requests.write` + + Delete a batch of closed file requests. + operationId: delete + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_delete_body' + examples: + delete: + value: + ids: + - oaCAVmEyrqYnkZX9955Y + - BaZmehYoXMPtaRmfTbSG + responses: + "200": + description: delete response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_7' + examples: + delete response: + value: + file_requests: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + /file_requests/delete_all_closed: + post: + tags: + - file_requests + summary: delete_all_closed + description: |- + [delete_all_closed](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-delete_all_closed) + + scope: `file_requests.write` + + Delete all closed file requests owned by this user. + operationId: deleteAllClosed + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: delete_all_closed response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_7' + examples: + delete_all_closed response: + value: + file_requests: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + /file_requests/get: + post: + tags: + - file_requests + summary: get + description: |- + [get](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-get) + + scope: `file_requests.read` + + Returns the specified file request. + operationId: get + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_get_body' + examples: + get: + value: + id: oaCAVmEyrqYnkZX9955Y + responses: + "200": + description: get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_6' + examples: + get response: + value: + created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + /file_requests/list_v2: + post: + tags: + - file_requests + summary: list + description: |- + [list](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list) + + scope: `file_requests.read` + + 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. + operationId: list + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_list_v2_body' + examples: + list: + value: + limit: 1000 + responses: + "200": + description: list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_8' + examples: + list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + file_requests: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + has_more: true + /file_requests/list/continue: + post: + tags: + - file_requests + summary: list/continue + description: |- + [list/continue](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list-continue) + + scope: `file_requests.read` + + Once a cursor has been retrieved from `list:2`, use this to paginate through all file requests. The cursor must come from a previous call to `list:2` or `list/continue`. + operationId: listContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body' + examples: + list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_8' + examples: + list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + file_requests: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + has_more: true + /file_requests/update: + post: + tags: + - file_requests + summary: update + description: |- + [update](https://www.dropbox.com/developers/documentation/http/documentation#file_requests-update) + + scope: `file_requests.write` + + Update a file request. + operationId: update + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/file_requests_update_body' + examples: + update: + value: + deadline: + ".tag": update + allow_late_uploads: seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + id: oaCAVmEyrqYnkZX9955Y + open: true + title: Homework submission + responses: + "200": + description: update response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_6' + examples: + update response: + value: + created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + /files/copy_v2: + post: + tags: + - files + summary: copy + description: |- + [copy](https://www.dropbox.com/developers/documentation/http/documentation#files-copy) + + scope: `files.content.write` + + Copy a file or folder to a different location in the user's Dropbox. + If the source path is a folder all its contents will be copied. + operationId: copy + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_copy_v2_body' + examples: + copy: + value: + allow_ownership_transfer: false + allow_shared_folder: false + autorename: false + from_path: /Homework/math + to_path: /Homework/algebra + responses: + "200": + description: copy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_9' + examples: + copy response: + value: + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/copy_batch_v2: + post: + tags: + - files + summary: copy_batch + description: |- + [copy_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch) + + scope: `files.content.write` + + Copy multiple files or folders to different locations at once in the user's Dropbox. + This route will replace `copy_batch:1`. The main difference is this route will return status for each entry, while `copy_batch:1` raises failure if any entry fails. + This route will either finish synchronously, or return a job ID and do the async copy job in background. Please use `copy_batch/check:2` to check the job status. + operationId: copyBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_copy_batch_v2_body' + examples: + copy_batch: + value: + autorename: false + entries: + - from_path: /Homework/math + to_path: /Homework/algebra + responses: + "200": + description: copy_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + examples: + copy_batch response: + value: + ".tag": complete + entries: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/copy_batch/check_v2: + post: + tags: + - files + summary: copy_batch/check + description: |- + [copy_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `copy_batch:2`. It returns list of results for each entry. + operationId: copyBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/copy_batch_check_v2_body' + examples: + copy_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: copy_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + examples: + copy_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/copy_reference/get: + post: + tags: + - files + summary: copy_reference/get + description: |- + [copy_reference/get](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-get) + + scope: `files.content.write` + + 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 `copy_reference/save`. + operationId: copyReferenceGet + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/copy_reference_get_body' + examples: + copy_reference/get: + value: + path: /video.mp4 + responses: + "200": + description: copy_reference/get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_11' + examples: + copy_reference/get response: + value: + copy_reference: z1X6ATl6aWtzOGq0c3g5Ng + expires: 2045-05-12T15:50:38Z + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/copy_reference/save: + post: + tags: + - files + summary: copy_reference/save + description: |- + [copy_reference/save](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-save) + + scope: `files.content.write` + + Save a copy reference returned by `copy_reference/get` to the user's Dropbox. + operationId: copyReferenceSave + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/copy_reference_save_body' + examples: + copy_reference/save: + value: + copy_reference: z1X6ATl6aWtzOGq0c3g5Ng + path: /video.mp4 + responses: + "200": + description: copy_reference/save response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_9' + examples: + copy_reference/save response: + value: + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/create_folder_v2: + post: + tags: + - files + summary: create_folder + description: |- + [create_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder) + + scope: `files.content.write` + + Create a folder at a given path. + operationId: createFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_create_folder_v2_body' + examples: + create_folder: + value: + autorename: false + path: /Homework/math + responses: + "200": + description: create_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_12' + examples: + create_folder response: + value: + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + /files/create_folder_batch: + post: + tags: + - files + summary: create_folder_batch + description: |- + [create_folder_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch) + + scope: `files.content.write` + + Create multiple folders at once. + This 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 `CreateFolderBatchArg.force_async` flag. Use `create_folder_batch/check` to check the job status. + operationId: createFolderBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_create_folder_batch_body' + examples: + create_folder_batch: + value: + autorename: false + force_async: false + paths: + - /Homework/math + responses: + "200": + description: create_folder_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_13' + examples: + create_folder_batch response: + value: + ".tag": complete + entries: + - ".tag": success + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + /files/create_folder_batch/check: + post: + tags: + - files + summary: create_folder_batch/check + description: |- + [create_folder_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `create_folder_batch`. If success, it returns list of result for each entry. + operationId: createFolderBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/create_folder_batch_check_body' + examples: + create_folder_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: create_folder_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_13' + examples: + create_folder_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + /files/delete_v2: + post: + tags: + - files + summary: delete + description: |- + [delete](https://www.dropbox.com/developers/documentation/http/documentation#files-delete) + + scope: `files.content.write` + + Delete the file or folder at a given path. + If the path is a folder, all its contents will be deleted too. + A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding `FileMetadata` or `FolderMetadata` for the item at time of deletion, and not a `DeletedMetadata` object. + operationId: delete1 + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_delete_v2_body' + examples: + delete: + value: + path: /Homework/math/Prime_Numbers.txt + responses: + "200": + description: delete response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_9' + examples: + delete response: + value: + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/delete_batch: + post: + tags: + - files + summary: delete_batch + description: |- + [delete_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch) + + scope: `files.content.write` + + Delete multiple files/folders at once. + This route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use `delete_batch/check` to check the job status. + operationId: deleteBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_delete_batch_body' + examples: + delete_batch: + value: + entries: + - path: /Homework/math/Prime_Numbers.txt + responses: + "200": + description: delete_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_14' + examples: + delete_batch response: + value: + ".tag": complete + entries: + - ".tag": success + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/delete_batch/check: + post: + tags: + - files + summary: delete_batch/check + description: |- + [delete_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `delete_batch`. If success, it returns list of result for each entry. + operationId: deleteBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/delete_batch_check_body' + examples: + delete_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: delete_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_14' + examples: + delete_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/download: + post: + tags: + - files + summary: download + description: |- + [download](https://www.dropbox.com/developers/documentation/http/documentation#files-download) + + scope: `files.content.read` + + Download a file from a user's Dropbox. + operationId: download + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "path": "/Homework/math/Prime_Numbers.txt" + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: download response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + download response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/download_zip: + post: + tags: + - files + summary: download_zip + description: |- + [download_zip](https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip) + + scope: `files.content.read` + + Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size. + operationId: downloadZip + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "path": "/Homework/math" + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: download_zip response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_12' + examples: + download_zip response: + value: + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + /files/export: + post: + tags: + - files + summary: export + description: |- + [export](https://www.dropbox.com/developers/documentation/http/documentation#files-export) + + scope: `files.content.read` + + Export a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose `ExportResult.file_metadata` has `ExportInfo.export_as` populated. + operationId: export + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "path": "/Homework/math/Prime_Numbers.gsheet" + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: export response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_16' + examples: + export response: + value: + export_metadata: + export_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + name: Prime_Numbers.xlsx + size: 7189 + file_metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_file_lock_batch: + post: + tags: + - files + summary: get_file_lock_batch + description: |- + [get_file_lock_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_file_lock_batch) + + scope: `files.content.read` + + Return the lock metadata for the given list of paths. + operationId: getFileLockBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_file_lock_batch_body' + examples: + get_file_lock_batch: + value: + entries: + - path: /John Doe/sample/test.pdf + responses: + "200": + description: get_file_lock_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_17' + examples: + get_file_lock_batch response: + value: + entries: + - ".tag": success + lock: + content: + ".tag": single_user + created: 2015-05-12T15:50:38Z + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_metadata: + post: + tags: + - files + summary: get_metadata + description: |- + [get_metadata](https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata) + + scope: `files.metadata.read` + + Returns the metadata for a file or folder. + Note: Metadata for the root folder is unsupported. + operationId: getMetadata + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_metadata_body' + examples: + get_metadata: + value: + include_deleted: false + include_has_explicit_shared_members: false + include_media_info: false + path: /Homework/math + responses: + "200": + description: get_metadata response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_18' + examples: + get_metadata response: + value: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_preview: + post: + tags: + - files + summary: get_preview + description: |- + [get_preview](https://www.dropbox.com/developers/documentation/http/documentation#files-get_preview) + + scope: `files.content.read` + + Get a preview for a file. + Currently, 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. + HTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx. + Other formats will return an unsupported extension error. + operationId: getPreview + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "path": "/word.docx" + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: get_preview response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + get_preview response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_temporary_link: + post: + tags: + - files + summary: get_temporary_link + description: |- + [get_temporary_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link) + + scope: `files.content.read` + + 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. + operationId: getTemporaryLink + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_temporary_link_body' + examples: + get_temporary_link: + value: + path: /video.mp4 + responses: + "200": + description: get_temporary_link response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_19' + examples: + get_temporary_link response: + value: + link: https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2 + metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_temporary_upload_link: + post: + tags: + - files + summary: get_temporary_upload_link + description: |- + [get_temporary_upload_link](https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_upload_link) + + scope: `files.content.write` + + Get a one-time use temporary upload link to upload a file to a Dropbox location. + + This endpoint acts as a delayed `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 `CommitInfo` previously provided to `get_temporary_upload_link` but evaluated only upon consumption. Hence, errors stemming from invalid `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. + + The POST request on the temporary upload link must have its Content-Type set to "application/octet-stream". + + Example temporary upload link consumption request: + + curl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND + --header "Content-Type: application/octet-stream" + --data-binary @local_file.txt + + A successful temporary upload link consumption request returns the content hash of the uploaded data in JSON format. + + Example succesful temporary upload link consumption response: + {"content-hash": "599d71033d700ac892a0e48fa61b125d2f5994"} + + An unsuccessful temporary upload link consumption request returns any of the following status codes: + + HTTP 400 Bad Request: Content-Type is not one of application/octet-stream and text/plain or request is invalid. + HTTP 409 Conflict: The temporary upload link does not exist or is currently unavailable, the upload failed, or another error happened. + HTTP 410 Gone: The temporary upload link is expired or consumed. + + Example unsuccessful temporary upload link consumption response: + Temporary upload link has been recently consumed. + operationId: getTemporaryUploadLink + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_temporary_upload_link_body' + examples: + get_temporary_upload_link: + value: + commit_info: + autorename: true + mode: add + mute: false + path: /Homework/math/Matrices.txt + strict_conflict: false + duration: 3600 + responses: + "200": + description: get_temporary_upload_link response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_20' + examples: + get_temporary_upload_link response: + value: + link: https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND + /files/get_thumbnail_v2: + post: + tags: + - files + summary: get_thumbnail + description: |- + [get_thumbnail](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail) + + scope: `files.content.read` + + Get a thumbnail for a file. + operationId: getThumbnail + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"resource\": {\n \".tag\": \"path\", \n \ + \ \"path\": \"/a.docx\"\n }, \n \"format\": \"jpeg\", \n \"size\"\ + : \"w64h64\", \n \"mode\": \"strict\"\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: get_thumbnail response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_21' + examples: + get_thumbnail response: + value: + file_metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/get_thumbnail_batch: + post: + tags: + - files + summary: get_thumbnail_batch + description: |- + [get_thumbnail_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail_batch) + + scope: `files.content.read` + + Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch. + This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail. + operationId: getThumbnailBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_get_thumbnail_batch_body' + examples: + get_thumbnail_batch: + value: + entries: + - format: jpeg + mode: strict + path: /image.jpg + size: w64h64 + responses: + "200": + description: get_thumbnail_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_22' + examples: + get_thumbnail_batch response: + value: + entries: + - ".tag": success + metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + thumbnail: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= + /files/list_folder: + post: + tags: + - files + summary: list_folder + description: |- + [list_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder) + + scope: `files.metadata.read` + + Starts returning the contents of a folder. If the result's `ListFolderResult.has_more` field is `true`, call `list_folder/continue` with the returned `ListFolderResult.cursor` to retrieve more entries. + If you're using `ListFolderArg.recursive` set to `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: + For each `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. + For each `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 `FolderSharingInfo.read_only` and set all its children's read-only statuses to match. + For each `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. + Note: `auth.RateLimitError` may be returned if multiple `list_folder` or `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. + operationId: listFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_list_folder_body' + examples: + list_folder: + value: + include_deleted: false + include_has_explicit_shared_members: false + include_media_info: false + include_mounted_folders: true + include_non_downloadable_files: true + path: /Homework/math + recursive: false + responses: + "200": + description: list_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_23' + examples: + list_folder response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + - ".tag": folder + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + has_more: false + /files/list_folder/continue: + post: + tags: + - files + summary: list_folder/continue + description: |- + [list_folder/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue) + + scope: `files.metadata.read` + + Once a cursor has been retrieved from `list_folder`, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for `list_folder`. + operationId: listFolderContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_continue_body' + examples: + list_folder/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_folder/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_23' + examples: + list_folder/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + - ".tag": folder + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + has_more: false + /files/list_folder/get_latest_cursor: + post: + tags: + - files + summary: list_folder/get_latest_cursor + description: |- + [list_folder/get_latest_cursor](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-get_latest_cursor) + + scope: `files.metadata.read` + + A way to quickly get a cursor for the folder's state. Unlike `list_folder`, `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. + operationId: listFolderGetLatestCursor + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_get_latest_cursor_body' + examples: + list_folder/get_latest_cursor: + value: + include_deleted: false + include_has_explicit_shared_members: false + include_media_info: false + include_mounted_folders: true + include_non_downloadable_files: true + path: /Homework/math + recursive: false + responses: + "200": + description: list_folder/get_latest_cursor response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_continue_body' + examples: + list_folder/get_latest_cursor response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + /files/list_folder/longpoll: + post: + tags: + - files + summary: list_folder/longpoll + description: |- + [list_folder/longpoll](https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-longpoll) + + scope: `files.metadata.read` + + A longpoll endpoint to wait for changes on an account. In conjunction with `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 [webhooks documentation](https://www.dropbox.com/developers/reference/webhooks). + operationId: listFolderLongpoll + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_longpoll_body' + examples: + list_folder/longpoll: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + timeout: 30 + responses: + "200": + description: list_folder/longpoll response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_24' + examples: + list_folder/longpoll response: + value: + changes: true + /files/list_revisions: + post: + tags: + - files + summary: list_revisions + description: |- + [list_revisions](https://www.dropbox.com/developers/documentation/http/documentation#files-list_revisions) + + scope: `files.metadata.read` + + 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. + In the `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 `ListRevisionsMode.id`. The `ListRevisionsMode.id` mode is useful to retrieve revisions for a given file across moves or renames. + operationId: listRevisions + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_list_revisions_body' + examples: + list_revisions: + value: + limit: 10 + mode: path + path: /root/word.docx + responses: + "200": + description: list_revisions response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_25' + examples: + list_revisions response: + value: + entries: + - client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + is_deleted: false + /files/lock_file_batch: + post: + tags: + - files + summary: lock_file_batch + description: |- + [lock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-lock_file_batch) + + scope: `files.content.write` + + 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. + operationId: lockFileBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_lock_file_batch_body' + examples: + lock_file_batch: + value: + entries: + - path: /John Doe/sample/test.pdf + responses: + "200": + description: lock_file_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_17' + examples: + lock_file_batch response: + value: + entries: + - ".tag": success + lock: + content: + ".tag": single_user + created: 2015-05-12T15:50:38Z + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/move_v2: + post: + tags: + - files + summary: move + description: |- + [move](https://www.dropbox.com/developers/documentation/http/documentation#files-move) + + scope: `files.content.write` + + Move a file or folder to a different location in the user's Dropbox. + If the source path is a folder all its contents will be moved. + Note that we do not currently support case-only renaming. + operationId: move + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_move_v2_body' + examples: + move: + value: + allow_ownership_transfer: false + allow_shared_folder: false + autorename: false + from_path: /Homework/math + to_path: /Homework/algebra + responses: + "200": + description: move response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_9' + examples: + move response: + value: + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/move_batch_v2: + post: + tags: + - files + summary: move_batch + description: |- + [move_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch) + + scope: `files.content.write` + + 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. + This route will replace `move_batch:1`. The main difference is this route will return status for each entry, while `move_batch:1` raises failure if any entry fails. + This route will either finish synchronously, or return a job ID and do the async move job in background. Please use `move_batch/check:2` to check the job status. + operationId: moveBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_move_batch_v2_body' + examples: + move_batch: + value: + allow_ownership_transfer: false + autorename: false + entries: + - from_path: /Homework/math + to_path: /Homework/algebra + responses: + "200": + description: move_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + examples: + move_batch response: + value: + ".tag": complete + entries: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/move_batch/check_v2: + post: + tags: + - files + summary: move_batch/check + description: |- + [move_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-move_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `move_batch:2`. It returns list of results for each entry. + operationId: moveBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/move_batch_check_v2_body' + examples: + move_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: move_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + examples: + move_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/permanently_delete: + post: + tags: + - files + summary: permanently_delete + description: |- + [permanently_delete](https://www.dropbox.com/developers/documentation/http/documentation#files-permanently_delete) + + scope: `files.permanent_delete` + + Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40). + Note: This endpoint is only available for Dropbox Business apps. + operationId: permanentlyDelete + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_permanently_delete_body' + examples: + permanently_delete: + value: + path: /Homework/math/Prime_Numbers.txt + responses: + "200": + description: "" + /files/restore: + post: + tags: + - files + summary: restore + description: |- + [restore](https://www.dropbox.com/developers/documentation/http/documentation#files-restore) + + scope: `files.content.write` + + Restore a specific revision of a file to the given path. + operationId: restore + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_restore_body' + examples: + restore: + value: + path: /root/word.docx + rev: a1c10ce0dd78 + responses: + "200": + description: restore response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + restore response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/save_url: + post: + tags: + - files + summary: save_url + description: |- + [save_url](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url) + + scope: `files.content.write` + + Save the data from a specified URL into a file in user's Dropbox. + Note that the transfer from the URL must complete within 5 minutes, or the operation will time out and the job will fail. + If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt). + operationId: saveUrl + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_save_url_body' + examples: + save_url: + value: + path: /a.txt + url: http://example.com/a.txt + responses: + "200": + description: save_url response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_26' + examples: + save_url response: + value: + ".tag": complete + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/save_url/check_job_status: + post: + tags: + - files + summary: save_url/check_job_status + description: |- + [save_url/check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#files-save_url-check_job_status) + + scope: `files.content.write` + + Check the status of a `save_url` job. + operationId: saveUrlCheckJobStatus + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/save_url_check_job_status_body' + examples: + save_url/check_job_status: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: save_url/check_job_status response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_27' + examples: + save_url/check_job_status response: + value: + ".tag": in_progress + /files/search_v2: + post: + tags: + - files + summary: search + description: |- + [search](https://www.dropbox.com/developers/documentation/http/documentation#files-search) + + scope: `files.metadata.read` + + Searches for files and folders. + Note: `search:2` along with `search/continue:2` can only be used to retrieve a maximum of 10,000 matches. + Recent 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. + operationId: search + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_search_v2_body' + examples: + search: + value: + include_highlights: false + query: cat + responses: + "200": + description: search response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_28' + examples: + search response: + value: + has_more: false + matches: + - metadata: + ".tag": metadata + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/search/continue_v2: + post: + tags: + - files + summary: search/continue + description: |- + [search/continue](https://www.dropbox.com/developers/documentation/http/documentation#files-search-continue) + + scope: `files.metadata.read` + + Fetches the next page of search results returned from `search:2`. + Note: `search:2` along with `search/continue:2` can only be used to retrieve a maximum of 10,000 matches. + Recent 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. + operationId: searchContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/search_continue_v2_body' + examples: + search/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: search/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_28' + examples: + search/continue response: + value: + has_more: false + matches: + - metadata: + ".tag": metadata + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/unlock_file_batch: + post: + tags: + - files + summary: unlock_file_batch + description: |- + [unlock_file_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-unlock_file_batch) + + scope: `files.content.write` + + 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. + operationId: unlockFileBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/files_unlock_file_batch_body' + examples: + unlock_file_batch: + value: + entries: + - path: /John Doe/sample/test.pdf + responses: + "200": + description: unlock_file_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_17' + examples: + unlock_file_batch response: + value: + entries: + - ".tag": success + lock: + content: + ".tag": single_user + created: 2015-05-12T15:50:38Z + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload: + post: + tags: + - files + summary: upload + description: |- + [upload](https://www.dropbox.com/developers/documentation/http/documentation#files-upload) + + scope: `files.content.write` + + Create a new file with the contents provided in the request. + Do not use this to upload a file larger than 150 MB. Instead, create an upload session with `upload_session/start`. + Calls 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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: upload + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"path\": \"/Homework/math/Matrices.txt\", \n \"mode\"\ + : \"add\", \n \"autorename\": true, \n \"mute\": false, \n \"\ + strict_conflict\": false\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: upload response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + upload response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload_session/append_v2: + post: + tags: + - files + summary: upload_session/append + description: |- + [upload_session/append](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-append) + + scope: `files.content.write` + + Append more data to an upload session. + When the parameter close is set, this call will close the session. + A 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. + Calls 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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: uploadSessionAppend + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\"\ + , \n \"offset\": 0\n }, \n \"close\": false\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: "" + /files/upload_session/finish: + post: + tags: + - files + summary: upload_session/finish + description: |- + [upload_session/finish](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish) + + scope: `files.content.write` + + Finish an upload session and save the uploaded data to the given file path. + A 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. + Calls 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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: uploadSessionFinish + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"cursor\": {\n \"session_id\": \"1234faaf0678bcde\"\ + , \n \"offset\": 0\n }, \n \"commit\": {\n \"path\"\ + : \"/Homework/math/Matrices.txt\", \n \"mode\": \"add\", \n \ + \ \"autorename\": true, \n \"mute\": false, \n \"strict_conflict\"\ + : false\n }\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: upload_session/finish response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_15' + examples: + upload_session/finish response: + value: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload_session/finish_batch: + post: + tags: + - files + summary: upload_session/finish_batch + description: |- + [upload_session/finish_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch) + + scope: `files.content.write` + + This route helps you commit many files at once into a user's Dropbox. Use `upload_session/start` and `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 `upload_session/finish`, use this route to finish all your upload sessions in a single request. + `UploadSessionStartArg.close` or `UploadSessionAppendArg.close` needs to be true for the last `upload_session/start` or `upload_session/append:2` call. The maximum size of a file one can upload to an upload session is 350 GB. + This route will return a job_id immediately and do the async commit job in background. Use `upload_session/finish_batch/check` to check the job status. + For 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. + Calls 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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: uploadSessionFinishBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/upload_session_finish_batch_body' + examples: + upload_session/finish_batch: + value: + entries: + - commit: + autorename: true + mode: add + mute: false + path: /Homework/math/Matrices.txt + strict_conflict: false + cursor: + offset: 0 + session_id: 1234faaf0678bcde + responses: + "200": + description: upload_session/finish_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_29' + examples: + upload_session/finish_batch response: + value: + ".tag": complete + entries: + - ".tag": success + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload_session/finish_batch/check: + post: + tags: + - files + summary: upload_session/finish_batch/check + description: |- + [upload_session/finish_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish_batch-check) + + scope: `files.content.write` + + Returns the status of an asynchronous job for `upload_session/finish_batch`. If success, it returns list of result for each entry. + operationId: uploadSessionFinishBatchCheck + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/finish_batch_check_body' + examples: + upload_session/finish_batch/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: upload_session/finish_batch/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_29' + examples: + upload_session/finish_batch/check response: + value: + ".tag": complete + entries: + - ".tag": success + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + /files/upload_session/start: + post: + tags: + - files + summary: upload_session/start + description: |- + [upload_session/start](https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-start) + + scope: `files.content.write` + + 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 `upload_session/append:2` to add more data and `upload_session/finish` to save all the data to a file in Dropbox. + A 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. + An upload session can be used for a maximum of 48 hours. Attempting to use an `UploadSessionStartResult.session_id` with `upload_session/append:2` or `upload_session/finish` more than 48 hours after its creation will return a `UploadSessionLookupError.not_found`. + Calls 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 [Data transport limit page](https://www.dropbox.com/developers/reference/data-transport-limit). + operationId: uploadSessionStart + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: |- + { + "close": false + } + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: upload_session/start response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_30' + examples: + upload_session/start response: + value: + session_id: 1234faaf0678bcde + /sharing/add_file_member: + post: + tags: + - sharing + summary: add_file_member + description: |- + [add_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member) + + scope: `sharing.write` + + Adds specified members to a file. + operationId: addFileMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_add_file_member_body' + examples: + add_file_member: + value: + access_level: viewer + add_message_as_comment: false + custom_message: This is a custom message about ACME.doc + file: id:3kmLmQFnf1AAAAAAAAAAAw + members: + - ".tag": email + email: justin@example.com + quiet: false + responses: + "200": + description: add_file_member response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - member: + ".tag": email + email: justin@example.com + result: + ".tag": success + items: + $ref: '#/components/schemas/inline_response_200_31' + examples: + add_file_member response: + value: + - member: + ".tag": email + email: justin@example.com + result: + ".tag": success + /sharing/add_folder_member: + post: + tags: + - sharing + summary: add_folder_member + description: |- + [add_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_folder_member) + + scope: `sharing.write` + + Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member. + For the new member to get access to all the functionality for this folder, you will need to call `mount_folder` on their behalf. + operationId: addFolderMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_add_folder_member_body' + examples: + add_folder_member: + value: + custom_message: Documentation for launch day + members: + - access_level: editor + member: + ".tag": email + email: justin@example.com + - access_level: viewer + member: + ".tag": dropbox_id + dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + quiet: false + shared_folder_id: "84528192421" + responses: + "200": + description: "" + /sharing/check_job_status: + post: + tags: + - sharing + summary: check_job_status + description: |- + [check_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_job_status) + + scope: `sharing.write` + + Returns the status of an asynchronous job. + operationId: checkJobStatus + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_check_job_status_body' + examples: + check_job_status: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: check_job_status response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_27' + examples: + check_job_status response: + value: + ".tag": in_progress + /sharing/check_remove_member_job_status: + post: + tags: + - sharing + summary: check_remove_member_job_status + description: |- + [check_remove_member_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_remove_member_job_status) + + scope: `sharing.write` + + Returns the status of an asynchronous job for sharing a folder. + operationId: checkRemoveMemberJobStatus + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_check_remove_member_job_status_body' + examples: + check_remove_member_job_status: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: check_remove_member_job_status response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + check_remove_member_job_status response: + value: + ".tag": complete + /sharing/check_share_job_status: + post: + tags: + - sharing + summary: check_share_job_status + description: |- + [check_share_job_status](https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_share_job_status) + + scope: `sharing.write` + + Returns the status of an asynchronous job for sharing a folder. + operationId: checkShareJobStatus + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_check_share_job_status_body' + examples: + check_share_job_status: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: check_share_job_status response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_33' + examples: + check_share_job_status response: + value: + ".tag": complete + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/get_file_metadata: + post: + tags: + - sharing + summary: get_file_metadata + description: |- + [get_file_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata) + + scope: `sharing.read` + + Returns shared file metadata. + operationId: getFileMetadata + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_get_file_metadata_body' + examples: + get_file_metadata: + value: + actions: [] + file: id:3kmLmQFnf1AAAAAAAAAAAw + responses: + "200": + description: get_file_metadata response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_34' + examples: + get_file_metadata response: + value: + access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + 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: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + /sharing/get_file_metadata/batch: + post: + tags: + - sharing + summary: get_file_metadata/batch + description: |- + [get_file_metadata/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata-batch) + + scope: `sharing.read` + + Returns shared file metadata. + operationId: getFileMetadataBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/get_file_metadata_batch_body' + examples: + get_file_metadata/batch: + value: + actions: [] + files: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + responses: + "200": + description: get_file_metadata/batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + ".tag": metadata + access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + 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: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + items: + $ref: '#/components/schemas/inline_response_200_35' + examples: + get_file_metadata/batch response: + value: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + ".tag": metadata + access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + 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: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + /sharing/get_folder_metadata: + post: + tags: + - sharing + summary: get_folder_metadata + description: |- + [get_folder_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_folder_metadata) + + scope: `sharing.read` + + Returns shared folder metadata by its folder ID. + operationId: getFolderMetadata + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_get_folder_metadata_body' + examples: + get_folder_metadata: + value: + actions: [] + shared_folder_id: "84528192421" + responses: + "200": + description: get_folder_metadata response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_36' + examples: + get_folder_metadata response: + value: + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/get_shared_link_file: + post: + tags: + - sharing + summary: get_shared_link_file + description: |- + [get_shared_link_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file) + + scope: `sharing.read` + + Download the shared link's file from a user's Dropbox. + operationId: getSharedLinkFile + parameters: + - name: dropbox-api-arg + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\n \"url\": \"https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0\"\ + , \n \"path\": \"/Prime_Numbers.txt\"\n}" + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: get_shared_link_file response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_37' + examples: + get_shared_link_file response: + value: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + /sharing/get_shared_link_metadata: + post: + tags: + - sharing + summary: get_shared_link_metadata + description: |- + [get_shared_link_metadata](https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_metadata) + + scope: `sharing.read` + + Get the shared link's metadata. + operationId: getSharedLinkMetadata + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_get_shared_link_metadata_body' + examples: + get_shared_link_metadata: + value: + path: /Prime_Numbers.txt + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + responses: + "200": + description: get_shared_link_metadata response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_37' + examples: + get_shared_link_metadata response: + value: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + /sharing/list_file_members: + post: + tags: + - sharing + summary: list_file_members + description: |- + [list_file_members](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members) + + scope: `sharing.read` + + Use to obtain the members who have been invited to a file, both inherited and uninherited members. + operationId: listFileMembers + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_file_members_body' + examples: + list_file_members: + value: + file: id:3kmLmQFnf1AAAAAAAAAAAw + include_inherited: true + limit: 100 + responses: + "200": + description: list_file_members response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_38' + examples: + list_file_members response: + value: + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + /sharing/list_file_members/batch: + post: + tags: + - sharing + summary: list_file_members/batch + description: |- + [list_file_members/batch](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-batch) + + scope: `sharing.read` + + 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. + Inherited users and groups are not included in the result, and permissions are not returned for this endpoint. + operationId: listFileMembersBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_file_members_batch_body' + examples: + list_file_members/batch: + value: + files: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + limit: 10 + responses: + "200": + description: list_file_members/batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + ".tag": result + member_count: 3 + members: + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + items: + $ref: '#/components/schemas/inline_response_200_39' + examples: + list_file_members/batch response: + value: + - file: id:3kmLmQFnf1AAAAAAAAAAAw + result: + ".tag": result + member_count: 3 + members: + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + /sharing/list_file_members/continue: + post: + tags: + - sharing + summary: list_file_members/continue + description: |- + [list_file_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-continue) + + scope: `sharing.read` + + Once a cursor has been retrieved from `list_file_members` or `list_file_members/batch`, use this to paginate through all shared file members. + operationId: listFileMembersContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_file_members_continue_body' + examples: + list_file_members/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_file_members/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_38' + examples: + list_file_members/continue response: + value: + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + /sharing/list_folder_members/continue: + post: + tags: + - sharing + summary: list_folder_members/continue + description: |- + [list_folder_members/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members-continue) + + scope: `sharing.read` + + Once a cursor has been retrieved from `list_folder_members`, use this to paginate through all shared folder members. + operationId: listFolderMembersContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folder_members_continue_body' + examples: + list_folder_members/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_folder_members/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_40' + examples: + list_folder_members/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + invitees: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + users: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + /sharing/list_folders: + post: + tags: + - sharing + summary: list_folders + description: |- + [list_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders) + + scope: `sharing.read` + + Return the list of all shared folders the current user has access to. + operationId: listFolders + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_folders_body' + examples: + list_folders: + value: + actions: [] + limit: 100 + responses: + "200": + description: list_folders response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_41' + examples: + list_folders response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/list_folders/continue: + post: + tags: + - sharing + summary: list_folders/continue + description: |- + [list_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders-continue) + + scope: `sharing.read` + + Once a cursor has been retrieved from `list_folders`, use this to paginate through all shared folders. The cursor must come from a previous call to `list_folders` or `list_folders/continue`. + operationId: listFoldersContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_folders_continue_body' + examples: + list_folders/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_folders/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_41' + examples: + list_folders/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/list_mountable_folders: + post: + tags: + - sharing + summary: list_mountable_folders + description: |- + [list_mountable_folders](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders) + + scope: `sharing.read` + + Return the list of all shared folders the current user can mount or unmount. + operationId: listMountableFolders + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_mountable_folders_body' + examples: + list_mountable_folders: + value: + actions: [] + limit: 100 + responses: + "200": + description: list_mountable_folders response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_41' + examples: + list_mountable_folders response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/list_mountable_folders/continue: + post: + tags: + - sharing + summary: list_mountable_folders/continue + description: |- + [list_mountable_folders/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders-continue) + + scope: `sharing.read` + + Once a cursor has been retrieved from `list_mountable_folders`, use this to paginate through all mountable shared folders. The cursor must come from a previous call to `list_mountable_folders` or `list_mountable_folders/continue`. + operationId: listMountableFoldersContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_mountable_folders_continue_body' + examples: + list_mountable_folders/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_mountable_folders/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_41' + examples: + list_mountable_folders/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/list_received_files: + post: + tags: + - sharing + summary: list_received_files + description: |- + [list_received_files](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files) + + scope: `sharing.read` + + Returns a list of all files shared with current user. + Does not include files the user has received via shared folders, and does not include unclaimed invitations. + operationId: listReceivedFiles + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_received_files_body' + examples: + list_received_files: + value: + actions: [] + limit: 100 + responses: + "200": + description: list_received_files response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_42' + examples: + list_received_files response: + value: + cursor: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ + entries: + - access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + 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: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + /sharing/list_received_files/continue: + post: + tags: + - sharing + summary: list_received_files/continue + description: |- + [list_received_files/continue](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files-continue) + + scope: `sharing.read` + + Get more results with a cursor from `list_received_files`. + operationId: listReceivedFilesContinue + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_received_files_continue_body' + examples: + list_received_files/continue: + value: + cursor: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId + responses: + "200": + description: list_received_files/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_42' + examples: + list_received_files/continue response: + value: + cursor: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ + entries: + - access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + 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: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + /sharing/list_shared_links: + post: + tags: + - sharing + summary: list_shared_links + description: |- + [list_shared_links](https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_shared_links) + + scope: `sharing.read` + + List shared links of this user. + If no path is given, returns a list of all shared links for the current user. + If 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. + operationId: listSharedLinks + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_list_shared_links_body' + examples: + list_shared_links: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: list_shared_links response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_43' + examples: + list_shared_links response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + links: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + /sharing/modify_shared_link_settings: + post: + tags: + - sharing + summary: modify_shared_link_settings + description: |- + [modify_shared_link_settings](https://www.dropbox.com/developers/documentation/http/documentation#sharing-modify_shared_link_settings) + + scope: `sharing.write` + + Modify the shared link's settings. + If 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 `LinkPermissions.resolved_visibility` of the returned `SharedLinkMetadata` will reflect the actual visibility of the shared link and the `LinkPermissions.requested_visibility` will reflect the requested visibility. + operationId: modifySharedLinkSettings + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_modify_shared_link_settings_body' + examples: + modify_shared_link_settings: + value: + remove_expiration: false + settings: + access: viewer + audience: public + requested_visibility: public + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + responses: + "200": + description: modify_shared_link_settings response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_37' + examples: + modify_shared_link_settings response: + value: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + /sharing/mount_folder: + post: + tags: + - sharing + summary: mount_folder + description: |- + [mount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-mount_folder) + + scope: `sharing.write` + + The current user mounts the designated folder. + Mount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox. + operationId: mountFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_mount_folder_body' + examples: + mount_folder: + value: + shared_folder_id: "84528192421" + responses: + "200": + description: mount_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_36' + examples: + mount_folder response: + value: + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/relinquish_file_membership: + post: + tags: + - sharing + summary: relinquish_file_membership + description: |- + [relinquish_file_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_file_membership) + + scope: `sharing.write` + + 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. + operationId: relinquishFileMembership + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_relinquish_file_membership_body' + examples: + relinquish_file_membership: + value: + file: id:3kmLmQFnf1AAAAAAAAAAAw + responses: + "200": + description: "" + /sharing/relinquish_folder_membership: + post: + tags: + - sharing + summary: relinquish_folder_membership + description: |- + [relinquish_folder_membership](https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_folder_membership) + + scope: `sharing.write` + + 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. + This will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true. + operationId: relinquishFolderMembership + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_relinquish_folder_membership_body' + examples: + relinquish_folder_membership: + value: + leave_a_copy: false + shared_folder_id: "84528192421" + responses: + "200": + description: relinquish_folder_membership response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + relinquish_folder_membership response: + value: + ".tag": complete + /sharing/remove_file_member_2: + post: + tags: + - sharing + summary: remove_file_member_2 + description: |- + [remove_file_member_2](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_file_member_2) + + scope: `sharing.write` + + Removes a specified member from the file. + operationId: removeFileMember2 + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_remove_file_member_2_body' + examples: + remove_file_member_2: + value: + file: id:3kmLmQFnf1AAAAAAAAAAAw + member: + ".tag": email + email: justin@example.com + responses: + "200": + description: remove_file_member_2 response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_44' + examples: + remove_file_member_2 response: + value: + ".tag": other + /sharing/remove_folder_member: + post: + tags: + - sharing + summary: remove_folder_member + description: |- + [remove_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_folder_member) + + scope: `sharing.write` + + Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member. + operationId: removeFolderMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_remove_folder_member_body' + examples: + remove_folder_member: + value: + leave_a_copy: false + member: + ".tag": email + email: justin@example.com + shared_folder_id: "84528192421" + responses: + "200": + description: remove_folder_member response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_45' + examples: + remove_folder_member response: + value: + ".tag": async_job_id + async_job_id: 34g93hh34h04y384084 + /sharing/revoke_shared_link: + post: + tags: + - sharing + summary: revoke_shared_link + description: |- + [revoke_shared_link](https://www.dropbox.com/developers/documentation/http/documentation#sharing-revoke_shared_link) + + scope: `sharing.write` + + Revoke a shared link. + Note that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders. To list all shared links that enable access to a specific file, you can use the `list_shared_links` with the file as the `ListSharedLinksArg.path` argument. + operationId: revokeSharedLink + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_revoke_shared_link_body' + examples: + revoke_shared_link: + value: + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + responses: + "200": + description: "" + /sharing/set_access_inheritance: + post: + tags: + - sharing + summary: set_access_inheritance + description: |- + [set_access_inheritance](https://www.dropbox.com/developers/documentation/http/documentation#sharing-set_access_inheritance) + + scope: `sharing.write` + + Change the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root. + If a `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder. + operationId: setAccessInheritance + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_set_access_inheritance_body' + examples: + set_access_inheritance: + value: + access_inheritance: inherit + shared_folder_id: "84528192421" + responses: + "200": + description: set_access_inheritance response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_33' + examples: + set_access_inheritance response: + value: + ".tag": complete + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/share_folder: + post: + tags: + - sharing + summary: share_folder + description: |- + [share_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-share_folder) + + scope: `sharing.write` + + Share a folder with collaborators. + Most sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set `ShareFolderArg.force_async`. + If a `ShareFolderLaunch.async_job_id` is returned, you'll need to call `check_share_job_status` until the action completes to get the metadata for the folder. + operationId: shareFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_share_folder_body' + examples: + share_folder: + value: + access_inheritance: inherit + acl_update_policy: editors + force_async: false + member_policy: team + path: /example/workspace + shared_link_policy: members + responses: + "200": + description: share_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_33' + examples: + share_folder response: + value: + ".tag": complete + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /sharing/transfer_folder: + post: + tags: + - sharing + summary: transfer_folder + description: |- + [transfer_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-transfer_folder) + + scope: `sharing.write` + + Transfer ownership of a shared folder to a member of the shared folder. + User must have `AccessLevel.owner` access to the shared folder to perform a transfer. + operationId: transferFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_transfer_folder_body' + examples: + transfer_folder: + value: + shared_folder_id: "84528192421" + to_dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + responses: + "200": + description: "" + /sharing/unmount_folder: + post: + tags: + - sharing + summary: unmount_folder + description: |- + [unmount_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unmount_folder) + + scope: `sharing.write` + + The current user unmounts the designated folder. They can re-mount the folder at a later time using `mount_folder`. + operationId: unmountFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_unmount_folder_body' + examples: + unmount_folder: + value: + shared_folder_id: "84528192421" + responses: + "200": + description: "" + /sharing/unshare_file: + post: + tags: + - sharing + summary: unshare_file + description: |- + [unshare_file](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_file) + + scope: `sharing.write` + + Remove all members from this file. Does not remove inherited members. + operationId: unshareFile + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_unshare_file_body' + examples: + unshare_file: + value: + file: id:3kmLmQFnf1AAAAAAAAAAAw + responses: + "200": + description: "" + /sharing/unshare_folder: + post: + tags: + - sharing + summary: unshare_folder + description: |- + [unshare_folder](https://www.dropbox.com/developers/documentation/http/documentation#sharing-unshare_folder) + + scope: `sharing.write` + + Allows a shared folder owner to unshare the folder. + You'll need to call `check_job_status` to determine if the action has completed successfully. + operationId: unshareFolder + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_unshare_folder_body' + examples: + unshare_folder: + value: + leave_a_copy: false + shared_folder_id: "84528192421" + responses: + "200": + description: unshare_folder response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + unshare_folder response: + value: + ".tag": complete + /sharing/update_file_member: + post: + tags: + - sharing + summary: update_file_member + description: |- + [update_file_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_file_member) + + scope: `sharing.write` + + Changes a member's access on a shared file. + operationId: updateFileMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_update_file_member_body' + examples: + update_file_member: + value: + access_level: viewer + file: id:3kmLmQFnf1AAAAAAAAAAAw + member: + ".tag": email + email: justin@example.com + responses: + "200": + description: update_file_member response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: object + properties: {} + examples: + update_file_member response: + value: {} + /sharing/update_folder_member: + post: + tags: + - sharing + summary: update_folder_member + description: |- + [update_folder_member](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_member) + + scope: `sharing.write` + + Allows an owner or editor of a shared folder to update another member's permissions. + operationId: updateFolderMember + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_update_folder_member_body' + examples: + update_folder_member: + value: + access_level: editor + member: + ".tag": email + email: justin@example.com + shared_folder_id: "84528192421" + responses: + "200": + description: update_folder_member response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: object + properties: {} + examples: + update_folder_member response: + value: {} + /sharing/update_folder_policy: + post: + tags: + - sharing + summary: update_folder_policy + description: |- + [update_folder_policy](https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_policy) + + scope: `sharing.write` + + Update the sharing policies for a shared folder. + User must have `AccessLevel.owner` access to the shared folder to update its policies. + operationId: updateFolderPolicy + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sharing_update_folder_policy_body' + examples: + update_folder_policy: + value: + acl_update_policy: owner + member_policy: team + shared_folder_id: "84528192421" + shared_link_policy: members + responses: + "200": + description: update_folder_policy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_36' + examples: + update_folder_policy response: + value: + access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + /team/devices/list_member_devices: + post: + tags: + - team + - devices + summary: devices/list_member_devices + description: |- + [devices/list_member_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_member_devices) + + scope: `sessions.list` + + List all device sessions of a team's member. + operationId: devicesListMemberDevices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/devices_list_member_devices_body' + examples: + devices/list_member_devices: + value: + include_desktop_clients: true + include_mobile_clients: true + include_web_sessions: true + team_member_id: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + responses: + "200": + description: "" + /team/devices/list_members_devices: + post: + tags: + - team + - devices + summary: devices/list_members_devices + description: |- + [devices/list_members_devices](https://www.dropbox.com/developers/documentation/http/teams#team-devices-list_members_devices) + + scope: `sessions.list` + + List all device sessions of a team. + Permission : Team member file access. + operationId: devicesListMembersDevices + requestBody: + content: + text/plain: + examples: + devices/list_members_devices: + value: "" + responses: + "200": + description: "" + /team/devices/revoke_device_session: + post: + tags: + - team + - devices + summary: devices/revoke_device_session + description: |- + [devices/revoke_device_session](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session) + + scope: `sessions.modify` + + Revoke a device session of a team's member. + operationId: devicesRevokeDeviceSession + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/devices_revoke_device_session_body' + examples: + devices/revoke_device_session: + value: + ".tag": web_session + session_id: 1234faaf0678bcde + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + responses: + "200": + description: "" + /team/devices/revoke_device_session_batch: + post: + tags: + - team + - devices + summary: devices/revoke_device_session_batch + description: |- + [devices/revoke_device_session_batch](https://www.dropbox.com/developers/documentation/http/teams#team-devices-revoke_device_session_batch) + + scope: `sessions.modify` + + Revoke a list of device sessions of team members. + operationId: devicesRevokeDeviceSessionBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/devices_revoke_device_session_batch_body' + examples: + devices/revoke_device_session_batch: + value: + revoke_devices: + - ".tag": web_session + session_id: 1234faaf0678bcde + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + responses: + "200": + description: "" + /team/groups/create: + post: + tags: + - team + - groups + summary: groups/create + description: |- + [groups/create](https://www.dropbox.com/developers/documentation/http/teams#team-groups-create) + + scope: `groups.write` + + Creates a new, empty group, with a requested name. + Permission : Team member management. + operationId: groupsCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_create_body' + examples: + groups/create: + value: + add_creator_as_owner: false + group_external_id: group-134 + group_name: Europe sales + responses: + "200": + description: groups/create response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_46' + examples: + groups/create response: + value: + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/delete: + post: + tags: + - team + - groups + summary: groups/delete + description: |- + [groups/delete](https://www.dropbox.com/developers/documentation/http/teams#team-groups-delete) + + scope: `groups.write` + + Deletes a group. + The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed. + Permission : Team member management. + operationId: groupsDelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_delete_body' + examples: + groups/delete: + value: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + responses: + "200": + description: groups/delete response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + groups/delete response: + value: + ".tag": complete + /team/groups/get_info: + post: + tags: + - team + - groups + summary: groups/get_info + description: |- + [groups/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-groups-get_info) + + scope: `groups.read` + + Retrieves information about one or more groups. Note that the optional field `GroupFullInfo.members` is not returned for system-managed groups. + Permission : Team Information. + operationId: groupsGetInfo + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_get_info_body' + examples: + groups/get_info: + value: + ".tag": group_ids + group_ids: + - g:e2db7665347abcd600000000001a2b3c + - g:111111147abcd6000000000222222c + responses: + "200": + description: groups/get_info response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": group_info + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/inline_response_200_47' + examples: + groups/get_info response: + value: + - ".tag": group_info + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/job_status/get: + post: + tags: + - team + - groups + summary: groups/job_status/get + description: |- + [groups/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-groups-job_status-get) + + scope: `groups.write` + + Once an async_job_id is returned from `groups/delete`, `groups/members/add` , or `groups/members/remove` use this method to poll the status of granting/revoking group members' access to group-owned resources. + Permission : Team member management. + operationId: groupsJobStatusGet + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/job_status_get_body' + examples: + groups/job_status/get: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: groups/job_status/get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + groups/job_status/get response: + value: + ".tag": complete + /team/groups/list: + post: + tags: + - team + - groups + summary: groups/list + description: |- + [groups/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list) + + scope: `groups.read` + + Lists groups on a team. + Permission : Team Information. + operationId: groupsList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_list_body' + examples: + groups/list: + value: + limit: 100 + responses: + "200": + description: groups/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_48' + examples: + groups/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + - group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + member_count: 10 + has_more: false + /team/groups/list/continue: + post: + tags: + - team + - groups + summary: groups/list/continue + description: |- + [groups/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-list-continue) + + scope: `groups.read` + + Once a cursor has been retrieved from `groups/list`, use this to paginate through all groups. + Permission : Team Information. + operationId: groupsListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_1' + examples: + groups/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: groups/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_48' + examples: + groups/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + - group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + member_count: 10 + has_more: false + /team/groups/members/add: + post: + tags: + - team + - groups + summary: groups/members/add + description: |- + [groups/members/add](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-add) + + scope: `groups.write` + + Adds members to a group. + The members are added immediately. However the granting of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed. + Permission : Team member management. + operationId: groupsMembersAdd + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_add_body' + examples: + groups/members/add: + value: + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + members: + - access_type: member + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + return_members: true + responses: + "200": + description: groups/members/add response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_49' + examples: + groups/members/add response: + value: + async_job_id: "99988877733388" + group_info: + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/members/list: + post: + tags: + - team + - groups + summary: groups/members/list + description: |- + [groups/members/list](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list) + + scope: `groups.read` + + Lists members of a group. + Permission : Team Information. + operationId: groupsMembersList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_list_body' + examples: + groups/members/list: + value: + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + limit: 100 + responses: + "200": + description: groups/members/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_50' + examples: + groups/members/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + members: [] + /team/groups/members/list/continue: + post: + tags: + - team + - groups + summary: groups/members/list/continue + description: |- + [groups/members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-list-continue) + + scope: `groups.read` + + Once a cursor has been retrieved from `groups/members/list`, use this to paginate through all members of the group. + Permission : Team information. + operationId: groupsMembersListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_2' + examples: + groups/members/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: groups/members/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_50' + examples: + groups/members/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + members: [] + /team/groups/members/remove: + post: + tags: + - team + - groups + summary: groups/members/remove + description: |- + [groups/members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-remove) + + scope: `groups.write` + + Removes members from a group. + The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the `groups/job_status/get` to determine whether this process has completed. + This method permits removing the only owner of a group, even in cases where this is not possible via the web client. + Permission : Team member management. + operationId: groupsMembersRemove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_remove_body' + examples: + groups/members/remove: + value: + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + return_members: true + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: groups/members/remove response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_49' + examples: + groups/members/remove response: + value: + async_job_id: "99988877733388" + group_info: + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/members/set_access_type: + post: + tags: + - team + - groups + summary: groups/members/set_access_type + description: |- + [groups/members/set_access_type](https://www.dropbox.com/developers/documentation/http/teams#team-groups-members-set_access_type) + + scope: `groups.write` + + Sets a member's access type in a group. + Permission : Team member management. + operationId: groupsMembersSetAccessType + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_set_access_type_body' + examples: + groups/members/set_access_type: + value: + access_type: member + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + return_members: true + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: groups/members/set_access_type response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": group_info + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/inline_response_200_47' + examples: + groups/members/set_access_type response: + value: + - ".tag": group_info + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/groups/update: + post: + tags: + - team + - groups + summary: groups/update + description: |- + [groups/update](https://www.dropbox.com/developers/documentation/http/teams#team-groups-update) + + scope: `groups.write` + + Updates a group's name and/or external ID. + Permission : Team member management. + operationId: groupsUpdate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/groups_update_body' + examples: + groups/update: + value: + group: + ".tag": group_id + group_id: g:e2db7665347abcd600000000001a2b3c + new_group_external_id: sales-234 + new_group_management_type: company_managed + new_group_name: Europe west sales + return_members: true + responses: + "200": + description: groups/update response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_46' + examples: + groups/update response: + value: + created: 1447255518000 + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: project launch + member_count: 5 + members: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + /team/legal_holds/create_policy: + post: + tags: + - team + - legal_holds + summary: legal_holds/create_policy + description: |- + [legal_holds/create_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-create_policy) + + scope: `team_data.member` + + Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsCreatePolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_create_policy_body' + examples: + legal_holds/create_policy: + value: + end_date: 2017-12-31T00:00:00Z + members: + - dbmid:FDFSVF-DFSDF + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + responses: + "200": + description: legal_holds/create_policy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_51' + examples: + legal_holds/create_policy response: + value: + activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + /team/legal_holds/get_policy: + post: + tags: + - team + - legal_holds + summary: legal_holds/get_policy + description: |- + [legal_holds/get_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-get_policy) + + scope: `team_data.member` + + Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsGetPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_get_policy_body' + examples: + legal_holds/get_policy: + value: + id: pid_dbhid:abcd1234 + responses: + "200": + description: legal_holds/get_policy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_51' + examples: + legal_holds/get_policy response: + value: + activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + /team/legal_holds/list_held_revisions: + post: + tags: + - team + - legal_holds + summary: legal_holds/list_held_revisions + description: |- + [legal_holds/list_held_revisions](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions) + + scope: `team_data.member` + + List the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsListHeldRevisions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_list_held_revisions_body' + examples: + legal_holds/list_held_revisions: + value: + id: pid_dbhid:abcd1234 + responses: + "200": + description: legal_holds/list_held_revisions response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_52' + examples: + legal_holds/list_held_revisions response: + value: + entries: + - author_email: a@a.com + author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + ".tag": active + content_hash: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + file_type: Document + new_filename: 111_222.pdf + original_file_path: /a.pdf + original_revision_id: ab2rij4i5ojgfd + server_modified: 2019-08-12T12:08:52Z + size: 3 + has_more: false + /team/legal_holds/list_held_revisions_continue: + post: + tags: + - team + - legal_holds + summary: legal_holds/list_held_revisions_continue + description: |- + [legal_holds/list_held_revisions_continue](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_held_revisions_continue) + + scope: `team_data.member` + + Continue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsListHeldRevisionsContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_list_held_revisions_continue_body' + examples: + legal_holds/list_held_revisions_continue: + value: + id: pid_dbhid:abcd1234 + responses: + "200": + description: legal_holds/list_held_revisions_continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_52' + examples: + legal_holds/list_held_revisions_continue response: + value: + entries: + - author_email: a@a.com + author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + ".tag": active + content_hash: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + file_type: Document + new_filename: 111_222.pdf + original_file_path: /a.pdf + original_revision_id: ab2rij4i5ojgfd + server_modified: 2019-08-12T12:08:52Z + size: 3 + has_more: false + /team/legal_holds/list_policies: + post: + tags: + - team + - legal_holds + summary: legal_holds/list_policies + description: |- + [legal_holds/list_policies](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-list_policies) + + scope: `team_data.member` + + Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsListPolicies + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_list_policies_body' + examples: + legal_holds/list_policies: + value: + include_released: false + responses: + "200": + description: legal_holds/list_policies response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_53' + examples: + legal_holds/list_policies response: + value: + policies: + - activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + /team/legal_holds/release_policy: + post: + tags: + - team + - legal_holds + summary: legal_holds/release_policy + description: |- + [legal_holds/release_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-release_policy) + + scope: `team_data.member` + + Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsReleasePolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_release_policy_body' + examples: + legal_holds/release_policy: + value: + id: pid_dbhid:abcd1234 + responses: + "200": + description: "" + /team/legal_holds/update_policy: + post: + tags: + - team + - legal_holds + summary: legal_holds/update_policy + description: |- + [legal_holds/update_policy](https://www.dropbox.com/developers/documentation/http/teams#team-legal_holds-update_policy) + + scope: `team_data.member` + + Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. + Permission : Team member file access. + operationId: legalHoldsUpdatePolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/legal_holds_update_policy_body' + examples: + legal_holds/update_policy: + value: + id: pid_dbhid:abcd1234 + members: + - dbmid:FDFSVF-DFSDF + responses: + "200": + description: legal_holds/update_policy response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_51' + examples: + legal_holds/update_policy response: + value: + activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + /team/linked_apps/list_member_linked_apps: + post: + tags: + - team + - linked_apps + summary: linked_apps/list_member_linked_apps + description: |- + [linked_apps/list_member_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_member_linked_apps) + + scope: `sessions.list` + + List all linked applications of the team member. + Note, this endpoint does not list any team-linked applications. + operationId: linkedAppsListMemberLinkedApps + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/linked_apps_list_member_linked_apps_body' + examples: + linked_apps/list_member_linked_apps: + value: + team_member_id: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + responses: + "200": + description: "" + /team/linked_apps/list_members_linked_apps: + post: + tags: + - team + - linked_apps + summary: linked_apps/list_members_linked_apps + description: |- + [linked_apps/list_members_linked_apps](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-list_members_linked_apps) + + scope: `sessions.list` + + List all applications linked to the team members' accounts. + Note, this endpoint does not list any team-linked applications. + operationId: linkedAppsListMembersLinkedApps + requestBody: + content: + text/plain: + examples: + linked_apps/list_members_linked_apps: + value: "" + responses: + "200": + description: "" + /team/linked_apps/revoke_linked_app: + post: + tags: + - team + - linked_apps + summary: linked_apps/revoke_linked_app + description: |- + [linked_apps/revoke_linked_app](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app) + + scope: `sessions.modify` + + Revoke a linked application of the team member. + operationId: linkedAppsRevokeLinkedApp + requestBody: + content: + text/plain: + examples: + linked_apps/revoke_linked_app: + value: "" + responses: + "200": + description: "" + /team/linked_apps/revoke_linked_app_batch: + post: + tags: + - team + - linked_apps + summary: linked_apps/revoke_linked_app_batch + description: |- + [linked_apps/revoke_linked_app_batch](https://www.dropbox.com/developers/documentation/http/teams#team-linked_apps-revoke_linked_app_batch) + + scope: `sessions.modify` + + Revoke a list of linked applications of the team members. + operationId: linkedAppsRevokeLinkedAppBatch + requestBody: + content: + text/plain: + examples: + linked_apps/revoke_linked_app_batch: + value: "" + responses: + "200": + description: "" + /team/member_space_limits/excluded_users/add: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/excluded_users/add + description: |- + [member_space_limits/excluded_users/add](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-add) + + scope: `members.write` + + Add users to member space limits excluded users list. + operationId: memberSpaceLimitsExcludedUsersAdd + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/excluded_users_add_body' + examples: + member_space_limits/excluded_users/add: + value: + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/excluded_users/add response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_54' + examples: + member_space_limits/excluded_users/add response: + value: + status: + ".tag": success + /team/member_space_limits/excluded_users/list: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/excluded_users/list + description: |- + [member_space_limits/excluded_users/list](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list) + + scope: `members.read` + + List member space limits excluded users. + operationId: memberSpaceLimitsExcludedUsersList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/excluded_users_list_body' + examples: + member_space_limits/excluded_users/list: + value: + limit: 100 + responses: + "200": + description: member_space_limits/excluded_users/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_55' + examples: + member_space_limits/excluded_users/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + users: [] + /team/member_space_limits/excluded_users/list/continue: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/excluded_users/list/continue + description: |- + [member_space_limits/excluded_users/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-list-continue) + + scope: `members.read` + + Continue listing member space limits excluded users. + operationId: memberSpaceLimitsExcludedUsersListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_3' + examples: + member_space_limits/excluded_users/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: member_space_limits/excluded_users/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_55' + examples: + member_space_limits/excluded_users/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + users: [] + /team/member_space_limits/excluded_users/remove: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/excluded_users/remove + description: |- + [member_space_limits/excluded_users/remove](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-excluded_users-remove) + + scope: `members.write` + + Remove users from member space limits excluded users list. + operationId: memberSpaceLimitsExcludedUsersRemove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/excluded_users_remove_body' + examples: + member_space_limits/excluded_users/remove: + value: + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/excluded_users/remove response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_54' + examples: + member_space_limits/excluded_users/remove response: + value: + status: + ".tag": success + /team/member_space_limits/get_custom_quota: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/get_custom_quota + description: |- + [member_space_limits/get_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-get_custom_quota) + + scope: `members.read` + + Get users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call. + operationId: memberSpaceLimitsGetCustomQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/member_space_limits_get_custom_quota_body' + examples: + member_space_limits/get_custom_quota: + value: + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/get_custom_quota response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": other + items: + $ref: '#/components/schemas/inline_response_200_44' + examples: + member_space_limits/get_custom_quota response: + value: + - ".tag": other + /team/member_space_limits/remove_custom_quota: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/remove_custom_quota + description: |- + [member_space_limits/remove_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-remove_custom_quota) + + scope: `members.write` + + Remove users custom quota. A maximum of 1000 members can be specified in a single call. + operationId: memberSpaceLimitsRemoveCustomQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/member_space_limits_remove_custom_quota_body' + examples: + member_space_limits/remove_custom_quota: + value: + users: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/remove_custom_quota response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": other + items: + $ref: '#/components/schemas/inline_response_200_44' + examples: + member_space_limits/remove_custom_quota response: + value: + - ".tag": other + /team/member_space_limits/set_custom_quota: + post: + tags: + - team + - member_space_limits + summary: member_space_limits/set_custom_quota + description: |- + [member_space_limits/set_custom_quota](https://www.dropbox.com/developers/documentation/http/teams#team-member_space_limits-set_custom_quota) + + scope: `members.read` + + Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call. + operationId: memberSpaceLimitsSetCustomQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/member_space_limits_set_custom_quota_body' + examples: + member_space_limits/set_custom_quota: + value: + users_and_quotas: + - quota_gb: 30 + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: member_space_limits/set_custom_quota response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": other + items: + $ref: '#/components/schemas/inline_response_200_44' + examples: + member_space_limits/set_custom_quota response: + value: + - ".tag": other + /team/members/add: + post: + tags: + - team + - members + summary: members/add + description: |- + [members/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-add) + + scope: `members.write` + + Adds members to a team. + Permission : Team member management + A maximum of 20 members can be specified in a single call. + If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. + If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. + Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'. + operationId: membersAdd + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_add_body_1' + examples: + members/add: + value: + force_async: false + new_members: + - member_email: tom.s@company.com + member_external_id: company_id:342432 + member_given_name: Tom + member_surname: Silverstone + role: member_only + send_welcome_email: true + responses: + "200": + description: members/add response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_56' + examples: + members/add response: + value: + ".tag": complete + complete: + - ".tag": success + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/add/job_status/get: + post: + tags: + - team + - members + summary: members/add/job_status/get + description: |- + [members/add/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-add-job_status-get) + + scope: `members.write` + + Once an async_job_id is returned from `members/add` , use this to poll the status of the asynchronous request. + Permission : Team member management. + operationId: membersAddJobStatusGet + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/job_status_get_body_1' + examples: + members/add/job_status/get: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: members/add/job_status/get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_56' + examples: + members/add/job_status/get response: + value: + ".tag": complete + complete: + - ".tag": success + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/delete_profile_photo: + post: + tags: + - team + - members + summary: members/delete_profile_photo + description: |- + [members/delete_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-delete_profile_photo) + + scope: `members.write` + + Deletes a team member's profile photo. + Permission : Team member management. + operationId: membersDeleteProfilePhoto + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_delete_profile_photo_body' + examples: + members/delete_profile_photo: + value: + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/delete_profile_photo response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_57' + examples: + members/delete_profile_photo response: + value: + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/get_info: + post: + tags: + - team + - members + summary: members/get_info + description: |- + [members/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-members-get_info) + + scope: `members.read` + + Returns information about multiple team members. + Permission : Team information + This endpoint will return `MembersGetInfoItem.id_not_found`, for IDs (or emails) that cannot be matched to a valid team member. + operationId: membersGetInfo + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_get_info_body' + examples: + members/get_info: + value: + members: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/get_info response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - ".tag": member_info + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + items: + $ref: '#/components/schemas/inline_response_200_58' + examples: + members/get_info response: + value: + - ".tag": member_info + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/list: + post: + tags: + - team + - members + summary: members/list + description: |- + [members/list](https://www.dropbox.com/developers/documentation/http/teams#team-members-list) + + scope: `members.read` + + Lists members of a team. + Permission : Team information. + operationId: membersList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_list_body_1' + examples: + members/list: + value: + include_removed: false + limit: 100 + responses: + "200": + description: members/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_59' + examples: + members/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + members: + - profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/list/continue: + post: + tags: + - team + - members + summary: members/list/continue + description: |- + [members/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-members-list-continue) + + scope: `members.read` + + Once a cursor has been retrieved from `members/list`, use this to paginate through all team members. + Permission : Team information. + operationId: membersListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_4' + examples: + members/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: members/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_59' + examples: + members/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: true + members: + - profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/move_former_member_files: + post: + tags: + - team + - members + summary: members/move_former_member_files + description: |- + [members/move_former_member_files](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files) + + scope: `members.write` + + Moves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/move_former_member_files/job_status/check`. + Permission : Team member management. + operationId: membersMoveFormerMemberFiles + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_move_former_member_files_body' + examples: + members/move_former_member_files: + value: + transfer_admin_id: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + transfer_dest_id: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/move_former_member_files response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + members/move_former_member_files response: + value: + ".tag": complete + /team/members/move_former_member_files/job_status/check: + post: + tags: + - team + - members + summary: members/move_former_member_files/job_status/check + description: |- + [members/move_former_member_files/job_status/check](https://www.dropbox.com/developers/documentation/http/teams#team-members-move_former_member_files-job_status-check) + + scope: `members.write` + + Once an async_job_id is returned from `members/move_former_member_files` , use this to poll the status of the asynchronous request. + Permission : Team member management. + operationId: membersMoveFormerMemberFilesJobStatusCheck + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/job_status_check_body' + examples: + members/move_former_member_files/job_status/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: members/move_former_member_files/job_status/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + members/move_former_member_files/job_status/check response: + value: + ".tag": complete + /team/members/recover: + post: + tags: + - team + - members + summary: members/recover + description: |- + [members/recover](https://www.dropbox.com/developers/documentation/http/teams#team-members-recover) + + scope: `members.delete` + + Recover a deleted member. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + operationId: membersRecover + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_recover_body' + examples: + members/recover: + value: + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: "" + /team/members/remove: + post: + tags: + - team + - members + summary: members/remove + description: |- + [members/remove](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove) + + scope: `members.delete` + + Removes a member from a team. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + Accounts can be recovered via `members/recover` for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling `members/add` while a user is still recoverable on your team will return with `MemberAddResult.user_already_on_team`. + Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams). + This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll `members/remove/job_status/get`. + operationId: membersRemove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_remove_body_1' + examples: + members/remove: + value: + keep_account: false + retain_team_shares: false + transfer_admin_id: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + transfer_dest_id: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + wipe_data: true + responses: + "200": + description: members/remove response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + members/remove response: + value: + ".tag": complete + /team/members/remove/job_status/get: + post: + tags: + - team + - members + summary: members/remove/job_status/get + description: |- + [members/remove/job_status/get](https://www.dropbox.com/developers/documentation/http/teams#team-members-remove-job_status-get) + + scope: `members.delete` + + Once an async_job_id is returned from `members/remove` , use this to poll the status of the asynchronous request. + Permission : Team member management. + operationId: membersRemoveJobStatusGet + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/job_status_get_body_2' + examples: + members/remove/job_status/get: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: members/remove/job_status/get response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_32' + examples: + members/remove/job_status/get response: + value: + ".tag": complete + /team/members/secondary_emails/add: + post: + tags: + - team + - members + summary: members/secondary_emails/add + description: |- + [members/secondary_emails/add](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-add) + + scope: `members.write` + + Add secondary emails to users. + Permission : Team member management. + Emails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent. + operationId: membersSecondaryEmailsAdd + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondary_emails_add_body' + examples: + members/secondary_emails/add: + value: + new_secondary_emails: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/secondary_emails/add response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_60' + examples: + members/secondary_emails/add response: + value: + results: + - ".tag": success + results: + - ".tag": success + success: + email: apple@orange.com + is_verified: true + - ".tag": unavailable + unavailable: alice@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + - ".tag": invalid_user + invalid_user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + /team/members/secondary_emails/delete: + post: + tags: + - team + - members + summary: members/secondary_emails/delete + description: |- + [members/secondary_emails/delete](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-delete) + + scope: `members.write` + + Delete secondary emails from users + Permission : Team member management. + Users will be notified of deletions of verified secondary emails at both the secondary email and their primary email. + operationId: membersSecondaryEmailsDelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondary_emails_delete_body' + examples: + members/secondary_emails/delete: + value: + emails_to_delete: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/secondary_emails/delete response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_61' + examples: + members/secondary_emails/delete response: + value: + results: + - ".tag": success + results: + - ".tag": success + success: alice@example.com + - ".tag": not_found + not_found: alic@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + /team/members/secondary_emails/resend_verification_emails: + post: + tags: + - team + - members + summary: members/secondary_emails/resend_verification_emails + description: |- + [members/secondary_emails/resend_verification_emails](https://www.dropbox.com/developers/documentation/http/teams#team-members-secondary_emails-resend_verification_emails) + + scope: `members.write` + + Resend secondary email verification emails. + Permission : Team member management. + operationId: membersSecondaryEmailsResendVerificationEmails + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondary_emails_resend_verification_emails_body' + examples: + members/secondary_emails/resend_verification_emails: + value: + emails_to_resend: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/secondary_emails/resend_verification_emails response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_62' + examples: + members/secondary_emails/resend_verification_emails response: + value: + results: + - ".tag": success + results: + - ".tag": success + success: alice@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + /team/members/send_welcome_email: + post: + tags: + - team + - members + summary: members/send_welcome_email + description: |- + [members/send_welcome_email](https://www.dropbox.com/developers/documentation/http/teams#team-members-send_welcome_email) + + scope: `members.write` + + Sends welcome email to pending team member. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + No-op if team member is not pending. + operationId: membersSendWelcomeEmail + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_send_welcome_email_body' + examples: + members/send_welcome_email: + value: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: "" + /team/members/set_admin_permissions: + post: + tags: + - team + - members + summary: members/set_admin_permissions + description: |- + [members/set_admin_permissions](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_admin_permissions) + + scope: `members.write` + + Updates a team member's permissions. + Permission : Team member management. + operationId: membersSetAdminPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_set_admin_permissions_body' + examples: + members/set_admin_permissions: + value: + new_role: member_only + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/set_admin_permissions response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_63' + examples: + members/set_admin_permissions response: + value: + role: + ".tag": member_only + team_member_id: dbmid:9978889 + /team/members/set_profile: + post: + tags: + - team + - members + summary: members/set_profile + description: |- + [members/set_profile](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile) + + scope: `members.write` + + Updates a team member's profile. + Permission : Team member management. + operationId: membersSetProfile + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_set_profile_body' + examples: + members/set_profile: + value: + new_email: t.smith@domain.com + new_surname: Smith + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/set_profile response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_57' + examples: + members/set_profile response: + value: + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/set_profile_photo: + post: + tags: + - team + - members + summary: members/set_profile_photo + description: |- + [members/set_profile_photo](https://www.dropbox.com/developers/documentation/http/teams#team-members-set_profile_photo) + + scope: `members.write` + + Updates a team member's profile photo. + Permission : Team member management. + operationId: membersSetProfilePhoto + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_set_profile_photo_body' + examples: + members/set_profile_photo: + value: + photo: + ".tag": base64_data + base64_data: SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: members/set_profile_photo response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_57' + examples: + members/set_profile_photo response: + value: + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + /team/members/suspend: + post: + tags: + - team + - members + summary: members/suspend + description: |- + [members/suspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-suspend) + + scope: `members.write` + + Suspend a member from a team. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + operationId: membersSuspend + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_suspend_body' + examples: + members/suspend: + value: + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + wipe_data: false + responses: + "200": + description: "" + /team/members/unsuspend: + post: + tags: + - team + - members + summary: members/unsuspend + description: |- + [members/unsuspend](https://www.dropbox.com/developers/documentation/http/teams#team-members-unsuspend) + + scope: `members.write` + + Unsuspend a member from a team. + Permission : Team member management + Exactly one of team_member_id, email, or external_id must be provided to identify the user account. + operationId: membersUnsuspend + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/members_unsuspend_body' + examples: + members/unsuspend: + value: + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + responses: + "200": + description: "" + /team/namespaces/list: + post: + tags: + - team + - namespaces + summary: namespaces/list + description: |- + [namespaces/list](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list) + + scope: `team_data.member` + + Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list. + operationId: namespacesList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/namespaces_list_body' + examples: + namespaces/list: + value: + limit: 1 + responses: + "200": + description: namespaces/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_64' + examples: + namespaces/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + namespaces: + - name: Marketing + namespace_id: "123456789" + namespace_type: + ".tag": shared_folder + - name: Franz Ferdinand + namespace_id: "123456789" + namespace_type: + ".tag": team_member_folder + team_member_id: dbmid:1234567 + /team/namespaces/list/continue: + post: + tags: + - team + - namespaces + summary: namespaces/list/continue + description: |- + [namespaces/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-namespaces-list-continue) + + scope: `team_data.member` + + Once a cursor has been retrieved from `namespaces/list`, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list. + operationId: namespacesListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_5' + examples: + namespaces/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: namespaces/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_64' + examples: + namespaces/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + namespaces: + - name: Marketing + namespace_id: "123456789" + namespace_type: + ".tag": shared_folder + - name: Franz Ferdinand + namespace_id: "123456789" + namespace_type: + ".tag": team_member_folder + team_member_id: dbmid:1234567 + /team/reports/get_activity: + post: + tags: + - team + - reports + summary: reports/get_activity + description: |- + [reports/get_activity](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_activity) + + scope: `team_info.read` + + Retrieves reporting data about a team's user activity. + operationId: reportsGetActivity + requestBody: + content: + text/plain: + examples: + reports/get_activity: + value: "" + responses: + "200": + description: "" + /team/reports/get_devices: + post: + tags: + - team + - reports + summary: reports/get_devices + description: |- + [reports/get_devices](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_devices) + + scope: `team_info.read` + + Retrieves reporting data about a team's linked devices. + operationId: reportsGetDevices + requestBody: + content: + text/plain: + examples: + reports/get_devices: + value: "" + responses: + "200": + description: "" + /team/reports/get_membership: + post: + tags: + - team + - reports + summary: reports/get_membership + description: |- + [reports/get_membership](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_membership) + + scope: `team_info.read` + + Retrieves reporting data about a team's membership. + operationId: reportsGetMembership + requestBody: + content: + text/plain: + examples: + reports/get_membership: + value: "" + responses: + "200": + description: "" + /team/reports/get_storage: + post: + tags: + - team + - reports + summary: reports/get_storage + description: |- + [reports/get_storage](https://www.dropbox.com/developers/documentation/http/teams#team-reports-get_storage) + + scope: `team_info.read` + + Retrieves reporting data about a team's storage usage. + operationId: reportsGetStorage + requestBody: + content: + text/plain: + examples: + reports/get_storage: + value: "" + responses: + "200": + description: "" + /team/team_folder/activate: + post: + tags: + - team + - team_folder + summary: team_folder/activate + description: |- + [team_folder/activate](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-activate) + + scope: `team_data.team_space` + + Sets an archived team folder's status to active. + Permission : Team member file access. + operationId: teamFolderActivate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_activate_body' + examples: + team_folder/activate: + value: + team_folder_id: "123456789" + responses: + "200": + description: team_folder/activate response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_65' + examples: + team_folder/activate response: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/archive: + post: + tags: + - team + - team_folder + summary: team_folder/archive + description: |- + [team_folder/archive](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive) + + scope: `team_data.team_space` + + Sets an active team folder's status to archived and removes all folder and file members. + Permission : Team member file access. + operationId: teamFolderArchive + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_archive_body' + examples: + team_folder/archive: + value: + force_async_off: false + team_folder_id: "123456789" + responses: + "200": + description: team_folder/archive response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_66' + examples: + team_folder/archive response: + value: + ".tag": complete + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/archive/check: + post: + tags: + - team + - team_folder + summary: team_folder/archive/check + description: |- + [team_folder/archive/check](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-archive-check) + + scope: `team_data.team_space` + + Returns the status of an asynchronous job for archiving a team folder. + Permission : Team member file access. + operationId: teamFolderArchiveCheck + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/archive_check_body' + examples: + team_folder/archive/check: + value: + async_job_id: 34g93hh34h04y384084 + responses: + "200": + description: team_folder/archive/check response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_66' + examples: + team_folder/archive/check response: + value: + ".tag": complete + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/create: + post: + tags: + - team + - team_folder + summary: team_folder/create + description: |- + [team_folder/create](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-create) + + scope: `team_data.team_space` + + Creates a new, active, team folder with no members. + Permission : Team member file access. + operationId: teamFolderCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_create_body' + examples: + team_folder/create: + value: + name: Marketing + sync_setting: not_synced + responses: + "200": + description: team_folder/create response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_65' + examples: + team_folder/create response: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/get_info: + post: + tags: + - team + - team_folder + summary: team_folder/get_info + description: |- + [team_folder/get_info](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-get_info) + + scope: `team_data.team_space` + + Retrieves metadata for team folders. + Permission : Team member file access. + operationId: teamFolderGetInfo + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_get_info_body' + examples: + team_folder/get_info: + value: + team_folder_ids: + - "947182" + - "5819424" + - "852307532" + responses: + "200": + description: "" + /team/team_folder/list: + post: + tags: + - team + - team_folder + summary: team_folder/list + description: |- + [team_folder/list](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list) + + scope: `team_data.team_space` + + Lists all team folders. + Permission : Team member file access. + operationId: teamFolderList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_list_body' + examples: + team_folder/list: + value: + limit: 100 + responses: + "200": + description: team_folder/list response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_67' + examples: + team_folder/list response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + team_folders: + - content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/list/continue: + post: + tags: + - team + - team_folder + summary: team_folder/list/continue + description: |- + [team_folder/list/continue](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-list-continue) + + scope: `team_data.team_space` + + Once a cursor has been retrieved from `team_folder/list`, use this to paginate through all team folders. + Permission : Team member file access. + operationId: teamFolderListContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/list_continue_body_6' + examples: + team_folder/list/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: team_folder/list/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_67' + examples: + team_folder/list/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: false + team_folders: + - content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/permanently_delete: + post: + tags: + - team + - team_folder + summary: team_folder/permanently_delete + description: |- + [team_folder/permanently_delete](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-permanently_delete) + + scope: `team_data.team_space` + + Permanently deletes an archived team folder. + Permission : Team member file access. + operationId: teamFolderPermanentlyDelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_permanently_delete_body' + examples: + team_folder/permanently_delete: + value: + team_folder_id: "123456789" + responses: + "200": + description: "" + /team/team_folder/rename: + post: + tags: + - team + - team_folder + summary: team_folder/rename + description: |- + [team_folder/rename](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-rename) + + scope: `team_data.team_space` + + Changes an active team folder's name. + Permission : Team member file access. + operationId: teamFolderRename + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_rename_body' + examples: + team_folder/rename: + value: + name: Sales + team_folder_id: "123456789" + responses: + "200": + description: team_folder/rename response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_65' + examples: + team_folder/rename response: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/team_folder/update_sync_settings: + post: + tags: + - team + - team_folder + summary: team_folder/update_sync_settings + description: |- + [team_folder/update_sync_settings](https://www.dropbox.com/developers/documentation/http/teams#team-team_folder-update_sync_settings) + + scope: `team_data.team_space` + + Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled. + operationId: teamFolderUpdateSyncSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_folder_update_sync_settings_body' + examples: + team_folder/update_sync_settings: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: not_synced + sync_setting: not_synced + team_folder_id: "123456789" + responses: + "200": + description: team_folder/update_sync_settings response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_65' + examples: + team_folder/update_sync_settings response: + value: + content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + /team/features/get_values: + post: + tags: + - team + summary: features/get_values + description: |- + [features/get_values](https://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) + + scope: `team_info.read` + + Get the values for one or more featues. This route allows you to check your account's capability for what feature you can access or what value you have for certain features. + Permission : Team information. + operationId: featuresGetValues + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/features_get_values_body' + examples: + features/get_values: + value: + features: + - ".tag": upload_api_rate_limit + - ".tag": has_team_shared_dropbox + responses: + "200": + description: features/get_values response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_68' + examples: + features/get_values response: + value: + values: + - ".tag": upload_api_rate_limit + upload_api_rate_limit: + ".tag": limit + limit: 25000 + - ".tag": has_team_shared_dropbox + has_team_shared_dropbox: + ".tag": has_team_shared_dropbox + has_team_shared_dropbox: false + /team/get_info: + post: + tags: + - team + summary: get_info + description: |- + [get_info](https://www.dropbox.com/developers/documentation/http/teams#team-get_info) + + scope: `team_info.read` + + Retrieves information about a team. + operationId: getInfo + responses: + "200": + description: get_info response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_69' + examples: + get_info response: + value: + name: Dropbox Inc. + num_licensed_users: 5 + num_provisioned_users: 2 + policies: + emm_state: + ".tag": disabled + office_addin: + ".tag": disabled + sharing: + shared_folder_join_policy: + ".tag": from_anyone + shared_folder_member_policy: + ".tag": team + shared_link_create_policy: + ".tag": team_only + team_id: dbtid:1234abcd + security: + - bearerAuth: [] + /team/token/get_authenticated_admin: + post: + tags: + - team + summary: token/get_authenticated_admin + description: |- + [token/get_authenticated_admin](https://www.dropbox.com/developers/documentation/http/teams#team-token-get_authenticated_admin) + + scope: `team_info.read` + + Returns the member profile of the admin who generated the team access token used to make the call. + operationId: tokenGetAuthenticatedAdmin + responses: + "200": + description: token/get_authenticated_admin response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_70' + examples: + token/get_authenticated_admin response: + value: + admin_profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + /team_log/get_events: + post: + tags: + - team_log + summary: get_events + description: |- + [get_events](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events) + + scope: `events.read` + + Retrieves team events. If the result's `GetTeamEventsResult.has_more` field is `true`, call `get_events/continue` with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll `get_events/continue` for new events. + Many attributes note 'may be missing due to historical data gap'. + Note that the file_operations category and & analogous paper events are not available on all Dropbox Business [plans](http://www.dropbox.com/business/plans-comparison). Use [features/get_values](http://www.dropbox.com/developers/documentation/http/teams#team-features-get_values) to check for this feature. + Permission : Team Auditing. + operationId: getEvents + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/team_log_get_events_body' + examples: + get_events: + value: + category: groups + limit: 50 + responses: + "200": + description: get_events response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_71' + examples: + get_events response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + events: + - actor: + ".tag": user + user: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + assets: + - ".tag": file + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + path: + contextual: /Contract Work/Draft + namespace_relative: + is_shared_namespace: false + ns_id: "1234" + relative_path: /Contract Work/Draft + context: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + details: + ".tag": shared_content_download_details + shared_content_access_level: + ".tag": viewer_no_comment + shared_content_link: abc + shared_content_owner: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + event_category: + ".tag": tfa + event_type: + ".tag": shared_content_download + description: (sharing) Downloaded shared file/folder + involve_non_team_member: true + origin: + access_method: + ".tag": end_user + end_user: + ".tag": web + session_id: dbwsid:123456789012345678901234567890123456789 + geo_location: + city: San Francisco + country: US + ip_address: 45.56.78.100 + region: California + participants: + - ".tag": user + user: + ".tag": team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + timestamp: 2017-01-25T15:51:30Z + has_more: false + security: + - bearerAuth: [] + /team_log/get_events/continue: + post: + tags: + - team_log + summary: get_events/continue + description: |- + [get_events/continue](https://www.dropbox.com/developers/documentation/http/teams#team_log-get_events-continue) + + scope: `events.read` + + Once a cursor has been retrieved from `get_events`, use this to paginate through all events. + Permission : Team Auditing. + operationId: getEventsContinue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/get_events_continue_body' + examples: + get_events/continue: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + responses: + "200": + description: get_events/continue response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_71' + examples: + get_events/continue response: + value: + cursor: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + events: + - actor: + ".tag": user + user: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + assets: + - ".tag": file + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + path: + contextual: /Contract Work/Draft + namespace_relative: + is_shared_namespace: false + ns_id: "1234" + relative_path: /Contract Work/Draft + context: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + details: + ".tag": shared_content_download_details + shared_content_access_level: + ".tag": viewer_no_comment + shared_content_link: abc + shared_content_owner: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + event_category: + ".tag": tfa + event_type: + ".tag": shared_content_download + description: (sharing) Downloaded shared file/folder + involve_non_team_member: true + origin: + access_method: + ".tag": end_user + end_user: + ".tag": web + session_id: dbwsid:123456789012345678901234567890123456789 + geo_location: + city: San Francisco + country: US + ip_address: 45.56.78.100 + region: California + participants: + - ".tag": user + user: + ".tag": team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + timestamp: 2017-01-25T15:51:30Z + has_more: false + security: + - bearerAuth: [] + /users/features/get_values: + post: + tags: + - users + summary: features/get_values + description: |- + [features/get_values](https://www.dropbox.com/developers/documentation/http/documentation#users-features-get_values) + + scope: `account_info.read` + + Get a list of feature values that may be configured for the current account. + operationId: featuresGetValues1 + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/features_get_values_body_1' + examples: + features/get_values: + value: + features: + - ".tag": paper_as_files + - ".tag": file_locking + responses: + "200": + description: features/get_values response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_72' + examples: + features/get_values response: + value: + values: + - ".tag": paper_as_files + paper_as_files: + ".tag": enabled + enabled: true + /users/get_account: + post: + tags: + - users + summary: get_account + description: |- + [get_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account) + + scope: `sharing.read` + + Get information about a user's account. + operationId: getAccount + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/users_get_account_body' + examples: + get_account: + value: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + responses: + "200": + description: get_account response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_73' + examples: + get_account response: + value: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: false + email: franz@dropbox.com + email_verified: true + is_teammate: false + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /users/get_account_batch: + post: + tags: + - users + summary: get_account_batch + description: |- + [get_account_batch](https://www.dropbox.com/developers/documentation/http/documentation#users-get_account_batch) + + scope: `sharing.read` + + Get information about multiple user accounts. At most 300 accounts may be queried per request. + operationId: getAccountBatch + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/users_get_account_batch_body' + examples: + get_account_batch: + value: + account_ids: + - dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + - dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ + responses: + "200": + description: get_account_batch response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + type: array + example: + - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: false + email: franz@dropbox.com + email_verified: true + is_teammate: false + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + items: + $ref: '#/components/schemas/inline_response_200_74' + examples: + get_account_batch response: + value: + - account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: false + email: franz@dropbox.com + email_verified: true + is_teammate: false + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + /users/get_current_account: + post: + tags: + - users + summary: get_current_account + description: |- + [get_current_account](https://www.dropbox.com/developers/documentation/http/documentation#users-get_current_account) + + scope: `account_info.read` + + Get information about the current user's account. + operationId: getCurrentAccount + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + - $ref: '#/components/parameters/DropboxApiSelectAdmin' + responses: + "200": + description: get_current_account response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_75' + examples: + get_current_account response: + value: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + account_type: + ".tag": business + country: US + disabled: false + email: franz@dropbox.com + email_verified: true + is_paired: true + locale: en + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + referral_link: https://db.tt/ZITNuhtI + root_info: + ".tag": user + home_namespace_id: "3235641" + root_namespace_id: "3235641" + team: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + office_addin_policy: + ".tag": disabled + sharing_policies: + shared_folder_join_policy: + ".tag": from_anyone + shared_folder_member_policy: + ".tag": team + shared_link_create_policy: + ".tag": team_only + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + /users/get_space_usage: + post: + tags: + - users + summary: get_space_usage + description: |- + [get_space_usage](https://www.dropbox.com/developers/documentation/http/documentation#users-get_space_usage) + + scope: `account_info.read` + + Get the space usage information for the current user's account. + operationId: getSpaceUsage + parameters: + - $ref: '#/components/parameters/DropboxApiPathRoot' + - $ref: '#/components/parameters/DropboxApiSelectUser' + responses: + "200": + description: get_space_usage response + headers: + X-Dropbox-Request-Id: + style: simple + explode: false + schema: + type: string + example: "1234" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_76' + examples: + get_space_usage response: + value: + allocation: + ".tag": individual + allocated: 10000000000 + used: 314159265 +components: + schemas: + Photo: + type: object + properties: + ".tag": + type: string + example: base64_data + base64_data: + type: string + example: SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4= + SetProfilePhotoRequest: + type: object + properties: + photo: + $ref: '#/components/schemas/Photo' + SetProfilePhotoResponse: + type: object + properties: + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + TokenFromOauth1Request: + type: object + properties: + oauth1_token: + type: string + example: qievr8hamyg6ndck + oauth1_token_secret: + type: string + example: qomoftv0472git7 + TokenFromOauth1Response: + type: object + properties: + oauth2_token: + type: string + example: 9mCrkS7BIdAAAAAAAAAAHHS0TsSnpYvKQVtKdBnN5IuzhYOGblSgTcHgBFKFMmFn + CheckAppRequest: + type: object + properties: + query: + type: string + example: foo + inline_response_200: + type: object + properties: + result: + type: string + example: foo + CheckUserRequest: + type: object + properties: + query: + type: string + example: foo + DeleteManualContactsBatchRequest: + type: object + properties: + email_addresses: + type: array + example: + - contactemailaddress1@domain.com + - contactemailaddress2@domain.com + items: + type: string + example: contactemailaddress1@domain.com + PropertyField: + type: object + properties: + name: + type: string + example: Security Policy + value: + type: string + example: Confidential + PropertyGroup: + type: object + properties: + fields: + type: array + example: + - name: Security Policy + value: Confidential + items: + $ref: '#/components/schemas/PropertyField' + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + AddPropertiesRequest: + type: object + properties: + path: + type: string + example: /my_awesome/word.docx + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + OverwritePropertiesRequest: + type: object + properties: + path: + type: string + example: /my_awesome/word.docx + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + RemovePropertiesRequest: + type: object + properties: + path: + type: string + example: /my_awesome/word.docx + property_template_ids: + type: array + example: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + SearchPropertiesMode: + type: object + properties: + ".tag": + type: string + example: field_name + field_name: + type: string + example: Security + SearchPropertiesQuery: + type: object + properties: + logical_operator: + type: string + example: or_operator + mode: + $ref: '#/components/schemas/SearchPropertiesMode' + query: + type: string + example: Confidential + SearchPropertiesRequest: + type: object + properties: + queries: + type: array + example: + - logical_operator: or_operator + mode: + ".tag": field_name + field_name: Security + query: Confidential + items: + $ref: '#/components/schemas/SearchPropertiesQuery' + template_filter: + type: string + example: filter_none + inline_response_200_1: + type: object + properties: + matches: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXz + is_deleted: false + path: /my_awesome/word.docx + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/inline_response_200_1_matches' + SearchPropertiesContinueRequest: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + PropertyGroupsUpdate: + type: object + properties: + add_or_update_fields: + type: array + example: + - name: Security Policy + value: Confidential + items: + $ref: '#/components/schemas/PropertyField' + remove_fields: + type: array + example: [] + items: {} + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + UpdatePropertiesRequest: + type: object + properties: + path: + type: string + example: /my_awesome/word.docx + update_property_groups: + type: array + example: + - add_or_update_fields: + - name: Security Policy + value: Confidential + remove_fields: [] + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroupsUpdate' + PropertyFieldTemplate: + type: object + properties: + description: + type: string + example: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: + type: string + example: Security Policy + type: + type: string + example: string + AddTemplateForTeam: + type: object + properties: + description: + type: string + example: These properties describe how confidential this file or folder + is. + fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + items: + $ref: '#/components/schemas/PropertyFieldTemplate' + name: + type: string + example: Security + inline_response_200_2: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + AddTemplateForUser: + type: object + properties: + description: + type: string + example: These properties describe how confidential this file or folder + is. + fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + items: + $ref: '#/components/schemas/PropertyFieldTemplate' + name: + type: string + example: Security + GetTemplateForTeam: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + inline_response_200_3: + type: object + properties: + description: + type: string + example: These properties describe how confidential this file or folder + is. + fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: + ".tag": string + items: + $ref: '#/components/schemas/inline_response_200_3_fields' + name: + type: string + example: Security + GetTemplateForUserRequest: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + inline_response_200_4: + type: object + properties: + template_ids: + type: array + example: + - ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + RemoveTemplateForTeamRequest: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + TemplateId: + type: object + properties: + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + templates_update_for_team_body: + type: object + properties: + add_fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + items: + $ref: '#/components/schemas/PropertyFieldTemplate' + description: + type: string + example: These properties will describe how confidential this file or folder + is. + name: + type: string + example: New Security Template Name + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + templates_update_for_user_body: + type: object + properties: + add_fields: + type: array + example: + - description: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: Security Policy + type: string + items: + $ref: '#/components/schemas/PropertyFieldTemplate' + description: + type: string + example: These properties will describe how confidential this file or folder + is. + name: + type: string + example: New Security Template Name + template_id: + type: string + example: ptid:1a5n2i6d3OYEAAAAAAAAAYa + inline_response_200_5: + type: object + properties: + file_request_count: + type: number + example: 15 + file_requestscreate_deadline: + type: object + properties: + allow_late_uploads: + type: string + example: seven_days + deadline: + type: string + example: 2020-10-12T17:00:00Z + file_requests_create_body: + type: object + properties: + deadline: + $ref: '#/components/schemas/file_requestscreate_deadline' + destination: + type: string + example: /File Requests/Homework + open: + type: boolean + example: true + title: + type: string + example: Homework submission + inline_response_200_6: + type: object + properties: + created: + type: string + example: 2015-10-05T17:00:00Z + deadline: + $ref: '#/components/schemas/inline_response_200_6_deadline' + destination: + type: string + example: /File Requests/Homework + file_count: + type: number + example: 3 + id: + type: string + example: oaCAVmEyrqYnkZX9955Y + is_open: + type: boolean + example: true + title: + type: string + example: Homework submission + url: + type: string + example: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + file_requests_delete_body: + type: object + properties: + ids: + type: array + example: + - oaCAVmEyrqYnkZX9955Y + - BaZmehYoXMPtaRmfTbSG + items: + type: string + example: oaCAVmEyrqYnkZX9955Y + inline_response_200_7: + type: object + properties: + file_requests: + type: array + example: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + items: + $ref: '#/components/schemas/inline_response_200_7_file_requests' + file_requests_get_body: + type: object + properties: + id: + type: string + example: oaCAVmEyrqYnkZX9955Y + file_requests_list_v2_body: + type: object + properties: + limit: + type: number + example: 1000 + inline_response_200_8: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + file_requests: + type: array + example: + - created: 2015-10-05T17:00:00Z + deadline: + allow_late_uploads: + ".tag": seven_days + deadline: 2020-10-12T17:00:00Z + destination: /File Requests/Homework + file_count: 3 + id: oaCAVmEyrqYnkZX9955Y + is_open: true + title: Homework submission + url: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + - created: 2015-11-02T04:00:00Z + deadline: + deadline: 2020-10-12T17:00:00Z + destination: /Photo contest entries + file_count: 105 + id: BAJ7IrRGicQKGToykQdB + is_open: true + title: Photo contest submission + url: https://www.dropbox.com/request/BAJ7IrRGjcQKGToykQdB + - created: 2015-12-15T13:02:00Z + destination: /Wedding photos + file_count: 37 + id: rxwMPvK3ATTa0VxOJu5T + is_open: true + title: Wedding photo submission + url: https://www.dropbox.com/request/rxwMPvK3ATTa0VxOJu5T + items: + $ref: '#/components/schemas/inline_response_200_7_file_requests' + has_more: + type: boolean + example: true + list_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + file_requestsupdate_deadline: + type: object + properties: + ".tag": + type: string + example: update + allow_late_uploads: + type: string + example: seven_days + deadline: + type: string + example: 2020-10-12T17:00:00Z + file_requests_update_body: + type: object + properties: + deadline: + $ref: '#/components/schemas/file_requestsupdate_deadline' + destination: + type: string + example: /File Requests/Homework + id: + type: string + example: oaCAVmEyrqYnkZX9955Y + open: + type: boolean + example: true + title: + type: string + example: Homework submission + files_copy_v2_body: + type: object + properties: + allow_ownership_transfer: + type: boolean + example: false + allow_shared_folder: + type: boolean + example: false + autorename: + type: boolean + example: false + from_path: + type: string + example: /Homework/math + to_path: + type: string + example: /Homework/algebra + inline_response_200_9: + type: object + properties: + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + filescopy_batch_v2_entries: + type: object + properties: + from_path: + type: string + example: /Homework/math + to_path: + type: string + example: /Homework/algebra + files_copy_batch_v2_body: + type: object + properties: + autorename: + type: boolean + example: false + entries: + type: array + example: + - from_path: /Homework/math + to_path: /Homework/algebra + items: + $ref: '#/components/schemas/filescopy_batch_v2_entries' + inline_response_200_10: + type: object + properties: + ".tag": + type: string + example: complete + entries: + type: array + example: + - ".tag": success + success: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_10_entries' + copy_batch_check_v2_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + copy_reference_get_body: + type: object + properties: + path: + type: string + example: /video.mp4 + inline_response_200_11: + type: object + properties: + copy_reference: + type: string + example: z1X6ATl6aWtzOGq0c3g5Ng + expires: + type: string + example: 2045-05-12T15:50:38Z + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + copy_reference_save_body: + type: object + properties: + copy_reference: + type: string + example: z1X6ATl6aWtzOGq0c3g5Ng + path: + type: string + example: /video.mp4 + files_create_folder_v2_body: + type: object + properties: + autorename: + type: boolean + example: false + path: + type: string + example: /Homework/math + inline_response_200_12: + type: object + properties: + metadata: + $ref: '#/components/schemas/inline_response_200_12_metadata' + files_create_folder_batch_body: + type: object + properties: + autorename: + type: boolean + example: false + force_async: + type: boolean + example: false + paths: + type: array + example: + - /Homework/math + items: + type: string + example: /Homework/math + inline_response_200_13: + type: object + properties: + ".tag": + type: string + example: complete + entries: + type: array + example: + - ".tag": success + metadata: + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + items: + $ref: '#/components/schemas/inline_response_200_13_entries' + create_folder_batch_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + files_delete_v2_body: + type: object + properties: + path: + type: string + example: /Homework/math/Prime_Numbers.txt + files_delete_batch_body: + type: object + properties: + entries: + type: array + example: + - path: /Homework/math/Prime_Numbers.txt + items: + $ref: '#/components/schemas/files_delete_v2_body' + inline_response_200_14: + type: object + properties: + ".tag": + type: string + example: complete + entries: + type: array + example: + - ".tag": success + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_14_entries' + delete_batch_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_15: + type: object + properties: + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + inline_response_200_16: + type: object + properties: + export_metadata: + $ref: '#/components/schemas/inline_response_200_16_export_metadata' + file_metadata: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + filesget_file_lock_batch_entries: + type: object + properties: + path: + type: string + example: /John Doe/sample/test.pdf + files_get_file_lock_batch_body: + type: object + properties: + entries: + type: array + example: + - path: /John Doe/sample/test.pdf + items: + $ref: '#/components/schemas/filesget_file_lock_batch_entries' + inline_response_200_17: + type: object + properties: + entries: + type: array + example: + - ".tag": success + lock: + content: + ".tag": single_user + created: 2015-05-12T15:50:38Z + lock_holder_account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: dbtid:1234abcd + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_17_entries' + files_get_metadata_body: + type: object + properties: + include_deleted: + type: boolean + example: false + include_has_explicit_shared_members: + type: boolean + example: false + include_media_info: + type: boolean + example: false + path: + type: string + example: /Homework/math + inline_response_200_18: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + files_get_temporary_link_body: + type: object + properties: + path: + type: string + example: /video.mp4 + inline_response_200_19: + type: object + properties: + link: + type: string + example: https://dl.dropboxusercontent.com/apitl/1/YXNkZmFzZGcyMzQyMzI0NjU2NDU2NDU2 + metadata: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + filesget_temporary_upload_link_commit_info: + type: object + properties: + autorename: + type: boolean + example: true + mode: + type: string + example: add + mute: + type: boolean + example: false + path: + type: string + example: /Homework/math/Matrices.txt + strict_conflict: + type: boolean + example: false + files_get_temporary_upload_link_body: + type: object + properties: + commit_info: + $ref: '#/components/schemas/filesget_temporary_upload_link_commit_info' + duration: + type: number + example: 3600 + inline_response_200_20: + type: object + properties: + link: + type: string + example: https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND + inline_response_200_21: + type: object + properties: + file_metadata: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + filesget_thumbnail_batch_entries: + type: object + properties: + format: + type: string + example: jpeg + mode: + type: string + example: strict + path: + type: string + example: /image.jpg + size: + type: string + example: w64h64 + files_get_thumbnail_batch_body: + type: object + properties: + entries: + type: array + example: + - format: jpeg + mode: strict + path: /image.jpg + size: w64h64 + items: + $ref: '#/components/schemas/filesget_thumbnail_batch_entries' + inline_response_200_22: + type: object + properties: + entries: + type: array + example: + - ".tag": success + metadata: + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + thumbnail: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= + items: + $ref: '#/components/schemas/inline_response_200_22_entries' + files_list_folder_body: + type: object + properties: + include_deleted: + type: boolean + example: false + include_has_explicit_shared_members: + type: boolean + example: false + include_media_info: + type: boolean + example: false + include_mounted_folders: + type: boolean + example: true + include_non_downloadable_files: + type: boolean + example: true + path: + type: string + example: /Homework/math + recursive: + type: boolean + example: false + inline_response_200_23: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + type: array + example: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + - ".tag": folder + id: id:a4ayc_80_OEAAAAAAAAAXz + name: math + path_display: /Homework/math + path_lower: /homework/math + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + sharing_info: + no_access: false + parent_shared_folder_id: "84528192421" + read_only: false + traverse_only: false + items: + $ref: '#/components/schemas/inline_response_200_23_entries' + has_more: + type: boolean + example: false + list_folder_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + list_folder_get_latest_cursor_body: + type: object + properties: + include_deleted: + type: boolean + example: false + include_has_explicit_shared_members: + type: boolean + example: false + include_media_info: + type: boolean + example: false + include_mounted_folders: + type: boolean + example: true + include_non_downloadable_files: + type: boolean + example: true + path: + type: string + example: /Homework/math + recursive: + type: boolean + example: false + list_folder_longpoll_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + timeout: + type: number + example: 30 + inline_response_200_24: + type: object + properties: + changes: + type: boolean + example: true + files_list_revisions_body: + type: object + properties: + limit: + type: number + example: 10 + mode: + type: string + example: path + path: + type: string + example: /root/word.docx + inline_response_200_25: + type: object + properties: + entries: + type: array + example: + - client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + is_deleted: + type: boolean + example: false + files_lock_file_batch_body: + type: object + properties: + entries: + type: array + example: + - path: /John Doe/sample/test.pdf + items: + $ref: '#/components/schemas/filesget_file_lock_batch_entries' + files_move_v2_body: + type: object + properties: + allow_ownership_transfer: + type: boolean + example: false + allow_shared_folder: + type: boolean + example: false + autorename: + type: boolean + example: false + from_path: + type: string + example: /Homework/math + to_path: + type: string + example: /Homework/algebra + files_move_batch_v2_body: + type: object + properties: + allow_ownership_transfer: + type: boolean + example: false + autorename: + type: boolean + example: false + entries: + type: array + example: + - from_path: /Homework/math + to_path: /Homework/algebra + items: + $ref: '#/components/schemas/filescopy_batch_v2_entries' + move_batch_check_v2_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + files_permanently_delete_body: + type: object + properties: + path: + type: string + example: /Homework/math/Prime_Numbers.txt + files_restore_body: + type: object + properties: + path: + type: string + example: /root/word.docx + rev: + type: string + example: a1c10ce0dd78 + files_save_url_body: + type: object + properties: + path: + type: string + example: /a.txt + url: + type: string + example: http://example.com/a.txt + inline_response_200_26: + type: object + properties: + ".tag": + type: string + example: complete + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + save_url_check_job_status_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_27: + type: object + properties: + ".tag": + type: string + example: in_progress + files_search_v2_body: + type: object + properties: + include_highlights: + type: boolean + example: false + query: + type: string + example: cat + inline_response_200_28: + type: object + properties: + has_more: + type: boolean + example: false + matches: + type: array + example: + - metadata: + ".tag": metadata + metadata: + ".tag": file + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_28_matches' + search_continue_v2_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + files_unlock_file_batch_body: + type: object + properties: + entries: + type: array + example: + - path: /John Doe/sample/test.pdf + items: + $ref: '#/components/schemas/filesget_file_lock_batch_entries' + filesupload_sessionfinish_batch_cursor: + type: object + properties: + offset: + type: number + example: 0 + session_id: + type: string + example: 1234faaf0678bcde + filesupload_sessionfinish_batch_entries: + type: object + properties: + commit: + $ref: '#/components/schemas/filesget_temporary_upload_link_commit_info' + cursor: + $ref: '#/components/schemas/filesupload_sessionfinish_batch_cursor' + upload_session_finish_batch_body: + type: object + properties: + entries: + type: array + example: + - commit: + autorename: true + mode: add + mute: false + path: /Homework/math/Matrices.txt + strict_conflict: false + cursor: + offset: 0 + session_id: 1234faaf0678bcde + items: + $ref: '#/components/schemas/filesupload_sessionfinish_batch_entries' + inline_response_200_29: + type: object + properties: + ".tag": + type: string + example: complete + entries: + type: array + example: + - ".tag": success + client_modified: 2015-05-12T15:50:38Z + content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + created: 2015-05-12T15:50:38Z + is_lockholder: true + lockholder_name: Imaginary User + has_explicit_shared_members: false + id: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: true + name: Prime_Numbers.txt + path_display: /Homework/math/Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + property_groups: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + sharing_info: + modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: "84528192421" + read_only: true + size: 7212 + items: + $ref: '#/components/schemas/inline_response_200_29_entries' + finish_batch_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_30: + type: object + properties: + session_id: + type: string + example: 1234faaf0678bcde + sharingadd_file_member_members: + type: object + properties: + ".tag": + type: string + example: email + email: + type: string + example: justin@example.com + sharing_add_file_member_body: + type: object + properties: + access_level: + type: string + example: viewer + add_message_as_comment: + type: boolean + example: false + custom_message: + type: string + example: This is a custom message about ACME.doc + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + members: + type: array + example: + - ".tag": email + email: justin@example.com + items: + $ref: '#/components/schemas/sharingadd_file_member_members' + quiet: + type: boolean + example: false + sharingadd_file_member_result: + type: object + properties: + ".tag": + type: string + example: success + inline_response_200_31: + type: object + properties: + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + result: + $ref: '#/components/schemas/sharingadd_file_member_result' + sharingadd_folder_member_member: + type: object + properties: + ".tag": + type: string + example: email + dropbox_id: + type: string + example: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + email: + type: string + example: justin@example.com + sharingadd_folder_member_members: + type: object + properties: + access_level: + type: string + example: editor + member: + $ref: '#/components/schemas/sharingadd_folder_member_member' + sharing_add_folder_member_body: + type: object + properties: + custom_message: + type: string + example: Documentation for launch day + members: + type: array + example: + - access_level: editor + member: + ".tag": email + email: justin@example.com + - access_level: viewer + member: + ".tag": dropbox_id + dropbox_id: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + items: + $ref: '#/components/schemas/sharingadd_folder_member_members' + quiet: + type: boolean + example: false + shared_folder_id: + type: string + example: "84528192421" + sharing_check_job_status_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + sharing_check_remove_member_job_status_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_32: + type: object + properties: + ".tag": + type: string + example: complete + sharing_check_share_job_status_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + inline_response_200_33: + type: object + properties: + ".tag": + type: string + example: complete + access_inheritance: + $ref: '#/components/schemas/inline_response_200_33_access_inheritance' + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inside_team_folder: + type: boolean + example: false + is_team_folder: + type: boolean + example: false + link_metadata: + $ref: '#/components/schemas/inline_response_200_33_link_metadata' + name: + type: string + example: dir + path_lower: + type: string + example: /dir + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: + type: string + example: "84528192421" + time_invited: + type: string + example: 2016-01-20T00:00:00Z + sharing_get_file_metadata_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + inline_response_200_34: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + id: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + name: + type: string + example: file.txt + owner_display_names: + type: array + example: + - Jane Doe + items: + type: string + example: Jane Doe + owner_team: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + path_display: + type: string + example: /dir/file.txt + path_lower: + type: string + example: /dir/file.txt + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: + type: string + example: 2016-01-20T00:00:00Z + get_file_metadata_batch_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + files: + type: array + example: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + items: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + sharingget_file_metadatabatch_result_access_type: + type: object + properties: + ".tag": + type: string + example: viewer + sharingget_file_metadatabatch_result_owner_team: + type: object + properties: + id: + type: string + example: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: + type: string + example: "Acme, Inc." + sharingget_file_metadatabatch_result_policy_acl_update_policy: + type: object + properties: + ".tag": + type: string + example: owner + sharingget_file_metadatabatch_result_policy_member_policy: + type: object + properties: + ".tag": + type: string + example: anyone + sharingget_file_metadatabatch_result_policy_resolved_member_policy: + type: object + properties: + ".tag": + type: string + example: team + sharingget_file_metadatabatch_result_policy: + type: object + properties: + acl_update_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + member_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_member_policy' + resolved_member_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_resolved_member_policy' + shared_link_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_member_policy' + sharingget_file_metadatabatch_result: + type: object + properties: + ".tag": + type: string + example: metadata + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + id: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + name: + type: string + example: file.txt + owner_display_names: + type: array + example: + - Jane Doe + items: + type: string + example: Jane Doe + owner_team: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + path_display: + type: string + example: /dir/file.txt + path_lower: + type: string + example: /dir/file.txt + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: + type: string + example: 2016-01-20T00:00:00Z + inline_response_200_35: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + result: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result' + sharing_get_folder_metadata_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + shared_folder_id: + type: string + example: "84528192421" + inline_response_200_36: + type: object + properties: + access_inheritance: + $ref: '#/components/schemas/inline_response_200_33_access_inheritance' + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inside_team_folder: + type: boolean + example: false + is_team_folder: + type: boolean + example: false + link_metadata: + $ref: '#/components/schemas/inline_response_200_33_link_metadata' + name: + type: string + example: dir + path_lower: + type: string + example: /dir + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: + type: string + example: "84528192421" + time_invited: + type: string + example: 2016-01-20T00:00:00Z + inline_response_200_37: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + $ref: '#/components/schemas/inline_response_200_37_link_permissions' + name: + type: string + example: Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + size: + type: number + example: 7212 + team_member_info: + $ref: '#/components/schemas/inline_response_200_37_team_member_info' + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + sharing_get_shared_link_metadata_body: + type: object + properties: + path: + type: string + example: /Prime_Numbers.txt + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + sharing_list_file_members_body: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + include_inherited: + type: boolean + example: true + limit: + type: number + example: 100 + inline_response_200_38: + type: object + properties: + groups: + type: array + example: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_groups' + invitees: + type: array + example: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitees' + users: + type: array + example: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_users' + list_file_members_batch_body: + type: object + properties: + files: + type: array + example: + - id:3kmLmQFnf1AAAAAAAAAAAw + - id:VvTaJu2VZzAAAAAAAAAADQ + items: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + limit: + type: number + example: 10 + sharinglist_file_membersbatch_result_members_access_type: + type: object + properties: + ".tag": + type: string + example: editor + sharinglist_file_membersbatch_result_members_group_group_management_type: + type: object + properties: + ".tag": + type: string + example: user_managed + sharinglist_file_membersbatch_result_members_group: + type: object + properties: + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: Test group + group_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + is_member: + type: boolean + example: false + is_owner: + type: boolean + example: false + member_count: + type: number + example: 10 + same_team: + type: boolean + example: true + sharinglist_file_membersbatch_result_members_groups: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_access_type' + group: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group' + is_inherited: + type: boolean + example: false + permissions: + type: array + example: [] + items: {} + sharinglist_file_membersbatch_result_members_invitee: + type: object + properties: + ".tag": + type: string + example: email + email: + type: string + example: jessica@example.com + sharinglist_file_membersbatch_result_members_invitees: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + invitee: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitee' + is_inherited: + type: boolean + example: false + permissions: + type: array + example: [] + items: {} + sharinglist_file_membersbatch_result_members_platform_type: + type: object + properties: + ".tag": + type: string + example: unknown + sharinglist_file_membersbatch_result_members_user: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: + type: string + example: Robert Smith + email: + type: string + example: bob@example.com + same_team: + type: boolean + example: true + team_member_id: + type: string + example: dbmid:abcd1234 + sharinglist_file_membersbatch_result_members_users: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inherited: + type: boolean + example: false + permissions: + type: array + example: [] + items: {} + platform_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_platform_type' + time_last_seen: + type: string + example: 2016-01-20T00:00:00Z + user: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_user' + sharinglist_file_membersbatch_result_members: + type: object + properties: + groups: + type: array + example: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_groups' + invitees: + type: array + example: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitees' + users: + type: array + example: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + platform_type: + ".tag": unknown + time_last_seen: 2016-01-20T00:00:00Z + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_users' + sharinglist_file_membersbatch_result: + type: object + properties: + ".tag": + type: string + example: result + member_count: + type: number + example: 3 + members: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members' + inline_response_200_39: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + result: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result' + list_file_members_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + list_folder_members_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + inline_response_200_40: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + type: array + example: + - access_type: + ".tag": editor + group: + group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + group_type: + ".tag": user_managed + is_member: false + is_owner: false + member_count: 10 + same_team: true + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_groups' + invitees: + type: array + example: + - access_type: + ".tag": viewer + invitee: + ".tag": email + email: jessica@example.com + is_inherited: false + permissions: [] + items: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_invitees' + users: + type: array + example: + - access_type: + ".tag": owner + is_inherited: false + permissions: [] + user: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + display_name: Robert Smith + email: bob@example.com + same_team: true + team_member_id: dbmid:abcd1234 + items: + $ref: '#/components/schemas/inline_response_200_40_users' + sharing_list_folders_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + limit: + type: number + example: 100 + inline_response_200_41: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + entries: + type: array + example: + - access_inheritance: + ".tag": inherit + access_type: + ".tag": owner + is_inside_team_folder: false + is_team_folder: false + 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: "" + name: dir + path_lower: /dir + permissions: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: "84528192421" + time_invited: 2016-01-20T00:00:00Z + items: + $ref: '#/components/schemas/inline_response_200_41_entries' + list_folders_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + sharing_list_mountable_folders_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + limit: + type: number + example: 100 + list_mountable_folders_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + sharing_list_received_files_body: + type: object + properties: + actions: + type: array + example: [] + items: {} + limit: + type: number + example: 100 + inline_response_200_42: + type: object + properties: + cursor: + type: string + example: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9cmV2aXNpb24H3Qf6o1fkHxQ + entries: + type: array + example: + - access_type: + ".tag": viewer + id: id:3kmLmQFnf1AAAAAAAAAAAw + name: file.txt + 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: [] + policy: + acl_update_policy: + ".tag": owner + member_policy: + ".tag": anyone + resolved_member_policy: + ".tag": team + shared_link_policy: + ".tag": anyone + preview_url: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: 2016-01-20T00:00:00Z + items: + $ref: '#/components/schemas/inline_response_200_42_entries' + list_received_files_continue_body: + type: object + properties: + cursor: + type: string + example: AzJJbGlzdF90eXBdofe9c3RPbGlzdGFyZ3NfYnlfZ2lkMRhcbric7Rdog9emfGRlc2MCRWxpbWl0BGRId + sharing_list_shared_links_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + inline_response_200_43: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: true + links: + type: array + example: + - ".tag": file + client_modified: 2015-05-12T15:50:38Z + id: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + can_revoke: false + resolved_visibility: + ".tag": public + revoke_failure_reason: + ".tag": owner_only + name: Prime_Numbers.txt + path_lower: /homework/math/prime_numbers.txt + rev: a1c10ce0dd78 + server_modified: 2015-05-12T15:50:38Z + size: 7212 + team_member_info: + display_name: Roger Rabbit + member_id: dbmid:abcd1234 + team_info: + id: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: "Acme, Inc." + url: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + items: + $ref: '#/components/schemas/inline_response_200_43_links' + sharingmodify_shared_link_settings_settings: + type: object + properties: + access: + type: string + example: viewer + audience: + type: string + example: public + requested_visibility: + type: string + example: public + sharing_modify_shared_link_settings_body: + type: object + properties: + remove_expiration: + type: boolean + example: false + settings: + $ref: '#/components/schemas/sharingmodify_shared_link_settings_settings' + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + sharing_mount_folder_body: + type: object + properties: + shared_folder_id: + type: string + example: "84528192421" + sharing_relinquish_file_membership_body: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + sharing_relinquish_folder_membership_body: + type: object + properties: + leave_a_copy: + type: boolean + example: false + shared_folder_id: + type: string + example: "84528192421" + sharing_remove_file_member_2_body: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + inline_response_200_44: + type: object + properties: + ".tag": + type: string + example: other + sharing_remove_folder_member_body: + type: object + properties: + leave_a_copy: + type: boolean + example: false + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + shared_folder_id: + type: string + example: "84528192421" + inline_response_200_45: + type: object + properties: + ".tag": + type: string + example: async_job_id + async_job_id: + type: string + example: 34g93hh34h04y384084 + sharing_revoke_shared_link_body: + type: object + properties: + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + sharing_set_access_inheritance_body: + type: object + properties: + access_inheritance: + type: string + example: inherit + shared_folder_id: + type: string + example: "84528192421" + sharing_share_folder_body: + type: object + properties: + access_inheritance: + type: string + example: inherit + acl_update_policy: + type: string + example: editors + force_async: + type: boolean + example: false + member_policy: + type: string + example: team + path: + type: string + example: /example/workspace + shared_link_policy: + type: string + example: members + sharing_transfer_folder_body: + type: object + properties: + shared_folder_id: + type: string + example: "84528192421" + to_dropbox_id: + type: string + example: dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q + sharing_unmount_folder_body: + type: object + properties: + shared_folder_id: + type: string + example: "84528192421" + sharing_unshare_file_body: + type: object + properties: + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + sharing_unshare_folder_body: + type: object + properties: + leave_a_copy: + type: boolean + example: false + shared_folder_id: + type: string + example: "84528192421" + sharing_update_file_member_body: + type: object + properties: + access_level: + type: string + example: viewer + file: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + sharing_update_folder_member_body: + type: object + properties: + access_level: + type: string + example: editor + member: + $ref: '#/components/schemas/sharingadd_file_member_members' + shared_folder_id: + type: string + example: "84528192421" + sharing_update_folder_policy_body: + type: object + properties: + acl_update_policy: + type: string + example: owner + member_policy: + type: string + example: team + shared_folder_id: + type: string + example: "84528192421" + shared_link_policy: + type: string + example: members + devices_list_member_devices_body: + type: object + properties: + include_desktop_clients: + type: boolean + example: true + include_mobile_clients: + type: boolean + example: true + include_web_sessions: + type: boolean + example: true + team_member_id: + type: string + example: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + devices_revoke_device_session_body: + type: object + properties: + ".tag": + type: string + example: web_session + session_id: + type: string + example: 1234faaf0678bcde + team_member_id: + type: string + example: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + devices_revoke_device_session_batch_body: + type: object + properties: + revoke_devices: + type: array + example: + - ".tag": web_session + session_id: 1234faaf0678bcde + team_member_id: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + items: + $ref: '#/components/schemas/devices_revoke_device_session_body' + groups_create_body: + type: object + properties: + add_creator_as_owner: + type: boolean + example: false + group_external_id: + type: string + example: group-134 + group_name: + type: string + example: Europe sales + inline_response_200_46: + type: object + properties: + created: + type: number + example: 1447255518000 + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: project launch + member_count: + type: number + example: 5 + members: + type: array + example: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/teamgroupsget_info_members' + groups_delete_body: + type: object + properties: + ".tag": + type: string + example: group_id + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + groups_get_info_body: + type: object + properties: + ".tag": + type: string + example: group_ids + group_ids: + type: array + example: + - g:e2db7665347abcd600000000001a2b3c + - g:111111147abcd6000000000222222c + items: + type: string + example: g:e2db7665347abcd600000000001a2b3c + teamgroupsget_info_access_type: + type: object + properties: + ".tag": + type: string + example: member + teamgroupsget_info_profile_membership_type: + type: object + properties: + ".tag": + type: string + example: full + teamgroupsget_info_profile_name: + type: object + properties: + abbreviated_name: + type: string + example: FF + display_name: + type: string + example: Franz Ferdinand (Personal) + familiar_name: + type: string + example: Franz + given_name: + type: string + example: Franz + surname: + type: string + example: Ferdinand + teamgroupsget_info_profile_secondary_emails: + type: object + properties: + email: + type: string + example: apple@orange.com + is_verified: + type: boolean + example: true + teamgroupsget_info_profile_status: + type: object + properties: + ".tag": + type: string + example: active + teamgroupsget_info_profile: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: + type: string + example: mary@lamb.com + email_verified: + type: boolean + example: true + joined_on: + type: string + example: 2015-05-12T15:50:38Z + membership_type: + $ref: '#/components/schemas/teamgroupsget_info_profile_membership_type' + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + type: array + example: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + items: + $ref: '#/components/schemas/teamgroupsget_info_profile_secondary_emails' + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + team_member_id: + type: string + example: dbmid:1234567 + teamgroupsget_info_members: + type: object + properties: + access_type: + $ref: '#/components/schemas/teamgroupsget_info_access_type' + profile: + $ref: '#/components/schemas/teamgroupsget_info_profile' + inline_response_200_47: + type: object + properties: + ".tag": + type: string + example: group_info + created: + type: number + example: 1447255518000 + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: project launch + member_count: + type: number + example: 5 + members: + type: array + example: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/teamgroupsget_info_members' + job_status_get_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + groups_list_body: + type: object + properties: + limit: + type: number + example: 100 + inline_response_200_48: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + groups: + type: array + example: + - group_id: g:e2db7665347abcd600000000001a2b3c + group_management_type: + ".tag": user_managed + group_name: Test group + member_count: 10 + items: + $ref: '#/components/schemas/inline_response_200_48_groups' + has_more: + type: boolean + example: false + list_continue_body_1: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + teamgroupsmembersadd_user: + type: object + properties: + ".tag": + type: string + example: team_member_id + team_member_id: + type: string + example: dbmid:efgh5678 + teamgroupsmembersadd_members: + type: object + properties: + access_type: + type: string + example: member + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + members_add_body: + type: object + properties: + group: + $ref: '#/components/schemas/groups_delete_body' + members: + type: array + example: + - access_type: member + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_members' + return_members: + type: boolean + example: true + inline_response_200_49: + type: object + properties: + async_job_id: + type: string + example: "99988877733388" + group_info: + $ref: '#/components/schemas/inline_response_200_49_group_info' + members_list_body: + type: object + properties: + group: + $ref: '#/components/schemas/groups_delete_body' + limit: + type: number + example: 100 + inline_response_200_50: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: false + members: + type: array + example: [] + items: {} + list_continue_body_2: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + members_remove_body: + type: object + properties: + group: + $ref: '#/components/schemas/groups_delete_body' + return_members: + type: boolean + example: true + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + members_set_access_type_body: + type: object + properties: + access_type: + type: string + example: member + group: + $ref: '#/components/schemas/groups_delete_body' + return_members: + type: boolean + example: true + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + groups_update_body: + type: object + properties: + group: + $ref: '#/components/schemas/groups_delete_body' + new_group_external_id: + type: string + example: sales-234 + new_group_management_type: + type: string + example: company_managed + new_group_name: + type: string + example: Europe west sales + return_members: + type: boolean + example: true + legal_holds_create_policy_body: + type: object + properties: + end_date: + type: string + example: 2017-12-31T00:00:00Z + members: + type: array + example: + - dbmid:FDFSVF-DFSDF + items: + type: string + example: dbmid:FDFSVF-DFSDF + name: + type: string + example: acme cfo policy + start_date: + type: string + example: 2016-01-01T00:00:00Z + inline_response_200_51: + type: object + properties: + activation_time: + type: string + example: 2016-01-20T00:00:10Z + end_date: + type: string + example: 2017-12-31T00:00:00Z + id: + type: string + example: pid_dbhid:abcd1234 + members: + $ref: '#/components/schemas/inline_response_200_51_members' + name: + type: string + example: acme cfo policy + start_date: + type: string + example: 2016-01-01T00:00:00Z + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + legal_holds_get_policy_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + legal_holds_list_held_revisions_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + inline_response_200_52: + type: object + properties: + entries: + type: array + example: + - author_email: a@a.com + author_member_id: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + ".tag": active + content_hash: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + file_type: Document + new_filename: 111_222.pdf + original_file_path: /a.pdf + original_revision_id: ab2rij4i5ojgfd + server_modified: 2019-08-12T12:08:52Z + size: 3 + items: + $ref: '#/components/schemas/inline_response_200_52_entries' + has_more: + type: boolean + example: false + legal_holds_list_held_revisions_continue_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + legal_holds_list_policies_body: + type: object + properties: + include_released: + type: boolean + example: false + inline_response_200_53: + type: object + properties: + policies: + type: array + example: + - activation_time: 2016-01-20T00:00:10Z + end_date: 2017-12-31T00:00:00Z + id: pid_dbhid:abcd1234 + members: + permanently_deleted_users: 2 + team_member_ids: + - dbmid:efgh5678 + name: acme cfo policy + start_date: 2016-01-01T00:00:00Z + status: + ".tag": active + items: + $ref: '#/components/schemas/inline_response_200_53_policies' + legal_holds_release_policy_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + legal_holds_update_policy_body: + type: object + properties: + id: + type: string + example: pid_dbhid:abcd1234 + members: + type: array + example: + - dbmid:FDFSVF-DFSDF + items: + type: string + example: dbmid:FDFSVF-DFSDF + linked_apps_list_member_linked_apps_body: + type: object + properties: + team_member_id: + type: string + example: dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + excluded_users_add_body: + type: object + properties: + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + inline_response_200_54: + type: object + properties: + status: + $ref: '#/components/schemas/sharingadd_file_member_result' + excluded_users_list_body: + type: object + properties: + limit: + type: number + example: 100 + inline_response_200_55: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: false + users: + type: array + example: [] + items: {} + list_continue_body_3: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + excluded_users_remove_body: + type: object + properties: + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + member_space_limits_get_custom_quota_body: + type: object + properties: + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + member_space_limits_remove_custom_quota_body: + type: object + properties: + users: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + teammember_space_limitsset_custom_quota_users_and_quotas: + type: object + properties: + quota_gb: + type: number + example: 30 + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + member_space_limits_set_custom_quota_body: + type: object + properties: + users_and_quotas: + type: array + example: + - quota_gb: 30 + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teammember_space_limitsset_custom_quota_users_and_quotas' + teammembersadd_new_members: + type: object + properties: + member_email: + type: string + example: tom.s@company.com + member_external_id: + type: string + example: company_id:342432 + member_given_name: + type: string + example: Tom + member_surname: + type: string + example: Silverstone + role: + type: string + example: member_only + send_welcome_email: + type: boolean + example: true + members_add_body_1: + type: object + properties: + force_async: + type: boolean + example: false + new_members: + type: array + example: + - member_email: tom.s@company.com + member_external_id: company_id:342432 + member_given_name: Tom + member_surname: Silverstone + role: member_only + send_welcome_email: true + items: + $ref: '#/components/schemas/teammembersadd_new_members' + inline_response_200_56: + type: object + properties: + ".tag": + type: string + example: complete + complete: + type: array + example: + - ".tag": success + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + items: + $ref: '#/components/schemas/inline_response_200_56_complete' + job_status_get_body_1: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + members_delete_profile_photo_body: + type: object + properties: + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + inline_response_200_57: + type: object + properties: + profile: + $ref: '#/components/schemas/teammembersget_info_profile' + role: + $ref: '#/components/schemas/teammembersget_info_role' + members_get_info_body: + type: object + properties: + members: + type: array + example: + - ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + teammembersget_info_profile_secondary_emails: + type: object + properties: + email: + type: string + example: grape@strawberry.com + is_verified: + type: boolean + example: false + teammembersget_info_profile: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: + type: string + example: tami@seagull.com + email_verified: + type: boolean + example: false + external_id: + type: string + example: "244423" + groups: + type: array + example: + - g:e2db7665347abcd600000000001a2b3c + items: + type: string + example: g:e2db7665347abcd600000000001a2b3c + joined_on: + type: string + example: 2015-05-12T15:50:38Z + member_folder_id: + type: string + example: "20" + membership_type: + $ref: '#/components/schemas/teamgroupsget_info_profile_membership_type' + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + type: array + example: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + items: + $ref: '#/components/schemas/teammembersget_info_profile_secondary_emails' + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + team_member_id: + type: string + example: dbmid:FDFSVF-DFSDF + teammembersget_info_role: + type: object + properties: + ".tag": + type: string + example: member_only + inline_response_200_58: + type: object + properties: + ".tag": + type: string + example: member_info + profile: + $ref: '#/components/schemas/teammembersget_info_profile' + role: + $ref: '#/components/schemas/teammembersget_info_role' + members_list_body_1: + type: object + properties: + include_removed: + type: boolean + example: false + limit: + type: number + example: 100 + inline_response_200_59: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: true + members: + type: array + example: + - profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: tami@seagull.com + email_verified: false + external_id: "244423" + groups: + - g:e2db7665347abcd600000000001a2b3c + joined_on: 2015-05-12T15:50:38Z + member_folder_id: "20" + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: grape@strawberry.com + is_verified: false + - email: apple@orange.com + is_verified: true + status: + ".tag": active + team_member_id: dbmid:FDFSVF-DFSDF + role: + ".tag": member_only + items: + $ref: '#/components/schemas/inline_response_200_59_members' + list_continue_body_4: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + members_move_former_member_files_body: + type: object + properties: + transfer_admin_id: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + transfer_dest_id: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + job_status_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + members_recover_body: + type: object + properties: + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + members_remove_body_1: + type: object + properties: + keep_account: + type: boolean + example: false + retain_team_shares: + type: boolean + example: false + transfer_admin_id: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + transfer_dest_id: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + wipe_data: + type: boolean + example: true + job_status_get_body_2: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + teammemberssecondary_emailsadd_new_secondary_emails: + type: object + properties: + secondary_emails: + type: array + example: + - bob2@hotmail.com + - bob@inst.gov + items: + type: string + example: bob2@hotmail.com + user: + $ref: '#/components/schemas/teamgroupsmembersadd_user' + secondary_emails_add_body: + type: object + properties: + new_secondary_emails: + type: array + example: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' + inline_response_200_60: + type: object + properties: + results: + type: array + example: + - ".tag": success + results: + - ".tag": success + success: + email: apple@orange.com + is_verified: true + - ".tag": unavailable + unavailable: alice@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + - ".tag": invalid_user + invalid_user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/inline_response_200_60_results_1' + secondary_emails_delete_body: + type: object + properties: + emails_to_delete: + type: array + example: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' + inline_response_200_61: + type: object + properties: + results: + type: array + example: + - ".tag": success + results: + - ".tag": success + success: alice@example.com + - ".tag": not_found + not_found: alic@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/inline_response_200_61_results_1' + secondary_emails_resend_verification_emails_body: + type: object + properties: + emails_to_resend: + type: array + example: + - secondary_emails: + - bob2@hotmail.com + - bob@inst.gov + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/teammemberssecondary_emailsadd_new_secondary_emails' + inline_response_200_62: + type: object + properties: + results: + type: array + example: + - ".tag": success + results: + - ".tag": success + success: alice@example.com + user: + ".tag": team_member_id + team_member_id: dbmid:efgh5678 + items: + $ref: '#/components/schemas/inline_response_200_62_results_1' + members_send_welcome_email_body: + type: object + properties: + ".tag": + type: string + example: team_member_id + team_member_id: + type: string + example: dbmid:efgh5678 + members_set_admin_permissions_body: + type: object + properties: + new_role: + type: string + example: member_only + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + inline_response_200_63: + type: object + properties: + role: + $ref: '#/components/schemas/teammembersget_info_role' + team_member_id: + type: string + example: dbmid:9978889 + members_set_profile_body: + type: object + properties: + new_email: + type: string + example: t.smith@domain.com + new_surname: + type: string + example: Smith + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + members_set_profile_photo_body: + type: object + properties: + photo: + $ref: '#/components/schemas/Photo' + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + members_suspend_body: + type: object + properties: + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + wipe_data: + type: boolean + example: false + members_unsuspend_body: + type: object + properties: + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + namespaces_list_body: + type: object + properties: + limit: + type: number + example: 1 + inline_response_200_64: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: false + namespaces: + type: array + example: + - name: Marketing + namespace_id: "123456789" + namespace_type: + ".tag": shared_folder + - name: Franz Ferdinand + namespace_id: "123456789" + namespace_type: + ".tag": team_member_folder + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/inline_response_200_64_namespaces' + list_continue_body_5: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + team_folder_activate_body: + type: object + properties: + team_folder_id: + type: string + example: "123456789" + inline_response_200_65: + type: object + properties: + content_sync_settings: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + items: + $ref: '#/components/schemas/inline_response_200_65_content_sync_settings' + is_team_shared_dropbox: + type: boolean + example: false + name: + type: string + example: Marketing + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + sync_setting: + $ref: '#/components/schemas/inline_response_200_65_sync_setting' + team_folder_id: + type: string + example: "123456789" + team_folder_archive_body: + type: object + properties: + force_async_off: + type: boolean + example: false + team_folder_id: + type: string + example: "123456789" + inline_response_200_66: + type: object + properties: + ".tag": + type: string + example: complete + content_sync_settings: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + items: + $ref: '#/components/schemas/inline_response_200_65_content_sync_settings' + is_team_shared_dropbox: + type: boolean + example: false + name: + type: string + example: Marketing + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + sync_setting: + $ref: '#/components/schemas/inline_response_200_65_sync_setting' + team_folder_id: + type: string + example: "123456789" + archive_check_body: + type: object + properties: + async_job_id: + type: string + example: 34g93hh34h04y384084 + team_folder_create_body: + type: object + properties: + name: + type: string + example: Marketing + sync_setting: + type: string + example: not_synced + team_folder_get_info_body: + type: object + properties: + team_folder_ids: + type: array + example: + - "947182" + - "5819424" + - "852307532" + items: + type: string + example: "947182" + team_folder_list_body: + type: object + properties: + limit: + type: number + example: 100 + inline_response_200_67: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + has_more: + type: boolean + example: false + team_folders: + type: array + example: + - content_sync_settings: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + is_team_shared_dropbox: false + name: Marketing + status: + ".tag": active + sync_setting: + ".tag": default + team_folder_id: "123456789" + items: + $ref: '#/components/schemas/inline_response_200_67_team_folders' + list_continue_body_6: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + team_folder_permanently_delete_body: + type: object + properties: + team_folder_id: + type: string + example: "123456789" + team_folder_rename_body: + type: object + properties: + name: + type: string + example: Sales + team_folder_id: + type: string + example: "123456789" + teamteam_folderupdate_sync_settings_content_sync_settings: + type: object + properties: + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + type: string + example: not_synced + team_folder_update_sync_settings_body: + type: object + properties: + content_sync_settings: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: not_synced + items: + $ref: '#/components/schemas/teamteam_folderupdate_sync_settings_content_sync_settings' + sync_setting: + type: string + example: not_synced + team_folder_id: + type: string + example: "123456789" + teamfeaturesget_values_features: + type: object + properties: + ".tag": + type: string + example: upload_api_rate_limit + features_get_values_body: + type: object + properties: + features: + type: array + example: + - ".tag": upload_api_rate_limit + - ".tag": has_team_shared_dropbox + items: + $ref: '#/components/schemas/teamfeaturesget_values_features' + inline_response_200_68: + type: object + properties: + values: + type: array + example: + - ".tag": upload_api_rate_limit + upload_api_rate_limit: + ".tag": limit + limit: 25000 + - ".tag": has_team_shared_dropbox + has_team_shared_dropbox: + ".tag": has_team_shared_dropbox + has_team_shared_dropbox: false + items: + $ref: '#/components/schemas/inline_response_200_68_values' + inline_response_200_69: + type: object + properties: + name: + type: string + example: Dropbox Inc. + num_licensed_users: + type: number + example: 5 + num_provisioned_users: + type: number + example: 2 + policies: + $ref: '#/components/schemas/inline_response_200_69_policies' + team_id: + type: string + example: dbtid:1234abcd + inline_response_200_70: + type: object + properties: + admin_profile: + $ref: '#/components/schemas/teammembersget_info_profile' + team_log_get_events_body: + type: object + properties: + category: + type: string + example: groups + limit: + type: number + example: 50 + inline_response_200_71: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + events: + type: array + example: + - actor: + ".tag": user + user: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + assets: + - ".tag": file + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + path: + contextual: /Contract Work/Draft + namespace_relative: + is_shared_namespace: false + ns_id: "1234" + relative_path: /Contract Work/Draft + context: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + details: + ".tag": shared_content_download_details + shared_content_access_level: + ".tag": viewer_no_comment + shared_content_link: abc + shared_content_owner: + ".tag": team_member + account_id: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: John Smith + email: john_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + event_category: + ".tag": tfa + event_type: + ".tag": shared_content_download + description: (sharing) Downloaded shared file/folder + involve_non_team_member: true + origin: + access_method: + ".tag": end_user + end_user: + ".tag": web + session_id: dbwsid:123456789012345678901234567890123456789 + geo_location: + city: San Francisco + country: US + ip_address: 45.56.78.100 + region: California + participants: + - ".tag": user + user: + ".tag": team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + timestamp: 2017-01-25T15:51:30Z + items: + $ref: '#/components/schemas/inline_response_200_71_events' + has_more: + type: boolean + example: false + get_events_continue_body: + type: object + properties: + cursor: + type: string + example: ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu + usersfeaturesget_values_features: + type: object + properties: + ".tag": + type: string + example: paper_as_files + features_get_values_body_1: + type: object + properties: + features: + type: array + example: + - ".tag": paper_as_files + - ".tag": file_locking + items: + $ref: '#/components/schemas/usersfeaturesget_values_features' + inline_response_200_72: + type: object + properties: + values: + type: array + example: + - ".tag": paper_as_files + paper_as_files: + ".tag": enabled + enabled: true + items: + $ref: '#/components/schemas/inline_response_200_72_values' + users_get_account_body: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + inline_response_200_73: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: + type: boolean + example: false + email: + type: string + example: franz@dropbox.com + email_verified: + type: boolean + example: true + is_teammate: + type: boolean + example: false + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + users_get_account_batch_body: + type: object + properties: + account_ids: + type: array + example: + - dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + - dbid:AAH1Vcz-DVoRDeixtr_OA8oUGgiqhs4XPOQ + items: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + inline_response_200_74: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + disabled: + type: boolean + example: false + email: + type: string + example: franz@dropbox.com + email_verified: + type: boolean + example: true + is_teammate: + type: boolean + example: false + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + profile_photo_url: + type: string + example: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + inline_response_200_75: + type: object + properties: + account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + account_type: + $ref: '#/components/schemas/inline_response_200_75_account_type' + country: + type: string + example: US + disabled: + type: boolean + example: false + email: + type: string + example: franz@dropbox.com + email_verified: + type: boolean + example: true + is_paired: + type: boolean + example: true + locale: + type: string + example: en + name: + $ref: '#/components/schemas/teamgroupsget_info_profile_name' + referral_link: + type: string + example: https://db.tt/ZITNuhtI + root_info: + $ref: '#/components/schemas/inline_response_200_75_root_info' + team: + $ref: '#/components/schemas/inline_response_200_75_team' + team_member_id: + type: string + example: dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU + inline_response_200_76: + type: object + properties: + allocation: + $ref: '#/components/schemas/inline_response_200_76_allocation' + used: + type: number + example: 314159265 + inline_response_200_1_matches: + type: object + properties: + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXz + is_deleted: + type: boolean + example: false + path: + type: string + example: /my_awesome/word.docx + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + inline_response_200_3_type: + type: object + properties: + ".tag": + type: string + example: string + inline_response_200_3_fields: + type: object + properties: + description: + type: string + example: |- + This is the security policy of the file or folder described. + Policies can be Confidential, Public or Internal. + name: + type: string + example: Security Policy + type: + $ref: '#/components/schemas/inline_response_200_3_type' + inline_response_200_6_deadline_allow_late_uploads: + type: object + properties: + ".tag": + type: string + example: seven_days + inline_response_200_6_deadline: + type: object + properties: + allow_late_uploads: + $ref: '#/components/schemas/inline_response_200_6_deadline_allow_late_uploads' + deadline: + type: string + example: 2020-10-12T17:00:00Z + inline_response_200_7_file_requests: + type: object + properties: + created: + type: string + example: 2015-10-05T17:00:00Z + deadline: + $ref: '#/components/schemas/inline_response_200_6_deadline' + destination: + type: string + example: /File Requests/Homework + file_count: + type: number + example: 3 + id: + type: string + example: oaCAVmEyrqYnkZX9955Y + is_open: + type: boolean + example: true + title: + type: string + example: Homework submission + url: + type: string + example: https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y + inline_response_200_9_metadata_file_lock_info: + type: object + properties: + created: + type: string + example: 2015-05-12T15:50:38Z + is_lockholder: + type: boolean + example: true + lockholder_name: + type: string + example: Imaginary User + inline_response_200_9_metadata_sharing_info: + type: object + properties: + modified_by: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + parent_shared_folder_id: + type: string + example: "84528192421" + read_only: + type: boolean + example: true + inline_response_200_9_metadata: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + inline_response_200_10_entries: + type: object + properties: + ".tag": + type: string + example: success + success: + $ref: '#/components/schemas/inline_response_200_9_metadata' + inline_response_200_12_metadata_sharing_info: + type: object + properties: + no_access: + type: boolean + example: false + parent_shared_folder_id: + type: string + example: "84528192421" + read_only: + type: boolean + example: false + traverse_only: + type: boolean + example: false + inline_response_200_12_metadata: + type: object + properties: + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXz + name: + type: string + example: math + path_display: + type: string + example: /Homework/math + path_lower: + type: string + example: /homework/math + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + sharing_info: + $ref: '#/components/schemas/inline_response_200_12_metadata_sharing_info' + inline_response_200_13_entries: + type: object + properties: + ".tag": + type: string + example: success + metadata: + $ref: '#/components/schemas/inline_response_200_12_metadata' + inline_response_200_14_entries: + type: object + properties: + ".tag": + type: string + example: success + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + inline_response_200_16_export_metadata: + type: object + properties: + export_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + name: + type: string + example: Prime_Numbers.xlsx + size: + type: number + example: 7189 + inline_response_200_16_file_metadata: + type: object + properties: + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + inline_response_200_17_lock_content: + type: object + properties: + ".tag": + type: string + example: single_user + created: + type: string + example: 2015-05-12T15:50:38Z + lock_holder_account_id: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + lock_holder_team_id: + type: string + example: dbtid:1234abcd + inline_response_200_17_lock: + type: object + properties: + content: + $ref: '#/components/schemas/inline_response_200_17_lock_content' + inline_response_200_17_entries: + type: object + properties: + ".tag": + type: string + example: success + lock: + $ref: '#/components/schemas/inline_response_200_17_lock' + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + inline_response_200_22_entries: + type: object + properties: + ".tag": + type: string + example: success + metadata: + $ref: '#/components/schemas/inline_response_200_16_file_metadata' + thumbnail: + type: string + example: iVBORw0KGgoAAAANSUhEUgAAAdcAAABrCAMAAAI= + inline_response_200_23_sharing_info: + type: object + properties: + modified_by: + type: string + example: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + no_access: + type: boolean + example: false + parent_shared_folder_id: + type: string + example: "84528192421" + read_only: + type: boolean + example: true + traverse_only: + type: boolean + example: false + inline_response_200_23_entries: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_23_sharing_info' + size: + type: number + example: 7212 + inline_response_200_28_metadata: + type: object + properties: + ".tag": + type: string + example: metadata + metadata: + $ref: '#/components/schemas/inline_response_200_9_metadata' + inline_response_200_28_matches: + type: object + properties: + metadata: + $ref: '#/components/schemas/inline_response_200_28_metadata' + inline_response_200_29_entries: + type: object + properties: + ".tag": + type: string + example: success + client_modified: + type: string + example: 2015-05-12T15:50:38Z + content_hash: + type: string + example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + file_lock_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_file_lock_info' + has_explicit_shared_members: + type: boolean + example: false + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + is_downloadable: + type: boolean + example: true + name: + type: string + example: Prime_Numbers.txt + path_display: + type: string + example: /Homework/math/Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + property_groups: + type: array + example: + - fields: + - name: Security Policy + value: Confidential + template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa + items: + $ref: '#/components/schemas/PropertyGroup' + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + sharing_info: + $ref: '#/components/schemas/inline_response_200_9_metadata_sharing_info' + size: + type: number + example: 7212 + inline_response_200_33_access_inheritance: + type: object + properties: + ".tag": + type: string + example: inherit + inline_response_200_33_link_metadata_audience_options: + type: object + properties: + ".tag": + type: string + example: public + inline_response_200_33_link_metadata_action: + type: object + properties: + ".tag": + type: string + example: change_audience + inline_response_200_33_link_metadata_link_permissions: + type: object + properties: + action: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_action' + allow: + type: boolean + example: true + inline_response_200_33_link_metadata: + type: object + properties: + audience_options: + type: array + example: + - ".tag": public + - ".tag": team + - ".tag": members + items: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_audience_options' + current_audience: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_audience_options' + link_permissions: + type: array + example: + - action: + ".tag": change_audience + allow: true + items: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_link_permissions' + password_protected: + type: boolean + example: false + url: + type: string + example: "" + inline_response_200_37_link_permissions_revoke_failure_reason: + type: object + properties: + ".tag": + type: string + example: owner_only + inline_response_200_37_link_permissions: + type: object + properties: + can_revoke: + type: boolean + example: false + resolved_visibility: + $ref: '#/components/schemas/inline_response_200_33_link_metadata_audience_options' + revoke_failure_reason: + $ref: '#/components/schemas/inline_response_200_37_link_permissions_revoke_failure_reason' + inline_response_200_37_team_member_info: + type: object + properties: + display_name: + type: string + example: Roger Rabbit + member_id: + type: string + example: dbmid:abcd1234 + team_info: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + inline_response_200_40_users: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inherited: + type: boolean + example: false + permissions: + type: array + example: [] + items: {} + user: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_user' + inline_response_200_41_entries: + type: object + properties: + access_inheritance: + $ref: '#/components/schemas/inline_response_200_33_access_inheritance' + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_acl_update_policy' + is_inside_team_folder: + type: boolean + example: false + is_team_folder: + type: boolean + example: false + link_metadata: + $ref: '#/components/schemas/inline_response_200_33_link_metadata' + name: + type: string + example: dir + path_lower: + type: string + example: /dir + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fo/fir9vjelf + shared_folder_id: + type: string + example: "84528192421" + time_invited: + type: string + example: 2016-01-20T00:00:00Z + inline_response_200_42_entries: + type: object + properties: + access_type: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_access_type' + id: + type: string + example: id:3kmLmQFnf1AAAAAAAAAAAw + name: + type: string + example: file.txt + owner_display_names: + type: array + example: + - Jane Doe + items: + type: string + example: Jane Doe + owner_team: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_owner_team' + path_display: + type: string + example: /dir/file.txt + path_lower: + type: string + example: /dir/file.txt + permissions: + type: array + example: [] + items: {} + policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy' + preview_url: + type: string + example: https://www.dropbox.com/scl/fi/fir9vjelf + time_invited: + type: string + example: 2016-01-20T00:00:00Z + inline_response_200_43_links: + type: object + properties: + ".tag": + type: string + example: file + client_modified: + type: string + example: 2015-05-12T15:50:38Z + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + link_permissions: + $ref: '#/components/schemas/inline_response_200_37_link_permissions' + name: + type: string + example: Prime_Numbers.txt + path_lower: + type: string + example: /homework/math/prime_numbers.txt + rev: + type: string + example: a1c10ce0dd78 + server_modified: + type: string + example: 2015-05-12T15:50:38Z + size: + type: number + example: 7212 + team_member_info: + $ref: '#/components/schemas/inline_response_200_37_team_member_info' + url: + type: string + example: https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0 + inline_response_200_48_groups: + type: object + properties: + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: Test group + member_count: + type: number + example: 10 + inline_response_200_49_group_info: + type: object + properties: + created: + type: number + example: 1447255518000 + group_id: + type: string + example: g:e2db7665347abcd600000000001a2b3c + group_management_type: + $ref: '#/components/schemas/sharinglist_file_membersbatch_result_members_group_group_management_type' + group_name: + type: string + example: project launch + member_count: + type: number + example: 5 + members: + type: array + example: + - access_type: + ".tag": member + profile: + account_id: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc + email: mary@lamb.com + email_verified: true + joined_on: 2015-05-12T15:50:38Z + membership_type: + ".tag": full + name: + abbreviated_name: FF + display_name: Franz Ferdinand (Personal) + familiar_name: Franz + given_name: Franz + surname: Ferdinand + profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128 + secondary_emails: + - email: apple@orange.com + is_verified: true + - email: banana@honeydew.com + is_verified: true + - email: grape@strawberry.com + is_verified: false + status: + ".tag": active + team_member_id: dbmid:1234567 + items: + $ref: '#/components/schemas/teamgroupsget_info_members' + inline_response_200_51_members: + type: object + properties: + permanently_deleted_users: + type: number + example: 2 + team_member_ids: + type: array + example: + - dbmid:efgh5678 + items: + type: string + example: dbmid:efgh5678 + inline_response_200_52_entries: + type: object + properties: + author_email: + type: string + example: a@a.com + author_member_id: + type: string + example: dbmid:abcd1234abcd1234abcd1234abcd1234a23 + author_member_status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + content_hash: + type: string + example: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 + file_type: + type: string + example: Document + new_filename: + type: string + example: 111_222.pdf + original_file_path: + type: string + example: /a.pdf + original_revision_id: + type: string + example: ab2rij4i5ojgfd + server_modified: + type: string + example: 2019-08-12T12:08:52Z + size: + type: number + example: 3 + inline_response_200_53_policies: + type: object + properties: + activation_time: + type: string + example: 2016-01-20T00:00:10Z + end_date: + type: string + example: 2017-12-31T00:00:00Z + id: + type: string + example: pid_dbhid:abcd1234 + members: + $ref: '#/components/schemas/inline_response_200_51_members' + name: + type: string + example: acme cfo policy + start_date: + type: string + example: 2016-01-01T00:00:00Z + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + inline_response_200_56_complete: + type: object + properties: + ".tag": + type: string + example: success + profile: + $ref: '#/components/schemas/teammembersget_info_profile' + role: + $ref: '#/components/schemas/teammembersget_info_role' + inline_response_200_59_members: + type: object + properties: + profile: + $ref: '#/components/schemas/teammembersget_info_profile' + role: + $ref: '#/components/schemas/teammembersget_info_role' + inline_response_200_60_results: + type: object + properties: + ".tag": + type: string + example: success + success: + $ref: '#/components/schemas/teamgroupsget_info_profile_secondary_emails' + unavailable: + type: string + example: alice@example.com + inline_response_200_60_results_1: + type: object + properties: + ".tag": + type: string + example: success + invalid_user: + $ref: '#/components/schemas/members_send_welcome_email_body' + results: + type: array + example: + - ".tag": success + success: + email: apple@orange.com + is_verified: true + - ".tag": unavailable + unavailable: alice@example.com + items: + $ref: '#/components/schemas/inline_response_200_60_results' + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + inline_response_200_61_results: + type: object + properties: + ".tag": + type: string + example: success + not_found: + type: string + example: alic@example.com + success: + type: string + example: alice@example.com + inline_response_200_61_results_1: + type: object + properties: + ".tag": + type: string + example: success + results: + type: array + example: + - ".tag": success + success: alice@example.com + - ".tag": not_found + not_found: alic@example.com + items: + $ref: '#/components/schemas/inline_response_200_61_results' + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + inline_response_200_62_results: + type: object + properties: + ".tag": + type: string + example: success + success: + type: string + example: alice@example.com + inline_response_200_62_results_1: + type: object + properties: + ".tag": + type: string + example: success + results: + type: array + example: + - ".tag": success + success: alice@example.com + items: + $ref: '#/components/schemas/inline_response_200_62_results' + user: + $ref: '#/components/schemas/members_send_welcome_email_body' + inline_response_200_64_namespace_type: + type: object + properties: + ".tag": + type: string + example: shared_folder + inline_response_200_64_namespaces: + type: object + properties: + name: + type: string + example: Marketing + namespace_id: + type: string + example: "123456789" + namespace_type: + $ref: '#/components/schemas/inline_response_200_64_namespace_type' + team_member_id: + type: string + example: dbmid:1234567 + inline_response_200_65_sync_setting: + type: object + properties: + ".tag": + type: string + example: default + inline_response_200_65_content_sync_settings: + type: object + properties: + id: + type: string + example: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + $ref: '#/components/schemas/inline_response_200_65_sync_setting' + inline_response_200_67_team_folders: + type: object + properties: + content_sync_settings: + type: array + example: + - id: id:a4ayc_80_OEAAAAAAAAAXw + sync_setting: + ".tag": default + items: + $ref: '#/components/schemas/inline_response_200_65_content_sync_settings' + is_team_shared_dropbox: + type: boolean + example: false + name: + type: string + example: Marketing + status: + $ref: '#/components/schemas/teamgroupsget_info_profile_status' + sync_setting: + $ref: '#/components/schemas/inline_response_200_65_sync_setting' + team_folder_id: + type: string + example: "123456789" + inline_response_200_68_has_team_shared_dropbox: + type: object + properties: + ".tag": + type: string + example: has_team_shared_dropbox + has_team_shared_dropbox: + type: boolean + example: false + inline_response_200_68_upload_api_rate_limit: + type: object + properties: + ".tag": + type: string + example: limit + limit: + type: number + example: 25000 + inline_response_200_68_values: + type: object + properties: + ".tag": + type: string + example: upload_api_rate_limit + has_team_shared_dropbox: + $ref: '#/components/schemas/inline_response_200_68_has_team_shared_dropbox' + upload_api_rate_limit: + $ref: '#/components/schemas/inline_response_200_68_upload_api_rate_limit' + inline_response_200_69_policies_emm_state: + type: object + properties: + ".tag": + type: string + example: disabled + inline_response_200_69_policies_sharing_shared_folder_join_policy: + type: object + properties: + ".tag": + type: string + example: from_anyone + inline_response_200_69_policies_sharing_shared_link_create_policy: + type: object + properties: + ".tag": + type: string + example: team_only + inline_response_200_69_policies_sharing: + type: object + properties: + shared_folder_join_policy: + $ref: '#/components/schemas/inline_response_200_69_policies_sharing_shared_folder_join_policy' + shared_folder_member_policy: + $ref: '#/components/schemas/sharingget_file_metadatabatch_result_policy_resolved_member_policy' + shared_link_create_policy: + $ref: '#/components/schemas/inline_response_200_69_policies_sharing_shared_link_create_policy' + inline_response_200_69_policies: + type: object + properties: + emm_state: + $ref: '#/components/schemas/inline_response_200_69_policies_emm_state' + office_addin: + $ref: '#/components/schemas/inline_response_200_69_policies_emm_state' + sharing: + $ref: '#/components/schemas/inline_response_200_69_policies_sharing' + inline_response_200_71_actor_user_team: + type: object + properties: + display_name: + type: string + example: A Team + inline_response_200_71_actor_user: + type: object + properties: + ".tag": + type: string + example: team_member + account_id: + type: string + example: dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho + display_name: + type: string + example: John Smith + email: + type: string + example: john_smith@acmecorp.com + member_external_id: + type: string + example: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224 + team: + $ref: '#/components/schemas/inline_response_200_71_actor_user_team' + team_member_id: + type: string + example: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + inline_response_200_71_actor: + type: object + properties: + ".tag": + type: string + example: user + user: + $ref: '#/components/schemas/inline_response_200_71_actor_user' + inline_response_200_71_path_namespace_relative: + type: object + properties: + is_shared_namespace: + type: boolean + example: false + ns_id: + type: string + example: "1234" + relative_path: + type: string + example: /Contract Work/Draft + inline_response_200_71_path: + type: object + properties: + contextual: + type: string + example: /Contract Work/Draft + namespace_relative: + $ref: '#/components/schemas/inline_response_200_71_path_namespace_relative' + inline_response_200_71_assets: + type: object + properties: + ".tag": + type: string + example: file + display_name: + type: string + example: reports.xls + file_id: + type: string + example: id:jQKLsZFQImAAAAAAEZAAQt + file_size: + type: number + example: 4 + path: + $ref: '#/components/schemas/inline_response_200_71_path' + inline_response_200_71_details_shared_content_access_level: + type: object + properties: + ".tag": + type: string + example: viewer_no_comment + inline_response_200_71_details: + type: object + properties: + ".tag": + type: string + example: shared_content_download_details + shared_content_access_level: + $ref: '#/components/schemas/inline_response_200_71_details_shared_content_access_level' + shared_content_link: + type: string + example: abc + shared_content_owner: + $ref: '#/components/schemas/inline_response_200_71_actor_user' + inline_response_200_71_event_category: + type: object + properties: + ".tag": + type: string + example: tfa + inline_response_200_71_event_type: + type: object + properties: + ".tag": + type: string + example: shared_content_download + description: + type: string + example: (sharing) Downloaded shared file/folder + inline_response_200_71_origin_access_method_end_user: + type: object + properties: + ".tag": + type: string + example: web + session_id: + type: string + example: dbwsid:123456789012345678901234567890123456789 + inline_response_200_71_origin_access_method: + type: object + properties: + ".tag": + type: string + example: end_user + end_user: + $ref: '#/components/schemas/inline_response_200_71_origin_access_method_end_user' + inline_response_200_71_origin_geo_location: + type: object + properties: + city: + type: string + example: San Francisco + country: + type: string + example: US + ip_address: + type: string + example: 45.56.78.100 + region: + type: string + example: California + inline_response_200_71_origin: + type: object + properties: + access_method: + $ref: '#/components/schemas/inline_response_200_71_origin_access_method' + geo_location: + $ref: '#/components/schemas/inline_response_200_71_origin_geo_location' + inline_response_200_71_user: + type: object + properties: + ".tag": + type: string + example: team_member + account_id: + type: string + example: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: + type: string + example: Jane Smith + email: + type: string + example: jane_smith@acmecorp.com + member_external_id: + type: string + example: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + $ref: '#/components/schemas/inline_response_200_71_actor_user_team' + team_member_id: + type: string + example: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + inline_response_200_71_participants: + type: object + properties: + ".tag": + type: string + example: user + user: + $ref: '#/components/schemas/inline_response_200_71_user' + inline_response_200_71_events: + type: object + properties: + actor: + $ref: '#/components/schemas/inline_response_200_71_actor' + assets: + type: array + example: + - ".tag": file + display_name: reports.xls + file_id: id:jQKLsZFQImAAAAAAEZAAQt + file_size: 4 + path: + contextual: /Contract Work/Draft + namespace_relative: + is_shared_namespace: false + ns_id: "1234" + relative_path: /Contract Work/Draft + items: + $ref: '#/components/schemas/inline_response_200_71_assets' + context: + $ref: '#/components/schemas/inline_response_200_71_actor_user' + details: + $ref: '#/components/schemas/inline_response_200_71_details' + event_category: + $ref: '#/components/schemas/inline_response_200_71_event_category' + event_type: + $ref: '#/components/schemas/inline_response_200_71_event_type' + involve_non_team_member: + type: boolean + example: true + origin: + $ref: '#/components/schemas/inline_response_200_71_origin' + participants: + type: array + example: + - ".tag": user + user: + ".tag": team_member + account_id: dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw + display_name: Jane Smith + email: jane_smith@acmecorp.com + member_external_id: ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225 + team: + display_name: A Team + team_member_id: dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q + items: + $ref: '#/components/schemas/inline_response_200_71_participants' + timestamp: + type: string + example: 2017-01-25T15:51:30Z + inline_response_200_72_paper_as_files: + type: object + properties: + ".tag": + type: string + example: enabled + enabled: + type: boolean + example: true + inline_response_200_72_values: + type: object + properties: + ".tag": + type: string + example: paper_as_files + paper_as_files: + $ref: '#/components/schemas/inline_response_200_72_paper_as_files' + inline_response_200_75_account_type: + type: object + properties: + ".tag": + type: string + example: business + inline_response_200_75_root_info: + type: object + properties: + ".tag": + type: string + example: user + home_namespace_id: + type: string + example: "3235641" + root_namespace_id: + type: string + example: "3235641" + inline_response_200_75_team: + type: object + properties: + id: + type: string + example: dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I + name: + type: string + example: "Acme, Inc." + office_addin_policy: + $ref: '#/components/schemas/inline_response_200_69_policies_emm_state' + sharing_policies: + $ref: '#/components/schemas/inline_response_200_69_policies_sharing' + inline_response_200_76_allocation: + type: object + properties: + ".tag": + type: string + example: individual + allocated: + type: number + example: 10000000000 + parameters: + DropboxApiPathRoot: + name: dropbox-api-path-root + in: header + required: false + style: simple + explode: false + schema: + type: string + example: "{\".tag\": \"namespace_id\", \"namespace_id\": \"2\"}" + DropboxApiSelectUser: + name: dropbox-api-select-user + in: header + required: false + style: simple + explode: false + schema: + type: string + example: dbmid:FDFSVF-DFSDF + DropboxApiSelectAdmin: + name: dropbox-api-select-admin + in: header + required: false + style: simple + explode: false + schema: + type: string + example: dbmid:FDFSVF-DFSDF + securitySchemes: + bearerAuth: + type: http + scheme: bearer