dropbox_api 0.1.16 → 0.1.19

Sign up to get free protection for your applications and to get access to all the features.
Files changed (487) hide show
  1. checksums.yaml +5 -5
  2. data/.gitignore +1 -0
  3. data/.rubocop.yml +15 -0
  4. data/.travis.yml +0 -2
  5. data/Gemfile +6 -1
  6. data/README.md +7 -2
  7. data/Rakefile +4 -3
  8. data/TODO.md +16 -7
  9. data/api_coverage.md +8 -8
  10. data/bin/console +4 -3
  11. data/docs/DropboxApi/Authenticator.html +3 -3
  12. data/docs/DropboxApi/ChunkedUploader.html +3 -3
  13. data/docs/DropboxApi/Client.html +1541 -182
  14. data/docs/DropboxApi/ConnectionBuilder.html +3 -3
  15. data/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html +3 -3
  16. data/docs/DropboxApi/Endpoints/Auth.html +3 -3
  17. data/docs/DropboxApi/Endpoints/Base.html +3 -3
  18. data/docs/DropboxApi/Endpoints/ContentDownload.html +3 -3
  19. data/docs/DropboxApi/Endpoints/ContentUpload.html +3 -3
  20. data/docs/DropboxApi/Endpoints/Files/Copy.html +3 -3
  21. data/docs/DropboxApi/Endpoints/Files/CopyBatch.html +359 -0
  22. data/docs/DropboxApi/Endpoints/Files/CopyBatchCheck.html +305 -0
  23. data/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html +3 -3
  24. data/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html +3 -3
  25. data/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html +5 -5
  26. data/docs/DropboxApi/Endpoints/Files/CreateFolder.html +3 -3
  27. data/docs/DropboxApi/Endpoints/Files/CreateFolderBatch.html +377 -0
  28. data/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html +308 -0
  29. data/docs/DropboxApi/Endpoints/Files/Delete.html +3 -3
  30. data/docs/DropboxApi/Endpoints/Files/DeleteBatch.html +305 -0
  31. data/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck.html +307 -0
  32. data/docs/DropboxApi/Endpoints/Files/Download.html +3 -3
  33. data/docs/DropboxApi/Endpoints/Files/GetMetadata.html +3 -3
  34. data/docs/DropboxApi/Endpoints/Files/GetPreview.html +3 -3
  35. data/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html +3 -3
  36. data/docs/DropboxApi/Endpoints/Files/GetThumbnail.html +3 -3
  37. data/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html +3 -3
  38. data/docs/DropboxApi/Endpoints/Files/ListFolder.html +30 -11
  39. data/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html +3 -3
  40. data/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html +3 -3
  41. data/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html +3 -3
  42. data/docs/DropboxApi/Endpoints/Files/ListRevisions.html +3 -3
  43. data/docs/DropboxApi/Endpoints/Files/Move.html +3 -3
  44. data/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html +3 -3
  45. data/docs/DropboxApi/Endpoints/Files/Restore.html +3 -3
  46. data/docs/DropboxApi/Endpoints/Files/SaveUrl.html +3 -3
  47. data/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html +3 -3
  48. data/docs/DropboxApi/Endpoints/Files/Search.html +3 -3
  49. data/docs/DropboxApi/Endpoints/Files/Upload.html +4 -4
  50. data/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html +3 -3
  51. data/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html +3 -3
  52. data/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html +3 -3
  53. data/docs/DropboxApi/Endpoints/Files.html +5 -5
  54. data/docs/DropboxApi/Endpoints/Rpc.html +4 -4
  55. data/docs/DropboxApi/Endpoints/RpcContent.html +3 -3
  56. data/docs/DropboxApi/Endpoints/RpcNotify.html +3 -3
  57. data/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html +3 -3
  58. data/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html +3 -3
  59. data/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html +103 -12
  60. data/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html +3 -3
  61. data/docs/DropboxApi/Endpoints/Sharing/ListFileMembers.html +3 -3
  62. data/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers.html +3 -3
  63. data/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks.html +3 -3
  64. data/docs/DropboxApi/Endpoints/Sharing/RevokeSharedLink.html +293 -0
  65. data/docs/DropboxApi/Endpoints/Sharing/ShareFolder.html +3 -3
  66. data/docs/DropboxApi/Endpoints/Sharing/UnshareFile.html +3 -3
  67. data/docs/DropboxApi/Endpoints/Sharing.html +5 -5
  68. data/docs/DropboxApi/Endpoints/Users/GetAccount.html +3 -3
  69. data/docs/DropboxApi/Endpoints/Users/GetAccountBatch.html +3 -3
  70. data/docs/DropboxApi/Endpoints/Users/GetCurrentAccount.html +3 -3
  71. data/docs/DropboxApi/Endpoints/Users/GetSpaceUsage.html +3 -3
  72. data/docs/DropboxApi/Endpoints/Users.html +3 -3
  73. data/docs/DropboxApi/Endpoints.html +3 -3
  74. data/docs/DropboxApi/Errors/AddFileMemberError.html +3 -3
  75. data/docs/DropboxApi/Errors/AddFolderMemberError.html +3 -3
  76. data/docs/DropboxApi/Errors/AddMemberSelectorError.html +3 -3
  77. data/docs/DropboxApi/Errors/AlreadySharedError.html +3 -3
  78. data/docs/DropboxApi/Errors/BadPathError.html +3 -3
  79. data/docs/DropboxApi/Errors/BasicError.html +4 -4
  80. data/docs/DropboxApi/Errors/CantCopySharedFolderError.html +3 -3
  81. data/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html +3 -3
  82. data/docs/DropboxApi/Errors/CantNestSharedFolderError.html +3 -3
  83. data/docs/DropboxApi/Errors/CantShareOutsideTeamError.html +3 -3
  84. data/docs/DropboxApi/Errors/ContainsSharedFolderError.html +3 -3
  85. data/docs/DropboxApi/Errors/ConversionError.html +3 -3
  86. data/docs/DropboxApi/Errors/CreateFileRequestError.html +3 -3
  87. data/docs/DropboxApi/Errors/CreateFolderBatchError.html +161 -0
  88. data/docs/DropboxApi/Errors/CreateFolderError.html +3 -3
  89. data/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html +3 -3
  90. data/docs/DropboxApi/Errors/CursorClosedError.html +3 -3
  91. data/docs/DropboxApi/Errors/CursorNotClosedError.html +3 -3
  92. data/docs/DropboxApi/Errors/DeleteError.html +5 -4
  93. data/docs/DropboxApi/Errors/DisallowedNameError.html +3 -3
  94. data/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html +3 -3
  95. data/docs/DropboxApi/Errors/DownloadError.html +3 -3
  96. data/docs/DropboxApi/Errors/DownloadFailedError.html +3 -3
  97. data/docs/DropboxApi/Errors/EmailUnverifiedError.html +3 -3
  98. data/docs/DropboxApi/Errors/FileAncestorConflictError.html +3 -3
  99. data/docs/DropboxApi/Errors/FileConflictError.html +3 -3
  100. data/docs/DropboxApi/Errors/FileMemberActionError.html +3 -3
  101. data/docs/DropboxApi/Errors/FolderConflictError.html +3 -3
  102. data/docs/DropboxApi/Errors/GetAccountError.html +3 -3
  103. data/docs/DropboxApi/Errors/GetCopyReferenceError.html +3 -3
  104. data/docs/DropboxApi/Errors/GetMetadataError.html +3 -3
  105. data/docs/DropboxApi/Errors/GroupDeletedError.html +3 -3
  106. data/docs/DropboxApi/Errors/GroupNotOnTeamError.html +3 -3
  107. data/docs/DropboxApi/Errors/HttpError.html +3 -3
  108. data/docs/DropboxApi/Errors/InProgressError.html +3 -3
  109. data/docs/DropboxApi/Errors/InsideAppFolderError.html +3 -3
  110. data/docs/DropboxApi/Errors/InsideOsxPackageError.html +3 -3
  111. data/docs/DropboxApi/Errors/InsidePublicFolderError.html +3 -3
  112. data/docs/DropboxApi/Errors/InsideSharedFolderError.html +3 -3
  113. data/docs/DropboxApi/Errors/InsufficientPlanError.html +3 -3
  114. data/docs/DropboxApi/Errors/InsufficientSpaceError.html +3 -3
  115. data/docs/DropboxApi/Errors/InternalError.html +3 -3
  116. data/docs/DropboxApi/Errors/InvalidCommentError.html +3 -3
  117. data/docs/DropboxApi/Errors/InvalidCopyReferenceError.html +3 -3
  118. data/docs/DropboxApi/Errors/InvalidCursorError.html +3 -3
  119. data/docs/DropboxApi/Errors/InvalidDropboxIdError.html +3 -3
  120. data/docs/DropboxApi/Errors/InvalidEmailError.html +3 -3
  121. data/docs/DropboxApi/Errors/InvalidFileError.html +3 -3
  122. data/docs/DropboxApi/Errors/InvalidIdError.html +3 -3
  123. data/docs/DropboxApi/Errors/InvalidMemberError.html +3 -3
  124. data/docs/DropboxApi/Errors/InvalidPathError.html +3 -3
  125. data/docs/DropboxApi/Errors/InvalidRevisionError.html +3 -3
  126. data/docs/DropboxApi/Errors/InvalidSettingsError.html +3 -3
  127. data/docs/DropboxApi/Errors/InvalidUrlError.html +3 -3
  128. data/docs/DropboxApi/Errors/IsAppFolderError.html +3 -3
  129. data/docs/DropboxApi/Errors/IsFileError.html +3 -3
  130. data/docs/DropboxApi/Errors/IsFolderError.html +3 -3
  131. data/docs/DropboxApi/Errors/IsOsxPackageError.html +3 -3
  132. data/docs/DropboxApi/Errors/IsPublicFolderError.html +3 -3
  133. data/docs/DropboxApi/Errors/ListFolderContinueError.html +3 -3
  134. data/docs/DropboxApi/Errors/ListFolderError.html +3 -3
  135. data/docs/DropboxApi/Errors/ListFolderLongpollError.html +3 -3
  136. data/docs/DropboxApi/Errors/ListRevisionsError.html +3 -3
  137. data/docs/DropboxApi/Errors/ListSharedLinksError.html +3 -3
  138. data/docs/DropboxApi/Errors/LookupError.html +3 -3
  139. data/docs/DropboxApi/Errors/MalformedPathError.html +3 -3
  140. data/docs/DropboxApi/Errors/NoAccountError.html +3 -3
  141. data/docs/DropboxApi/Errors/NoPermissionError.html +3 -3
  142. data/docs/DropboxApi/Errors/NoWritePermissionError.html +3 -3
  143. data/docs/DropboxApi/Errors/NotAMemberError.html +3 -3
  144. data/docs/DropboxApi/Errors/NotFileError.html +3 -3
  145. data/docs/DropboxApi/Errors/NotFolderError.html +3 -3
  146. data/docs/DropboxApi/Errors/NotFoundError.html +3 -3
  147. data/docs/DropboxApi/Errors/PollError.html +3 -3
  148. data/docs/DropboxApi/Errors/PreviewError.html +3 -3
  149. data/docs/DropboxApi/Errors/RateLimitError.html +3 -3
  150. data/docs/DropboxApi/Errors/RelocationBatchEntryError.html +163 -0
  151. data/docs/DropboxApi/Errors/RelocationError.html +3 -3
  152. data/docs/DropboxApi/Errors/RestoreError.html +3 -3
  153. data/docs/DropboxApi/Errors/RestrictedContentError.html +3 -3
  154. data/docs/DropboxApi/Errors/RevokeSharedLinkError.html +164 -0
  155. data/docs/DropboxApi/Errors/SaveCopyReferenceError.html +3 -3
  156. data/docs/DropboxApi/Errors/SaveUrlError.html +3 -3
  157. data/docs/DropboxApi/Errors/SearchError.html +3 -3
  158. data/docs/DropboxApi/Errors/SettingsError.html +3 -3
  159. data/docs/DropboxApi/Errors/ShareFolderError.html +3 -3
  160. data/docs/DropboxApi/Errors/SharePathError.html +3 -3
  161. data/docs/DropboxApi/Errors/SharedFolderAccessError.html +3 -3
  162. data/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html +3 -3
  163. data/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html +3 -3
  164. data/docs/DropboxApi/Errors/SharedLinkError.html +3 -3
  165. data/docs/DropboxApi/Errors/SharedLinkMalformedError.html +143 -0
  166. data/docs/DropboxApi/Errors/SharedLinkNotFoundError.html +3 -3
  167. data/docs/DropboxApi/Errors/SharingFileAccessError.html +3 -3
  168. data/docs/DropboxApi/Errors/SharingUserError.html +3 -3
  169. data/docs/DropboxApi/Errors/TeamFolderError.html +3 -3
  170. data/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html +3 -3
  171. data/docs/DropboxApi/Errors/ThumbnailBatchError.html +3 -3
  172. data/docs/DropboxApi/Errors/ThumbnailError.html +3 -3
  173. data/docs/DropboxApi/Errors/TooManyFilesError.html +3 -3
  174. data/docs/DropboxApi/Errors/TooManyMembersError.html +3 -3
  175. data/docs/DropboxApi/Errors/TooManyPendingInvitesError.html +3 -3
  176. data/docs/DropboxApi/Errors/TooManyRequestsError.html +3 -3
  177. data/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html +3 -3
  178. data/docs/DropboxApi/Errors/TooManyWriteOperationsError.html +3 -3
  179. data/docs/DropboxApi/Errors/UnmountedError.html +3 -3
  180. data/docs/DropboxApi/Errors/UnshareFileError.html +3 -3
  181. data/docs/DropboxApi/Errors/UnsupportedContentError.html +3 -3
  182. data/docs/DropboxApi/Errors/UnsupportedExtensionError.html +3 -3
  183. data/docs/DropboxApi/Errors/UnsupportedImageError.html +3 -3
  184. data/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html +3 -3
  185. data/docs/DropboxApi/Errors/UnverifiedDropboxId.html +3 -3
  186. data/docs/DropboxApi/Errors/UploadError.html +3 -3
  187. data/docs/DropboxApi/Errors/UploadSessionFinishError.html +3 -3
  188. data/docs/DropboxApi/Errors/UploadSessionLookupError.html +3 -3
  189. data/docs/DropboxApi/Errors/UploadSessionOffsetError.html +3 -3
  190. data/docs/DropboxApi/Errors/UploadWriteFailedError.html +3 -3
  191. data/docs/DropboxApi/Errors/WriteConflictError.html +3 -3
  192. data/docs/DropboxApi/Errors/WriteError.html +3 -3
  193. data/docs/DropboxApi/Errors.html +5 -5
  194. data/docs/DropboxApi/Metadata/AccessLevel.html +3 -3
  195. data/docs/DropboxApi/Metadata/AddFileMemberResult.html +3 -3
  196. data/docs/DropboxApi/Metadata/AddMember.html +3 -3
  197. data/docs/DropboxApi/Metadata/Base.html +3 -3
  198. data/docs/DropboxApi/Metadata/BasicAccount.html +3 -3
  199. data/docs/DropboxApi/Metadata/CommitInfo.html +3 -3
  200. data/docs/DropboxApi/Metadata/Deleted.html +3 -3
  201. data/docs/DropboxApi/Metadata/Dimensions.html +3 -3
  202. data/docs/DropboxApi/Metadata/Field.html +3 -3
  203. data/docs/DropboxApi/Metadata/File.html +3 -3
  204. data/docs/DropboxApi/Metadata/FileLinkMetadata.html +3 -3
  205. data/docs/DropboxApi/Metadata/FileMemberAction.html +3 -3
  206. data/docs/DropboxApi/Metadata/FileRequest.html +3 -3
  207. data/docs/DropboxApi/Metadata/Folder.html +3 -3
  208. data/docs/DropboxApi/Metadata/FolderLinkMetadata.html +3 -3
  209. data/docs/DropboxApi/Metadata/FolderSharingInfo.html +3 -3
  210. data/docs/DropboxApi/Metadata/LinkPermissions.html +3 -3
  211. data/docs/DropboxApi/Metadata/Location.html +3 -3
  212. data/docs/DropboxApi/Metadata/MediaInfo.html +3 -3
  213. data/docs/DropboxApi/Metadata/MediaMetadata.html +3 -3
  214. data/docs/DropboxApi/Metadata/Member.html +3 -3
  215. data/docs/DropboxApi/Metadata/MemberAction.html +3 -3
  216. data/docs/DropboxApi/Metadata/MemberActionList.html +3 -3
  217. data/docs/DropboxApi/Metadata/MemberPermission.html +3 -3
  218. data/docs/DropboxApi/Metadata/MemberPermissionList.html +3 -3
  219. data/docs/DropboxApi/Metadata/Name.html +3 -3
  220. data/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html +3 -3
  221. data/docs/DropboxApi/Metadata/PhotoMetadata.html +3 -3
  222. data/docs/DropboxApi/Metadata/Resource.html +3 -3
  223. data/docs/DropboxApi/Metadata/SharedFolder.html +3 -3
  224. data/docs/DropboxApi/Metadata/SharedFolderPolicy.html +3 -3
  225. data/docs/DropboxApi/Metadata/SharedLink.html +3 -3
  226. data/docs/DropboxApi/Metadata/SharedLinkMetadata.html +3 -3
  227. data/docs/DropboxApi/Metadata/SpaceAllocation.html +3 -3
  228. data/docs/DropboxApi/Metadata/SpaceUsage.html +3 -3
  229. data/docs/DropboxApi/Metadata/Tag.html +3 -3
  230. data/docs/DropboxApi/Metadata/Team.html +3 -3
  231. data/docs/DropboxApi/Metadata/TeamMemberInfo.html +3 -3
  232. data/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html +3 -3
  233. data/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html +3 -3
  234. data/docs/DropboxApi/Metadata/UploadSessionCursor.html +3 -3
  235. data/docs/DropboxApi/Metadata/VideoMetadata.html +3 -3
  236. data/docs/DropboxApi/Metadata/WriteMode.html +3 -3
  237. data/docs/DropboxApi/Metadata.html +3 -3
  238. data/docs/DropboxApi/MiddleWare/DecodeResult.html +3 -3
  239. data/docs/DropboxApi/MiddleWare/Stack.html +3 -3
  240. data/docs/DropboxApi/MiddleWare.html +3 -3
  241. data/docs/DropboxApi/OptionsValidator.html +4 -4
  242. data/docs/DropboxApi/ResultBuilder.html +3 -3
  243. data/docs/DropboxApi/Results/AddFileMemberResultList.html +3 -3
  244. data/docs/DropboxApi/Results/Base.html +4 -4
  245. data/docs/DropboxApi/Results/BasicAccountBatch.html +3 -3
  246. data/docs/DropboxApi/Results/CopyBatchResult.html +224 -0
  247. data/docs/DropboxApi/Results/CreateFolderBatchResult.html +241 -0
  248. data/docs/DropboxApi/Results/CreateFolderBatchResultEntry.html +234 -0
  249. data/docs/DropboxApi/Results/DeleteBatchResult.html +241 -0
  250. data/docs/DropboxApi/Results/DeleteBatchResultEntry.html +226 -0
  251. data/docs/DropboxApi/Results/GetCopyReferenceResult.html +3 -3
  252. data/docs/DropboxApi/Results/GetTemporaryLinkResult.html +3 -3
  253. data/docs/DropboxApi/Results/GetThumbnailBatchResult.html +3 -3
  254. data/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html +3 -3
  255. data/docs/DropboxApi/Results/ListFolderLongpollResult.html +3 -3
  256. data/docs/DropboxApi/Results/ListFolderResult.html +3 -3
  257. data/docs/DropboxApi/Results/ListRevisionsResult.html +3 -3
  258. data/docs/DropboxApi/Results/ListSharedLinksResult.html +3 -3
  259. data/docs/DropboxApi/Results/RelocationBatchResult.html +241 -0
  260. data/docs/DropboxApi/Results/RelocationBatchResultEntry.html +226 -0
  261. data/docs/DropboxApi/Results/SaveCopyReferenceResult.html +3 -3
  262. data/docs/DropboxApi/Results/SaveUrlJobStatus.html +3 -3
  263. data/docs/DropboxApi/Results/SaveUrlResult.html +3 -3
  264. data/docs/DropboxApi/Results/Search/Match.html +3 -3
  265. data/docs/DropboxApi/Results/Search.html +3 -3
  266. data/docs/DropboxApi/Results/SearchResult.html +3 -3
  267. data/docs/DropboxApi/Results/ShareFolderLaunch.html +3 -3
  268. data/docs/DropboxApi/Results/SharedFileMembers.html +3 -3
  269. data/docs/DropboxApi/Results/SharedFolderMembers.html +3 -3
  270. data/docs/DropboxApi/Results/UploadSessionStart.html +3 -3
  271. data/docs/DropboxApi/Results/VoidResult.html +3 -3
  272. data/docs/DropboxApi/Results.html +5 -5
  273. data/docs/DropboxApi.html +4 -4
  274. data/docs/DropboxScaffoldBuilder.html +105 -50
  275. data/docs/_index.html +140 -14
  276. data/docs/class_list.html +1 -1
  277. data/docs/file.README.html +3 -3
  278. data/docs/file.api_coverage.html +10 -10
  279. data/docs/file.rails_setup.html +3 -3
  280. data/docs/frames.html +1 -1
  281. data/docs/index.html +3 -3
  282. data/docs/js/app.js +11 -0
  283. data/docs/method_list.html +430 -254
  284. data/docs/top-level-namespace.html +3 -3
  285. data/dropbox_api.gemspec +15 -16
  286. data/lib/dropbox_api/authenticator.rb +3 -2
  287. data/lib/dropbox_api/chunked_uploader.rb +2 -1
  288. data/lib/dropbox_api/client.rb +2 -1
  289. data/lib/dropbox_api/connection_builder.rb +1 -0
  290. data/lib/dropbox_api/endpoints/auth/token_revoke.rb +2 -1
  291. data/lib/dropbox_api/endpoints/base.rb +7 -4
  292. data/lib/dropbox_api/endpoints/content_download.rb +4 -6
  293. data/lib/dropbox_api/endpoints/content_upload.rb +2 -1
  294. data/lib/dropbox_api/endpoints/file_requests/create_file_request.rb +2 -1
  295. data/lib/dropbox_api/endpoints/files/copy.rb +4 -3
  296. data/lib/dropbox_api/endpoints/files/copy_batch.rb +36 -0
  297. data/lib/dropbox_api/endpoints/files/copy_batch_check.rb +21 -0
  298. data/lib/dropbox_api/endpoints/files/copy_reference_get.rb +3 -2
  299. data/lib/dropbox_api/endpoints/files/copy_reference_save.rb +4 -3
  300. data/lib/dropbox_api/endpoints/files/create_folder.rb +3 -2
  301. data/lib/dropbox_api/endpoints/files/create_folder_batch.rb +41 -0
  302. data/lib/dropbox_api/endpoints/files/create_folder_batch_check.rb +22 -0
  303. data/lib/dropbox_api/endpoints/files/delete.rb +3 -2
  304. data/lib/dropbox_api/endpoints/files/delete_batch.rb +23 -0
  305. data/lib/dropbox_api/endpoints/files/delete_batch_check.rb +21 -0
  306. data/lib/dropbox_api/endpoints/files/download.rb +3 -2
  307. data/lib/dropbox_api/endpoints/files/get_metadata.rb +3 -2
  308. data/lib/dropbox_api/endpoints/files/get_preview.rb +3 -2
  309. data/lib/dropbox_api/endpoints/files/get_temporary_link.rb +3 -2
  310. data/lib/dropbox_api/endpoints/files/get_thumbnail.rb +3 -2
  311. data/lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb +4 -3
  312. data/lib/dropbox_api/endpoints/files/list_folder.rb +3 -2
  313. data/lib/dropbox_api/endpoints/files/list_folder_continue.rb +3 -2
  314. data/lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb +2 -1
  315. data/lib/dropbox_api/endpoints/files/list_folder_longpoll.rb +3 -2
  316. data/lib/dropbox_api/endpoints/files/list_revisions.rb +3 -2
  317. data/lib/dropbox_api/endpoints/files/move.rb +4 -3
  318. data/lib/dropbox_api/endpoints/files/permanently_delete.rb +3 -2
  319. data/lib/dropbox_api/endpoints/files/restore.rb +4 -3
  320. data/lib/dropbox_api/endpoints/files/save_url.rb +4 -3
  321. data/lib/dropbox_api/endpoints/files/save_url_check_job_status.rb +3 -2
  322. data/lib/dropbox_api/endpoints/files/search.rb +16 -27
  323. data/lib/dropbox_api/endpoints/files/upload.rb +3 -2
  324. data/lib/dropbox_api/endpoints/files/upload_session_append_v2.rb +3 -2
  325. data/lib/dropbox_api/endpoints/files/upload_session_finish.rb +4 -3
  326. data/lib/dropbox_api/endpoints/files/upload_session_start.rb +4 -3
  327. data/lib/dropbox_api/endpoints/rpc.rb +2 -1
  328. data/lib/dropbox_api/endpoints/rpc_content.rb +2 -1
  329. data/lib/dropbox_api/endpoints/rpc_notify.rb +2 -1
  330. data/lib/dropbox_api/endpoints/sharing/add_file_member.rb +4 -3
  331. data/lib/dropbox_api/endpoints/sharing/add_folder_member.rb +4 -3
  332. data/lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb +4 -3
  333. data/lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb +3 -2
  334. data/lib/dropbox_api/endpoints/sharing/list_file_members.rb +4 -3
  335. data/lib/dropbox_api/endpoints/sharing/list_folder_members.rb +4 -3
  336. data/lib/dropbox_api/endpoints/sharing/list_shared_links.rb +2 -1
  337. data/lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb +3 -2
  338. data/lib/dropbox_api/endpoints/sharing/share_folder.rb +3 -2
  339. data/lib/dropbox_api/endpoints/sharing/unshare_file.rb +3 -2
  340. data/lib/dropbox_api/endpoints/users/get_account.rb +3 -2
  341. data/lib/dropbox_api/endpoints/users/get_account_batch.rb +3 -2
  342. data/lib/dropbox_api/endpoints/users/get_current_account.rb +2 -1
  343. data/lib/dropbox_api/endpoints/users/get_space_usage.rb +2 -1
  344. data/lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb +1 -0
  345. data/lib/dropbox_api/errors/add_file_member_error.rb +5 -4
  346. data/lib/dropbox_api/errors/add_folder_member_error.rb +11 -10
  347. data/lib/dropbox_api/errors/add_member_selector_error.rb +6 -5
  348. data/lib/dropbox_api/errors/already_shared_error.rb +1 -0
  349. data/lib/dropbox_api/errors/basic_error.rb +2 -1
  350. data/lib/dropbox_api/errors/create_file_request_error.rb +1 -0
  351. data/lib/dropbox_api/errors/create_folder_batch_error.rb +8 -0
  352. data/lib/dropbox_api/errors/create_folder_error.rb +2 -1
  353. data/lib/dropbox_api/errors/create_shared_link_with_settings_error.rb +6 -5
  354. data/lib/dropbox_api/errors/delete_error.rb +5 -3
  355. data/lib/dropbox_api/errors/download_error.rb +2 -1
  356. data/lib/dropbox_api/errors/file_member_action_error.rb +5 -4
  357. data/lib/dropbox_api/errors/get_account_error.rb +2 -1
  358. data/lib/dropbox_api/errors/get_copy_reference_error.rb +2 -1
  359. data/lib/dropbox_api/errors/get_metadata_error.rb +2 -1
  360. data/lib/dropbox_api/errors/http_error.rb +1 -0
  361. data/lib/dropbox_api/errors/list_folder_continue_error.rb +3 -2
  362. data/lib/dropbox_api/errors/list_folder_error.rb +2 -1
  363. data/lib/dropbox_api/errors/list_folder_longpoll_error.rb +2 -1
  364. data/lib/dropbox_api/errors/list_revisions_error.rb +2 -1
  365. data/lib/dropbox_api/errors/list_shared_links_error.rb +3 -2
  366. data/lib/dropbox_api/errors/lookup_error.rb +6 -5
  367. data/lib/dropbox_api/errors/poll_error.rb +3 -2
  368. data/lib/dropbox_api/errors/preview_error.rb +5 -4
  369. data/lib/dropbox_api/errors/relocation_batch_entry_error.rb +10 -0
  370. data/lib/dropbox_api/errors/relocation_error.rb +8 -7
  371. data/lib/dropbox_api/errors/restore_error.rb +4 -3
  372. data/lib/dropbox_api/errors/revoke_shared_link_error.rb +5 -4
  373. data/lib/dropbox_api/errors/save_copy_reference_error.rb +6 -5
  374. data/lib/dropbox_api/errors/save_url_error.rb +5 -4
  375. data/lib/dropbox_api/errors/search_error.rb +2 -1
  376. data/lib/dropbox_api/errors/settings_error.rb +3 -2
  377. data/lib/dropbox_api/errors/share_folder_error.rb +6 -5
  378. data/lib/dropbox_api/errors/share_path_error.rb +12 -11
  379. data/lib/dropbox_api/errors/shared_folder_access_error.rb +5 -4
  380. data/lib/dropbox_api/errors/shared_link_error.rb +4 -3
  381. data/lib/dropbox_api/errors/sharing_file_access_error.rb +6 -5
  382. data/lib/dropbox_api/errors/sharing_user_error.rb +2 -1
  383. data/lib/dropbox_api/errors/thumbnail_batch_error.rb +2 -1
  384. data/lib/dropbox_api/errors/thumbnail_error.rb +5 -4
  385. data/lib/dropbox_api/errors/too_many_requests_error.rb +3 -2
  386. data/lib/dropbox_api/errors/unshare_file_error.rb +3 -2
  387. data/lib/dropbox_api/errors/upload_error.rb +2 -1
  388. data/lib/dropbox_api/errors/upload_session_finish_error.rb +4 -3
  389. data/lib/dropbox_api/errors/upload_session_lookup_error.rb +5 -4
  390. data/lib/dropbox_api/errors/upload_session_offset_error.rb +1 -0
  391. data/lib/dropbox_api/errors/upload_write_failed_error.rb +2 -1
  392. data/lib/dropbox_api/errors/write_conflict_error.rb +4 -3
  393. data/lib/dropbox_api/errors/write_error.rb +6 -5
  394. data/lib/dropbox_api/metadata/access_level.rb +1 -0
  395. data/lib/dropbox_api/metadata/add_file_member_result.rb +1 -0
  396. data/lib/dropbox_api/metadata/add_member.rb +3 -2
  397. data/lib/dropbox_api/metadata/base.rb +2 -1
  398. data/lib/dropbox_api/metadata/basic_account.rb +1 -0
  399. data/lib/dropbox_api/metadata/commit_info.rb +2 -1
  400. data/lib/dropbox_api/metadata/deleted.rb +1 -0
  401. data/lib/dropbox_api/metadata/dimensions.rb +1 -0
  402. data/lib/dropbox_api/metadata/field.rb +7 -4
  403. data/lib/dropbox_api/metadata/file.rb +2 -1
  404. data/lib/dropbox_api/metadata/file_categories_list.rb +9 -0
  405. data/lib/dropbox_api/metadata/file_category.rb +22 -0
  406. data/lib/dropbox_api/metadata/file_extensions_list.rb +13 -0
  407. data/lib/dropbox_api/metadata/file_link_metadata.rb +1 -0
  408. data/lib/dropbox_api/metadata/file_member_action.rb +2 -1
  409. data/lib/dropbox_api/metadata/file_request.rb +1 -0
  410. data/lib/dropbox_api/metadata/file_status.rb +14 -0
  411. data/lib/dropbox_api/metadata/folder.rb +2 -1
  412. data/lib/dropbox_api/metadata/folder_link_metadata.rb +1 -0
  413. data/lib/dropbox_api/metadata/folder_sharing_info.rb +1 -0
  414. data/lib/dropbox_api/metadata/link_permissions.rb +1 -0
  415. data/lib/dropbox_api/metadata/location.rb +1 -0
  416. data/lib/dropbox_api/metadata/media_info.rb +1 -0
  417. data/lib/dropbox_api/metadata/media_metadata.rb +1 -0
  418. data/lib/dropbox_api/metadata/member.rb +6 -5
  419. data/lib/dropbox_api/metadata/member_action.rb +1 -0
  420. data/lib/dropbox_api/metadata/member_action_list.rb +1 -0
  421. data/lib/dropbox_api/metadata/member_permission.rb +1 -0
  422. data/lib/dropbox_api/metadata/member_permission_list.rb +1 -0
  423. data/lib/dropbox_api/metadata/metadata_v2.rb +7 -0
  424. data/lib/dropbox_api/metadata/name.rb +1 -0
  425. data/lib/dropbox_api/metadata/parent_folder_access_info.rb +1 -0
  426. data/lib/dropbox_api/metadata/photo_metadata.rb +1 -0
  427. data/lib/dropbox_api/metadata/resource.rb +2 -1
  428. data/lib/dropbox_api/metadata/search_match_field_options.rb +9 -0
  429. data/lib/dropbox_api/metadata/search_match_type_v2.rb +16 -0
  430. data/lib/dropbox_api/metadata/search_match_v2.rb +18 -0
  431. data/lib/dropbox_api/metadata/search_options.rb +33 -0
  432. data/lib/dropbox_api/metadata/search_order_by.rb +14 -0
  433. data/lib/dropbox_api/metadata/shared_folder.rb +1 -0
  434. data/lib/dropbox_api/metadata/shared_folder_policy.rb +1 -0
  435. data/lib/dropbox_api/metadata/shared_link.rb +3 -2
  436. data/lib/dropbox_api/metadata/shared_link_metadata.rb +2 -1
  437. data/lib/dropbox_api/metadata/space_allocation.rb +1 -0
  438. data/lib/dropbox_api/metadata/space_usage.rb +1 -0
  439. data/lib/dropbox_api/metadata/tag.rb +2 -1
  440. data/lib/dropbox_api/metadata/team.rb +1 -0
  441. data/lib/dropbox_api/metadata/team_member_info.rb +1 -0
  442. data/lib/dropbox_api/metadata/thumbnail_batch_result_data.rb +1 -0
  443. data/lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb +3 -2
  444. data/lib/dropbox_api/metadata/upload_session_cursor.rb +1 -0
  445. data/lib/dropbox_api/metadata/video_metadata.rb +1 -0
  446. data/lib/dropbox_api/metadata/write_mode.rb +6 -5
  447. data/lib/dropbox_api/middleware/decode_result.rb +3 -2
  448. data/lib/dropbox_api/middleware/stack.rb +1 -0
  449. data/lib/dropbox_api/options_validator.rb +1 -0
  450. data/lib/dropbox_api/result_builder.rb +3 -2
  451. data/lib/dropbox_api/results/add_file_member_result_list.rb +1 -0
  452. data/lib/dropbox_api/results/base.rb +1 -0
  453. data/lib/dropbox_api/results/basic_account_batch.rb +1 -0
  454. data/lib/dropbox_api/results/copy_batch_result.rb +15 -0
  455. data/lib/dropbox_api/results/create_folder_batch_result.rb +21 -0
  456. data/lib/dropbox_api/results/create_folder_batch_result_entry.rb +20 -0
  457. data/lib/dropbox_api/results/delete_batch_result.rb +21 -0
  458. data/lib/dropbox_api/results/delete_batch_result_entry.rb +16 -0
  459. data/lib/dropbox_api/results/get_copy_reference_result.rb +4 -3
  460. data/lib/dropbox_api/results/get_temporary_link_result.rb +3 -2
  461. data/lib/dropbox_api/results/get_thumbnail_batch_result.rb +2 -1
  462. data/lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb +2 -1
  463. data/lib/dropbox_api/results/list_folder_longpoll_result.rb +3 -2
  464. data/lib/dropbox_api/results/list_folder_result.rb +4 -3
  465. data/lib/dropbox_api/results/list_revisions_result.rb +3 -2
  466. data/lib/dropbox_api/results/list_shared_links_result.rb +4 -3
  467. data/lib/dropbox_api/results/relocation_batch_result.rb +21 -0
  468. data/lib/dropbox_api/results/relocation_batch_result_entry.rb +16 -0
  469. data/lib/dropbox_api/results/save_copy_reference_result.rb +2 -1
  470. data/lib/dropbox_api/results/save_url_job_status.rb +7 -6
  471. data/lib/dropbox_api/results/save_url_result.rb +2 -1
  472. data/lib/dropbox_api/results/search/match.rb +3 -2
  473. data/lib/dropbox_api/results/search_v2_result.rb +24 -0
  474. data/lib/dropbox_api/results/share_folder_launch.rb +4 -3
  475. data/lib/dropbox_api/results/shared_file_members.rb +5 -4
  476. data/lib/dropbox_api/results/shared_folder_members.rb +5 -4
  477. data/lib/dropbox_api/results/upload_session_start.rb +2 -1
  478. data/lib/dropbox_api/results/void_result.rb +1 -0
  479. data/lib/dropbox_api/version.rb +2 -1
  480. data/lib/dropbox_api.rb +28 -3
  481. data/yardoc/endpoint_handler.rb +2 -1
  482. data/yardoc/helpers/html_helper.rb +2 -1
  483. data/yardoc/rspec.rb +3 -2
  484. data/yardoc/templates/default/method_details/setup.rb +1 -0
  485. metadata +64 -28
  486. data/CHANGES.md +0 -7
  487. data/lib/dropbox_api/results/search_result.rb +0 -22
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: DropboxApi::Client
8
8
 
