dropbox_api 0.1.14 → 0.1.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +0 -1
- data/.yardopts +1 -0
- data/docs/DropboxApi.html +135 -0
- data/docs/DropboxApi/Authenticator.html +217 -0
- data/docs/DropboxApi/ChunkedUploader.html +409 -0
- data/docs/DropboxApi/Client.html +8747 -0
- data/docs/DropboxApi/ConnectionBuilder.html +326 -0
- data/docs/DropboxApi/Endpoints.html +119 -0
- data/docs/DropboxApi/Endpoints/Auth.html +115 -0
- data/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html +265 -0
- data/docs/DropboxApi/Endpoints/Base.html +197 -0
- data/docs/DropboxApi/Endpoints/ContentDownload.html +383 -0
- data/docs/DropboxApi/Endpoints/ContentUpload.html +351 -0
- data/docs/DropboxApi/Endpoints/Files.html +117 -0
- data/docs/DropboxApi/Endpoints/Files/Copy.html +323 -0
- data/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html +304 -0
- data/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html +320 -0
- data/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html +307 -0
- data/docs/DropboxApi/Endpoints/Files/CreateFolder.html +305 -0
- data/docs/DropboxApi/Endpoints/Files/Delete.html +341 -0
- data/docs/DropboxApi/Endpoints/Files/Download.html +284 -0
- data/docs/DropboxApi/Endpoints/Files/GetMetadata.html +376 -0
- data/docs/DropboxApi/Endpoints/Files/GetPreview.html +286 -0
- data/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html +286 -0
- data/docs/DropboxApi/Endpoints/Files/GetThumbnail.html +388 -0
- data/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html +431 -0
- data/docs/DropboxApi/Endpoints/Files/ListFolder.html +383 -0
- data/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html +298 -0
- data/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html +371 -0
- data/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html +360 -0
- data/docs/DropboxApi/Endpoints/Files/ListRevisions.html +338 -0
- data/docs/DropboxApi/Endpoints/Files/Move.html +364 -0
- data/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html +337 -0
- data/docs/DropboxApi/Endpoints/Files/Restore.html +305 -0
- data/docs/DropboxApi/Endpoints/Files/SaveUrl.html +324 -0
- data/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html +306 -0
- data/docs/DropboxApi/Endpoints/Files/Search.html +399 -0
- data/docs/DropboxApi/Endpoints/Files/Upload.html +439 -0
- data/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html +377 -0
- data/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html +328 -0
- data/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html +350 -0
- data/docs/DropboxApi/Endpoints/Rpc.html +353 -0
- data/docs/DropboxApi/Endpoints/RpcContent.html +236 -0
- data/docs/DropboxApi/Endpoints/RpcNotify.html +240 -0
- data/docs/DropboxApi/Endpoints/Sharing.html +117 -0
- data/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html +415 -0
- data/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html +400 -0
- data/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html +322 -0
- data/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html +344 -0
- data/docs/DropboxApi/Endpoints/Sharing/ListFileMembers.html +421 -0
- data/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers.html +400 -0
- data/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks.html +345 -0
- data/docs/DropboxApi/Endpoints/Sharing/ShareFolder.html +428 -0
- data/docs/DropboxApi/Endpoints/Sharing/UnshareFile.html +290 -0
- data/docs/DropboxApi/Endpoints/Users.html +117 -0
- data/docs/DropboxApi/Endpoints/Users/GetAccount.html +301 -0
- data/docs/DropboxApi/Endpoints/Users/GetAccountBatch.html +303 -0
- data/docs/DropboxApi/Endpoints/Users/GetCurrentAccount.html +282 -0
- data/docs/DropboxApi/Endpoints/Users/GetSpaceUsage.html +282 -0
- data/docs/DropboxApi/Errors.html +117 -0
- data/docs/DropboxApi/Errors/AddFileMemberError.html +164 -0
- data/docs/DropboxApi/Errors/AddFolderMemberError.html +170 -0
- data/docs/DropboxApi/Errors/AddMemberSelectorError.html +165 -0
- data/docs/DropboxApi/Errors/AlreadySharedError.html +213 -0
- data/docs/DropboxApi/Errors/BadPathError.html +143 -0
- data/docs/DropboxApi/Errors/BasicError.html +356 -0
- data/docs/DropboxApi/Errors/CantCopySharedFolderError.html +143 -0
- data/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html +143 -0
- data/docs/DropboxApi/Errors/CantNestSharedFolderError.html +143 -0
- data/docs/DropboxApi/Errors/CantShareOutsideTeamError.html +143 -0
- data/docs/DropboxApi/Errors/ContainsSharedFolderError.html +143 -0
- data/docs/DropboxApi/Errors/ConversionError.html +143 -0
- data/docs/DropboxApi/Errors/CreateFileRequestError.html +160 -0
- data/docs/DropboxApi/Errors/CreateFolderError.html +161 -0
- data/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html +165 -0
- data/docs/DropboxApi/Errors/CursorClosedError.html +143 -0
- data/docs/DropboxApi/Errors/CursorNotClosedError.html +143 -0
- data/docs/DropboxApi/Errors/DeleteError.html +162 -0
- data/docs/DropboxApi/Errors/DisallowedNameError.html +143 -0
- data/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html +143 -0
- data/docs/DropboxApi/Errors/DownloadError.html +161 -0
- data/docs/DropboxApi/Errors/DownloadFailedError.html +143 -0
- data/docs/DropboxApi/Errors/EmailUnverifiedError.html +143 -0
- data/docs/DropboxApi/Errors/FileAncestorConflictError.html +143 -0
- data/docs/DropboxApi/Errors/FileConflictError.html +143 -0
- data/docs/DropboxApi/Errors/FileMemberActionError.html +164 -0
- data/docs/DropboxApi/Errors/FolderConflictError.html +143 -0
- data/docs/DropboxApi/Errors/GetAccountError.html +161 -0
- data/docs/DropboxApi/Errors/GetCopyReferenceError.html +161 -0
- data/docs/DropboxApi/Errors/GetMetadataError.html +161 -0
- data/docs/DropboxApi/Errors/GroupDeletedError.html +143 -0
- data/docs/DropboxApi/Errors/GroupNotOnTeamError.html +143 -0
- data/docs/DropboxApi/Errors/HttpError.html +124 -0
- data/docs/DropboxApi/Errors/InProgressError.html +143 -0
- data/docs/DropboxApi/Errors/InsideAppFolderError.html +143 -0
- data/docs/DropboxApi/Errors/InsideOsxPackageError.html +143 -0
- data/docs/DropboxApi/Errors/InsidePublicFolderError.html +143 -0
- data/docs/DropboxApi/Errors/InsideSharedFolderError.html +143 -0
- data/docs/DropboxApi/Errors/InsufficientPlanError.html +143 -0
- data/docs/DropboxApi/Errors/InsufficientSpaceError.html +143 -0
- data/docs/DropboxApi/Errors/InternalError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidCommentError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidCopyReferenceError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidCursorError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidDropboxIdError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidEmailError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidFileError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidIdError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidMemberError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidPathError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidRevisionError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidSettingsError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidUrlError.html +143 -0
- data/docs/DropboxApi/Errors/IsAppFolderError.html +143 -0
- data/docs/DropboxApi/Errors/IsFileError.html +143 -0
- data/docs/DropboxApi/Errors/IsFolderError.html +143 -0
- data/docs/DropboxApi/Errors/IsOsxPackageError.html +143 -0
- data/docs/DropboxApi/Errors/IsPublicFolderError.html +143 -0
- data/docs/DropboxApi/Errors/ListFolderContinueError.html +162 -0
- data/docs/DropboxApi/Errors/ListFolderError.html +161 -0
- data/docs/DropboxApi/Errors/ListFolderLongpollError.html +161 -0
- data/docs/DropboxApi/Errors/ListRevisionsError.html +161 -0
- data/docs/DropboxApi/Errors/ListSharedLinksError.html +162 -0
- data/docs/DropboxApi/Errors/LookupError.html +165 -0
- data/docs/DropboxApi/Errors/MalformedPathError.html +143 -0
- data/docs/DropboxApi/Errors/NoAccountError.html +143 -0
- data/docs/DropboxApi/Errors/NoPermissionError.html +143 -0
- data/docs/DropboxApi/Errors/NoWritePermissionError.html +143 -0
- data/docs/DropboxApi/Errors/NotAMemberError.html +143 -0
- data/docs/DropboxApi/Errors/NotFileError.html +143 -0
- data/docs/DropboxApi/Errors/NotFolderError.html +143 -0
- data/docs/DropboxApi/Errors/NotFoundError.html +143 -0
- data/docs/DropboxApi/Errors/PollError.html +162 -0
- data/docs/DropboxApi/Errors/PreviewError.html +164 -0
- data/docs/DropboxApi/Errors/RateLimitError.html +143 -0
- data/docs/DropboxApi/Errors/RelocationError.html +167 -0
- data/docs/DropboxApi/Errors/RestoreError.html +163 -0
- data/docs/DropboxApi/Errors/RestrictedContentError.html +143 -0
- data/docs/DropboxApi/Errors/SaveCopyReferenceError.html +165 -0
- data/docs/DropboxApi/Errors/SaveUrlError.html +164 -0
- data/docs/DropboxApi/Errors/SearchError.html +161 -0
- data/docs/DropboxApi/Errors/SettingsError.html +162 -0
- data/docs/DropboxApi/Errors/ShareFolderError.html +165 -0
- data/docs/DropboxApi/Errors/SharePathError.html +171 -0
- data/docs/DropboxApi/Errors/SharedFolderAccessError.html +164 -0
- data/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html +143 -0
- data/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html +143 -0
- data/docs/DropboxApi/Errors/SharedLinkError.html +163 -0
- data/docs/DropboxApi/Errors/SharedLinkNotFoundError.html +143 -0
- data/docs/DropboxApi/Errors/SharingFileAccessError.html +165 -0
- data/docs/DropboxApi/Errors/SharingUserError.html +161 -0
- data/docs/DropboxApi/Errors/TeamFolderError.html +143 -0
- data/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html +143 -0
- data/docs/DropboxApi/Errors/ThumbnailBatchError.html +161 -0
- data/docs/DropboxApi/Errors/ThumbnailError.html +164 -0
- data/docs/DropboxApi/Errors/TooManyFilesError.html +143 -0
- data/docs/DropboxApi/Errors/TooManyMembersError.html +143 -0
- data/docs/DropboxApi/Errors/TooManyPendingInvitesError.html +143 -0
- data/docs/DropboxApi/Errors/TooManyRequestsError.html +321 -0
- data/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html +143 -0
- data/docs/DropboxApi/Errors/TooManyWriteOperationsError.html +167 -0
- data/docs/DropboxApi/Errors/UnmountedError.html +143 -0
- data/docs/DropboxApi/Errors/UnshareFileError.html +162 -0
- data/docs/DropboxApi/Errors/UnsupportedContentError.html +143 -0
- data/docs/DropboxApi/Errors/UnsupportedExtensionError.html +143 -0
- data/docs/DropboxApi/Errors/UnsupportedImageError.html +143 -0
- data/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html +143 -0
- data/docs/DropboxApi/Errors/UnverifiedDropboxId.html +143 -0
- data/docs/DropboxApi/Errors/UploadError.html +161 -0
- data/docs/DropboxApi/Errors/UploadSessionFinishError.html +163 -0
- data/docs/DropboxApi/Errors/UploadSessionLookupError.html +164 -0
- data/docs/DropboxApi/Errors/UploadSessionOffsetError.html +220 -0
- data/docs/DropboxApi/Errors/UploadWriteFailedError.html +161 -0
- data/docs/DropboxApi/Errors/WriteConflictError.html +163 -0
- data/docs/DropboxApi/Errors/WriteError.html +165 -0
- data/docs/DropboxApi/Metadata.html +117 -0
- data/docs/DropboxApi/Metadata/AccessLevel.html +259 -0
- data/docs/DropboxApi/Metadata/AddFileMemberResult.html +164 -0
- data/docs/DropboxApi/Metadata/AddMember.html +246 -0
- data/docs/DropboxApi/Metadata/Base.html +545 -0
- data/docs/DropboxApi/Metadata/BasicAccount.html +167 -0
- data/docs/DropboxApi/Metadata/CommitInfo.html +232 -0
- data/docs/DropboxApi/Metadata/Deleted.html +158 -0
- data/docs/DropboxApi/Metadata/Dimensions.html +140 -0
- data/docs/DropboxApi/Metadata/Field.html +358 -0
- data/docs/DropboxApi/Metadata/File.html +238 -0
- data/docs/DropboxApi/Metadata/FileLinkMetadata.html +180 -0
- data/docs/DropboxApi/Metadata/FileMemberAction.html +230 -0
- data/docs/DropboxApi/Metadata/FileRequest.html +167 -0
- data/docs/DropboxApi/Metadata/Folder.html +228 -0
- data/docs/DropboxApi/Metadata/FolderLinkMetadata.html +140 -0
- data/docs/DropboxApi/Metadata/FolderSharingInfo.html +156 -0
- data/docs/DropboxApi/Metadata/LinkPermissions.html +161 -0
- data/docs/DropboxApi/Metadata/Location.html +140 -0
- data/docs/DropboxApi/Metadata/MediaInfo.html +245 -0
- data/docs/DropboxApi/Metadata/MediaMetadata.html +237 -0
- data/docs/DropboxApi/Metadata/Member.html +313 -0
- data/docs/DropboxApi/Metadata/MemberAction.html +274 -0
- data/docs/DropboxApi/Metadata/MemberActionList.html +221 -0
- data/docs/DropboxApi/Metadata/MemberPermission.html +163 -0
- data/docs/DropboxApi/Metadata/MemberPermissionList.html +237 -0
- data/docs/DropboxApi/Metadata/Name.html +158 -0
- data/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html +140 -0
- data/docs/DropboxApi/Metadata/PhotoMetadata.html +164 -0
- data/docs/DropboxApi/Metadata/Resource.html +207 -0
- data/docs/DropboxApi/Metadata/SharedFolder.html +165 -0
- data/docs/DropboxApi/Metadata/SharedFolderPolicy.html +156 -0
- data/docs/DropboxApi/Metadata/SharedLink.html +375 -0
- data/docs/DropboxApi/Metadata/SharedLinkMetadata.html +204 -0
- data/docs/DropboxApi/Metadata/SpaceAllocation.html +156 -0
- data/docs/DropboxApi/Metadata/SpaceUsage.html +159 -0
- data/docs/DropboxApi/Metadata/Tag.html +293 -0
- data/docs/DropboxApi/Metadata/Team.html +140 -0
- data/docs/DropboxApi/Metadata/TeamMemberInfo.html +160 -0
- data/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html +140 -0
- data/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html +221 -0
- data/docs/DropboxApi/Metadata/UploadSessionCursor.html +226 -0
- data/docs/DropboxApi/Metadata/VideoMetadata.html +165 -0
- data/docs/DropboxApi/Metadata/WriteMode.html +439 -0
- data/docs/DropboxApi/MiddleWare.html +117 -0
- data/docs/DropboxApi/MiddleWare/DecodeResult.html +273 -0
- data/docs/DropboxApi/MiddleWare/Stack.html +452 -0
- data/docs/DropboxApi/OptionsValidator.html +234 -0
- data/docs/DropboxApi/ResultBuilder.html +570 -0
- data/docs/DropboxApi/Results.html +119 -0
- data/docs/DropboxApi/Results/AddFileMemberResultList.html +227 -0
- data/docs/DropboxApi/Results/Base.html +206 -0
- data/docs/DropboxApi/Results/BasicAccountBatch.html +205 -0
- data/docs/DropboxApi/Results/GetCopyReferenceResult.html +351 -0
- data/docs/DropboxApi/Results/GetTemporaryLinkResult.html +263 -0
- data/docs/DropboxApi/Results/GetThumbnailBatchResult.html +214 -0
- data/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html +210 -0
- data/docs/DropboxApi/Results/ListFolderLongpollResult.html +287 -0
- data/docs/DropboxApi/Results/ListFolderResult.html +368 -0
- data/docs/DropboxApi/Results/ListRevisionsResult.html +300 -0
- data/docs/DropboxApi/Results/ListSharedLinksResult.html +368 -0
- data/docs/DropboxApi/Results/SaveCopyReferenceResult.html +221 -0
- data/docs/DropboxApi/Results/SaveUrlJobStatus.html +230 -0
- data/docs/DropboxApi/Results/SaveUrlResult.html +227 -0
- data/docs/DropboxApi/Results/Search.html +115 -0
- data/docs/DropboxApi/Results/Search/Match.html +314 -0
- data/docs/DropboxApi/Results/SearchResult.html +368 -0
- data/docs/DropboxApi/Results/ShareFolderLaunch.html +205 -0
- data/docs/DropboxApi/Results/SharedFileMembers.html +369 -0
- data/docs/DropboxApi/Results/SharedFolderMembers.html +369 -0
- data/docs/DropboxApi/Results/UploadSessionStart.html +210 -0
- data/docs/DropboxApi/Results/VoidResult.html +140 -0
- data/docs/DropboxScaffoldBuilder.html +1117 -0
- data/docs/_index.html +1984 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +4 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.README.html +257 -0
- data/docs/file.api_coverage.html +595 -0
- data/docs/file.rails_setup.html +152 -0
- data/docs/file_list.html +66 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +257 -0
- data/docs/js/app.js +292 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1779 -0
- data/docs/top-level-namespace.html +112 -0
- data/lib/dropbox_api/chunked_uploader.rb +1 -0
- data/lib/dropbox_api/version.rb +1 -1
- metadata +264 -2
|
@@ -0,0 +1,257 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.15
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "README";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="file_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index</a> »
|
|
40
|
+
<span class="title">File: README</span>
|
|
41
|
+
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<div id="search">
|
|
45
|
+
|
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
|
47
|
+
href="class_list.html">
|
|
48
|
+
|
|
49
|
+
<svg width="24" height="24">
|
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
</svg>
|
|
54
|
+
</a>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
<div class="clear"></div>
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div id="content"><div id='filecontents'><h1>DropboxApi</h1>
|
|
61
|
+
|
|
62
|
+
<p>Library for communicating with Dropbox API v2.</p>
|
|
63
|
+
|
|
64
|
+
<h2>Installation</h2>
|
|
65
|
+
|
|
66
|
+
<p>Add this line to your application's Gemfile:</p>
|
|
67
|
+
|
|
68
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dropbox_api</span><span class='tstring_end'>'</span></span>
|
|
69
|
+
</code></pre>
|
|
70
|
+
|
|
71
|
+
<p>And then execute:</p>
|
|
72
|
+
|
|
73
|
+
<pre class="code ruby"><code class="ruby">$ bundle
|
|
74
|
+
</code></pre>
|
|
75
|
+
|
|
76
|
+
<p>Or install it yourself as:</p>
|
|
77
|
+
|
|
78
|
+
<pre class="code ruby"><code class="ruby">$ gem install dropbox_api
|
|
79
|
+
</code></pre>
|
|
80
|
+
|
|
81
|
+
<h2>Documentation</h2>
|
|
82
|
+
|
|
83
|
+
<p>Please, refer to this gem's custom <a href="http://jesus.github.io/dropbox_api">Dropbox API
|
|
84
|
+
documentation</a>.
|
|
85
|
+
Most of the time you'll be checking the <a href="http://jesus.github.io/dropbox_api/DropboxApi/Client.html">available
|
|
86
|
+
endpoints</a>.</p>
|
|
87
|
+
|
|
88
|
+
<p>Unfortunately, the documentation at <a href="http://www.rubydoc.info">RubyDoc.info</a> is
|
|
89
|
+
disrecommended because it lacks some nice features that have been added with
|
|
90
|
+
YARD plugins:</p>
|
|
91
|
+
|
|
92
|
+
<ul>
|
|
93
|
+
<li>Each endpoint includes its tests right below the description, this works as
|
|
94
|
+
an example of its usage.</li>
|
|
95
|
+
<li>All endpoints are shown as methods of the <code>Client</code> class, just as you will
|
|
96
|
+
use them.</li>
|
|
97
|
+
</ul>
|
|
98
|
+
|
|
99
|
+
<h2>Basic set up</h2>
|
|
100
|
+
|
|
101
|
+
<h3>Authorize your application</h3>
|
|
102
|
+
|
|
103
|
+
<p>Dropbox uses OAuth, in order to use this library from your application you'll
|
|
104
|
+
have to get an authorization code.</p>
|
|
105
|
+
|
|
106
|
+
<p>Once you have it, just pass it on client initialization:</p>
|
|
107
|
+
|
|
108
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>VofXAX8D...</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
109
|
+
<span class='comment'>#=> #<DropboxApi::Client ...>
|
|
110
|
+
</span></code></pre>
|
|
111
|
+
|
|
112
|
+
<p>Or set it as an ENV variable called <code>DROPBOX_OAUTH_BEARER</code>, for example:</p>
|
|
113
|
+
|
|
114
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DROPBOX_OAUTH_BEARER</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>VofXAX8D...</span><span class='tstring_end'>"</span></span>
|
|
115
|
+
<span class='const'><span class='object_link'><a href="DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
|
|
116
|
+
<span class='comment'>#=> #<DropboxApi::Client ...>
|
|
117
|
+
</span></code></pre>
|
|
118
|
+
|
|
119
|
+
<p>Note that setting an ENV variable is only a feasible choice if you're only
|
|
120
|
+
using one account.</p>
|
|
121
|
+
|
|
122
|
+
<h4>Option A: Get your access token from the website</h4>
|
|
123
|
+
|
|
124
|
+
<p>The easiest way to obtain an access token is to get it from the Dropbox website.
|
|
125
|
+
You just need to log in to Dropbox and refer to the <em>developers</em> section, go to
|
|
126
|
+
<em>My apps</em> and select your application, you may need to create one if you
|
|
127
|
+
haven't done so yet.</p>
|
|
128
|
+
|
|
129
|
+
<p>Under your application settings, find section <em>OAuth 2</em>. You'll find a button
|
|
130
|
+
to generate an access token.</p>
|
|
131
|
+
|
|
132
|
+
<h4>Option B: Use <code>DropboxApi::Authenticator</code></h4>
|
|
133
|
+
|
|
134
|
+
<p>You can obtain an authorization code with this library:</p>
|
|
135
|
+
|
|
136
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_authenticator'>authenticator</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DropboxApi/Authenticator.html" title="DropboxApi::Authenticator (class)">Authenticator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Authenticator.html#initialize-instance_method" title="DropboxApi::Authenticator#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'>CLIENT_ID</span><span class='comma'>,</span> <span class='const'>CLIENT_SECRET</span><span class='rparen'>)</span>
|
|
137
|
+
<span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_authorize_url'>authorize_url</span> <span class='comment'>#=> "https://www.dropbox.com/..."
|
|
138
|
+
</span>
|
|
139
|
+
<span class='comment'># Now you need to open the authorization URL in your browser,
|
|
140
|
+
</span><span class='comment'># authorize the application and copy your code.
|
|
141
|
+
</span>
|
|
142
|
+
<span class='id identifier rubyid_auth_bearer'>auth_bearer</span> <span class='op'>=</span> <span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='const'>CODE</span><span class='rparen'>)</span> <span class='comment'>#=> #<OAuth2::AccessToken ...>`
|
|
143
|
+
</span><span class='id identifier rubyid_auth_bearer'>auth_bearer</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span> <span class='comment'>#=> "VofXAX8D..."
|
|
144
|
+
</span><span class='comment'># Keep this token, you'll need it to initialize a `DropboxApi::Client` object
|
|
145
|
+
</span></code></pre>
|
|
146
|
+
|
|
147
|
+
<h4>Standard OAuth 2 flow</h4>
|
|
148
|
+
|
|
149
|
+
<p>This is what many web applications will use. The process is described in
|
|
150
|
+
Dropbox's <a href="https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web">OAuth guide</a>.</p>
|
|
151
|
+
|
|
152
|
+
<p>If you have a Rails application, you might be interested in this <a href="http://jesus.github.io/dropbox_api/file.rails_setup.html">setup
|
|
153
|
+
guide</a>.</p>
|
|
154
|
+
|
|
155
|
+
<h3>Performing API calls</h3>
|
|
156
|
+
|
|
157
|
+
<p>Once you've initialized a client, for example:</p>
|
|
158
|
+
|
|
159
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>VofXAX8D...</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
160
|
+
<span class='comment'>#=> #<DropboxApi::Client ...>
|
|
161
|
+
</span></code></pre>
|
|
162
|
+
|
|
163
|
+
<p>You can perform an API call like this:</p>
|
|
164
|
+
|
|
165
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sample_folder</span><span class='tstring_end'>"</span></span>
|
|
166
|
+
<span class='comment'>#=> #<DropboxApi::Results::ListFolderResult>
|
|
167
|
+
</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span>
|
|
168
|
+
<span class='comment'>#=> [#<DropboxApi::Metadata::Folder>, #<DropboxApi::Metadata::File>]
|
|
169
|
+
</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_has_more?'>has_more?</span>
|
|
170
|
+
<span class='comment'>#=> false
|
|
171
|
+
</span></code></pre>
|
|
172
|
+
|
|
173
|
+
<p>The instance of <code>Client</code> we've initialized is the one you'll be using to
|
|
174
|
+
perform API calls. You can check the class' documentation to find
|
|
175
|
+
<a href="http://jesus.github.io/dropbox_api/DropboxApi/Client.html">all available endpoints</a>.</p>
|
|
176
|
+
|
|
177
|
+
<h3>Large file uploads</h3>
|
|
178
|
+
|
|
179
|
+
<p>If you need to upload files larger than 150MB the default <code>#upload</code> endpoint
|
|
180
|
+
won't work. Instead, you need to start a upload session and upload
|
|
181
|
+
the file in small chunks.</p>
|
|
182
|
+
|
|
183
|
+
<p>To make this easier, the method <code>upload_by_chunks</code> will handle this for you,
|
|
184
|
+
example:</p>
|
|
185
|
+
|
|
186
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>VofXAX8D...</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
187
|
+
<span class='comment'>#=> #<DropboxApi::Client ...>
|
|
188
|
+
</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>large_file.avi</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span>
|
|
189
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload_by_chunks'>upload_by_chunks</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/remote_path.txt</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_f'>f</span>
|
|
190
|
+
<span class='kw'>end</span>
|
|
191
|
+
</code></pre>
|
|
192
|
+
|
|
193
|
+
<p>Check out the
|
|
194
|
+
<a href="http://www.xuuso.com/dropbox_api/DropboxApi/Client.html#upload_by_chunks-instance_method">method documentation</a>
|
|
195
|
+
to find out all available options.</p>
|
|
196
|
+
|
|
197
|
+
<h2>Dependencies</h2>
|
|
198
|
+
|
|
199
|
+
<p>This gem depends on
|
|
200
|
+
<a href="https://github.com/oauth-xx/oauth2">oauth2</a>
|
|
201
|
+
and
|
|
202
|
+
<a href="https://github.com/lostisland/faraday">faraday</a>.</p>
|
|
203
|
+
|
|
204
|
+
<p>It has official support for Ruby versions <code>1.9.x</code> and <code>2.x</code>.</p>
|
|
205
|
+
|
|
206
|
+
<h2>Development</h2>
|
|
207
|
+
|
|
208
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run
|
|
209
|
+
<code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
|
210
|
+
|
|
211
|
+
<h3>Testing</h3>
|
|
212
|
+
|
|
213
|
+
<p>I recommend you to use a test account other than your main one.</p>
|
|
214
|
+
|
|
215
|
+
<p>We use VCR to record the HTTP calls to Dropbox, however we sometimes need to
|
|
216
|
+
regenerate the cassettes. Let's take <code>list_folder</code> as an example to show what
|
|
217
|
+
would be the procedure to do so:</p>
|
|
218
|
+
|
|
219
|
+
<ol>
|
|
220
|
+
<li><p>Manually delete the existing cassettes in
|
|
221
|
+
<code>spec/fixtures/vcr_cassettes/list_folder/*.yml</code>.</p></li>
|
|
222
|
+
<li><p>Run the task to build the scaffolding in your Dropbox account so the tests
|
|
223
|
+
will pass. If it doesn't exist you may need to write it yourself, check
|
|
224
|
+
the <code>DropboxScaffoldBuilder</code> class to find all existing scaffold builders.</p>
|
|
225
|
+
|
|
226
|
+
<pre class="code text"><code class="text">DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder]
|
|
227
|
+
</code></pre></li>
|
|
228
|
+
<li><p>Run the tests and the cassettes will be written:</p>
|
|
229
|
+
|
|
230
|
+
<pre class="code text"><code class="text">DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec spec/endpoints/files/list_folder_spec.rb
|
|
231
|
+
</code></pre></li>
|
|
232
|
+
</ol>
|
|
233
|
+
|
|
234
|
+
<p>The OAuth bearer shouldn't have been recorded in the cassette and it should've
|
|
235
|
+
been filtered. However, you may want to double check before pushing your
|
|
236
|
+
updates to Github.</p>
|
|
237
|
+
|
|
238
|
+
<p>Tip: You can simply run <code>export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER</code> at
|
|
239
|
+
the beginning of your work session so you don't need to prefix it in every
|
|
240
|
+
command line.</p>
|
|
241
|
+
|
|
242
|
+
<h2>Contributing</h2>
|
|
243
|
+
|
|
244
|
+
<p>Any help will be much appreciated. The easiest way to help is to implement one
|
|
245
|
+
or more of the <a href="http://jesus.github.io/dropbox_api/file.api_coverage.html">endpoints that are still pending</a>. To see how the
|
|
246
|
+
endpoints are implemented, check out the <code>lib/dropbox_api/endpoints</code> folder.</p>
|
|
247
|
+
</div></div>
|
|
248
|
+
|
|
249
|
+
<div id="footer">
|
|
250
|
+
Generated on Mon Nov 12 20:42:55 2018 by
|
|
251
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
252
|
+
0.9.15 (ruby-2.3.3).
|
|
253
|
+
</div>
|
|
254
|
+
|
|
255
|
+
</div>
|
|
256
|
+
</body>
|
|
257
|
+
</html>
|
|
@@ -0,0 +1,595 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
File: API Implementation Coverage
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.15
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "api_coverage";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="file_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index</a> »
|
|
40
|
+
<span class="title">File: API Implementation Coverage</span>
|
|
41
|
+
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<div id="search">
|
|
45
|
+
|
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
|
47
|
+
href="class_list.html">
|
|
48
|
+
|
|
49
|
+
<svg width="24" height="24">
|
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
</svg>
|
|
54
|
+
</a>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
<div class="clear"></div>
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div id="content"><div id='filecontents'><p>The Dropbox API changes frequently, so you may find out that the feature that
|
|
61
|
+
you need is missing. This document indicates what endpoints have been
|
|
62
|
+
implemented.</p>
|
|
63
|
+
|
|
64
|
+
<p>Full moon means fully implemented. Half moon means that the basic functionality
|
|
65
|
+
of the endpoint has been implemented but some options may be missing. Guess
|
|
66
|
+
what new moon means.</p>
|
|
67
|
+
|
|
68
|
+
<h2>File properties</h2>
|
|
69
|
+
|
|
70
|
+
<table><thead>
|
|
71
|
+
<tr>
|
|
72
|
+
<th>API call</th>
|
|
73
|
+
<th style="text-align: center">Status</th>
|
|
74
|
+
</tr>
|
|
75
|
+
</thead><tbody>
|
|
76
|
+
<tr>
|
|
77
|
+
<td><code>/properties/add</code></td>
|
|
78
|
+
<td style="text-align: center">🌑</td>
|
|
79
|
+
</tr>
|
|
80
|
+
<tr>
|
|
81
|
+
<td><code>/properties/overwrite</code></td>
|
|
82
|
+
<td style="text-align: center">🌑</td>
|
|
83
|
+
</tr>
|
|
84
|
+
<tr>
|
|
85
|
+
<td><code>/properties/remove</code></td>
|
|
86
|
+
<td style="text-align: center">🌑</td>
|
|
87
|
+
</tr>
|
|
88
|
+
<tr>
|
|
89
|
+
<td><code>/properties/search</code></td>
|
|
90
|
+
<td style="text-align: center">🌑</td>
|
|
91
|
+
</tr>
|
|
92
|
+
<tr>
|
|
93
|
+
<td><code>/properties/search/continue</code></td>
|
|
94
|
+
<td style="text-align: center">🌑</td>
|
|
95
|
+
</tr>
|
|
96
|
+
<tr>
|
|
97
|
+
<td><code>/properties/update</code></td>
|
|
98
|
+
<td style="text-align: center">🌑</td>
|
|
99
|
+
</tr>
|
|
100
|
+
<tr>
|
|
101
|
+
<td><code>/templates/add_for_user</code></td>
|
|
102
|
+
<td style="text-align: center">🌑</td>
|
|
103
|
+
</tr>
|
|
104
|
+
<tr>
|
|
105
|
+
<td><code>/templates/get_for_user</code></td>
|
|
106
|
+
<td style="text-align: center">🌑</td>
|
|
107
|
+
</tr>
|
|
108
|
+
<tr>
|
|
109
|
+
<td><code>/templates/list_for_user</code></td>
|
|
110
|
+
<td style="text-align: center">🌑</td>
|
|
111
|
+
</tr>
|
|
112
|
+
<tr>
|
|
113
|
+
<td><code>/templates/remove_for_user</code></td>
|
|
114
|
+
<td style="text-align: center">🌑</td>
|
|
115
|
+
</tr>
|
|
116
|
+
<tr>
|
|
117
|
+
<td><code>/templates/update_for_user</code></td>
|
|
118
|
+
<td style="text-align: center">🌑</td>
|
|
119
|
+
</tr>
|
|
120
|
+
</tbody></table>
|
|
121
|
+
|
|
122
|
+
<h2>File requests</h2>
|
|
123
|
+
|
|
124
|
+
<table><thead>
|
|
125
|
+
<tr>
|
|
126
|
+
<th>API call</th>
|
|
127
|
+
<th style="text-align: center">Status</th>
|
|
128
|
+
</tr>
|
|
129
|
+
</thead><tbody>
|
|
130
|
+
<tr>
|
|
131
|
+
<td><code>/create</code></td>
|
|
132
|
+
<td style="text-align: center">🌕</td>
|
|
133
|
+
</tr>
|
|
134
|
+
<tr>
|
|
135
|
+
<td><code>/get</code></td>
|
|
136
|
+
<td style="text-align: center">🌑</td>
|
|
137
|
+
</tr>
|
|
138
|
+
<tr>
|
|
139
|
+
<td><code>/list</code></td>
|
|
140
|
+
<td style="text-align: center">🌑</td>
|
|
141
|
+
</tr>
|
|
142
|
+
<tr>
|
|
143
|
+
<td><code>/update</code></td>
|
|
144
|
+
<td style="text-align: center">🌑</td>
|
|
145
|
+
</tr>
|
|
146
|
+
</tbody></table>
|
|
147
|
+
|
|
148
|
+
<h2>Files</h2>
|
|
149
|
+
|
|
150
|
+
<table><thead>
|
|
151
|
+
<tr>
|
|
152
|
+
<th>API call</th>
|
|
153
|
+
<th style="text-align: center">Status</th>
|
|
154
|
+
</tr>
|
|
155
|
+
</thead><tbody>
|
|
156
|
+
<tr>
|
|
157
|
+
<td><code>/copy</code></td>
|
|
158
|
+
<td style="text-align: center">🌕</td>
|
|
159
|
+
</tr>
|
|
160
|
+
<tr>
|
|
161
|
+
<td><code>/copy_batch</code></td>
|
|
162
|
+
<td style="text-align: center">🌑</td>
|
|
163
|
+
</tr>
|
|
164
|
+
<tr>
|
|
165
|
+
<td><code>/copy_batch/check</code></td>
|
|
166
|
+
<td style="text-align: center">🌑</td>
|
|
167
|
+
</tr>
|
|
168
|
+
<tr>
|
|
169
|
+
<td><code>/copy_reference/get</code></td>
|
|
170
|
+
<td style="text-align: center">🌕</td>
|
|
171
|
+
</tr>
|
|
172
|
+
<tr>
|
|
173
|
+
<td><code>/copy_reference/save</code></td>
|
|
174
|
+
<td style="text-align: center">🌕</td>
|
|
175
|
+
</tr>
|
|
176
|
+
<tr>
|
|
177
|
+
<td><code>/create_folder</code></td>
|
|
178
|
+
<td style="text-align: center">🌕</td>
|
|
179
|
+
</tr>
|
|
180
|
+
<tr>
|
|
181
|
+
<td><code>/create_folder_batch</code></td>
|
|
182
|
+
<td style="text-align: center">🌑</td>
|
|
183
|
+
</tr>
|
|
184
|
+
<tr>
|
|
185
|
+
<td><code>/create_folder_batch/check</code></td>
|
|
186
|
+
<td style="text-align: center">🌑</td>
|
|
187
|
+
</tr>
|
|
188
|
+
<tr>
|
|
189
|
+
<td><code>/delete</code></td>
|
|
190
|
+
<td style="text-align: center">🌕</td>
|
|
191
|
+
</tr>
|
|
192
|
+
<tr>
|
|
193
|
+
<td><code>/delete_batch</code></td>
|
|
194
|
+
<td style="text-align: center">🌑</td>
|
|
195
|
+
</tr>
|
|
196
|
+
<tr>
|
|
197
|
+
<td><code>/delete_batch/check</code></td>
|
|
198
|
+
<td style="text-align: center">🌑</td>
|
|
199
|
+
</tr>
|
|
200
|
+
<tr>
|
|
201
|
+
<td><code>/download</code></td>
|
|
202
|
+
<td style="text-align: center">🌔</td>
|
|
203
|
+
</tr>
|
|
204
|
+
<tr>
|
|
205
|
+
<td><code>/download_zip</code></td>
|
|
206
|
+
<td style="text-align: center">🌑</td>
|
|
207
|
+
</tr>
|
|
208
|
+
<tr>
|
|
209
|
+
<td><code>/get_metadata</code></td>
|
|
210
|
+
<td style="text-align: center">🌕</td>
|
|
211
|
+
</tr>
|
|
212
|
+
<tr>
|
|
213
|
+
<td><code>/get_preview</code></td>
|
|
214
|
+
<td style="text-align: center">🌕</td>
|
|
215
|
+
</tr>
|
|
216
|
+
<tr>
|
|
217
|
+
<td><code>/get_temporary_link</code></td>
|
|
218
|
+
<td style="text-align: center">🌕</td>
|
|
219
|
+
</tr>
|
|
220
|
+
<tr>
|
|
221
|
+
<td><code>/get_temporary_upload_link</code></td>
|
|
222
|
+
<td style="text-align: center">🌑</td>
|
|
223
|
+
</tr>
|
|
224
|
+
<tr>
|
|
225
|
+
<td><code>/get_thumbnail</code></td>
|
|
226
|
+
<td style="text-align: center">🌕</td>
|
|
227
|
+
</tr>
|
|
228
|
+
<tr>
|
|
229
|
+
<td><code>/get_thumbnail_batch</code></td>
|
|
230
|
+
<td style="text-align: center">🌑</td>
|
|
231
|
+
</tr>
|
|
232
|
+
<tr>
|
|
233
|
+
<td><code>/list_folder</code></td>
|
|
234
|
+
<td style="text-align: center">🌕</td>
|
|
235
|
+
</tr>
|
|
236
|
+
<tr>
|
|
237
|
+
<td><code>/list_folder/continue</code></td>
|
|
238
|
+
<td style="text-align: center">🌕</td>
|
|
239
|
+
</tr>
|
|
240
|
+
<tr>
|
|
241
|
+
<td><code>/list_folder/get_latest_cursor</code></td>
|
|
242
|
+
<td style="text-align: center">🌕</td>
|
|
243
|
+
</tr>
|
|
244
|
+
<tr>
|
|
245
|
+
<td><code>/list_folder/longpoll</code></td>
|
|
246
|
+
<td style="text-align: center">🌕</td>
|
|
247
|
+
</tr>
|
|
248
|
+
<tr>
|
|
249
|
+
<td><code>/list_revisions</code></td>
|
|
250
|
+
<td style="text-align: center">🌕</td>
|
|
251
|
+
</tr>
|
|
252
|
+
<tr>
|
|
253
|
+
<td><code>/move</code></td>
|
|
254
|
+
<td style="text-align: center">🌕</td>
|
|
255
|
+
</tr>
|
|
256
|
+
<tr>
|
|
257
|
+
<td><code>/move_batch</code></td>
|
|
258
|
+
<td style="text-align: center">🌑</td>
|
|
259
|
+
</tr>
|
|
260
|
+
<tr>
|
|
261
|
+
<td><code>/move_batch/check</code></td>
|
|
262
|
+
<td style="text-align: center">🌑</td>
|
|
263
|
+
</tr>
|
|
264
|
+
<tr>
|
|
265
|
+
<td><code>/permanently_delete</code></td>
|
|
266
|
+
<td style="text-align: center">🌕</td>
|
|
267
|
+
</tr>
|
|
268
|
+
<tr>
|
|
269
|
+
<td><code>/restore</code></td>
|
|
270
|
+
<td style="text-align: center">🌕</td>
|
|
271
|
+
</tr>
|
|
272
|
+
<tr>
|
|
273
|
+
<td><code>/save_url</code></td>
|
|
274
|
+
<td style="text-align: center">🌕</td>
|
|
275
|
+
</tr>
|
|
276
|
+
<tr>
|
|
277
|
+
<td><code>/save_url/check_job_status</code></td>
|
|
278
|
+
<td style="text-align: center">🌕</td>
|
|
279
|
+
</tr>
|
|
280
|
+
<tr>
|
|
281
|
+
<td><code>/search</code></td>
|
|
282
|
+
<td style="text-align: center">🌔</td>
|
|
283
|
+
</tr>
|
|
284
|
+
<tr>
|
|
285
|
+
<td><code>/upload</code></td>
|
|
286
|
+
<td style="text-align: center">🌕</td>
|
|
287
|
+
</tr>
|
|
288
|
+
<tr>
|
|
289
|
+
<td><code>/upload_session/append</code></td>
|
|
290
|
+
<td style="text-align: center">alias?</td>
|
|
291
|
+
</tr>
|
|
292
|
+
<tr>
|
|
293
|
+
<td><code>/upload_session/append_v2</code></td>
|
|
294
|
+
<td style="text-align: center">🌕</td>
|
|
295
|
+
</tr>
|
|
296
|
+
<tr>
|
|
297
|
+
<td><code>/upload_session/finish</code></td>
|
|
298
|
+
<td style="text-align: center">🌕</td>
|
|
299
|
+
</tr>
|
|
300
|
+
<tr>
|
|
301
|
+
<td><code>/upload_session/finish_batch</code></td>
|
|
302
|
+
<td style="text-align: center">🌑</td>
|
|
303
|
+
</tr>
|
|
304
|
+
<tr>
|
|
305
|
+
<td><code>/upload_session/finish_batch/check</code></td>
|
|
306
|
+
<td style="text-align: center">🌑</td>
|
|
307
|
+
</tr>
|
|
308
|
+
<tr>
|
|
309
|
+
<td><code>/upload_session/start</code></td>
|
|
310
|
+
<td style="text-align: center">🌕</td>
|
|
311
|
+
</tr>
|
|
312
|
+
</tbody></table>
|
|
313
|
+
|
|
314
|
+
<h2>Paper</h2>
|
|
315
|
+
|
|
316
|
+
<table><thead>
|
|
317
|
+
<tr>
|
|
318
|
+
<th>API call</th>
|
|
319
|
+
<th style="text-align: center">Status</th>
|
|
320
|
+
</tr>
|
|
321
|
+
</thead><tbody>
|
|
322
|
+
<tr>
|
|
323
|
+
<td><code>/docs/archive</code></td>
|
|
324
|
+
<td style="text-align: center">🌑</td>
|
|
325
|
+
</tr>
|
|
326
|
+
<tr>
|
|
327
|
+
<td><code>/docs/create</code></td>
|
|
328
|
+
<td style="text-align: center">🌑</td>
|
|
329
|
+
</tr>
|
|
330
|
+
<tr>
|
|
331
|
+
<td><code>/docs/download</code></td>
|
|
332
|
+
<td style="text-align: center">🌑</td>
|
|
333
|
+
</tr>
|
|
334
|
+
<tr>
|
|
335
|
+
<td><code>/docs/folder_users/list</code></td>
|
|
336
|
+
<td style="text-align: center">🌑</td>
|
|
337
|
+
</tr>
|
|
338
|
+
<tr>
|
|
339
|
+
<td><code>/docs/folder_users/list/continue</code></td>
|
|
340
|
+
<td style="text-align: center">🌑</td>
|
|
341
|
+
</tr>
|
|
342
|
+
<tr>
|
|
343
|
+
<td><code>/docs/get_folder_info</code></td>
|
|
344
|
+
<td style="text-align: center">🌑</td>
|
|
345
|
+
</tr>
|
|
346
|
+
<tr>
|
|
347
|
+
<td><code>/docs/list</code></td>
|
|
348
|
+
<td style="text-align: center">🌑</td>
|
|
349
|
+
</tr>
|
|
350
|
+
<tr>
|
|
351
|
+
<td><code>/docs/list/continue</code></td>
|
|
352
|
+
<td style="text-align: center">🌑</td>
|
|
353
|
+
</tr>
|
|
354
|
+
<tr>
|
|
355
|
+
<td><code>/docs/permanently_delete</code></td>
|
|
356
|
+
<td style="text-align: center">🌑</td>
|
|
357
|
+
</tr>
|
|
358
|
+
<tr>
|
|
359
|
+
<td><code>/docs/sharing_policy/get</code></td>
|
|
360
|
+
<td style="text-align: center">🌑</td>
|
|
361
|
+
</tr>
|
|
362
|
+
<tr>
|
|
363
|
+
<td><code>/docs/sharing_policy/set</code></td>
|
|
364
|
+
<td style="text-align: center">🌑</td>
|
|
365
|
+
</tr>
|
|
366
|
+
<tr>
|
|
367
|
+
<td><code>/docs/update</code></td>
|
|
368
|
+
<td style="text-align: center">🌑</td>
|
|
369
|
+
</tr>
|
|
370
|
+
<tr>
|
|
371
|
+
<td><code>/docs/users/add</code></td>
|
|
372
|
+
<td style="text-align: center">🌑</td>
|
|
373
|
+
</tr>
|
|
374
|
+
<tr>
|
|
375
|
+
<td><code>/docs/users/list</code></td>
|
|
376
|
+
<td style="text-align: center">🌑</td>
|
|
377
|
+
</tr>
|
|
378
|
+
<tr>
|
|
379
|
+
<td><code>/docs/users/list/continue</code></td>
|
|
380
|
+
<td style="text-align: center">🌑</td>
|
|
381
|
+
</tr>
|
|
382
|
+
<tr>
|
|
383
|
+
<td><code>/docs/users/remove</code></td>
|
|
384
|
+
<td style="text-align: center">🌑</td>
|
|
385
|
+
</tr>
|
|
386
|
+
</tbody></table>
|
|
387
|
+
|
|
388
|
+
<h2>Sharing</h2>
|
|
389
|
+
|
|
390
|
+
<table><thead>
|
|
391
|
+
<tr>
|
|
392
|
+
<th>API call</th>
|
|
393
|
+
<th style="text-align: center">Status</th>
|
|
394
|
+
</tr>
|
|
395
|
+
</thead><tbody>
|
|
396
|
+
<tr>
|
|
397
|
+
<td><code>/add_file_member</code></td>
|
|
398
|
+
<td style="text-align: center">🌕</td>
|
|
399
|
+
</tr>
|
|
400
|
+
<tr>
|
|
401
|
+
<td><code>/add_folder_member</code></td>
|
|
402
|
+
<td style="text-align: center">🌕</td>
|
|
403
|
+
</tr>
|
|
404
|
+
<tr>
|
|
405
|
+
<td><code>/check_job_status</code></td>
|
|
406
|
+
<td style="text-align: center">🌑</td>
|
|
407
|
+
</tr>
|
|
408
|
+
<tr>
|
|
409
|
+
<td><code>/check_remove_member_job_status</code></td>
|
|
410
|
+
<td style="text-align: center">🌑</td>
|
|
411
|
+
</tr>
|
|
412
|
+
<tr>
|
|
413
|
+
<td><code>/check_share_job_status</code></td>
|
|
414
|
+
<td style="text-align: center">🌑</td>
|
|
415
|
+
</tr>
|
|
416
|
+
<tr>
|
|
417
|
+
<td><code>/create_shared_link_with_settings</code></td>
|
|
418
|
+
<td style="text-align: center">🌓</td>
|
|
419
|
+
</tr>
|
|
420
|
+
<tr>
|
|
421
|
+
<td><code>/get_file_metadata</code></td>
|
|
422
|
+
<td style="text-align: center">🌑</td>
|
|
423
|
+
</tr>
|
|
424
|
+
<tr>
|
|
425
|
+
<td><code>/get_file_metadata/batch</code></td>
|
|
426
|
+
<td style="text-align: center">🌑</td>
|
|
427
|
+
</tr>
|
|
428
|
+
<tr>
|
|
429
|
+
<td><code>/get_folder_metadata</code></td>
|
|
430
|
+
<td style="text-align: center">🌑</td>
|
|
431
|
+
</tr>
|
|
432
|
+
<tr>
|
|
433
|
+
<td><code>/get_shared_link_file</code></td>
|
|
434
|
+
<td style="text-align: center">🌑</td>
|
|
435
|
+
</tr>
|
|
436
|
+
<tr>
|
|
437
|
+
<td><code>/get_shared_link_metadata</code></td>
|
|
438
|
+
<td style="text-align: center">🌔</td>
|
|
439
|
+
</tr>
|
|
440
|
+
<tr>
|
|
441
|
+
<td><code>/list_file_members</code></td>
|
|
442
|
+
<td style="text-align: center">🌕</td>
|
|
443
|
+
</tr>
|
|
444
|
+
<tr>
|
|
445
|
+
<td><code>/list_file_members/batch</code></td>
|
|
446
|
+
<td style="text-align: center">🌑</td>
|
|
447
|
+
</tr>
|
|
448
|
+
<tr>
|
|
449
|
+
<td><code>/list_file_members/continue</code></td>
|
|
450
|
+
<td style="text-align: center">🌑</td>
|
|
451
|
+
</tr>
|
|
452
|
+
<tr>
|
|
453
|
+
<td><code>/list_folder_members</code></td>
|
|
454
|
+
<td style="text-align: center">🌕</td>
|
|
455
|
+
</tr>
|
|
456
|
+
<tr>
|
|
457
|
+
<td><code>/list_folder_members/continue</code></td>
|
|
458
|
+
<td style="text-align: center">🌑</td>
|
|
459
|
+
</tr>
|
|
460
|
+
<tr>
|
|
461
|
+
<td><code>/list_folders</code></td>
|
|
462
|
+
<td style="text-align: center">🌑</td>
|
|
463
|
+
</tr>
|
|
464
|
+
<tr>
|
|
465
|
+
<td><code>/list_folders/continue</code></td>
|
|
466
|
+
<td style="text-align: center">🌑</td>
|
|
467
|
+
</tr>
|
|
468
|
+
<tr>
|
|
469
|
+
<td><code>/list_mountable_folders</code></td>
|
|
470
|
+
<td style="text-align: center">🌑</td>
|
|
471
|
+
</tr>
|
|
472
|
+
<tr>
|
|
473
|
+
<td><code>/list_mountable_folders/continue</code></td>
|
|
474
|
+
<td style="text-align: center">🌑</td>
|
|
475
|
+
</tr>
|
|
476
|
+
<tr>
|
|
477
|
+
<td><code>/list_received_files</code></td>
|
|
478
|
+
<td style="text-align: center">🌑</td>
|
|
479
|
+
</tr>
|
|
480
|
+
<tr>
|
|
481
|
+
<td><code>/list_received_files/continue</code></td>
|
|
482
|
+
<td style="text-align: center">🌑</td>
|
|
483
|
+
</tr>
|
|
484
|
+
<tr>
|
|
485
|
+
<td><code>/list_shared_links</code></td>
|
|
486
|
+
<td style="text-align: center">🌕</td>
|
|
487
|
+
</tr>
|
|
488
|
+
<tr>
|
|
489
|
+
<td><code>/modify_shared_link_settings</code></td>
|
|
490
|
+
<td style="text-align: center">🌑</td>
|
|
491
|
+
</tr>
|
|
492
|
+
<tr>
|
|
493
|
+
<td><code>/mount_folder</code></td>
|
|
494
|
+
<td style="text-align: center">🌑</td>
|
|
495
|
+
</tr>
|
|
496
|
+
<tr>
|
|
497
|
+
<td><code>/relinquish_file_membership</code></td>
|
|
498
|
+
<td style="text-align: center">🌑</td>
|
|
499
|
+
</tr>
|
|
500
|
+
<tr>
|
|
501
|
+
<td><code>/relinquish_folder_membership</code></td>
|
|
502
|
+
<td style="text-align: center">🌑</td>
|
|
503
|
+
</tr>
|
|
504
|
+
<tr>
|
|
505
|
+
<td><code>/remove_file_member_2</code></td>
|
|
506
|
+
<td style="text-align: center">🌑</td>
|
|
507
|
+
</tr>
|
|
508
|
+
<tr>
|
|
509
|
+
<td><code>/remove_folder_member</code></td>
|
|
510
|
+
<td style="text-align: center">🌑</td>
|
|
511
|
+
</tr>
|
|
512
|
+
<tr>
|
|
513
|
+
<td><code>/revoke_shared_link</code></td>
|
|
514
|
+
<td style="text-align: center">🌑</td>
|
|
515
|
+
</tr>
|
|
516
|
+
<tr>
|
|
517
|
+
<td><code>/set_access_inheritance</code></td>
|
|
518
|
+
<td style="text-align: center">🌑</td>
|
|
519
|
+
</tr>
|
|
520
|
+
<tr>
|
|
521
|
+
<td><code>/share_folder</code></td>
|
|
522
|
+
<td style="text-align: center">🌕</td>
|
|
523
|
+
</tr>
|
|
524
|
+
<tr>
|
|
525
|
+
<td><code>/transfer_folder</code></td>
|
|
526
|
+
<td style="text-align: center">🌑</td>
|
|
527
|
+
</tr>
|
|
528
|
+
<tr>
|
|
529
|
+
<td><code>/unmount_folder</code></td>
|
|
530
|
+
<td style="text-align: center">🌑</td>
|
|
531
|
+
</tr>
|
|
532
|
+
<tr>
|
|
533
|
+
<td><code>/unshare_file</code></td>
|
|
534
|
+
<td style="text-align: center">🌕</td>
|
|
535
|
+
</tr>
|
|
536
|
+
<tr>
|
|
537
|
+
<td><code>/unshare_folder</code></td>
|
|
538
|
+
<td style="text-align: center">🌑</td>
|
|
539
|
+
</tr>
|
|
540
|
+
<tr>
|
|
541
|
+
<td><code>/update_file_member</code></td>
|
|
542
|
+
<td style="text-align: center">🌑</td>
|
|
543
|
+
</tr>
|
|
544
|
+
<tr>
|
|
545
|
+
<td><code>/update_folder_member</code></td>
|
|
546
|
+
<td style="text-align: center">🌑</td>
|
|
547
|
+
</tr>
|
|
548
|
+
<tr>
|
|
549
|
+
<td><code>/update_folder_policy</code></td>
|
|
550
|
+
<td style="text-align: center">🌑</td>
|
|
551
|
+
</tr>
|
|
552
|
+
</tbody></table>
|
|
553
|
+
|
|
554
|
+
<h2>Users</h2>
|
|
555
|
+
|
|
556
|
+
<table><thead>
|
|
557
|
+
<tr>
|
|
558
|
+
<th>API call</th>
|
|
559
|
+
<th style="text-align: center">Status</th>
|
|
560
|
+
</tr>
|
|
561
|
+
</thead><tbody>
|
|
562
|
+
<tr>
|
|
563
|
+
<td><code>/get_account</code></td>
|
|
564
|
+
<td style="text-align: center">🌕</td>
|
|
565
|
+
</tr>
|
|
566
|
+
<tr>
|
|
567
|
+
<td><code>/get_account_batch</code></td>
|
|
568
|
+
<td style="text-align: center">🌕</td>
|
|
569
|
+
</tr>
|
|
570
|
+
<tr>
|
|
571
|
+
<td><code>/get_current_account</code></td>
|
|
572
|
+
<td style="text-align: center">🌕</td>
|
|
573
|
+
</tr>
|
|
574
|
+
<tr>
|
|
575
|
+
<td><code>/get_space_usage</code></td>
|
|
576
|
+
<td style="text-align: center">🌕</td>
|
|
577
|
+
</tr>
|
|
578
|
+
</tbody></table>
|
|
579
|
+
|
|
580
|
+
<h2>Dropbox Business API</h2>
|
|
581
|
+
|
|
582
|
+
<p>Unfortunately, none of the Dropbox Business endpoints have been implemented.
|
|
583
|
+
If this is a problem for you, please <a href="https://github.com/Jesus/dropbox_api/issues/new">open an
|
|
584
|
+
issue</a>.</p>
|
|
585
|
+
</div></div>
|
|
586
|
+
|
|
587
|
+
<div id="footer">
|
|
588
|
+
Generated on Mon Nov 12 20:42:55 2018 by
|
|
589
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
590
|
+
0.9.15 (ruby-2.3.3).
|
|
591
|
+
</div>
|
|
592
|
+
|
|
593
|
+
</div>
|
|
594
|
+
</body>
|
|
595
|
+
</html>
|