9
- &mdash; Documentation by YARD 0.9.15
9
+ &mdash; Documentation by YARD 0.9.19
10
10
 
11
11
  </title>
12
12
 
@@ -306,6 +306,29 @@
306
306
  <span class="summary_desc"><div class='inline'><p>List shared links of this user.</p>
307
307
  </div></span>
308
308
 
309
+ </li>
310
+
311
+
312
+ <li class="public ">
313
+ <span class="summary_signature">
314
+
315
+ <a href="#revoke_shared_link-instance_method" title="#revoke_shared_link (instance method)">#<strong>revoke_shared_link</strong>(url) &#x21d2; Object </a>
316
+
317
+
318
+
319
+ </span>
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+ <span class="summary_desc"><div class='inline'><p>Revoke a shared link.</p>
330
+ </div></span>
331
+
309
332
  </li>
310
333
 
311
334
 
@@ -384,6 +407,52 @@
384
407
  <span class="summary_desc"><div class='inline'><p>Copy a file or folder to a different location in the user&#39;s Dropbox.</p>
385
408
  </div></span>
386
409
 
410
+ </li>
411
+
412
+
413
+ <li class="public ">
414
+ <span class="summary_signature">
415
+
416
+ <a href="#copy_batch-instance_method" title="#copy_batch (instance method)">#<strong>copy_batch</strong>(entries, options = {}) &#x21d2; String, Array </a>
417
+
418
+
419
+
420
+ </span>
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+ <span class="summary_desc"><div class='inline'><p>Copy multiple files or folders to different locations at once in the user&#39;s Dropbox.</p>
431
+ </div></span>
432
+
433
+ </li>
434
+
435
+
436
+ <li class="public ">
437
+ <span class="summary_signature">
438
+
439
+ <a href="#copy_batch_check-instance_method" title="#copy_batch_check (instance method)">#<strong>copy_batch_check</strong>(async_job_id) &#x21d2; :in_progress, Array </a>
440
+
441
+
442
+
443
+ </span>
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+ <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for <span class='object_link'><a href="#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">#copy_batch</a></span>.</p>
454
+ </div></span>
455
+
387
456
  </li>
388
457
 
389
458
 
@@ -476,6 +545,52 @@
476
545
  <span class="summary_desc"><div class='inline'><p>Create a folder at a given path.</p>
477
546
  </div></span>
478
547
 
548
+ </li>
549
+
550
+
551
+ <li class="public ">
552
+ <span class="summary_signature">
553
+
554
+ <a href="#create_folder_batch-instance_method" title="#create_folder_batch (instance method)">#<strong>create_folder_batch</strong>(paths, options = {}) &#x21d2; String, Array </a>
555
+
556
+
557
+
558
+ </span>
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+ <span class="summary_desc"><div class='inline'><p>Create multiple folders at once.</p>
569
+ </div></span>
570
+
571
+ </li>
572
+
573
+
574
+ <li class="public ">
575
+ <span class="summary_signature">
576
+
577
+ <a href="#create_folder_batch_check-instance_method" title="#create_folder_batch_check (instance method)">#<strong>create_folder_batch_check</strong>(async_job_id) &#x21d2; Array </a>
578
+
579
+
580
+
581
+ </span>
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+ <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for create_folder_batch.</p>
592
+ </div></span>
593
+
479
594
  </li>
480
595
 
481
596
 
@@ -499,6 +614,52 @@
499
614
  <span class="summary_desc"><div class='inline'><p>Delete the file or folder at a given path.</p>
500
615
  </div></span>
501
616
 
617
+ </li>
618
+
619
+
620
+ <li class="public ">
621
+ <span class="summary_signature">
622
+
623
+ <a href="#delete_batch-instance_method" title="#delete_batch (instance method)">#<strong>delete_batch</strong>(entries) &#x21d2; String, Array </a>
624
+
625
+
626
+
627
+ </span>
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+ <span class="summary_desc"><div class='inline'><p>Delete multiple files/folders at once.</p>
638
+ </div></span>
639
+
640
+ </li>
641
+
642
+
643
+ <li class="public ">
644
+ <span class="summary_signature">
645
+
646
+ <a href="#delete_batch_check-instance_method" title="#delete_batch_check (instance method)">#<strong>delete_batch_check</strong>(async_job_id) &#x21d2; :in_progress, Array </a>
647
+
648
+
649
+
650
+ </span>
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+ <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for delete_batch.</p>
661
+ </div></span>
662
+
502
663
  </li>
503
664
 
504
665
 
@@ -1425,7 +1586,7 @@ display to added members in their invitation. This field is optional.</p>
1425
1586
  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 33</span>
1426
1587
 
1427
1588
  <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/bsd.pdf</span><span class='tstring_end'>&quot;</span></span>
1428
- <span class='id identifier rubyid_members'>members</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_add_file_member'>add_file_member</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='qwords_beg'>%w(</span><span class='tstring_content'>a@test.com</span><span class='words_sep'> </span><span class='tstring_content'>b@test.com</span><span class='words_sep'>)</span><span class='rparen'>)</span>
1589
+ <span class='id identifier rubyid_members'>members</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_add_file_member'>add_file_member</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='qwords_beg'>%w(</span><span class='tstring_content'>a@test.com</span><span class='words_sep'> </span><span class='tstring_content'>b@test.com</span><span class='tstring_end'>)</span></span><span class='rparen'>)</span>
1429
1590
 
1430
1591
  <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
1431
1592
  <span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</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="Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></span><span class='rparen'>)</span>
@@ -2000,9 +2161,9 @@ If the source path is a folder all its contents will be copied.</p>
2000
2161
  </div>
2001
2162
 
2002
2163
  <div class="method_details ">
2003
- <h3 class="signature " id="copy_reference_get-instance_method">
2164
+ <h3 class="signature " id="copy_batch-instance_method">
2004
2165
 
2005
- #<strong>copy_reference_get</strong>(path) &#x21d2; <tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>
2166
+ #<strong>copy_batch</strong>(entries, options = {}) &#x21d2; <tt>String</tt>, <tt>Array</tt>
2006
2167
 
2007
2168
 
2008
2169
 
@@ -2010,9 +2171,14 @@ If the source path is a folder all its contents will be copied.</p>
2010
2171
 
2011
2172
  </h3><div class="docstring">
2012
2173
  <div class="discussion">
2013
- <p>Get a copy reference to a file or folder.
2014
- This reference string can be used to save that file or folder
2015
- to another user&#39;s Dropbox by passing it to <span class='object_link'><a href="#copy_reference_save-instance_method" title="DropboxApi::Client#copy_reference_save (method)">#copy_reference_save</a></span>.</p>
2174
+ <p>Copy multiple files or folders to different locations at once in the
2175
+ user&#39;s Dropbox.</p>
2176
+
2177
+ <p>This will either finish synchronously, or return a job ID and do
2178
+ the async copy job in background. Please use <span class='object_link'><a href="#copy_batch_check-instance_method" title="DropboxApi::Client#copy_batch_check (method)">#copy_batch_check</a></span>
2179
+ to check the job status.</p>
2180
+
2181
+ <p>Note: No errors are returned by this endpoint.</p>
2016
2182
 
2017
2183
 
2018
2184
  </div>
@@ -2023,53 +2189,379 @@ to another user&#39;s Dropbox by passing it to <span class='object_link'><a href
2023
2189
 
2024
2190
  <li>
2025
2191
 
2026
- <span class='name'>path</span>
2192
+ <span class='name'>entries</span>
2027
2193
 
2028
2194
 
2029
- <span class='type'>(<tt>String</tt>)</span>
2195
+ <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
2030
2196
 
2031
2197
 
2032
2198
 
2033
2199
  &mdash;
2034
- <div class='inline'><p>The path to the file or folder you want to get a
2035
- copy reference to.</p>
2200
+ <div class='inline'><p>List of entries to be moved or copied.
2201
+ Each entry must be a hash with two keys: <code>:from_path</code> &amp; <code>:to_path</code>.</p>
2036
2202
  </div>
2037
2203
 
2038
2204
  </li>
2039
2205
 
2040
2206
  </ul>
2041
2207
 
2208
+
2209
+
2210
+
2211
+
2212
+
2213
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
2214
+ <ul class="option">
2215
+
2216
+ <li>
2217
+ <span class="name">autorename</span>
2218
+ <span class="type">(<tt>Boolean</tt>)</span>
2219
+ <span class="default">
2220
+
2221
+ </span>
2222
+
2223
+ &mdash; <div class='inline'><p>If there&#39;s a conflict with any file,
2224
+ have the Dropbox server try to autorename that file to avoid the
2225
+ conflict. The default for this field is <code>false</code>.</p>
2226
+ </div>
2227
+
2228
+ </li>
2229
+
2230
+ </ul>
2231
+
2232
+
2042
2233
  <p class="tag_title">Returns:</p>
2043
2234
  <ul class="return">
2044
2235
 
2045
2236
  <li>
2046
2237
 
2047
2238
 
2048
- <span class='type'>(<tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>)</span>
2239
+ <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
2240
+
2049
2241
 
2050
2242
 
2243
+ &mdash;
2244
+ <div class='inline'><p>Either the job id or the list of job statuses.</p>
2245
+ </div>
2051
2246
 
2052
2247
  </li>
2053
2248
 
2054
2249
  </ul>
2055
2250
 
2056
2251
  </div>
2252
+ <div class="tags">
2253
+ <p class="tag_title">Specifications:</p>
2254
+ <ul class="specs">
2255
+
2256
+ <li>
2257
+ returns an async job id
2258
+ <table class="source_code test_code">
2259
+ <tr>
2260
+ <td>
2261
+ <pre class="lines">
2262
+
2263
+
2264
+ 7
2265
+ 8
2266
+ 9
2267
+ 10
2268
+ 11
2269
+ 12
2270
+ 13</pre>
2271
+ </td>
2272
+ <td>
2273
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_spec.rb', line 24</span>
2274
+
2275
+ <span class='id identifier rubyid_job_id'>job_id</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch'>copy_batch</span> <span class='lbracket'>[</span><span class='lbrace'>{</span>
2276
+ <span class='symbol'>:from_path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
2277
+ <span class='symbol'>:to_path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_renamed.txt</span><span class='tstring_end'>&quot;</span></span>
2278
+ <span class='rbrace'>}</span><span class='rbracket'>]</span>
2279
+
2280
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_job_id'>job_id</span><span class='rparen'>)</span>
2281
+ <span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dbjid:AAA6b4uwc19nEau5k-OBI_h-hjrR7pNDaUA3_0hOwV-UZ2pkw_zXWp3FSuVZrQ0d9IXKGkwB5JdYI4mJZumLc6qZ</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
2282
+ </td>
2283
+ </tr>
2284
+ </table>
2285
+ </li>
2286
+
2287
+ <li>
2288
+ if autorename option is true, returns an async job id
2289
+ <table class="source_code test_code">
2290
+ <tr>
2291
+ <td>
2292
+ <pre class="lines">
2293
+
2294
+
2295
+ 17
2296
+ 18
2297
+ 19
2298
+ 20
2299
+ 21
2300
+ 22
2301
+ 23</pre>
2302
+ </td>
2303
+ <td>
2304
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_spec.rb', line 24</span>
2305
+
2306
+ <span class='id identifier rubyid_job_id'>job_id</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch'>copy_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='lbrace'>{</span>
2307
+ <span class='symbol'>:from_path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_2.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
2308
+ <span class='symbol'>:to_path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_2_renamed.txt</span><span class='tstring_end'>&quot;</span></span>
2309
+ <span class='rbrace'>}</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:autorename</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='rparen'>)</span>
2310
+
2311
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_job_id'>job_id</span><span class='rparen'>)</span>
2312
+ <span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dbjid:AABe-bOUUq5nrybciMJxIxaGAD16nGCKByGyY3Z_2m6kshGW903XTikVT3_5V6JQQu20p3QxoCfws7_hT40deF6q</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
2313
+ </td>
2314
+ </tr>
2315
+ </table>
2316
+ </li>
2317
+
2318
+ </ul>
2319
+ </div>
2320
+
2057
2321
  <table class="source_code">
2058
2322
  <tr>
2059
2323
  <td>
2060
2324
  <pre class="lines">
2061
2325
 
2062
2326
 
2063
- 15
2064
- 16
2065
- 17
2066
- 18
2067
- 19</pre>
2327
+ 24
2328
+ 25
2329
+ 26
2330
+ 27
2331
+ 28
2332
+ 29
2333
+ 30
2334
+ 31
2335
+ 32
2336
+ 33</pre>
2068
2337
  </td>
2069
2338
  <td>
2070
- <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 15</span>
2339
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch.rb', line 24</span>
2071
2340
 
2072
- <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:copy_reference_get</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='op'>|</span>
2341
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:copy_batch</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
2342
+ <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
2343
+ <span class='symbol'>:autorename</span>
2344
+ <span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
2345
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
2346
+
2347
+ <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
2348
+ <span class='symbol'>:entries</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_entries'>entries</span>
2349
+ <span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
2350
+ <span class='kw'>end</span></pre>
2351
+ </td>
2352
+ </tr>
2353
+ </table>
2354
+ </div>
2355
+
2356
+ <div class="method_details ">
2357
+ <h3 class="signature " id="copy_batch_check-instance_method">
2358
+
2359
+ #<strong>copy_batch_check</strong>(async_job_id) &#x21d2; <tt>:in_progress</tt>, <tt>Array</tt>
2360
+
2361
+
2362
+
2363
+
2364
+
2365
+ </h3><div class="docstring">
2366
+ <div class="discussion">
2367
+ <p>Returns the status of an asynchronous job for <span class='object_link'><a href="#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">#copy_batch</a></span>. It
2368
+ returns a list of results for each entry.</p>
2369
+
2370
+
2371
+ </div>
2372
+ </div>
2373
+ <div class="tags">
2374
+ <p class="tag_title">Parameters:</p>
2375
+ <ul class="param">
2376
+
2377
+ <li>
2378
+
2379
+ <span class='name'>async_job_id</span>
2380
+
2381
+
2382
+ <span class='type'>(<tt>String</tt>)</span>
2383
+
2384
+
2385
+
2386
+ &mdash;
2387
+ <div class='inline'><p>Id of the asynchronous job.
2388
+ This is the value of a response returned from the method that
2389
+ launched the job.</p>
2390
+ </div>
2391
+
2392
+ </li>
2393
+
2394
+ </ul>
2395
+
2396
+ <p class="tag_title">Returns:</p>
2397
+ <ul class="return">
2398
+
2399
+ <li>
2400
+
2401
+
2402
+ <span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
2403
+
2404
+
2405
+
2406
+ &mdash;
2407
+ <div class='inline'><p>This could be either the <code>:in_progress</code>
2408
+ flag or a list of job statuses.</p>
2409
+ </div>
2410
+
2411
+ </li>
2412
+
2413
+ </ul>
2414
+
2415
+ </div>
2416
+ <div class="tags">
2417
+ <p class="tag_title">Specifications:</p>
2418
+ <ul class="specs">
2419
+
2420
+ <li>
2421
+ returns all types of entries
2422
+ <table class="source_code test_code">
2423
+ <tr>
2424
+ <td>
2425
+ <pre class="lines">
2426
+
2427
+
2428
+ 6
2429
+ 7
2430
+ 8
2431
+ 9
2432
+ 10</pre>
2433
+ </td>
2434
+ <td>
2435
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_check_spec.rb', line 16</span>
2436
+
2437
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch_check'>copy_batch_check</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsU</span><span class='tstring_end'>&quot;</span></span>
2438
+
2439
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
2440
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
2441
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span></pre>
2442
+ </td>
2443
+ </tr>
2444
+ </table>
2445
+ </li>
2446
+
2447
+ <li>
2448
+ returns &#39;invalid_async_job_id&#39; error
2449
+ <table class="source_code test_code">
2450
+ <tr>
2451
+ <td>
2452
+ <pre class="lines">
2453
+
2454
+
2455
+ 14
2456
+ 15
2457
+ 16</pre>
2458
+ </td>
2459
+ <td>
2460
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_check_spec.rb', line 16</span>
2461
+
2462
+ <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
2463
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch_check'>copy_batch_check</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsE</span><span class='tstring_end'>&quot;</span></span>
2464
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span></span><span class='rparen'>)</span></pre>
2465
+ </td>
2466
+ </tr>
2467
+ </table>
2468
+ </li>
2469
+
2470
+ </ul>
2471
+ </div>
2472
+
2473
+ <table class="source_code">
2474
+ <tr>
2475
+ <td>
2476
+ <pre class="lines">
2477
+
2478
+
2479
+ 16
2480
+ 17
2481
+ 18</pre>
2482
+ </td>
2483
+ <td>
2484
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 16</span>
2485
+
2486
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:copy_batch_check</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_async_job_id'>async_job_id</span><span class='op'>|</span>
2487
+ <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='symbol'>:async_job_id</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
2488
+ <span class='kw'>end</span></pre>
2489
+ </td>
2490
+ </tr>
2491
+ </table>
2492
+ </div>
2493
+
2494
+ <div class="method_details ">
2495
+ <h3 class="signature " id="copy_reference_get-instance_method">
2496
+
2497
+ #<strong>copy_reference_get</strong>(path) &#x21d2; <tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>
2498
+
2499
+
2500
+
2501
+
2502
+
2503
+ </h3><div class="docstring">
2504
+ <div class="discussion">
2505
+ <p>Get a copy reference to a file or folder.
2506
+ This reference string can be used to save that file or folder
2507
+ to another user&#39;s Dropbox by passing it to <span class='object_link'><a href="#copy_reference_save-instance_method" title="DropboxApi::Client#copy_reference_save (method)">#copy_reference_save</a></span>.</p>
2508
+
2509
+
2510
+ </div>
2511
+ </div>
2512
+ <div class="tags">
2513
+ <p class="tag_title">Parameters:</p>
2514
+ <ul class="param">
2515
+
2516
+ <li>
2517
+
2518
+ <span class='name'>path</span>
2519
+
2520
+
2521
+ <span class='type'>(<tt>String</tt>)</span>
2522
+
2523
+
2524
+
2525
+ &mdash;
2526
+ <div class='inline'><p>The path to the file or folder you want to get a
2527
+ copy reference to.</p>
2528
+ </div>
2529
+
2530
+ </li>
2531
+
2532
+ </ul>
2533
+
2534
+ <p class="tag_title">Returns:</p>
2535
+ <ul class="return">
2536
+
2537
+ <li>
2538
+
2539
+
2540
+ <span class='type'>(<tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>)</span>
2541
+
2542
+
2543
+
2544
+ </li>
2545
+
2546
+ </ul>
2547
+
2548
+ </div>
2549
+ <table class="source_code">
2550
+ <tr>
2551
+ <td>
2552
+ <pre class="lines">
2553
+
2554
+
2555
+ 15
2556
+ 16
2557
+ 17
2558
+ 18
2559
+ 19</pre>
2560
+ </td>
2561
+ <td>
2562
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 15</span>
2563
+
2564
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:copy_reference_get</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='op'>|</span>
2073
2565
  <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
2074
2566
  <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span>
2075
2567
  <span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -2304,8 +2796,8 @@ this will be relative to the app folder.</p>
2304
2796
 
2305
2797
  <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:create_file_request</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_title'>title</span><span class='comma'>,</span> <span class='id identifier rubyid_destination'>destination</span><span class='op'>|</span>
2306
2798
  <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
2307
- <span class='label'>title:</span> <span class='id identifier rubyid_title'>title</span><span class='comma'>,</span>
2308
- <span class='label'>destination:</span> <span class='id identifier rubyid_destination'>destination</span>
2799
+ <span class='symbol'>:title</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_title'>title</span><span class='comma'>,</span>
2800
+ <span class='symbol'>:destination</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_destination'>destination</span>
2309
2801
  <span class='rbrace'>}</span><span class='rparen'>)</span>
2310
2802
  <span class='kw'>end</span></pre>
2311
2803
  </td>
@@ -2473,9 +2965,9 @@ this will be relative to the app folder.</p>
2473
2965
  </div>
2474
2966
 
2475
2967
  <div class="method_details ">
2476
- <h3 class="signature " id="create_shared_link_with_settings-instance_method">
2968
+ <h3 class="signature " id="create_folder_batch-instance_method">
2477
2969
 
2478
- #<strong>create_shared_link_with_settings</strong>(path, settings = {}) &#x21d2; <tt><span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>
2970
+ #<strong>create_folder_batch</strong>(paths, options = {}) &#x21d2; <tt>String</tt>, <tt>Array</tt>
2479
2971
 
2480
2972
 
2481
2973
 
@@ -2483,10 +2975,15 @@ this will be relative to the app folder.</p>
2483
2975
 
2484
2976
  </h3><div class="docstring">
2485
2977
  <div class="discussion">
2486
- <p>Create a shared link with custom settings. If no settings are given then
2487
- the default visibility is :public. (The resolved
2488
- visibility, though, may depend on other aspects such as team and shared
2489
- folder settings).</p>
2978
+ <p>Create multiple folders at once.</p>
2979
+
2980
+ <p>This route is asynchronous for large batches, which returns a job ID
2981
+ immediately and runs the create folder batch asynchronously. Otherwise,
2982
+ creates the folders and returns the result synchronously for smaller
2983
+ inputs. You can force asynchronous behaviour by using the <code>:force_async</code>
2984
+ flag. Use <span class='object_link'><a href="#create_folder_batch_check-instance_method" title="DropboxApi::Client#create_folder_batch_check (method)">#create_folder_batch_check</a></span> to check the job status.</p>
2985
+
2986
+ <p>Note: No errors are returned by this endpoint.</p>
2490
2987
 
2491
2988
 
2492
2989
  </div>
@@ -2497,32 +2994,445 @@ folder settings).</p>
2497
2994
 
2498
2995
  <li>
2499
2996
 
2500
- <span class='name'>path</span>
2997
+ <span class='name'>paths</span>
2501
2998
 
2502
2999
 
2503
- <span class='type'>(<tt>String</tt>)</span>
3000
+ <span class='type'>(<tt>Array</tt>)</span>
2504
3001
 
2505
3002
 
2506
3003
 
2507
3004
  &mdash;
2508
- <div class='inline'><p>The path to be shared by the shared link.</p>
3005
+ <div class='inline'><p>List of paths to be created in the user&#39;s Dropbox.
3006
+ Duplicate path arguments in the batch are considered only once.</p>
2509
3007
  </div>
2510
3008
 
2511
3009
  </li>
2512
3010
 
2513
- <li>
3011
+ </ul>
3012
+
3013
+
3014
+
3015
+
3016
+
3017
+
3018
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
3019
+ <ul class="option">
2514
3020
 
2515
- <span class='name'>settings</span>
3021
+ <li>
3022
+ <span class="name">autorename</span>
3023
+ <span class="type">(<tt>Boolean</tt>)</span>
3024
+ <span class="default">
3025
+
3026
+ </span>
3027
+
3028
+ &mdash; <div class='inline'><p>If there&#39;s a conflict, have the
3029
+ Dropbox server try to autorename the folder to avoid the conflict.
3030
+ The default for this field is <code>false</code>.</p>
3031
+ </div>
3032
+
3033
+ </li>
3034
+
3035
+ <li>
3036
+ <span class="name">force_async</span>
3037
+ <span class="type">(<tt>Boolean</tt>)</span>
3038
+ <span class="default">
3039
+
3040
+ </span>
3041
+
3042
+ &mdash; <div class='inline'><p>Whether to force the create to
3043
+ happen asynchronously. The default for this field is <code>false</code>.</p>
3044
+ </div>
3045
+
3046
+ </li>
2516
3047
 
3048
+ </ul>
3049
+
3050
+
3051
+ <p class="tag_title">Returns:</p>
3052
+ <ul class="return">
3053
+
3054
+ <li>
2517
3055
 
2518
- <span class='type'>(<tt>SharedLinkSettings</tt>)</span>
2519
3056
 
3057
+ <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
2520
3058
 
2521
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2522
3059
 
2523
3060
 
2524
3061
  &mdash;
2525
- <div class='inline'><p>The requested settings for the newly
3062
+ <div class='inline'><p>Either the job id or the list of job statuses.</p>
3063
+ </div>
3064
+
3065
+ </li>
3066
+
3067
+ </ul>
3068
+
3069
+ </div>
3070
+ <div class="tags">
3071
+ <p class="tag_title">Specifications:</p>
3072
+ <ul class="specs">
3073
+
3074
+ <li>
3075
+ returns the created folders synchronously
3076
+ <table class="source_code test_code">
3077
+ <tr>
3078
+ <td>
3079
+ <pre class="lines">
3080
+
3081
+
3082
+ 6
3083
+ 7
3084
+ 8
3085
+ 9</pre>
3086
+ </td>
3087
+ <td>
3088
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
3089
+
3090
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/Create Batch</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/Create Batch 1</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
3091
+
3092
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span>
3093
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span></pre>
3094
+ </td>
3095
+ </tr>
3096
+ </table>
3097
+ </li>
3098
+
3099
+ <li>
3100
+ returns async_job_id when large entries are passed
3101
+ <table class="source_code test_code">
3102
+ <tr>
3103
+ <td>
3104
+ <pre class="lines">
3105
+
3106
+
3107
+ 13
3108
+ 14
3109
+ 15
3110
+ 16
3111
+ 17
3112
+ 18</pre>
3113
+ </td>
3114
+ <td>
3115
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
3116
+
3117
+ <span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
3118
+ <span class='int'>100</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_paths'>paths</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/Folder </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_i'>i</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
3119
+
3120
+ <span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='rparen'>)</span>
3121
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
3122
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_key'>have_key</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
3123
+ </td>
3124
+ </tr>
3125
+ </table>
3126
+ </li>
3127
+
3128
+ <li>
3129
+ returns async_job_id when force_async is true
3130
+ <table class="source_code test_code">
3131
+ <tr>
3132
+ <td>
3133
+ <pre class="lines">
3134
+
3135
+
3136
+ 22
3137
+ 23
3138
+ 24
3139
+ 25</pre>
3140
+ </td>
3141
+ <td>
3142
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
3143
+
3144
+ <span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/Create Batch 2</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/Create Batch 3</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:force_async</span> <span class='op'>=&gt;</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
3145
+
3146
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
3147
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_key'>have_key</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
3148
+ </td>
3149
+ </tr>
3150
+ </table>
3151
+ </li>
3152
+
3153
+ <li>
3154
+ when autorename is true, does not return error for repeated entries
3155
+ <table class="source_code test_code">
3156
+ <tr>
3157
+ <td>
3158
+ <pre class="lines">
3159
+
3160
+
3161
+ 29
3162
+ 30
3163
+ 31</pre>
3164
+ </td>
3165
+ <td>
3166
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
3167
+
3168
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/Create Batch 1</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/Create Batch 1</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:autorename</span> <span class='op'>=&gt;</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
3169
+
3170
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_not_to'>not_to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/FolderConflictError.html" title="DropboxApi::Errors::FolderConflictError (class)">FolderConflictError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span></pre>
3171
+ </td>
3172
+ </tr>
3173
+ </table>
3174
+ </li>
3175
+
3176
+ <li>
3177
+ raises error, when invalid option is passed
3178
+ <table class="source_code test_code">
3179
+ <tr>
3180
+ <td>
3181
+ <pre class="lines">
3182
+
3183
+
3184
+ 35
3185
+ 36
3186
+ 37</pre>
3187
+ </td>
3188
+ <td>
3189
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
3190
+
3191
+ <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
3192
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/Create Batch 4</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/Create Batch 5</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:async</span> <span class='op'>=&gt;</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
3193
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='const'>ArgumentError</span><span class='rparen'>)</span></pre>
3194
+ </td>
3195
+ </tr>
3196
+ </table>
3197
+ </li>
3198
+
3199
+ </ul>
3200
+ </div>
3201
+
3202
+ <table class="source_code">
3203
+ <tr>
3204
+ <td>
3205
+ <pre class="lines">
3206
+
3207
+
3208
+ 27
3209
+ 28
3210
+ 29
3211
+ 30
3212
+ 31
3213
+ 32
3214
+ 33
3215
+ 34
3216
+ 35
3217
+ 36
3218
+ 37
3219
+ 38</pre>
3220
+ </td>
3221
+ <td>
3222
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch.rb', line 27</span>
3223
+
3224
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:create_folder_batch</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_paths'>paths</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
3225
+ <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
3226
+ <span class='symbol'>:autorename</span><span class='comma'>,</span>
3227
+ <span class='symbol'>:force_async</span>
3228
+ <span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
3229
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
3230
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:force_async</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
3231
+
3232
+ <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
3233
+ <span class='symbol'>:paths</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_paths'>paths</span>
3234
+ <span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
3235
+ <span class='kw'>end</span></pre>
3236
+ </td>
3237
+ </tr>
3238
+ </table>
3239
+ </div>
3240
+
3241
+ <div class="method_details ">
3242
+ <h3 class="signature " id="create_folder_batch_check-instance_method">
3243
+
3244
+ #<strong>create_folder_batch_check</strong>(async_job_id) &#x21d2; <tt>Array</tt>
3245
+
3246
+
3247
+
3248
+
3249
+
3250
+ </h3><div class="docstring">
3251
+ <div class="discussion">
3252
+ <p>Returns the status of an asynchronous job for create_folder_batch.
3253
+ If success, it returns list of result for each entry.</p>
3254
+
3255
+
3256
+ </div>
3257
+ </div>
3258
+ <div class="tags">
3259
+ <p class="tag_title">Parameters:</p>
3260
+ <ul class="param">
3261
+
3262
+ <li>
3263
+
3264
+ <span class='name'>async_job_id</span>
3265
+
3266
+
3267
+ <span class='type'>(<tt>String</tt>)</span>
3268
+
3269
+
3270
+
3271
+ &mdash;
3272
+ <div class='inline'><p>Id of the asynchronous job.
3273
+ This is the value of a response returned from the method that launched
3274
+ the job.</p>
3275
+ </div>
3276
+
3277
+ </li>
3278
+
3279
+ </ul>
3280
+
3281
+ <p class="tag_title">Returns:</p>
3282
+ <ul class="return">
3283
+
3284
+ <li>
3285
+
3286
+
3287
+ <span class='type'>(<tt>Array</tt>)</span>
3288
+
3289
+
3290
+
3291
+ &mdash;
3292
+ <div class='inline'><p>A list of one result for each entry.</p>
3293
+ </div>
3294
+
3295
+ </li>
3296
+
3297
+ </ul>
3298
+
3299
+ </div>
3300
+ <div class="tags">
3301
+ <p class="tag_title">Specifications:</p>
3302
+ <ul class="specs">
3303
+
3304
+ <li>
3305
+ returns mixed results with failure and success status for each entry
3306
+ <table class="source_code test_code">
3307
+ <tr>
3308
+ <td>
3309
+ <pre class="lines">
3310
+
3311
+
3312
+ 6
3313
+ 7
3314
+ 8
3315
+ 9
3316
+ 10</pre>
3317
+ </td>
3318
+ <td>
3319
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 15</span>
3320
+
3321
+ <span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch_check'>create_folder_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQE</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
3322
+
3323
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
3324
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/MalformedPathError.html" title="DropboxApi::Errors::MalformedPathError (class)">MalformedPathError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
3325
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/FolderConflictError.html" title="DropboxApi::Errors::FolderConflictError (class)">FolderConflictError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span></pre>
3326
+ </td>
3327
+ </tr>
3328
+ </table>
3329
+ </li>
3330
+
3331
+ <li>
3332
+ raises an error with an invalid async job id
3333
+ <table class="source_code test_code">
3334
+ <tr>
3335
+ <td>
3336
+ <pre class="lines">
3337
+
3338
+
3339
+ 14
3340
+ 15
3341
+ 16</pre>
3342
+ </td>
3343
+ <td>
3344
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 15</span>
3345
+
3346
+ <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
3347
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch_check'>create_folder_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
3348
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span></span><span class='rparen'>)</span></pre>
3349
+ </td>
3350
+ </tr>
3351
+ </table>
3352
+ </li>
3353
+
3354
+ </ul>
3355
+ </div>
3356
+
3357
+ <table class="source_code">
3358
+ <tr>
3359
+ <td>
3360
+ <pre class="lines">
3361
+
3362
+
3363
+ 15
3364
+ 16
3365
+ 17
3366
+ 18
3367
+ 19</pre>
3368
+ </td>
3369
+ <td>
3370
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch_check.rb', line 15</span>
3371
+
3372
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:create_folder_batch_check</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_async_job_id'>async_job_id</span><span class='op'>|</span>
3373
+ <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
3374
+ <span class='symbol'>:async_job_id</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
3375
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
3376
+ <span class='kw'>end</span></pre>
3377
+ </td>
3378
+ </tr>
3379
+ </table>
3380
+ </div>
3381
+
3382
+ <div class="method_details ">
3383
+ <h3 class="signature " id="create_shared_link_with_settings-instance_method">
3384
+
3385
+ #<strong>create_shared_link_with_settings</strong>(path, settings = {}) &#x21d2; <tt><span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>
3386
+
3387
+
3388
+
3389
+
3390
+
3391
+ </h3><div class="docstring">
3392
+ <div class="discussion">
3393
+ <p>Create a shared link with custom settings. If no settings are given then
3394
+ the default visibility is :public. (The resolved
3395
+ visibility, though, may depend on other aspects such as team and shared
3396
+ folder settings).</p>
3397
+
3398
+ <p>NOTE: The <code>settings</code> parameter will only work for pro, business or
3399
+ enterprise accounts. It will return no permission error otherwise.</p>
3400
+
3401
+
3402
+ </div>
3403
+ </div>
3404
+ <div class="tags">
3405
+ <p class="tag_title">Parameters:</p>
3406
+ <ul class="param">
3407
+
3408
+ <li>
3409
+
3410
+ <span class='name'>path</span>
3411
+
3412
+
3413
+ <span class='type'>(<tt>String</tt>)</span>
3414
+
3415
+
3416
+
3417
+ &mdash;
3418
+ <div class='inline'><p>The path to be shared by the shared link.</p>
3419
+ </div>
3420
+
3421
+ </li>
3422
+
3423
+ <li>
3424
+
3425
+ <span class='name'>settings</span>
3426
+
3427
+
3428
+ <span class='type'>(<tt>SharedLinkSettings</tt>)</span>
3429
+
3430
+
3431
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
3432
+
3433
+
3434
+ &mdash;
3435
+ <div class='inline'><p>The requested settings for the newly
2526
3436
  created shared link This field is optional.</p>
2527
3437
  </div>
2528
3438
 
@@ -2530,40 +3440,463 @@ created shared link This field is optional.</p>
2530
3440
 
2531
3441
  </ul>
2532
3442
 
2533
- <p class="tag_title">Returns:</p>
2534
- <ul class="return">
2535
-
2536
- <li>
2537
-
2538
-
2539
- <span class='type'>(<tt><span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>)</span>
2540
-
2541
-
2542
-
2543
- </li>
2544
-
2545
- </ul>
3443
+
3444
+
3445
+
3446
+
3447
+
3448
+ <p class="tag_title">Options Hash (<tt>settings</tt>):</p>
3449
+ <ul class="option">
3450
+
3451
+ <li>
3452
+ <span class="name">requested_visibility</span>
3453
+ <span class="type">(<tt>Object</tt>)</span>
3454
+ <span class="default">
3455
+
3456
+ </span>
3457
+
3458
+ &mdash; <div class='inline'><p>The requested access for this
3459
+ shared link. This field is optional. Must be one of &quot;public&quot;,
3460
+ &quot;team_only&quot; or &quot;password&quot;.</p>
3461
+ </div>
3462
+
3463
+ </li>
3464
+
3465
+ <li>
3466
+ <span class="name">link_password</span>
3467
+ <span class="type">(<tt>Object</tt>)</span>
3468
+ <span class="default">
3469
+
3470
+ </span>
3471
+
3472
+ &mdash; <div class='inline'><p>If requested_visibility is
3473
+ &quot;password&quot; this is needed to specify the password to access the link.
3474
+ This field is optional.</p>
3475
+ </div>
3476
+
3477
+ </li>
3478
+
3479
+ <li>
3480
+ <span class="name">expires</span>
3481
+ <span class="type">(<tt>Object</tt>)</span>
3482
+ <span class="default">
3483
+
3484
+ </span>
3485
+
3486
+ &mdash; <div class='inline'><p>Expiration time of the shared link. By default
3487
+ the link won&#39;t expire. This field is optional.</p>
3488
+ </div>
3489
+
3490
+ </li>
3491
+
3492
+ </ul>
3493
+
3494
+
3495
+ <p class="tag_title">Returns:</p>
3496
+ <ul class="return">
3497
+
3498
+ <li>
3499
+
3500
+
3501
+ <span class='type'>(<tt><span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>)</span>
3502
+
3503
+
3504
+
3505
+ </li>
3506
+
3507
+ </ul>
3508
+
3509
+ </div>
3510
+ <table class="source_code">
3511
+ <tr>
3512
+ <td>
3513
+ <pre class="lines">
3514
+
3515
+
3516
+ 31
3517
+ 32
3518
+ 33
3519
+ 34
3520
+ 35
3521
+ 36
3522
+ 37
3523
+ 38
3524
+ 39
3525
+ 40
3526
+ 41
3527
+ 42
3528
+ 43
3529
+ 44
3530
+ 45</pre>
3531
+ </td>
3532
+ <td>
3533
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 31</span>
3534
+
3535
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:create_shared_link_with_settings</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
3536
+ <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
3537
+ <span class='symbol'>:requested_visibility</span><span class='comma'>,</span>
3538
+ <span class='symbol'>:link_password</span><span class='comma'>,</span>
3539
+ <span class='symbol'>:expires</span>
3540
+ <span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
3541
+ <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:requested_visibility</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>public</span><span class='tstring_end'>&#39;</span></span>
3542
+ <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:link_password</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
3543
+ <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:expires</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
3544
+
3545
+ <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
3546
+ <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
3547
+ <span class='symbol'>:settings</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_settings'>settings</span>
3548
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
3549
+ <span class='kw'>end</span></pre>
3550
+ </td>
3551
+ </tr>
3552
+ </table>
3553
+ </div>
3554
+
3555
+ <div class="method_details ">
3556
+ <h3 class="signature " id="delete-instance_method">
3557
+
3558
+ #<strong>delete</strong>(path, options = {}) &#x21d2; <tt>Object</tt>
3559
+
3560
+
3561
+
3562
+
3563
+
3564
+ </h3><div class="docstring">
3565
+ <div class="discussion">
3566
+ <p>Delete the file or folder at a given path.</p>
3567
+
3568
+ <p>If the path is a folder, all its contents will be deleted too.</p>
3569
+
3570
+ <p>A successful response indicates that the file or folder was deleted.
3571
+ The returned metadata will be the corresponding
3572
+ <span class='object_link'><a href="Metadata/File.html" title="DropboxApi::Metadata::File (class)">Metadata::File</a></span> or <span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Metadata::Folder</a></span> for the
3573
+ item at time of deletion, and not a <span class='object_link'><a href="Metadata/Deleted.html" title="DropboxApi::Metadata::Deleted (class)">Metadata::Deleted</a></span> object.</p>
3574
+
3575
+
3576
+ </div>
3577
+ </div>
3578
+ <div class="tags">
3579
+ <p class="tag_title">Parameters:</p>
3580
+ <ul class="param">
3581
+
3582
+ <li>
3583
+
3584
+ <span class='name'>path</span>
3585
+
3586
+
3587
+ <span class='type'>(<tt>String</tt>)</span>
3588
+
3589
+
3590
+
3591
+ &mdash;
3592
+ <div class='inline'><p>Path in the user&#39;s Dropbox to delete.</p>
3593
+ </div>
3594
+
3595
+ </li>
3596
+
3597
+ </ul>
3598
+
3599
+
3600
+
3601
+
3602
+
3603
+
3604
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
3605
+ <ul class="option">
3606
+
3607
+ <li>
3608
+ <span class="name">parent_rev</span>
3609
+ <span class="type">(<tt>String</tt>)</span>
3610
+ <span class="default">
3611
+
3612
+ </span>
3613
+
3614
+ &mdash; <div class='inline'><p>Perform delete if given &quot;rev&quot;
3615
+ matches the existing file&#39;s latest &quot;rev&quot;. This field does not support
3616
+ deleting a folder. If the given &quot;rev&quot; doesn&#39;t match, a
3617
+ <span class='object_link'><a href="Errors/FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">Errors::FileConflictError</a></span> will be raised.</p>
3618
+ </div>
3619
+
3620
+ </li>
3621
+
3622
+ </ul>
3623
+
3624
+
3625
+
3626
+ </div>
3627
+ <div class="tags">
3628
+ <p class="tag_title">Specifications:</p>
3629
+ <ul class="specs">
3630
+
3631
+ <li>
3632
+ returns the deleted file
3633
+ <table class="source_code test_code">
3634
+ <tr>
3635
+ <td>
3636
+ <pre class="lines">
3637
+
3638
+
3639
+ 7
3640
+ 8
3641
+ 9
3642
+ 10</pre>
3643
+ </td>
3644
+ <td>
3645
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 24</span>
3646
+
3647
+ <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/will_be_deleted.txt</span><span class='tstring_end'>&quot;</span></span>
3648
+
3649
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span><span class='rparen'>)</span>
3650
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>will_be_deleted.txt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
3651
+ </td>
3652
+ </tr>
3653
+ </table>
3654
+ </li>
3655
+
3656
+ <li>
3657
+ won&#39;t delete the file if `parent_rev` doesn&#39;t match
3658
+ <table class="source_code test_code">
3659
+ <tr>
3660
+ <td>
3661
+ <pre class="lines">
3662
+
3663
+
3664
+ 14
3665
+ 15
3666
+ 16</pre>
3667
+ </td>
3668
+ <td>
3669
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 24</span>
3670
+
3671
+ <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
3672
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/wont_be_deleted.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:parent_rev</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1c0576c68d6</span><span class='tstring_end'>&quot;</span></span>
3673
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">FileConflictError</a></span></span><span class='rparen'>)</span></pre>
3674
+ </td>
3675
+ </tr>
3676
+ </table>
3677
+ </li>
3678
+
3679
+ <li>
3680
+ returns the deleted folder
3681
+ <table class="source_code test_code">
3682
+ <tr>
3683
+ <td>
3684
+ <pre class="lines">
3685
+
3686
+
3687
+ 20
3688
+ 21
3689
+ 22
3690
+ 23</pre>
3691
+ </td>
3692
+ <td>
3693
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 24</span>
3694
+
3695
+ <span class='id identifier rubyid_folder'>folder</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/folder</span><span class='tstring_end'>&quot;</span></span>
3696
+
3697
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_folder'>folder</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span>
3698
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_folder'>folder</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
3699
+ </td>
3700
+ </tr>
3701
+ </table>
3702
+ </li>
3703
+
3704
+ <li>
3705
+ raises an error if the name is invalid
3706
+ <table class="source_code test_code">
3707
+ <tr>
3708
+ <td>
3709
+ <pre class="lines">
3710
+
3711
+
3712
+ 27
3713
+ 28
3714
+ 29</pre>
3715
+ </td>
3716
+ <td>
3717
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 24</span>
3718
+
3719
+ <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
3720
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/unexisting folder</span><span class='tstring_end'>&quot;</span></span>
3721
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='rparen'>)</span></pre>
3722
+ </td>
3723
+ </tr>
3724
+ </table>
3725
+ </li>
3726
+
3727
+ </ul>
3728
+ </div>
3729
+
3730
+ <table class="source_code">
3731
+ <tr>
3732
+ <td>
3733
+ <pre class="lines">
3734
+
3735
+
3736
+ 24
3737
+ 25
3738
+ 26
3739
+ 27
3740
+ 28
3741
+ 29
3742
+ 30</pre>
3743
+ </td>
3744
+ <td>
3745
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete.rb', line 24</span>
3746
+
3747
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:delete</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
3748
+ <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:parent_rev</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
3749
+
3750
+ <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
3751
+ <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span>
3752
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
3753
+ <span class='kw'>end</span></pre>
3754
+ </td>
3755
+ </tr>
3756
+ </table>
3757
+ </div>
3758
+
3759
+ <div class="method_details ">
3760
+ <h3 class="signature " id="delete_batch-instance_method">
3761
+
3762
+ #<strong>delete_batch</strong>(entries) &#x21d2; <tt>String</tt>, <tt>Array</tt>
3763
+
3764
+
3765
+
3766
+
3767
+
3768
+ </h3><div class="docstring">
3769
+ <div class="discussion">
3770
+ <p>Delete multiple files/folders at once.</p>
3771
+
3772
+ <p>This route is asynchronous, which returns a job ID immediately and runs
3773
+ the delete batch asynchronously. Use <span class='object_link'><a href="#delete_batch_check-instance_method" title="DropboxApi::Client#delete_batch_check (method)">#delete_batch_check</a></span> to check
3774
+ the job status.</p>
3775
+
3776
+
3777
+ </div>
3778
+ </div>
3779
+ <div class="tags">
3780
+ <p class="tag_title">Parameters:</p>
3781
+ <ul class="param">
3782
+
3783
+ <li>
3784
+
3785
+ <span class='name'>entries</span>
3786
+
3787
+
3788
+ <span class='type'>(<tt>Array</tt>)</span>
3789
+
3790
+
3791
+
3792
+ &mdash;
3793
+ <div class='inline'><p>List of entries, each entry is a Hash with these
3794
+ fields: <code>path</code> (mandatory) &amp; parent_rev (optional).</p>
3795
+ </div>
3796
+
3797
+ </li>
3798
+
3799
+ </ul>
3800
+
3801
+ <p class="tag_title">Returns:</p>
3802
+ <ul class="return">
3803
+
3804
+ <li>
3805
+
3806
+
3807
+ <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
3808
+
3809
+
3810
+
3811
+ &mdash;
3812
+ <div class='inline'><p>Either the job id or the list of job statuses.</p>
3813
+ </div>
3814
+
3815
+ </li>
3816
+
3817
+ </ul>
3818
+
3819
+ </div>
3820
+ <div class="tags">
3821
+ <p class="tag_title">Specifications:</p>
3822
+ <ul class="specs">
3823
+
3824
+ <li>
3825
+ returns async_job_id for multiple entries
3826
+ <table class="source_code test_code">
3827
+ <tr>
3828
+ <td>
3829
+ <pre class="lines">
3830
+
3831
+
3832
+ 8
3833
+ 9
3834
+ 10
3835
+ 11
3836
+ 12</pre>
3837
+ </td>
3838
+ <td>
3839
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_spec.rb', line 16</span>
3840
+
3841
+ <span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='lbrace'>{</span> <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/folder_to_delete_1</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/folder_to_delete_2</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='rbracket'>]</span>
3842
+ <span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch'>delete_batch</span> <span class='id identifier rubyid_entries'>entries</span>
3843
+
3844
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
3845
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_key'>have_key</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
3846
+ </td>
3847
+ </tr>
3848
+ </table>
3849
+ </li>
3850
+
3851
+ <li>
3852
+ returns async_job_id for single entry too
3853
+ <table class="source_code test_code">
3854
+ <tr>
3855
+ <td>
3856
+ <pre class="lines">
3857
+
3858
+
3859
+ 16
3860
+ 17
3861
+ 18
3862
+ 19
3863
+ 20</pre>
3864
+ </td>
3865
+ <td>
3866
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_spec.rb', line 16</span>
3867
+
3868
+ <span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='lbrace'>{</span> <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/folder_to_delete/file_to_delete.docx</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:parent_rev</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1c0576c68d6</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='rbracket'>]</span>
3869
+ <span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch'>delete_batch</span> <span class='id identifier rubyid_entries'>entries</span>
2546
3870
 
3871
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
3872
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_key'>have_key</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
3873
+ </td>
3874
+ </tr>
3875
+ </table>
3876
+ </li>
3877
+
3878
+ </ul>
2547
3879
  </div>
3880
+
2548
3881
  <table class="source_code">
2549
3882
  <tr>
2550
3883
  <td>
2551
3884
  <pre class="lines">
2552
3885
 
2553
3886
 
3887
+ 16
2554
3888
  17
2555
3889
  18
2556
3890
  19
2557
- 20
2558
- 21</pre>
3891
+ 20</pre>
2559
3892
  </td>
2560
3893
  <td>
2561
- <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 17</span>
3894
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch.rb', line 16</span>
2562
3895
 
2563
- <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:create_shared_link_with_settings</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
2564
- <span class='comment'># NOTE: This endpoint accepts an additional option `settings` which
2565
- </span> <span class='comment'># hasn&#39;t been implemented.
2566
- </span> <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span>
3896
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:delete_batch</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entries'>entries</span><span class='op'>|</span>
3897
+ <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
3898
+ <span class='symbol'>:entries</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_entries'>entries</span>
3899
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
2567
3900
  <span class='kw'>end</span></pre>
2568
3901
  </td>
2569
3902
  </tr>
@@ -2571,9 +3904,9 @@ created shared link This field is optional.</p>
2571
3904
  </div>
2572
3905
 
2573
3906
  <div class="method_details ">
2574
- <h3 class="signature " id="delete-instance_method">
3907
+ <h3 class="signature " id="delete_batch_check-instance_method">
2575
3908
 
2576
- #<strong>delete</strong>(path, options = {}) &#x21d2; <tt>Object</tt>
3909
+ #<strong>delete_batch_check</strong>(async_job_id) &#x21d2; <tt>:in_progress</tt>, <tt>Array</tt>
2577
3910
 
2578
3911
 
2579
3912
 
@@ -2581,14 +3914,8 @@ created shared link This field is optional.</p>
2581
3914
 
2582
3915
  </h3><div class="docstring">
2583
3916
  <div class="discussion">
2584
- <p>Delete the file or folder at a given path.</p>
2585
-
2586
- <p>If the path is a folder, all its contents will be deleted too.</p>
2587
-
2588
- <p>A successful response indicates that the file or folder was deleted.
2589
- The returned metadata will be the corresponding
2590
- <span class='object_link'><a href="Metadata/File.html" title="DropboxApi::Metadata::File (class)">Metadata::File</a></span> or <span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Metadata::Folder</a></span> for the
2591
- item at time of deletion, and not a <span class='object_link'><a href="Metadata/Deleted.html" title="DropboxApi::Metadata::Deleted (class)">Metadata::Deleted</a></span> object.</p>
3917
+ <p>Returns the status of an asynchronous job for delete_batch. If success,
3918
+ it returns list of result for each entry.</p>
2592
3919
 
2593
3920
 
2594
3921
  </div>
@@ -2599,7 +3926,7 @@ item at time of deletion, and not a <span class='object_link'><a href="Metadata/
2599
3926
 
2600
3927
  <li>
2601
3928
 
2602
- <span class='name'>path</span>
3929
+ <span class='name'>async_job_id</span>
2603
3930
 
2604
3931
 
2605
3932
  <span class='type'>(<tt>String</tt>)</span>
@@ -2607,39 +3934,31 @@ item at time of deletion, and not a <span class='object_link'><a href="Metadata/
2607
3934
 
2608
3935
 
2609
3936
  &mdash;
2610
- <div class='inline'><p>Path in the user&#39;s Dropbox to delete.</p>
3937
+ <div class='inline'><p>Id of the asynchronous job.</p>
2611
3938
  </div>
2612
3939
 
2613
3940
  </li>
2614
3941
 
2615
3942
  </ul>
2616
3943
 
3944
+ <p class="tag_title">Returns:</p>
3945
+ <ul class="return">
2617
3946
 
2618
-
2619
-
2620
-
2621
-
2622
- <p class="tag_title">Options Hash (<tt>options</tt>):</p>
2623
- <ul class="option">
3947
+ <li>
2624
3948
 
2625
- <li>
2626
- <span class="name">parent_rev</span>
2627
- <span class="type">(<tt>String</tt>)</span>
2628
- <span class="default">
2629
-
2630
- </span>
2631
-
2632
- &mdash; <div class='inline'><p>Perform delete if given &quot;rev&quot;
2633
- matches the existing file&#39;s latest &quot;rev&quot;. This field does not support
2634
- deleting a folder. If the given &quot;rev&quot; doesn&#39;t match, a
2635
- <span class='object_link'><a href="Errors/FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">Errors::FileConflictError</a></span> will be raised.</p>
3949
+
3950
+ <span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
3951
+
3952
+
3953
+
3954
+ &mdash;
3955
+ <div class='inline'><p>This could be either the <code>:in_progress</code>
3956
+ flag or a list of job statuses.</p>
2636
3957
  </div>
2637
-
2638
- </li>
2639
3958
 
2640
- </ul>
3959
+ </li>
2641
3960
 
2642
-
3961
+ </ul>
2643
3962
 
2644
3963
  </div>
2645
3964
  <div class="tags">
@@ -2647,96 +3966,52 @@ deleting a folder. If the given &quot;rev&quot; doesn&#39;t match, a
2647
3966
  <ul class="specs">
2648
3967
 
2649
3968
  <li>
2650
- returns the deleted file
3969
+ returns mixed results when complete
2651
3970
  <table class="source_code test_code">
2652
3971
  <tr>
2653
3972
  <td>
2654
3973
  <pre class="lines">
2655
3974
 
2656
3975
 
3976
+ 6
2657
3977
  7
2658
3978
  8
2659
3979
  9
2660
- 10</pre>
3980
+ 10
3981
+ 11</pre>
2661
3982
  </td>
2662
3983
  <td>
2663
- <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 24</span>
3984
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_check_spec.rb', line 14</span>
2664
3985
 
2665
- <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/will_be_deleted.txt</span><span class='tstring_end'>&quot;</span></span>
3986
+ <span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch_check'>delete_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dbjid:AAC2JUPMEtK-kEg7QVrNEemnX-FfQkJ_0r_tJJ2UpHhwvrUGrpw19CH4U5cfZKWPLxLVJoKgffTOy_zSKk6W953h</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
2666
3987
 
2667
- <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span><span class='rparen'>)</span>
2668
- <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>will_be_deleted.txt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
3988
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
3989
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
3990
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">FileConflictError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
3991
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span></pre>
2669
3992
  </td>
2670
3993
  </tr>
2671
3994
  </table>
2672
3995
  </li>
2673
3996
 
2674
3997
  <li>
2675
- wont&#39; delete the file if `parent_rev` doesn&#39;t match
3998
+ raises an error with an invalid async job id
2676
3999
  <table class="source_code test_code">
2677
4000
  <tr>
2678
4001
  <td>
2679
4002
  <pre class="lines">
2680
4003
 
2681
4004
 
2682
- 14
2683
4005
  15
2684
- 16</pre>
2685
- </td>
2686
- <td>
2687
- <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 24</span>
2688
-
2689
- <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
2690
- <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/wont_be_deleted.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:parent_rev</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1c0576c68d6</span><span class='tstring_end'>&quot;</span></span>
2691
- <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">FileConflictError</a></span></span><span class='rparen'>)</span></pre>
2692
- </td>
2693
- </tr>
2694
- </table>
2695
- </li>
2696
-
2697
- <li>
2698
- returns the deleted folder
2699
- <table class="source_code test_code">
2700
- <tr>
2701
- <td>
2702
- <pre class="lines">
2703
-
2704
-
2705
- 20
2706
- 21
2707
- 22
2708
- 23</pre>
2709
- </td>
2710
- <td>
2711
- <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 24</span>
2712
-
2713
- <span class='id identifier rubyid_folder'>folder</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/folder</span><span class='tstring_end'>&quot;</span></span>
2714
-
2715
- <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_folder'>folder</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span>
2716
- <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_folder'>folder</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
2717
- </td>
2718
- </tr>
2719
- </table>
2720
- </li>
2721
-
2722
- <li>
2723
- raises an error if the name is invalid
2724
- <table class="source_code test_code">
2725
- <tr>
2726
- <td>
2727
- <pre class="lines">
2728
-
2729
-
2730
- 27
2731
- 28
2732
- 29</pre>
4006
+ 16
4007
+ 17</pre>
2733
4008
  </td>
2734
4009
  <td>
2735
- <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 24</span>
4010
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_check_spec.rb', line 14</span>
2736
4011
 
2737
4012
  <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
2738
- <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/unexisting folder</span><span class='tstring_end'>&quot;</span></span>
2739
- <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='rparen'>)</span></pre>
4013
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch_check'>delete_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
4014
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</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="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span></span><span class='rparen'>)</span></pre>
2740
4015
  </td>
2741
4016
  </tr>
2742
4017
  </table>
@@ -2751,22 +4026,18 @@ deleting a folder. If the given &quot;rev&quot; doesn&#39;t match, a
2751
4026
  <pre class="lines">
2752
4027
 
2753
4028
 
2754
- 24
2755
- 25
2756
- 26
2757
- 27
2758
- 28
2759
- 29
2760
- 30</pre>
4029
+ 14
4030
+ 15
4031
+ 16
4032
+ 17
4033
+ 18</pre>
2761
4034
  </td>
2762
4035
  <td>
2763
- <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete.rb', line 24</span>
4036
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch_check.rb', line 14</span>
2764
4037
 
2765
- <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:delete</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
2766
- <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:parent_rev</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
2767
-
2768
- <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
2769
- <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span>
4038
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:delete_batch_check</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_async_job_id'>async_job_id</span><span class='op'>|</span>
4039
+ <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
4040
+ <span class='symbol'>:async_job_id</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
2770
4041
  <span class='rbrace'>}</span><span class='rparen'>)</span>
2771
4042
  <span class='kw'>end</span></pre>
2772
4043
  </td>
@@ -3169,9 +4440,9 @@ contain any duplicate account IDs.</p>
3169
4440
  <td>
3170
4441
  <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_batch_spec.rb', line 14</span>
3171
4442
 
3172
- <span class='id identifier rubyid_account_ids'>account_ids</span> <span class='op'>=</span> <span class='qwords_beg'>%w(
3173
- </span><span class='tstring_content'> dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX</span><span class='words_sep'>
3174
- </span><span class='tstring_content'> dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs</span><span class='words_sep'>
4443
+ <span class='id identifier rubyid_account_ids'>account_ids</span> <span class='op'>=</span> <span class='qwords_beg'>%w(</span><span class='words_sep'>
4444
+ </span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX</span><span class='words_sep'>
4445
+ </span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs</span><span class='words_sep'>
3175
4446
  </span><span class='tstring_end'>)</span></span>
3176
4447
 
3177
4448
  <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
@@ -3795,7 +5066,7 @@ a password, this parameter can be used.</p>
3795
5066
  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 22</span>
3796
5067
 
3797
5068
  <span class='id identifier rubyid_shared_link'>shared_link</span> <span class='op'>=</span> <span class='ivar'>@client</span>
3798
- <span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
5069
+ <span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
3799
5070
  <span class='period'>.</span><span class='id identifier rubyid_links'>links</span>
3800
5071
  <span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
3801
5072
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_shared_link_metadata'>get_shared_link_metadata</span> <span class='id identifier rubyid_shared_link'>shared_link</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
@@ -3826,7 +5097,7 @@ a password, this parameter can be used.</p>
3826
5097
  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 22</span>
3827
5098
 
3828
5099
  <span class='id identifier rubyid_shared_link'>shared_link</span> <span class='op'>=</span> <span class='ivar'>@client</span>
3829
- <span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
5100
+ <span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
3830
5101
  <span class='period'>.</span><span class='id identifier rubyid_links'>links</span>
3831
5102
  <span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
3832
5103
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_shared_link_metadata'>get_shared_link_metadata</span> <span class='id identifier rubyid_shared_link'>shared_link</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
@@ -4817,6 +6088,21 @@ is set for photo and video. The default for this field is <code>false</code>.</p
4817
6088
  returned for deleted file or folder, otherwise
4818
6089
  <span class='object_link'><a href="Errors/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">Errors::NotFoundError</a></span>
4819
6090
  will be raised. The default for this field is <code>false</code>.</p>
6091
+ </div>
6092
+
6093
+ </li>
6094
+
6095
+ <li>
6096
+ <span class="name">limit</span>
6097
+ <span class="type">(<tt>Numeric</tt>)</span>
6098
+ <span class="default">
6099
+
6100
+ </span>
6101
+
6102
+ &mdash; <div class='inline'><p>If present, will specify max number of
6103
+ results per request (Note:
6104
+ <a href="https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder" target="_parent" title="Dropbox docs">Dropbox docs</a> indicate
6105
+ this is &quot;approximate&quot;, and more may be returned)</p>
4820
6106
  </div>
4821
6107
 
4822
6108
  </li>
@@ -4843,7 +6129,7 @@ will be raised. The default for this field is <code>false</code>.</p>
4843
6129
  9</pre>
4844
6130
  </td>
4845
6131
  <td>
4846
- <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
6132
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
4847
6133
 
4848
6134
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
4849
6135
 
@@ -4866,7 +6152,7 @@ will be raised. The default for this field is <code>false</code>.</p>
4866
6152
  15</pre>
4867
6153
  </td>
4868
6154
  <td>
4869
- <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
6155
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
4870
6156
 
4871
6157
  <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
4872
6158
  <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/unexisting_folder</span><span class='tstring_end'>&quot;</span></span>
@@ -4891,7 +6177,7 @@ will be raised. The default for this field is <code>false</code>.</p>
4891
6177
  23</pre>
4892
6178
  </td>
4893
6179
  <td>
4894
- <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
6180
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
4895
6181
 
4896
6182
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
4897
6183
 
@@ -4920,10 +6206,10 @@ will be raised. The default for this field is <code>false</code>.</p>
4920
6206
  33</pre>
4921
6207
  </td>
4922
6208
  <td>
4923
- <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
6209
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
4924
6210
 
4925
6211
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
4926
- <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>shared_link:</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
6212
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:shared_link</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
4927
6213
 
4928
6214
  <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='op'>|</span>
4929
6215
  <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span><span class='rparen'>)</span>
@@ -4947,7 +6233,7 @@ will be raised. The default for this field is <code>false</code>.</p>
4947
6233
  39</pre>
4948
6234
  </td>
4949
6235
  <td>
4950
- <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 24</span>
6236
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
4951
6237
 
4952
6238
  <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
4953
6239
  <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/img.png</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:invalid_arg</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>value</span><span class='tstring_end'>&quot;</span></span>
@@ -4966,10 +6252,6 @@ will be raised. The default for this field is <code>false</code>.</p>
4966
6252
  <pre class="lines">
4967
6253
 
4968
6254
 
4969
- 24
4970
- 25
4971
- 26
4972
- 27
4973
6255
  28
4974
6256
  29
4975
6257
  30
@@ -4982,10 +6264,16 @@ will be raised. The default for this field is <code>false</code>.</p>
4982
6264
  37
4983
6265
  38
4984
6266
  39
4985
- 40</pre>
6267
+ 40
6268
+ 41
6269
+ 42
6270
+ 43
6271
+ 44
6272
+ 45
6273
+ 46</pre>
4986
6274
  </td>
4987
6275
  <td>
4988
- <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 24</span>
6276
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 28</span>
4989
6277
 
4990
6278
  <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:list_folder</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
4991
6279
  <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
@@ -4993,13 +6281,15 @@ will be raised. The default for this field is <code>false</code>.</p>
4993
6281
  <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
4994
6282
  <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
4995
6283
  <span class='symbol'>:shared_link</span><span class='comma'>,</span>
4996
- <span class='symbol'>:include_has_explicit_shared_members</span>
6284
+ <span class='symbol'>:include_has_explicit_shared_members</span><span class='comma'>,</span>
6285
+ <span class='symbol'>:limit</span>
4997
6286
  <span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
4998
6287
  <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:recursive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
4999
6288
  <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_media_info</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
5000
6289
  <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_deleted</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
5001
6290
  <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_build_shared_link_param'>build_shared_link_param</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span>
5002
-
6291
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span>
6292
+
5003
6293
  <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
5004
6294
  <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span>
5005
6295
  <span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -6485,6 +7775,75 @@ deleting a folder.</p>
6485
7775
  </td>
6486
7776
  </tr>
6487
7777
  </table>
7778
+ </div>
7779
+
7780
+ <div class="method_details ">
7781
+ <h3 class="signature " id="revoke_shared_link-instance_method">
7782
+
7783
+ #<strong>revoke_shared_link</strong>(url) &#x21d2; <tt>Object</tt>
7784
+
7785
+
7786
+
7787
+
7788
+
7789
+ </h3><div class="docstring">
7790
+ <div class="discussion">
7791
+ <p>Revoke a shared link.</p>
7792
+
7793
+ <p>Note that even after revoking a shared link to a file, the file may be accessible
7794
+ if there are shared links leading to any of the file parent folders. </p>
7795
+
7796
+ <p>A successful response indicates that the shared link was revoked.</p>
7797
+
7798
+
7799
+ </div>
7800
+ </div>
7801
+ <div class="tags">
7802
+ <p class="tag_title">Parameters:</p>
7803
+ <ul class="param">
7804
+
7805
+ <li>
7806
+
7807
+ <span class='name'>url</span>
7808
+
7809
+
7810
+ <span class='type'>(<tt>String</tt>)</span>
7811
+
7812
+
7813
+
7814
+ &mdash;
7815
+ <div class='inline'><p>shared url which needs to be revoked.</p>
7816
+ </div>
7817
+
7818
+ </li>
7819
+
7820
+ </ul>
7821
+
7822
+
7823
+ </div>
7824
+ <table class="source_code">
7825
+ <tr>
7826
+ <td>
7827
+ <pre class="lines">
7828
+
7829
+
7830
+ 17
7831
+ 18
7832
+ 19
7833
+ 20
7834
+ 21</pre>
7835
+ </td>
7836
+ <td>
7837
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb', line 17</span>
7838
+
7839
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:revoke_shared_link</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_url'>url</span><span class='op'>|</span>
7840
+ <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
7841
+ <span class='symbol'>:url</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_url'>url</span>
7842
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
7843
+ <span class='kw'>end</span></pre>
7844
+ </td>
7845
+ </tr>
7846
+ </table>
6488
7847
  </div>
6489
7848
 
6490
7849
  <div class="method_details ">
@@ -8737,9 +10096,9 @@ that you can use to continue the upload afterwards.</p>
8737
10096
  </div>
8738
10097
 
8739
10098
  <div id="footer">
8740
- Generated on Fri Nov 16 09:02:02 2018 by
10099
+ Generated on Fri May 31 17:53:31 2019 by
8741
10100
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
8742
- 0.9.15 (ruby-2.3.3).
10101
+ 0.9.19 (ruby-2.6.2).
8743
10102
  </div>
8744
10103
 
8745
10104
  </div>