2018-11-03 18:33:35 +00:00
( function ( global , factory ) {
typeof exports === 'object' && typeof module !== 'undefined' ? module . exports = factory ( ) :
typeof define === 'function' && define . amd ? define ( factory ) :
( global . Dropbox = factory ( ) ) ;
} ( this , ( function ( ) { 'use strict' ;
// Auto-generated by Stone, do not modify.
var routes = { } ;
/ * *
* Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access token .
* @ function Dropbox # authTokenFromOauth1
* @ arg { AuthTokenFromOAuth1Arg } arg - The request parameters .
* @ returns { Promise . < AuthTokenFromOAuth1Result , Error . < AuthTokenFromOAuth1Error >> }
* /
routes . authTokenFromOauth1 = function ( arg ) {
return this . request ( 'auth/token/from_oauth1' , arg , 'app' , 'api' , 'rpc' ) ;
} ;
/ * *
* Disables the access token used to authenticate the call .
* @ function Dropbox # authTokenRevoke
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < void , Error . < void >> }
* /
routes . authTokenRevoke = function ( arg ) {
return this . request ( 'auth/token/revoke' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-29 00:56:17 +00:00
/ * *
* Removes all manually added contacts . You ' ll still keep contacts who are on
* your team or who you imported . New contacts will be added when you share .
* @ function Dropbox # contactsDeleteManualContacts
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < void , Error . < void >> }
* /
routes . contactsDeleteManualContacts = function ( arg ) {
return this . request ( 'contacts/delete_manual_contacts' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Removes manually added contacts from the given list .
* @ function Dropbox # contactsDeleteManualContactsBatch
* @ arg { ContactsDeleteManualContactsArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < ContactsDeleteManualContactsError >> }
* /
routes . contactsDeleteManualContactsBatch = function ( arg ) {
return this . request ( 'contacts/delete_manual_contacts_batch' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Add property groups to a Dropbox file . See templates / add _for _user or
* templates / add _for _team to create new templates .
* @ function Dropbox # filePropertiesPropertiesAdd
* @ arg { FilePropertiesAddPropertiesArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesAddPropertiesError >> }
* /
routes . filePropertiesPropertiesAdd = function ( arg ) {
return this . request ( 'file_properties/properties/add' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Overwrite property groups associated with a file . This endpoint should be
* used instead of properties / update when property groups are being updated via
* a "snapshot" instead of via a "delta" . In other words , this endpoint will
* delete all omitted fields from a property group , whereas properties / update
* will only delete fields that are explicitly marked for deletion .
* @ function Dropbox # filePropertiesPropertiesOverwrite
* @ arg { FilePropertiesOverwritePropertyGroupArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesInvalidPropertyGroupError >> }
* /
routes . filePropertiesPropertiesOverwrite = function ( arg ) {
return this . request ( 'file_properties/properties/overwrite' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Permanently removes the specified property group from the file . To remove
* specific property field key value pairs , see properties / update . To update a
* template , see templates / update _for _user or templates / update _for _team . To
* remove a template , see templates / remove _for _user or
* templates / remove _for _team .
* @ function Dropbox # filePropertiesPropertiesRemove
* @ arg { FilePropertiesRemovePropertiesArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesRemovePropertiesError >> }
* /
routes . filePropertiesPropertiesRemove = function ( arg ) {
return this . request ( 'file_properties/properties/remove' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Search across property templates for particular property field values .
* @ function Dropbox # filePropertiesPropertiesSearch
* @ arg { FilePropertiesPropertiesSearchArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesPropertiesSearchResult , Error . < FilePropertiesPropertiesSearchError >> }
* /
routes . filePropertiesPropertiesSearch = function ( arg ) {
return this . request ( 'file_properties/properties/search' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from properties / search , use this to paginate
* through all search results .
* @ function Dropbox # filePropertiesPropertiesSearchContinue
* @ arg { FilePropertiesPropertiesSearchContinueArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesPropertiesSearchResult , Error . < FilePropertiesPropertiesSearchContinueError >> }
* /
routes . filePropertiesPropertiesSearchContinue = function ( arg ) {
return this . request ( 'file_properties/properties/search/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Add , update or remove properties associated with the supplied file and
* templates . This endpoint should be used instead of properties / overwrite when
* property groups are being updated via a "delta" instead of via a "snapshot" .
* In other words , this endpoint will not delete any omitted fields from a
* property group , whereas properties / overwrite will delete any fields that are
* omitted from a property group .
* @ function Dropbox # filePropertiesPropertiesUpdate
* @ arg { FilePropertiesUpdatePropertiesArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesUpdatePropertiesError >> }
* /
routes . filePropertiesPropertiesUpdate = function ( arg ) {
return this . request ( 'file_properties/properties/update' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Add a template associated with a team . See properties / add to add properties
* to a file or folder . Note : this endpoint will create team - owned templates .
* @ function Dropbox # filePropertiesTemplatesAddForTeam
* @ arg { FilePropertiesAddTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesAddTemplateResult , Error . < FilePropertiesModifyTemplateError >> }
* /
routes . filePropertiesTemplatesAddForTeam = function ( arg ) {
return this . request ( 'file_properties/templates/add_for_team' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Add a template associated with a user . See properties / add to add properties
* to a file . This endpoint can 't be called on a team member or admin' s behalf .
* @ function Dropbox # filePropertiesTemplatesAddForUser
* @ arg { FilePropertiesAddTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesAddTemplateResult , Error . < FilePropertiesModifyTemplateError >> }
* /
routes . filePropertiesTemplatesAddForUser = function ( arg ) {
return this . request ( 'file_properties/templates/add_for_user' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get the schema for a specified template .
* @ function Dropbox # filePropertiesTemplatesGetForTeam
* @ arg { FilePropertiesGetTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesGetTemplateResult , Error . < FilePropertiesTemplateError >> }
* /
routes . filePropertiesTemplatesGetForTeam = function ( arg ) {
return this . request ( 'file_properties/templates/get_for_team' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get the schema for a specified template . This endpoint can ' t be called on a
* team member or admin ' s behalf .
* @ function Dropbox # filePropertiesTemplatesGetForUser
* @ arg { FilePropertiesGetTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesGetTemplateResult , Error . < FilePropertiesTemplateError >> }
* /
routes . filePropertiesTemplatesGetForUser = function ( arg ) {
return this . request ( 'file_properties/templates/get_for_user' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get the template identifiers for a team . To get the schema of each template
* use templates / get _for _team .
* @ function Dropbox # filePropertiesTemplatesListForTeam
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < FilePropertiesListTemplateResult , Error . < FilePropertiesTemplateError >> }
* /
routes . filePropertiesTemplatesListForTeam = function ( arg ) {
return this . request ( 'file_properties/templates/list_for_team' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get the template identifiers for a team . To get the schema of each template
* use templates / get _for _user . This endpoint can ' t be called on a team member or
* admin ' s behalf .
* @ function Dropbox # filePropertiesTemplatesListForUser
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < FilePropertiesListTemplateResult , Error . < FilePropertiesTemplateError >> }
* /
routes . filePropertiesTemplatesListForUser = function ( arg ) {
return this . request ( 'file_properties/templates/list_for_user' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Permanently removes the specified template created from
* templates / add _for _user . All properties associated with the template will also
* be removed . This action cannot be undone .
* @ function Dropbox # filePropertiesTemplatesRemoveForTeam
* @ arg { FilePropertiesRemoveTemplateArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesTemplateError >> }
* /
routes . filePropertiesTemplatesRemoveForTeam = function ( arg ) {
return this . request ( 'file_properties/templates/remove_for_team' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Permanently removes the specified template created from
* templates / add _for _user . All properties associated with the template will also
* be removed . This action cannot be undone .
* @ function Dropbox # filePropertiesTemplatesRemoveForUser
* @ arg { FilePropertiesRemoveTemplateArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesTemplateError >> }
* /
routes . filePropertiesTemplatesRemoveForUser = function ( arg ) {
return this . request ( 'file_properties/templates/remove_for_user' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Update a template associated with a team . This route can update the template
* name , the template description and add optional properties to templates .
* @ function Dropbox # filePropertiesTemplatesUpdateForTeam
* @ arg { FilePropertiesUpdateTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesUpdateTemplateResult , Error . < FilePropertiesModifyTemplateError >> }
* /
routes . filePropertiesTemplatesUpdateForTeam = function ( arg ) {
return this . request ( 'file_properties/templates/update_for_team' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Update a template associated with a user . This route can update the template
* name , the template description and add optional properties to templates . This
* endpoint can 't be called on a team member or admin' s behalf .
* @ function Dropbox # filePropertiesTemplatesUpdateForUser
* @ arg { FilePropertiesUpdateTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesUpdateTemplateResult , Error . < FilePropertiesModifyTemplateError >> }
* /
routes . filePropertiesTemplatesUpdateForUser = function ( arg ) {
return this . request ( 'file_properties/templates/update_for_user' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Creates a file request for this user .
* @ function Dropbox # fileRequestsCreate
* @ arg { FileRequestsCreateFileRequestArgs } arg - The request parameters .
* @ returns { Promise . < FileRequestsFileRequest , Error . < FileRequestsCreateFileRequestError >> }
* /
routes . fileRequestsCreate = function ( arg ) {
return this . request ( 'file_requests/create' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns the specified file request .
* @ function Dropbox # fileRequestsGet
* @ arg { FileRequestsGetFileRequestArgs } arg - The request parameters .
* @ returns { Promise . < FileRequestsFileRequest , Error . < FileRequestsGetFileRequestError >> }
* /
routes . fileRequestsGet = function ( arg ) {
return this . request ( 'file_requests/get' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns a list of file requests owned by this user . For apps with the app
* folder permission , this will only return file requests with destinations in
* the app folder .
* @ function Dropbox # fileRequestsList
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < FileRequestsListFileRequestsResult , Error . < FileRequestsListFileRequestsError >> }
* /
routes . fileRequestsList = function ( arg ) {
return this . request ( 'file_requests/list' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Update a file request .
* @ function Dropbox # fileRequestsUpdate
* @ arg { FileRequestsUpdateFileRequestArgs } arg - The request parameters .
* @ returns { Promise . < FileRequestsFileRequest , Error . < FileRequestsUpdateFileRequestError >> }
* /
routes . fileRequestsUpdate = function ( arg ) {
return this . request ( 'file_requests/update' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns the metadata for a file or folder . This is an alpha endpoint
* compatible with the properties API . Note : Metadata for the root folder is
* unsupported .
* @ function Dropbox # filesAlphaGetMetadata
* @ deprecated
* @ arg { FilesAlphaGetMetadataArg } arg - The request parameters .
* @ returns { Promise . < ( FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata ) , Error . < FilesAlphaGetMetadataError >> }
* /
routes . filesAlphaGetMetadata = function ( arg ) {
return this . request ( 'files/alpha/get_metadata' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Create a new file with the contents provided in the request . Note that this
* endpoint is part of the properties API alpha and is slightly different from
* upload . Do not use this to upload a file larger than 150 MB . Instead , create
* an upload session with upload _session / start .
* @ function Dropbox # filesAlphaUpload
* @ deprecated
* @ arg { FilesCommitInfoWithProperties } arg - The request parameters .
* @ returns { Promise . < FilesFileMetadata , Error . < FilesUploadErrorWithProperties >> }
* /
routes . filesAlphaUpload = function ( arg ) {
return this . request ( 'files/alpha/upload' , arg , 'user' , 'content' , 'upload' ) ;
} ;
2018-11-29 00:56:17 +00:00
/ * *
* Copy a file or folder to a different location in the user ' s Dropbox . If the
* source path is a folder all its contents will be copied .
* @ function Dropbox # filesCopyV2
* @ arg { FilesRelocationArg } arg - The request parameters .
* @ returns { Promise . < FilesRelocationResult , Error . < FilesRelocationError >> }
* /
routes . filesCopyV2 = function ( arg ) {
return this . request ( 'files/copy_v2' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Copy a file or folder to a different location in the user ' s Dropbox . If the
* source path is a folder all its contents will be copied .
* @ function Dropbox # filesCopy
* @ deprecated
* @ arg { FilesRelocationArg } arg - The request parameters .
* @ returns { Promise . < ( FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata ) , Error . < FilesRelocationError >> }
* /
routes . filesCopy = function ( arg ) {
return this . request ( 'files/copy' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2019-07-08 09:59:04 +00:00
/ * *
* Copy multiple files or folders to different locations at once in the user ' s
* Dropbox . This route will replace copy _batch . The main difference is this
* route will return stutus for each entry , while copy _batch raises failure if
* any entry fails . This route will either finish synchronously , or return a job
* ID and do the async copy job in background . Please use copy _batch / check _v2 to
* check the job status .
* @ function Dropbox # filesCopyBatchV2
* @ arg { Object } arg - The request parameters .
* @ returns { Promise . < FilesRelocationBatchV2Launch , Error . < void >> }
* /
routes . filesCopyBatchV2 = function ( arg ) {
return this . request ( 'files/copy_batch_v2' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Copy multiple files or folders to different locations at once in the user ' s
* Dropbox . If RelocationBatchArg . allow _shared _folder is false , this route is
2018-11-29 00:56:17 +00:00
* atomic . If one entry fails , the whole transaction will abort . If
* RelocationBatchArg . allow _shared _folder is true , atomicity is not guaranteed ,
* but it allows you to copy the contents of shared folders to new locations .
2018-11-03 18:33:35 +00:00
* This route will return job ID immediately and do the async copy job in
* background . Please use copy _batch / check to check the job status .
* @ function Dropbox # filesCopyBatch
2019-07-08 09:59:04 +00:00
* @ deprecated
2018-11-03 18:33:35 +00:00
* @ arg { FilesRelocationBatchArg } arg - The request parameters .
* @ returns { Promise . < FilesRelocationBatchLaunch , Error . < void >> }
* /
routes . filesCopyBatch = function ( arg ) {
return this . request ( 'files/copy_batch' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2019-07-08 09:59:04 +00:00
/ * *
* Returns the status of an asynchronous job for copy _batch _v2 . It returns list
* of results for each entry .
* @ function Dropbox # filesCopyBatchCheckV2
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < FilesRelocationBatchV2JobStatus , Error . < AsyncPollError >> }
* /
routes . filesCopyBatchCheckV2 = function ( arg ) {
return this . request ( 'files/copy_batch/check_v2' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Returns the status of an asynchronous job for copy _batch . If success , it
* returns list of results for each entry .
* @ function Dropbox # filesCopyBatchCheck
2019-07-08 09:59:04 +00:00
* @ deprecated
2018-11-03 18:33:35 +00:00
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < FilesRelocationBatchJobStatus , Error . < AsyncPollError >> }
* /
routes . filesCopyBatchCheck = function ( arg ) {
return this . request ( 'files/copy_batch/check' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get a copy reference to a file or folder . This reference string can be used
* to save that file or folder to another user ' s Dropbox by passing it to
* copy _reference / save .
* @ function Dropbox # filesCopyReferenceGet
* @ arg { FilesGetCopyReferenceArg } arg - The request parameters .
* @ returns { Promise . < FilesGetCopyReferenceResult , Error . < FilesGetCopyReferenceError >> }
* /
routes . filesCopyReferenceGet = function ( arg ) {
return this . request ( 'files/copy_reference/get' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Save a copy reference returned by copy _reference / get to the user ' s Dropbox .
* @ function Dropbox # filesCopyReferenceSave
* @ arg { FilesSaveCopyReferenceArg } arg - The request parameters .
* @ returns { Promise . < FilesSaveCopyReferenceResult , Error . < FilesSaveCopyReferenceError >> }
* /
routes . filesCopyReferenceSave = function ( arg ) {
return this . request ( 'files/copy_reference/save' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2018-11-29 00:56:17 +00:00
* Create a folder at a given path .
* @ function Dropbox # filesCreateFolderV2
* @ arg { FilesCreateFolderArg } arg - The request parameters .
* @ returns { Promise . < FilesCreateFolderResult , Error . < FilesCreateFolderError >> }
2018-11-03 18:33:35 +00:00
* /
2018-11-29 00:56:17 +00:00
routes . filesCreateFolderV2 = function ( arg ) {
return this . request ( 'files/create_folder_v2' , arg , 'user' , 'api' , 'rpc' ) ;
2018-11-03 18:33:35 +00:00
} ;
/ * *
* Create a folder at a given path .
* @ function Dropbox # filesCreateFolder
* @ deprecated
* @ arg { FilesCreateFolderArg } arg - The request parameters .
* @ returns { Promise . < FilesFolderMetadata , Error . < FilesCreateFolderError >> }
* /
routes . filesCreateFolder = function ( arg ) {
return this . request ( 'files/create_folder' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Create multiple folders at once . This route is asynchronous for large
* batches , which returns a job ID immediately and runs the create folder batch
* asynchronously . Otherwise , creates the folders and returns the result
* synchronously for smaller inputs . You can force asynchronous behaviour by
* using the CreateFolderBatchArg . force _async flag . Use
* create _folder _batch / check to check the job status .
* @ function Dropbox # filesCreateFolderBatch
* @ arg { FilesCreateFolderBatchArg } arg - The request parameters .
* @ returns { Promise . < FilesCreateFolderBatchLaunch , Error . < void >> }
* /
routes . filesCreateFolderBatch = function ( arg ) {
return this . request ( 'files/create_folder_batch' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns the status of an asynchronous job for create _folder _batch . If
* success , it returns list of result for each entry .
* @ function Dropbox # filesCreateFolderBatchCheck
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < FilesCreateFolderBatchJobStatus , Error . < AsyncPollError >> }
* /
routes . filesCreateFolderBatchCheck = function ( arg ) {
return this . request ( 'files/create_folder_batch/check' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2018-11-29 00:56:17 +00:00
* Delete the file or folder at a given path . If the path is a folder , all its
* contents will be deleted too . A successful response indicates that the file
* or folder was deleted . The returned metadata will be the corresponding
* FileMetadata or FolderMetadata for the item at time of deletion , and not a
* DeletedMetadata object .
* @ function Dropbox # filesDeleteV2
* @ arg { FilesDeleteArg } arg - The request parameters .
* @ returns { Promise . < FilesDeleteResult , Error . < FilesDeleteError >> }
2018-11-03 18:33:35 +00:00
* /
2018-11-29 00:56:17 +00:00
routes . filesDeleteV2 = function ( arg ) {
return this . request ( 'files/delete_v2' , arg , 'user' , 'api' , 'rpc' ) ;
2018-11-03 18:33:35 +00:00
} ;
/ * *
* Delete the file or folder at a given path . If the path is a folder , all its
* contents will be deleted too . A successful response indicates that the file
* or folder was deleted . The returned metadata will be the corresponding
* FileMetadata or FolderMetadata for the item at time of deletion , and not a
* DeletedMetadata object .
* @ function Dropbox # filesDelete
* @ deprecated
* @ arg { FilesDeleteArg } arg - The request parameters .
* @ returns { Promise . < ( FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata ) , Error . < FilesDeleteError >> }
* /
routes . filesDelete = function ( arg ) {
return this . request ( 'files/delete' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Delete multiple files / folders at once . This route is asynchronous , which
* returns a job ID immediately and runs the delete batch asynchronously . Use
* delete _batch / check to check the job status .
* @ function Dropbox # filesDeleteBatch
* @ arg { FilesDeleteBatchArg } arg - The request parameters .
* @ returns { Promise . < FilesDeleteBatchLaunch , Error . < void >> }
* /
routes . filesDeleteBatch = function ( arg ) {
return this . request ( 'files/delete_batch' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns the status of an asynchronous job for delete _batch . If success , it
* returns list of result for each entry .
* @ function Dropbox # filesDeleteBatchCheck
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < FilesDeleteBatchJobStatus , Error . < AsyncPollError >> }
* /
routes . filesDeleteBatchCheck = function ( arg ) {
return this . request ( 'files/delete_batch/check' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Download a file from a user ' s Dropbox .
* @ function Dropbox # filesDownload
* @ arg { FilesDownloadArg } arg - The request parameters .
* @ returns { Promise . < FilesFileMetadata , Error . < FilesDownloadError >> }
* /
routes . filesDownload = function ( arg ) {
return this . request ( 'files/download' , arg , 'user' , 'content' , 'download' ) ;
} ;
/ * *
* Download a folder from the user ' s Dropbox , as a zip file . The folder must be
2018-11-29 00:56:17 +00:00
* less than 20 GB in size and have fewer than 10 , 000 total files . The input
* cannot be a single file . Any single file must be less than 4 GB in size .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # filesDownloadZip
* @ arg { FilesDownloadZipArg } arg - The request parameters .
* @ returns { Promise . < FilesDownloadZipResult , Error . < FilesDownloadZipError >> }
* /
routes . filesDownloadZip = function ( arg ) {
return this . request ( 'files/download_zip' , arg , 'user' , 'content' , 'download' ) ;
} ;
/ * *
* Returns the metadata for a file or folder . Note : Metadata for the root folder
* is unsupported .
* @ function Dropbox # filesGetMetadata
* @ arg { FilesGetMetadataArg } arg - The request parameters .
* @ returns { Promise . < ( FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata ) , Error . < FilesGetMetadataError >> }
* /
routes . filesGetMetadata = function ( arg ) {
return this . request ( 'files/get_metadata' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get a preview for a file . Currently , PDF previews are generated for files
* with the following extensions : . ai , . doc , . docm , . docx , . eps , . odp , . odt ,
* . pps , . ppsm , . ppsx , . ppt , . pptm , . pptx , . rtf . HTML previews are generated for
* files with the following extensions : . csv , . ods , . xls , . xlsm , . xlsx . Other
* formats will return an unsupported extension error .
* @ function Dropbox # filesGetPreview
* @ arg { FilesPreviewArg } arg - The request parameters .
* @ returns { Promise . < FilesFileMetadata , Error . < FilesPreviewError >> }
* /
routes . filesGetPreview = function ( arg ) {
return this . request ( 'files/get_preview' , arg , 'user' , 'content' , 'download' ) ;
} ;
/ * *
* Get a temporary link to stream content of a file . This link will expire in
2018-11-29 00:56:17 +00:00
* four hours and afterwards you will get 410 Gone . So this URL should not be
* used to display content directly in the browser . Content - Type of the link is
2018-11-03 18:33:35 +00:00
* determined automatically by the file ' s mime type .
* @ function Dropbox # filesGetTemporaryLink
* @ arg { FilesGetTemporaryLinkArg } arg - The request parameters .
* @ returns { Promise . < FilesGetTemporaryLinkResult , Error . < FilesGetTemporaryLinkError >> }
* /
routes . filesGetTemporaryLink = function ( arg ) {
return this . request ( 'files/get_temporary_link' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-29 00:56:17 +00:00
/ * *
* Get a one - time use temporary upload link to upload a file to a Dropbox
* location . This endpoint acts as a delayed upload . The returned temporary
* upload link may be used to make a POST request with the data to be uploaded .
* The upload will then be perfomed with the CommitInfo previously provided to
* get _temporary _upload _link but evaluated only upon consumption . Hence , errors
* stemming from invalid CommitInfo with respect to the state of the user ' s
* Dropbox will only be communicated at consumption time . Additionally , these
* errors are surfaced as generic HTTP 409 Conflict responses , potentially
* hiding issue details . The maximum temporary upload link duration is 4 hours .
* Upon consumption or expiration , a new link will have to be generated .
* Multiple links may exist for a specific upload path at any given time . The
* POST request on the temporary upload link must have its Content - Type set to
* "application/octet-stream" . Example temporary upload link consumption
* request : curl - X POST
* https : //dl.dropboxusercontent.com/apitul/1/bNi2uIYF51cVBND --header
* "Content-Type: application/octet-stream" -- data - binary @ local _file . txt A
* successful temporary upload link consumption request returns the content hash
* of the uploaded data in JSON format . Example succesful temporary upload link
* consumption response : { "content-hash" :
* "599d71033d700ac892a0e48fa61b125d2f5994" } An unsuccessful temporary upload
* link consumption request returns any of the following status codes : HTTP 400
* Bad Request : Content - Type is not one of application / octet - stream and
* text / plain or request is invalid . HTTP 409 Conflict : The temporary upload
* link does not exist or is currently unavailable , the upload failed , or
* another error happened . HTTP 410 Gone : The temporary upload link is expired
* or consumed . Example unsuccessful temporary upload link consumption
* response : Temporary upload link has been recently consumed .
* @ function Dropbox # filesGetTemporaryUploadLink
* @ arg { FilesGetTemporaryUploadLinkArg } arg - The request parameters .
* @ returns { Promise . < FilesGetTemporaryUploadLinkResult , Error . < void >> }
* /
routes . filesGetTemporaryUploadLink = function ( arg ) {
return this . request ( 'files/get_temporary_upload_link' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Get a thumbnail for an image . This method currently supports files with the
* following file extensions : jpg , jpeg , png , tiff , tif , gif and bmp . Photos
* that are larger than 20 MB in size won ' t be converted to a thumbnail .
* @ function Dropbox # filesGetThumbnail
* @ arg { FilesThumbnailArg } arg - The request parameters .
* @ returns { Promise . < FilesFileMetadata , Error . < FilesThumbnailError >> }
* /
routes . filesGetThumbnail = function ( arg ) {
return this . request ( 'files/get_thumbnail' , arg , 'user' , 'content' , 'download' ) ;
} ;
/ * *
* Get thumbnails for a list of images . We allow up to 25 thumbnails in a single
* batch . This method currently supports files with the following file
* extensions : jpg , jpeg , png , tiff , tif , gif and bmp . Photos that are larger
* than 20 MB in size won ' t be converted to a thumbnail .
* @ function Dropbox # filesGetThumbnailBatch
* @ arg { FilesGetThumbnailBatchArg } arg - The request parameters .
* @ returns { Promise . < FilesGetThumbnailBatchResult , Error . < FilesGetThumbnailBatchError >> }
* /
routes . filesGetThumbnailBatch = function ( arg ) {
return this . request ( 'files/get_thumbnail_batch' , arg , 'user' , 'content' , 'rpc' ) ;
} ;
/ * *
* Starts returning the contents of a folder . If the result ' s
* ListFolderResult . has _more field is true , call list _folder / continue with the
* returned ListFolderResult . cursor to retrieve more entries . If you ' re using
* ListFolderArg . recursive set to true to keep a local cache of the contents of
* a Dropbox account , iterate through each entry in order and process them as
* follows to keep your local state in sync : For each FileMetadata , store the
* new entry at the given path in your local state . If the required parent
* folders don 't exist yet, create them. If there' s already something else at
* the given path , replace it and remove all its children . For each
* FolderMetadata , store the new entry at the given path in your local state . If
* the required parent folders don 't exist yet, create them. If there' s already
* something else at the given path , replace it but leave the children as they
* are . Check the new entry ' s FolderSharingInfo . read _only and set all its
* children ' s read - only statuses to match . For each DeletedMetadata , if your
* local state has something at the given path , remove it and all its children .
* If there ' s nothing at the given path , ignore this entry . Note :
* auth . RateLimitError may be returned if multiple list _folder or
* list _folder / continue calls with same parameters are made simultaneously by
* same API app for same user . If your app implements retry logic , please hold
* off the retry until the previous request finishes .
* @ function Dropbox # filesListFolder
* @ arg { FilesListFolderArg } arg - The request parameters .
* @ returns { Promise . < FilesListFolderResult , Error . < FilesListFolderError >> }
* /
routes . filesListFolder = function ( arg ) {
return this . request ( 'files/list_folder' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from list _folder , use this to paginate
* through all files and retrieve updates to the folder , following the same
* rules as documented for list _folder .
* @ function Dropbox # filesListFolderContinue
* @ arg { FilesListFolderContinueArg } arg - The request parameters .
* @ returns { Promise . < FilesListFolderResult , Error . < FilesListFolderContinueError >> }
* /
routes . filesListFolderContinue = function ( arg ) {
return this . request ( 'files/list_folder/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* A way to quickly get a cursor for the folder ' s state . Unlike list _folder ,
* list _folder / get _latest _cursor doesn ' t return any entries . This endpoint is
* for app which only needs to know about new files and modifications and
* doesn ' t need to know about files that already exist in Dropbox .
* @ function Dropbox # filesListFolderGetLatestCursor
* @ arg { FilesListFolderArg } arg - The request parameters .
* @ returns { Promise . < FilesListFolderGetLatestCursorResult , Error . < FilesListFolderError >> }
* /
routes . filesListFolderGetLatestCursor = function ( arg ) {
return this . request ( 'files/list_folder/get_latest_cursor' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* A longpoll endpoint to wait for changes on an account . In conjunction with
* list _folder / continue , this call gives you a low - latency way to monitor an
* account for file changes . The connection will block until there are changes
* available or a timeout occurs . This endpoint is useful mostly for client - side
* apps . If you ' re looking for server - side notifications , check out our webhooks
* documentation https : //www.dropbox.com/developers/reference/webhooks.
* @ function Dropbox # filesListFolderLongpoll
* @ arg { FilesListFolderLongpollArg } arg - The request parameters .
* @ returns { Promise . < FilesListFolderLongpollResult , Error . < FilesListFolderLongpollError >> }
* /
routes . filesListFolderLongpoll = function ( arg ) {
return this . request ( 'files/list_folder/longpoll' , arg , 'noauth' , 'notify' , 'rpc' ) ;
} ;
/ * *
* Returns revisions for files based on a file path or a file id . The file path
* or file id is identified from the latest file entry at the given file path or
* id . This end point allows your app to query either by file path or file id by
* setting the mode parameter appropriately . In the ListRevisionsMode . path
* ( default ) mode , all revisions at the same file path as the latest file entry
* are returned . If revisions with the same file id are desired , then mode must
* be set to ListRevisionsMode . id . The ListRevisionsMode . id mode is useful to
* retrieve revisions for a given file across moves or renames .
* @ function Dropbox # filesListRevisions
* @ arg { FilesListRevisionsArg } arg - The request parameters .
* @ returns { Promise . < FilesListRevisionsResult , Error . < FilesListRevisionsError >> }
* /
routes . filesListRevisions = function ( arg ) {
return this . request ( 'files/list_revisions' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-29 00:56:17 +00:00
/ * *
* Move a file or folder to a different location in the user ' s Dropbox . If the
* source path is a folder all its contents will be moved .
* @ function Dropbox # filesMoveV2
* @ arg { FilesRelocationArg } arg - The request parameters .
* @ returns { Promise . < FilesRelocationResult , Error . < FilesRelocationError >> }
* /
routes . filesMoveV2 = function ( arg ) {
return this . request ( 'files/move_v2' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Move a file or folder to a different location in the user ' s Dropbox . If the
* source path is a folder all its contents will be moved .
* @ function Dropbox # filesMove
* @ deprecated
* @ arg { FilesRelocationArg } arg - The request parameters .
* @ returns { Promise . < ( FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata ) , Error . < FilesRelocationError >> }
* /
routes . filesMove = function ( arg ) {
return this . request ( 'files/move' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2019-07-08 09:59:04 +00:00
/ * *
* Move multiple files or folders to different locations at once in the user ' s
* Dropbox . This route will replace move _batch _v2 . The main difference is this
* route will return stutus for each entry , while move _batch raises failure if
* any entry fails . This route will either finish synchronously , or return a job
* ID and do the async move job in background . Please use move _batch / check _v2 to
* check the job status .
* @ function Dropbox # filesMoveBatchV2
* @ arg { FilesMoveBatchArg } arg - The request parameters .
* @ returns { Promise . < FilesRelocationBatchV2Launch , Error . < void >> }
* /
routes . filesMoveBatchV2 = function ( arg ) {
return this . request ( 'files/move_batch_v2' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Move multiple files or folders to different locations at once in the user ' s
* Dropbox . This route is 'all or nothing' , which means if one entry fails , the
* whole transaction will abort . This route will return job ID immediately and
* do the async moving job in background . Please use move _batch / check to check
* the job status .
* @ function Dropbox # filesMoveBatch
* @ arg { FilesRelocationBatchArg } arg - The request parameters .
* @ returns { Promise . < FilesRelocationBatchLaunch , Error . < void >> }
* /
routes . filesMoveBatch = function ( arg ) {
return this . request ( 'files/move_batch' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2019-07-08 09:59:04 +00:00
/ * *
* Returns the status of an asynchronous job for move _batch _v2 . It returns list
* of results for each entry .
* @ function Dropbox # filesMoveBatchCheckV2
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < FilesRelocationBatchV2JobStatus , Error . < AsyncPollError >> }
* /
routes . filesMoveBatchCheckV2 = function ( arg ) {
return this . request ( 'files/move_batch/check_v2' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Returns the status of an asynchronous job for move _batch . If success , it
* returns list of results for each entry .
* @ function Dropbox # filesMoveBatchCheck
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < FilesRelocationBatchJobStatus , Error . < AsyncPollError >> }
* /
routes . filesMoveBatchCheck = function ( arg ) {
return this . request ( 'files/move_batch/check' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Permanently delete the file or folder at a given path ( see
* https : //www.dropbox.com/en/help/40). Note: This endpoint is only available
* for Dropbox Business apps .
* @ function Dropbox # filesPermanentlyDelete
* @ arg { FilesDeleteArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilesDeleteError >> }
* /
routes . filesPermanentlyDelete = function ( arg ) {
return this . request ( 'files/permanently_delete' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* @ function Dropbox # filesPropertiesAdd
* @ deprecated
* @ arg { FilePropertiesAddPropertiesArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesAddPropertiesError >> }
* /
routes . filesPropertiesAdd = function ( arg ) {
return this . request ( 'files/properties/add' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* @ function Dropbox # filesPropertiesOverwrite
* @ deprecated
* @ arg { FilePropertiesOverwritePropertyGroupArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesInvalidPropertyGroupError >> }
* /
routes . filesPropertiesOverwrite = function ( arg ) {
return this . request ( 'files/properties/overwrite' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* @ function Dropbox # filesPropertiesRemove
* @ deprecated
* @ arg { FilePropertiesRemovePropertiesArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesRemovePropertiesError >> }
* /
routes . filesPropertiesRemove = function ( arg ) {
return this . request ( 'files/properties/remove' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* @ function Dropbox # filesPropertiesTemplateGet
* @ deprecated
* @ arg { FilePropertiesGetTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesGetTemplateResult , Error . < FilePropertiesTemplateError >> }
* /
routes . filesPropertiesTemplateGet = function ( arg ) {
return this . request ( 'files/properties/template/get' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* @ function Dropbox # filesPropertiesTemplateList
* @ deprecated
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < FilePropertiesListTemplateResult , Error . < FilePropertiesTemplateError >> }
* /
routes . filesPropertiesTemplateList = function ( arg ) {
return this . request ( 'files/properties/template/list' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* @ function Dropbox # filesPropertiesUpdate
* @ deprecated
* @ arg { FilePropertiesUpdatePropertiesArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilePropertiesUpdatePropertiesError >> }
* /
routes . filesPropertiesUpdate = function ( arg ) {
return this . request ( 'files/properties/update' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2018-11-29 00:56:17 +00:00
* Restore a specific revision of a file to the given path .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # filesRestore
* @ arg { FilesRestoreArg } arg - The request parameters .
* @ returns { Promise . < FilesFileMetadata , Error . < FilesRestoreError >> }
* /
routes . filesRestore = function ( arg ) {
return this . request ( 'files/restore' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Save the data from a specified URL into a file in user ' s Dropbox . Note that
* the transfer from the URL must complete within 5 minutes , or the operation
* will time out and the job will fail . If the given path already exists , the
* file will be renamed to avoid the conflict ( e . g . myfile ( 1 ) . txt ) .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # filesSaveUrl
* @ arg { FilesSaveUrlArg } arg - The request parameters .
* @ returns { Promise . < FilesSaveUrlResult , Error . < FilesSaveUrlError >> }
* /
routes . filesSaveUrl = function ( arg ) {
return this . request ( 'files/save_url' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Check the status of a save _url job .
* @ function Dropbox # filesSaveUrlCheckJobStatus
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < FilesSaveUrlJobStatus , Error . < AsyncPollError >> }
* /
routes . filesSaveUrlCheckJobStatus = function ( arg ) {
return this . request ( 'files/save_url/check_job_status' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Searches for files and folders . Note : Recent changes may not immediately be
* reflected in search results due to a short delay in indexing .
* @ function Dropbox # filesSearch
* @ arg { FilesSearchArg } arg - The request parameters .
* @ returns { Promise . < FilesSearchResult , Error . < FilesSearchError >> }
* /
routes . filesSearch = function ( arg ) {
return this . request ( 'files/search' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Create a new file with the contents provided in the request . Do not use this
* to upload a file larger than 150 MB . Instead , create an upload session with
2018-11-29 00:56:17 +00:00
* upload _session / start . Calls to this endpoint will count as data transport
* calls for any Dropbox Business teams with a limit on the number of data
* transport calls allowed per month . For more information , see the Data
* transport limit page
* https : //www.dropbox.com/developers/reference/data-transport-limit.
2018-11-03 18:33:35 +00:00
* @ function Dropbox # filesUpload
* @ arg { FilesCommitInfo } arg - The request parameters .
* @ returns { Promise . < FilesFileMetadata , Error . < FilesUploadError >> }
* /
routes . filesUpload = function ( arg ) {
return this . request ( 'files/upload' , arg , 'user' , 'content' , 'upload' ) ;
} ;
/ * *
* Append more data to an upload session . When the parameter close is set , this
* call will close the session . A single request should not upload more than 150
* MB . The maximum size of a file one can upload to an upload session is 350 GB .
2018-11-29 00:56:17 +00:00
* Calls to this endpoint will count as data transport calls for any Dropbox
* Business teams with a limit on the number of data transport calls allowed per
* month . For more information , see the Data transport limit page
* https : //www.dropbox.com/developers/reference/data-transport-limit.
2018-11-03 18:33:35 +00:00
* @ function Dropbox # filesUploadSessionAppendV2
* @ arg { FilesUploadSessionAppendArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilesUploadSessionLookupError >> }
* /
routes . filesUploadSessionAppendV2 = function ( arg ) {
return this . request ( 'files/upload_session/append_v2' , arg , 'user' , 'content' , 'upload' ) ;
} ;
2018-11-29 00:56:17 +00:00
/ * *
* Append more data to an upload session . A single request should not upload
* more than 150 MB . The maximum size of a file one can upload to an upload
* session is 350 GB . Calls to this endpoint will count as data transport calls
* for any Dropbox Business teams with a limit on the number of data transport
* calls allowed per month . For more information , see the Data transport limit
* page https : //www.dropbox.com/developers/reference/data-transport-limit.
* @ function Dropbox # filesUploadSessionAppend
* @ deprecated
* @ arg { FilesUploadSessionCursor } arg - The request parameters .
* @ returns { Promise . < void , Error . < FilesUploadSessionLookupError >> }
* /
routes . filesUploadSessionAppend = function ( arg ) {
return this . request ( 'files/upload_session/append' , arg , 'user' , 'content' , 'upload' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Finish an upload session and save the uploaded data to the given file path . A
* single request should not upload more than 150 MB . The maximum size of a file
2018-11-29 00:56:17 +00:00
* one can upload to an upload session is 350 GB . Calls to this endpoint will
* count as data transport calls for any Dropbox Business teams with a limit on
* the number of data transport calls allowed per month . For more information ,
* see the Data transport limit page
* https : //www.dropbox.com/developers/reference/data-transport-limit.
2018-11-03 18:33:35 +00:00
* @ function Dropbox # filesUploadSessionFinish
* @ arg { FilesUploadSessionFinishArg } arg - The request parameters .
* @ returns { Promise . < FilesFileMetadata , Error . < FilesUploadSessionFinishError >> }
* /
routes . filesUploadSessionFinish = function ( arg ) {
return this . request ( 'files/upload_session/finish' , arg , 'user' , 'content' , 'upload' ) ;
} ;
/ * *
* This route helps you commit many files at once into a user ' s Dropbox . Use
* upload _session / start and upload _session / append _v2 to upload file contents . We
* recommend uploading many files in parallel to increase throughput . Once the
* file contents have been uploaded , rather than calling upload _session / finish ,
* use this route to finish all your upload sessions in a single request .
* UploadSessionStartArg . close or UploadSessionAppendArg . close needs to be true
* for the last upload _session / start or upload _session / append _v2 call . The
* maximum size of a file one can upload to an upload session is 350 GB . This
* route will return a job _id immediately and do the async commit job in
* background . Use upload _session / finish _batch / check to check the job status .
* For the same account , this route should be executed serially . That means you
* should not start the next job before current job finishes . We allow up to
2018-11-29 00:56:17 +00:00
* 1000 entries in a single request . Calls to this endpoint will count as data
* transport calls for any Dropbox Business teams with a limit on the number of
* data transport calls allowed per month . For more information , see the Data
* transport limit page
* https : //www.dropbox.com/developers/reference/data-transport-limit.
2018-11-03 18:33:35 +00:00
* @ function Dropbox # filesUploadSessionFinishBatch
* @ arg { FilesUploadSessionFinishBatchArg } arg - The request parameters .
* @ returns { Promise . < FilesUploadSessionFinishBatchLaunch , Error . < void >> }
* /
routes . filesUploadSessionFinishBatch = function ( arg ) {
return this . request ( 'files/upload_session/finish_batch' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns the status of an asynchronous job for upload _session / finish _batch . If
* success , it returns list of result for each entry .
* @ function Dropbox # filesUploadSessionFinishBatchCheck
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < FilesUploadSessionFinishBatchJobStatus , Error . < AsyncPollError >> }
* /
routes . filesUploadSessionFinishBatchCheck = function ( arg ) {
return this . request ( 'files/upload_session/finish_batch/check' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Upload sessions allow you to upload a single file in one or more requests ,
* for example where the size of the file is greater than 150 MB . This call
* starts a new upload session with the given data . You can then use
* upload _session / append _v2 to add more data and upload _session / finish to save
* all the data to a file in Dropbox . A single request should not upload more
* than 150 MB . The maximum size of a file one can upload to an upload session
* is 350 GB . An upload session can be used for a maximum of 48 hours .
* Attempting to use an UploadSessionStartResult . session _id with
* upload _session / append _v2 or upload _session / finish more than 48 hours after
2018-11-29 00:56:17 +00:00
* its creation will return a UploadSessionLookupError . not _found . Calls to this
* endpoint will count as data transport calls for any Dropbox Business teams
* with a limit on the number of data transport calls allowed per month . For
* more information , see the Data transport limit page
* https : //www.dropbox.com/developers/reference/data-transport-limit.
2018-11-03 18:33:35 +00:00
* @ function Dropbox # filesUploadSessionStart
* @ arg { FilesUploadSessionStartArg } arg - The request parameters .
* @ returns { Promise . < FilesUploadSessionStartResult , Error . < void >> }
* /
routes . filesUploadSessionStart = function ( arg ) {
return this . request ( 'files/upload_session/start' , arg , 'user' , 'content' , 'upload' ) ;
} ;
/ * *
* Marks the given Paper doc as archived . Note : This action can be performed or
* undone by anyone with edit permissions to the doc .
* @ function Dropbox # paperDocsArchive
* @ arg { PaperRefPaperDoc } arg - The request parameters .
* @ returns { Promise . < void , Error . < PaperDocLookupError >> }
* /
routes . paperDocsArchive = function ( arg ) {
return this . request ( 'paper/docs/archive' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Creates a new Paper doc with the provided content .
* @ function Dropbox # paperDocsCreate
* @ arg { PaperPaperDocCreateArgs } arg - The request parameters .
* @ returns { Promise . < PaperPaperDocCreateUpdateResult , Error . < PaperPaperDocCreateError >> }
* /
routes . paperDocsCreate = function ( arg ) {
return this . request ( 'paper/docs/create' , arg , 'user' , 'api' , 'upload' ) ;
} ;
/ * *
* Exports and downloads Paper doc either as HTML or markdown .
* @ function Dropbox # paperDocsDownload
* @ arg { PaperPaperDocExport } arg - The request parameters .
* @ returns { Promise . < PaperPaperDocExportResult , Error . < PaperDocLookupError >> }
* /
routes . paperDocsDownload = function ( arg ) {
return this . request ( 'paper/docs/download' , arg , 'user' , 'api' , 'download' ) ;
} ;
/ * *
* Lists the users who are explicitly invited to the Paper folder in which the
* Paper doc is contained . For private folders all users ( including owner )
* shared on the folder are listed and for team folders all non - team users
* shared on the folder are returned .
* @ function Dropbox # paperDocsFolderUsersList
* @ arg { PaperListUsersOnFolderArgs } arg - The request parameters .
* @ returns { Promise . < PaperListUsersOnFolderResponse , Error . < PaperDocLookupError >> }
* /
routes . paperDocsFolderUsersList = function ( arg ) {
return this . request ( 'paper/docs/folder_users/list' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from docs / folder _users / list , use this to
* paginate through all users on the Paper folder .
* @ function Dropbox # paperDocsFolderUsersListContinue
* @ arg { PaperListUsersOnFolderContinueArgs } arg - The request parameters .
* @ returns { Promise . < PaperListUsersOnFolderResponse , Error . < PaperListUsersCursorError >> }
* /
routes . paperDocsFolderUsersListContinue = function ( arg ) {
return this . request ( 'paper/docs/folder_users/list/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Retrieves folder information for the given Paper doc . This includes : -
* folder sharing policy ; permissions for subfolders are set by the top - level
* folder . - full 'filepath' , i . e . the list of folders ( both folderId and
* folderName ) from the root folder to the folder directly containing the
* Paper doc . Note : If the Paper doc is not in any folder ( aka unfiled ) the
* response will be empty .
* @ function Dropbox # paperDocsGetFolderInfo
* @ arg { PaperRefPaperDoc } arg - The request parameters .
* @ returns { Promise . < PaperFoldersContainingPaperDoc , Error . < PaperDocLookupError >> }
* /
routes . paperDocsGetFolderInfo = function ( arg ) {
return this . request ( 'paper/docs/get_folder_info' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Return the list of all Paper docs according to the argument specifications .
* To iterate over through the full pagination , pass the cursor to
* docs / list / continue .
* @ function Dropbox # paperDocsList
* @ arg { PaperListPaperDocsArgs } arg - The request parameters .
* @ returns { Promise . < PaperListPaperDocsResponse , Error . < void >> }
* /
routes . paperDocsList = function ( arg ) {
return this . request ( 'paper/docs/list' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from docs / list , use this to paginate through
* all Paper doc .
* @ function Dropbox # paperDocsListContinue
* @ arg { PaperListPaperDocsContinueArgs } arg - The request parameters .
* @ returns { Promise . < PaperListPaperDocsResponse , Error . < PaperListDocsCursorError >> }
* /
routes . paperDocsListContinue = function ( arg ) {
return this . request ( 'paper/docs/list/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Permanently deletes the given Paper doc . This operation is final as the doc
* cannot be recovered . Note : This action can be performed only by the doc
* owner .
* @ function Dropbox # paperDocsPermanentlyDelete
* @ arg { PaperRefPaperDoc } arg - The request parameters .
* @ returns { Promise . < void , Error . < PaperDocLookupError >> }
* /
routes . paperDocsPermanentlyDelete = function ( arg ) {
return this . request ( 'paper/docs/permanently_delete' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Gets the default sharing policy for the given Paper doc .
* @ function Dropbox # paperDocsSharingPolicyGet
* @ arg { PaperRefPaperDoc } arg - The request parameters .
* @ returns { Promise . < PaperSharingPolicy , Error . < PaperDocLookupError >> }
* /
routes . paperDocsSharingPolicyGet = function ( arg ) {
return this . request ( 'paper/docs/sharing_policy/get' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Sets the default sharing policy for the given Paper doc . The default
* 'team_sharing_policy' can be changed only by teams , omit this field for
* personal accounts . Note : 'public_sharing_policy' cannot be set to the value
* 'disabled' because this setting can be changed only via the team admin
* console .
* @ function Dropbox # paperDocsSharingPolicySet
* @ arg { PaperPaperDocSharingPolicy } arg - The request parameters .
* @ returns { Promise . < void , Error . < PaperDocLookupError >> }
* /
routes . paperDocsSharingPolicySet = function ( arg ) {
return this . request ( 'paper/docs/sharing_policy/set' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Updates an existing Paper doc with the provided content .
* @ function Dropbox # paperDocsUpdate
* @ arg { PaperPaperDocUpdateArgs } arg - The request parameters .
* @ returns { Promise . < PaperPaperDocCreateUpdateResult , Error . < PaperPaperDocUpdateError >> }
* /
routes . paperDocsUpdate = function ( arg ) {
return this . request ( 'paper/docs/update' , arg , 'user' , 'api' , 'upload' ) ;
} ;
/ * *
* Allows an owner or editor to add users to a Paper doc or change their
* permissions using their email address or Dropbox account ID . Note : The Doc
* owner ' s permissions cannot be changed .
* @ function Dropbox # paperDocsUsersAdd
* @ arg { PaperAddPaperDocUser } arg - The request parameters .
* @ returns { Promise . < Array . < PaperAddPaperDocUserMemberResult > , Error . < PaperDocLookupError >> }
* /
routes . paperDocsUsersAdd = function ( arg ) {
return this . request ( 'paper/docs/users/add' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Lists all users who visited the Paper doc or users with explicit access . This
* call excludes users who have been removed . The list is sorted by the date of
* the visit or the share date . The list will include both users , the explicitly
* shared ones as well as those who came in using the Paper url link .
* @ function Dropbox # paperDocsUsersList
* @ arg { PaperListUsersOnPaperDocArgs } arg - The request parameters .
* @ returns { Promise . < PaperListUsersOnPaperDocResponse , Error . < PaperDocLookupError >> }
* /
routes . paperDocsUsersList = function ( arg ) {
return this . request ( 'paper/docs/users/list' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from docs / users / list , use this to paginate
* through all users on the Paper doc .
* @ function Dropbox # paperDocsUsersListContinue
* @ arg { PaperListUsersOnPaperDocContinueArgs } arg - The request parameters .
* @ returns { Promise . < PaperListUsersOnPaperDocResponse , Error . < PaperListUsersCursorError >> }
* /
routes . paperDocsUsersListContinue = function ( arg ) {
return this . request ( 'paper/docs/users/list/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Allows an owner or editor to remove users from a Paper doc using their email
* address or Dropbox account ID . Note : Doc owner cannot be removed .
* @ function Dropbox # paperDocsUsersRemove
* @ arg { PaperRemovePaperDocUser } arg - The request parameters .
* @ returns { Promise . < void , Error . < PaperDocLookupError >> }
* /
routes . paperDocsUsersRemove = function ( arg ) {
return this . request ( 'paper/docs/users/remove' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Adds specified members to a file .
* @ function Dropbox # sharingAddFileMember
* @ arg { SharingAddFileMemberArgs } arg - The request parameters .
* @ returns { Promise . < Array . < SharingFileMemberActionResult > , Error . < SharingAddFileMemberError >> }
* /
routes . sharingAddFileMember = function ( arg ) {
return this . request ( 'sharing/add_file_member' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Allows an owner or editor ( if the ACL update policy allows ) of a shared
* folder to add another member . For the new member to get access to all the
* functionality for this folder , you will need to call mount _folder on their
2019-07-08 09:59:04 +00:00
* behalf .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingAddFolderMember
* @ arg { SharingAddFolderMemberArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < SharingAddFolderMemberError >> }
* /
routes . sharingAddFolderMember = function ( arg ) {
return this . request ( 'sharing/add_folder_member' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Identical to update _file _member but with less information returned .
* @ function Dropbox # sharingChangeFileMemberAccess
* @ deprecated
* @ arg { SharingChangeFileMemberAccessArgs } arg - The request parameters .
* @ returns { Promise . < SharingFileMemberActionResult , Error . < SharingFileMemberActionError >> }
* /
routes . sharingChangeFileMemberAccess = function ( arg ) {
return this . request ( 'sharing/change_file_member_access' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Returns the status of an asynchronous job .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingCheckJobStatus
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < SharingJobStatus , Error . < AsyncPollError >> }
* /
routes . sharingCheckJobStatus = function ( arg ) {
return this . request ( 'sharing/check_job_status' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Returns the status of an asynchronous job for sharing a folder .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingCheckRemoveMemberJobStatus
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < SharingRemoveMemberJobStatus , Error . < AsyncPollError >> }
* /
routes . sharingCheckRemoveMemberJobStatus = function ( arg ) {
return this . request ( 'sharing/check_remove_member_job_status' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Returns the status of an asynchronous job for sharing a folder .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingCheckShareJobStatus
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < SharingShareFolderJobStatus , Error . < AsyncPollError >> }
* /
routes . sharingCheckShareJobStatus = function ( arg ) {
return this . request ( 'sharing/check_share_job_status' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Create a shared link . If a shared link already exists for the given path ,
* that link is returned . Note that in the returned PathLinkMetadata , the
* PathLinkMetadata . url field is the shortened URL if
* CreateSharedLinkArg . short _url argument is set to true . Previously , it was
* technically possible to break a shared link by moving or renaming the
* corresponding file or folder . In the future , this will no longer be the case ,
* so your app shouldn ' t rely on this behavior . Instead , if your app needs to
* revoke a shared link , use revoke _shared _link .
* @ function Dropbox # sharingCreateSharedLink
* @ deprecated
* @ arg { SharingCreateSharedLinkArg } arg - The request parameters .
* @ returns { Promise . < SharingPathLinkMetadata , Error . < SharingCreateSharedLinkError >> }
* /
routes . sharingCreateSharedLink = function ( arg ) {
return this . request ( 'sharing/create_shared_link' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Create a shared link with custom settings . If no settings are given then the
* default visibility is RequestedVisibility . public ( The resolved visibility ,
* though , may depend on other aspects such as team and shared folder settings ) .
* @ function Dropbox # sharingCreateSharedLinkWithSettings
* @ arg { SharingCreateSharedLinkWithSettingsArg } arg - The request parameters .
* @ returns { Promise . < ( SharingFileLinkMetadata | SharingFolderLinkMetadata | SharingSharedLinkMetadata ) , Error . < SharingCreateSharedLinkWithSettingsError >> }
* /
routes . sharingCreateSharedLinkWithSettings = function ( arg ) {
return this . request ( 'sharing/create_shared_link_with_settings' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns shared file metadata .
* @ function Dropbox # sharingGetFileMetadata
* @ arg { SharingGetFileMetadataArg } arg - The request parameters .
* @ returns { Promise . < SharingSharedFileMetadata , Error . < SharingGetFileMetadataError >> }
* /
routes . sharingGetFileMetadata = function ( arg ) {
return this . request ( 'sharing/get_file_metadata' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns shared file metadata .
* @ function Dropbox # sharingGetFileMetadataBatch
* @ arg { SharingGetFileMetadataBatchArg } arg - The request parameters .
* @ returns { Promise . < Array . < SharingGetFileMetadataBatchResult > , Error . < SharingSharingUserError >> }
* /
routes . sharingGetFileMetadataBatch = function ( arg ) {
return this . request ( 'sharing/get_file_metadata/batch' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Returns shared folder metadata by its folder ID .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingGetFolderMetadata
* @ arg { SharingGetMetadataArgs } arg - The request parameters .
* @ returns { Promise . < SharingSharedFolderMetadata , Error . < SharingSharedFolderAccessError >> }
* /
routes . sharingGetFolderMetadata = function ( arg ) {
return this . request ( 'sharing/get_folder_metadata' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Download the shared link 's file from a user' s Dropbox .
* @ function Dropbox # sharingGetSharedLinkFile
* @ arg { Object } arg - The request parameters .
* @ returns { Promise . < ( SharingFileLinkMetadata | SharingFolderLinkMetadata | SharingSharedLinkMetadata ) , Error . < SharingGetSharedLinkFileError >> }
* /
routes . sharingGetSharedLinkFile = function ( arg ) {
return this . request ( 'sharing/get_shared_link_file' , arg , 'user' , 'content' , 'download' ) ;
} ;
/ * *
* Get the shared link ' s metadata .
* @ function Dropbox # sharingGetSharedLinkMetadata
* @ arg { SharingGetSharedLinkMetadataArg } arg - The request parameters .
* @ returns { Promise . < ( SharingFileLinkMetadata | SharingFolderLinkMetadata | SharingSharedLinkMetadata ) , Error . < SharingSharedLinkError >> }
* /
routes . sharingGetSharedLinkMetadata = function ( arg ) {
return this . request ( 'sharing/get_shared_link_metadata' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns a list of LinkMetadata objects for this user , including collection
* links . If no path is given , returns a list of all shared links for the
* current user , including collection links , up to a maximum of 1000 links . If a
* non - empty path is given , returns a list of all shared links that allow access
* to the given path . Collection links are never returned in this case . Note
* that the url field in the response is never the shortened URL .
* @ function Dropbox # sharingGetSharedLinks
* @ deprecated
* @ arg { SharingGetSharedLinksArg } arg - The request parameters .
* @ returns { Promise . < SharingGetSharedLinksResult , Error . < SharingGetSharedLinksError >> }
* /
routes . sharingGetSharedLinks = function ( arg ) {
return this . request ( 'sharing/get_shared_links' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Use to obtain the members who have been invited to a file , both inherited and
* uninherited members .
* @ function Dropbox # sharingListFileMembers
* @ arg { SharingListFileMembersArg } arg - The request parameters .
* @ returns { Promise . < SharingSharedFileMembers , Error . < SharingListFileMembersError >> }
* /
routes . sharingListFileMembers = function ( arg ) {
return this . request ( 'sharing/list_file_members' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get members of multiple files at once . The arguments to this route are more
* limited , and the limit on query result size per file is more strict . To
* customize the results more , use the individual file endpoint . Inherited users
* and groups are not included in the result , and permissions are not returned
* for this endpoint .
* @ function Dropbox # sharingListFileMembersBatch
* @ arg { SharingListFileMembersBatchArg } arg - The request parameters .
* @ returns { Promise . < Array . < SharingListFileMembersBatchResult > , Error . < SharingSharingUserError >> }
* /
routes . sharingListFileMembersBatch = function ( arg ) {
return this . request ( 'sharing/list_file_members/batch' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from list _file _members or
* list _file _members / batch , use this to paginate through all shared file
* members .
* @ function Dropbox # sharingListFileMembersContinue
* @ arg { SharingListFileMembersContinueArg } arg - The request parameters .
* @ returns { Promise . < SharingSharedFileMembers , Error . < SharingListFileMembersContinueError >> }
* /
routes . sharingListFileMembersContinue = function ( arg ) {
return this . request ( 'sharing/list_file_members/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Returns shared folder membership by its folder ID .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingListFolderMembers
* @ arg { SharingListFolderMembersArgs } arg - The request parameters .
* @ returns { Promise . < SharingSharedFolderMembers , Error . < SharingSharedFolderAccessError >> }
* /
routes . sharingListFolderMembers = function ( arg ) {
return this . request ( 'sharing/list_folder_members' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from list _folder _members , use this to
2019-07-08 09:59:04 +00:00
* paginate through all shared folder members .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingListFolderMembersContinue
* @ arg { SharingListFolderMembersContinueArg } arg - The request parameters .
* @ returns { Promise . < SharingSharedFolderMembers , Error . < SharingListFolderMembersContinueError >> }
* /
routes . sharingListFolderMembersContinue = function ( arg ) {
return this . request ( 'sharing/list_folder_members/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Return the list of all shared folders the current user has access to .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingListFolders
* @ arg { SharingListFoldersArgs } arg - The request parameters .
* @ returns { Promise . < SharingListFoldersResult , Error . < void >> }
* /
routes . sharingListFolders = function ( arg ) {
return this . request ( 'sharing/list_folders' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from list _folders , use this to paginate
* through all shared folders . The cursor must come from a previous call to
2019-07-08 09:59:04 +00:00
* list _folders or list _folders / continue .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingListFoldersContinue
* @ arg { SharingListFoldersContinueArg } arg - The request parameters .
* @ returns { Promise . < SharingListFoldersResult , Error . < SharingListFoldersContinueError >> }
* /
routes . sharingListFoldersContinue = function ( arg ) {
return this . request ( 'sharing/list_folders/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Return the list of all shared folders the current user can mount or unmount .
* @ function Dropbox # sharingListMountableFolders
* @ arg { SharingListFoldersArgs } arg - The request parameters .
* @ returns { Promise . < SharingListFoldersResult , Error . < void >> }
* /
routes . sharingListMountableFolders = function ( arg ) {
return this . request ( 'sharing/list_mountable_folders' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from list _mountable _folders , use this to
* paginate through all mountable shared folders . The cursor must come from a
* previous call to list _mountable _folders or list _mountable _folders / continue .
* @ function Dropbox # sharingListMountableFoldersContinue
* @ arg { SharingListFoldersContinueArg } arg - The request parameters .
* @ returns { Promise . < SharingListFoldersResult , Error . < SharingListFoldersContinueError >> }
* /
routes . sharingListMountableFoldersContinue = function ( arg ) {
return this . request ( 'sharing/list_mountable_folders/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns a list of all files shared with current user . Does not include files
* the user has received via shared folders , and does not include unclaimed
* invitations .
* @ function Dropbox # sharingListReceivedFiles
* @ arg { SharingListFilesArg } arg - The request parameters .
* @ returns { Promise . < SharingListFilesResult , Error . < SharingSharingUserError >> }
* /
routes . sharingListReceivedFiles = function ( arg ) {
return this . request ( 'sharing/list_received_files' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get more results with a cursor from list _received _files .
* @ function Dropbox # sharingListReceivedFilesContinue
* @ arg { SharingListFilesContinueArg } arg - The request parameters .
* @ returns { Promise . < SharingListFilesResult , Error . < SharingListFilesContinueError >> }
* /
routes . sharingListReceivedFilesContinue = function ( arg ) {
return this . request ( 'sharing/list_received_files/continue' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* List shared links of this user . If no path is given , returns a list of all
* shared links for the current user . If a non - empty path is given , returns a
* list of all shared links that allow access to the given path - direct links
* to the given path and links to parent folders of the given path . Links to
* parent folders can be suppressed by setting direct _only to true .
* @ function Dropbox # sharingListSharedLinks
* @ arg { SharingListSharedLinksArg } arg - The request parameters .
* @ returns { Promise . < SharingListSharedLinksResult , Error . < SharingListSharedLinksError >> }
* /
routes . sharingListSharedLinks = function ( arg ) {
return this . request ( 'sharing/list_shared_links' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Modify the shared link ' s settings . If the requested visibility conflict with
* the shared links policy of the team or the shared folder ( in case the linked
* file is part of a shared folder ) then the LinkPermissions . resolved _visibility
* of the returned SharedLinkMetadata will reflect the actual visibility of the
* shared link and the LinkPermissions . requested _visibility will reflect the
* requested visibility .
* @ function Dropbox # sharingModifySharedLinkSettings
* @ arg { SharingModifySharedLinkSettingsArgs } arg - The request parameters .
* @ returns { Promise . < ( SharingFileLinkMetadata | SharingFolderLinkMetadata | SharingSharedLinkMetadata ) , Error . < SharingModifySharedLinkSettingsError >> }
* /
routes . sharingModifySharedLinkSettings = function ( arg ) {
return this . request ( 'sharing/modify_shared_link_settings' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* The current user mounts the designated folder . Mount a shared folder for a
* user after they have been added as a member . Once mounted , the shared folder
2019-07-08 09:59:04 +00:00
* will appear in their Dropbox .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingMountFolder
* @ arg { SharingMountFolderArg } arg - The request parameters .
* @ returns { Promise . < SharingSharedFolderMetadata , Error . < SharingMountFolderError >> }
* /
routes . sharingMountFolder = function ( arg ) {
return this . request ( 'sharing/mount_folder' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* The current user relinquishes their membership in the designated file . Note
* that the current user may still have inherited access to this file through
2019-07-08 09:59:04 +00:00
* the parent folder .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingRelinquishFileMembership
* @ arg { SharingRelinquishFileMembershipArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < SharingRelinquishFileMembershipError >> }
* /
routes . sharingRelinquishFileMembership = function ( arg ) {
return this . request ( 'sharing/relinquish_file_membership' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* The current user relinquishes their membership in the designated shared
* folder and will no longer have access to the folder . A folder owner cannot
* relinquish membership in their own folder . This will run synchronously if
2019-07-08 09:59:04 +00:00
* leave _a _copy is false , and asynchronously if leave _a _copy is true .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingRelinquishFolderMembership
* @ arg { SharingRelinquishFolderMembershipArg } arg - The request parameters .
* @ returns { Promise . < AsyncLaunchEmptyResult , Error . < SharingRelinquishFolderMembershipError >> }
* /
routes . sharingRelinquishFolderMembership = function ( arg ) {
return this . request ( 'sharing/relinquish_folder_membership' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Identical to remove _file _member _2 but with less information returned .
* @ function Dropbox # sharingRemoveFileMember
* @ deprecated
* @ arg { SharingRemoveFileMemberArg } arg - The request parameters .
* @ returns { Promise . < SharingFileMemberActionIndividualResult , Error . < SharingRemoveFileMemberError >> }
* /
routes . sharingRemoveFileMember = function ( arg ) {
return this . request ( 'sharing/remove_file_member' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Removes a specified member from the file .
* @ function Dropbox # sharingRemoveFileMember2
* @ arg { SharingRemoveFileMemberArg } arg - The request parameters .
* @ returns { Promise . < SharingFileMemberRemoveActionResult , Error . < SharingRemoveFileMemberError >> }
* /
routes . sharingRemoveFileMember2 = function ( arg ) {
return this . request ( 'sharing/remove_file_member_2' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Allows an owner or editor ( if the ACL update policy allows ) of a shared
2019-07-08 09:59:04 +00:00
* folder to remove another member .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingRemoveFolderMember
* @ arg { SharingRemoveFolderMemberArg } arg - The request parameters .
* @ returns { Promise . < AsyncLaunchResultBase , Error . < SharingRemoveFolderMemberError >> }
* /
routes . sharingRemoveFolderMember = function ( arg ) {
return this . request ( 'sharing/remove_folder_member' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Revoke a shared link . Note that even after revoking a shared link to a file ,
* the file may be accessible if there are shared links leading to any of the
* file parent folders . To list all shared links that enable access to a
* specific file , you can use the list _shared _links with the file as the
* ListSharedLinksArg . path argument .
* @ function Dropbox # sharingRevokeSharedLink
* @ arg { SharingRevokeSharedLinkArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < SharingRevokeSharedLinkError >> }
* /
routes . sharingRevokeSharedLink = function ( arg ) {
return this . request ( 'sharing/revoke_shared_link' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Change the inheritance policy of an existing Shared Folder . Only permitted
* for shared folders in a shared team root . If a ShareFolderLaunch . async _job _id
* is returned , you ' ll need to call check _share _job _status until the action
* completes to get the metadata for the folder .
* @ function Dropbox # sharingSetAccessInheritance
* @ arg { SharingSetAccessInheritanceArg } arg - The request parameters .
* @ returns { Promise . < SharingShareFolderLaunch , Error . < SharingSetAccessInheritanceError >> }
* /
routes . sharingSetAccessInheritance = function ( arg ) {
return this . request ( 'sharing/set_access_inheritance' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Share a folder with collaborators . Most sharing will be completed
* synchronously . Large folders will be completed asynchronously . To make
* testing the async case repeatable , set ` ShareFolderArg.force_async ` . If a
* ShareFolderLaunch . async _job _id is returned , you ' ll need to call
* check _share _job _status until the action completes to get the metadata for the
2019-07-08 09:59:04 +00:00
* folder .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingShareFolder
* @ arg { SharingShareFolderArg } arg - The request parameters .
* @ returns { Promise . < SharingShareFolderLaunch , Error . < SharingShareFolderError >> }
* /
routes . sharingShareFolder = function ( arg ) {
return this . request ( 'sharing/share_folder' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Transfer ownership of a shared folder to a member of the shared folder . User
* must have AccessLevel . owner access to the shared folder to perform a
2019-07-08 09:59:04 +00:00
* transfer .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingTransferFolder
* @ arg { SharingTransferFolderArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < SharingTransferFolderError >> }
* /
routes . sharingTransferFolder = function ( arg ) {
return this . request ( 'sharing/transfer_folder' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* The current user unmounts the designated folder . They can re - mount the folder
2019-07-08 09:59:04 +00:00
* at a later time using mount _folder .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingUnmountFolder
* @ arg { SharingUnmountFolderArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < SharingUnmountFolderError >> }
* /
routes . sharingUnmountFolder = function ( arg ) {
return this . request ( 'sharing/unmount_folder' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Remove all members from this file . Does not remove inherited members .
* @ function Dropbox # sharingUnshareFile
* @ arg { SharingUnshareFileArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < SharingUnshareFileError >> }
* /
routes . sharingUnshareFile = function ( arg ) {
return this . request ( 'sharing/unshare_file' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Allows a shared folder owner to unshare the folder . You ' ll need to call
2019-07-08 09:59:04 +00:00
* check _job _status to determine if the action has completed successfully .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingUnshareFolder
* @ arg { SharingUnshareFolderArg } arg - The request parameters .
* @ returns { Promise . < AsyncLaunchEmptyResult , Error . < SharingUnshareFolderError >> }
* /
routes . sharingUnshareFolder = function ( arg ) {
return this . request ( 'sharing/unshare_folder' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Changes a member ' s access on a shared file .
* @ function Dropbox # sharingUpdateFileMember
* @ arg { SharingUpdateFileMemberArgs } arg - The request parameters .
* @ returns { Promise . < SharingMemberAccessLevelResult , Error . < SharingFileMemberActionError >> }
* /
routes . sharingUpdateFileMember = function ( arg ) {
return this . request ( 'sharing/update_file_member' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Allows an owner or editor of a shared folder to update another member ' s
2019-07-08 09:59:04 +00:00
* permissions .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingUpdateFolderMember
* @ arg { SharingUpdateFolderMemberArg } arg - The request parameters .
* @ returns { Promise . < SharingMemberAccessLevelResult , Error . < SharingUpdateFolderMemberError >> }
* /
routes . sharingUpdateFolderMember = function ( arg ) {
return this . request ( 'sharing/update_folder_member' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Update the sharing policies for a shared folder . User must have
2019-07-08 09:59:04 +00:00
* AccessLevel . owner access to the shared folder to update its policies .
2018-11-03 18:33:35 +00:00
* @ function Dropbox # sharingUpdateFolderPolicy
* @ arg { SharingUpdateFolderPolicyArg } arg - The request parameters .
* @ returns { Promise . < SharingSharedFolderMetadata , Error . < SharingUpdateFolderPolicyError >> }
* /
routes . sharingUpdateFolderPolicy = function ( arg ) {
return this . request ( 'sharing/update_folder_policy' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Retrieves team events . Events have a lifespan of two years . Events older than
* two years will not be returned . Many attributes note ' may be missing due to
* historical data gap ' . Note that the file _operations category and & analogous
* paper events are not available on all Dropbox Business plans
* / b u s i n e s s / p l a n s - c o m p a r i s o n . U s e f e a t u r e s / g e t _ v a l u e s
* / d e v e l o p e r s / d o c u m e n t a t i o n / h t t p / t e a m s # t e a m - f e a t u r e s - g e t _ v a l u e s t o c h e c k f o r
* this feature . Permission : Team Auditing .
* @ function Dropbox # teamLogGetEvents
* @ arg { TeamLogGetTeamEventsArg } arg - The request parameters .
* @ returns { Promise . < TeamLogGetTeamEventsResult , Error . < TeamLogGetTeamEventsError >> }
* /
routes . teamLogGetEvents = function ( arg ) {
return this . request ( 'team_log/get_events' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from get _events , use this to paginate
* through all events . Permission : Team Auditing .
* @ function Dropbox # teamLogGetEventsContinue
* @ arg { TeamLogGetTeamEventsContinueArg } arg - The request parameters .
* @ returns { Promise . < TeamLogGetTeamEventsResult , Error . < TeamLogGetTeamEventsContinueError >> }
* /
routes . teamLogGetEventsContinue = function ( arg ) {
return this . request ( 'team_log/get_events/continue' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get information about a user ' s account .
* @ function Dropbox # usersGetAccount
* @ arg { UsersGetAccountArg } arg - The request parameters .
* @ returns { Promise . < UsersBasicAccount , Error . < UsersGetAccountError >> }
* /
routes . usersGetAccount = function ( arg ) {
return this . request ( 'users/get_account' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get information about multiple user accounts . At most 300 accounts may be
* queried per request .
* @ function Dropbox # usersGetAccountBatch
* @ arg { UsersGetAccountBatchArg } arg - The request parameters .
* @ returns { Promise . < Object , Error . < UsersGetAccountBatchError >> }
* /
routes . usersGetAccountBatch = function ( arg ) {
return this . request ( 'users/get_account_batch' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get information about the current user ' s account .
* @ function Dropbox # usersGetCurrentAccount
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < UsersFullAccount , Error . < void >> }
* /
routes . usersGetCurrentAccount = function ( arg ) {
return this . request ( 'users/get_current_account' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get the space usage information for the current user ' s account .
* @ function Dropbox # usersGetSpaceUsage
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < UsersSpaceUsage , Error . < void >> }
* /
routes . usersGetSpaceUsage = function ( arg ) {
return this . request ( 'users/get_space_usage' , arg , 'user' , 'api' , 'rpc' ) ;
} ;
var RPC = 'rpc' ;
var UPLOAD = 'upload' ;
var DOWNLOAD = 'download' ;
function getSafeUnicode ( c ) {
var unicode = ( '000' + c . charCodeAt ( 0 ) . toString ( 16 ) ) . slice ( - 4 ) ;
return '\\u' + unicode ;
}
/* global WorkerGlobalScope */
function isWindowOrWorker ( ) {
return typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope || typeof module === 'undefined' || typeof window !== 'undefined' ;
}
function getBaseURL ( host ) {
return 'https://' + host + '.dropboxapi.com/2/' ;
}
// source https://www.dropboxforum.com/t5/API-support/HTTP-header-quot-Dropbox-API-Arg-quot-could-not-decode-input-as/m-p/173823/highlight/true#M6786
function httpHeaderSafeJson ( args ) {
return JSON . stringify ( args ) . replace ( /[\u007f-\uffff]/g , getSafeUnicode ) ;
}
var classCallCheck = function ( instance , Constructor ) {
if ( ! ( instance instanceof Constructor ) ) {
throw new TypeError ( "Cannot call a class as a function" ) ;
}
} ;
var createClass = function ( ) {
function defineProperties ( target , props ) {
for ( var i = 0 ; i < props . length ; i ++ ) {
var descriptor = props [ i ] ;
descriptor . enumerable = descriptor . enumerable || false ;
descriptor . configurable = true ;
if ( "value" in descriptor ) descriptor . writable = true ;
Object . defineProperty ( target , descriptor . key , descriptor ) ;
}
}
return function ( Constructor , protoProps , staticProps ) {
if ( protoProps ) defineProperties ( Constructor . prototype , protoProps ) ;
if ( staticProps ) defineProperties ( Constructor , staticProps ) ;
return Constructor ;
} ;
} ( ) ;
var inherits = function ( subClass , superClass ) {
if ( typeof superClass !== "function" && superClass !== null ) {
throw new TypeError ( "Super expression must either be null or a function, not " + typeof superClass ) ;
}
subClass . prototype = Object . create ( superClass && superClass . prototype , {
constructor : {
value : subClass ,
enumerable : false ,
writable : true ,
configurable : true
}
} ) ;
if ( superClass ) Object . setPrototypeOf ? Object . setPrototypeOf ( subClass , superClass ) : subClass . _ _proto _ _ = superClass ;
} ;
var possibleConstructorReturn = function ( self , call ) {
if ( ! self ) {
throw new ReferenceError ( "this hasn't been initialised - super() hasn't been called" ) ;
}
return call && ( typeof call === "object" || typeof call === "function" ) ? call : self ;
} ;
var slicedToArray = function ( ) {
function sliceIterator ( arr , i ) {
var _arr = [ ] ;
var _n = true ;
var _d = false ;
var _e = undefined ;
try {
for ( var _i = arr [ Symbol . iterator ] ( ) , _s ; ! ( _n = ( _s = _i . next ( ) ) . done ) ; _n = true ) {
_arr . push ( _s . value ) ;
if ( i && _arr . length === i ) break ;
}
} catch ( err ) {
_d = true ;
_e = err ;
} finally {
try {
if ( ! _n && _i [ "return" ] ) _i [ "return" ] ( ) ;
} finally {
if ( _d ) throw _e ;
}
}
return _arr ;
}
return function ( arr , i ) {
if ( Array . isArray ( arr ) ) {
return arr ;
} else if ( Symbol . iterator in Object ( arr ) ) {
return sliceIterator ( arr , i ) ;
} else {
throw new TypeError ( "Invalid attempt to destructure non-iterable instance" ) ;
}
} ;
} ( ) ;
function getDataFromConsumer ( res ) {
if ( ! res . ok ) {
return res . text ( ) ;
}
return isWindowOrWorker ( ) ? res . blob ( ) : res . buffer ( ) ;
}
function responseHandler ( res , data ) {
if ( ! res . ok ) {
// eslint-disable-next-line no-throw-literal
throw {
error : data ,
response : res ,
status : res . status
} ;
}
var result = JSON . parse ( res . headers . get ( 'dropbox-api-result' ) ) ;
if ( isWindowOrWorker ( ) ) {
result . fileBlob = data ;
} else {
result . fileBinary = data ;
}
return result ;
}
2018-11-29 00:56:17 +00:00
function downloadRequest ( fetch ) {
return function downloadRequestWithFetch ( path , args , auth , host , accessToken , options ) {
if ( auth !== 'user' ) {
throw new Error ( 'Unexpected auth type: ' + auth ) ;
2018-11-03 18:33:35 +00:00
}
2018-11-29 00:56:17 +00:00
var fetchOptions = {
method : 'POST' ,
headers : {
Authorization : 'Bearer ' + accessToken ,
'Dropbox-API-Arg' : httpHeaderSafeJson ( args )
}
} ;
if ( options ) {
if ( options . selectUser ) {
fetchOptions . headers [ 'Dropbox-API-Select-User' ] = options . selectUser ;
}
if ( options . selectAdmin ) {
fetchOptions . headers [ 'Dropbox-API-Select-Admin' ] = options . selectAdmin ;
}
2019-07-08 09:59:04 +00:00
if ( options . pathRoot ) {
fetchOptions . headers [ 'Dropbox-API-Path-Root' ] = options . pathRoot ;
}
2018-11-03 18:33:35 +00:00
}
2018-11-29 00:56:17 +00:00
return fetch ( getBaseURL ( host ) + path , fetchOptions ) . then ( function ( res ) {
return getDataFromConsumer ( res ) . then ( function ( data ) {
return [ res , data ] ;
} ) ;
} ) . then ( function ( _ref ) {
var _ref2 = slicedToArray ( _ref , 2 ) ,
res = _ref2 [ 0 ] ,
data = _ref2 [ 1 ] ;
2018-11-03 18:33:35 +00:00
2018-11-29 00:56:17 +00:00
return responseHandler ( res , data ) ;
} ) ;
} ;
2018-11-03 18:33:35 +00:00
}
function parseBodyToType$1 ( res ) {
var clone = res . clone ( ) ;
return new Promise ( function ( resolve ) {
res . json ( ) . then ( function ( data ) {
return resolve ( data ) ;
} ) . catch ( function ( ) {
return clone . text ( ) . then ( function ( data ) {
return resolve ( data ) ;
} ) ;
} ) ;
} ) . then ( function ( data ) {
return [ res , data ] ;
} ) ;
}
2018-11-29 00:56:17 +00:00
function uploadRequest ( fetch ) {
return function uploadRequestWithFetch ( path , args , auth , host , accessToken , options ) {
if ( auth !== 'user' ) {
throw new Error ( 'Unexpected auth type: ' + auth ) ;
}
2018-11-03 18:33:35 +00:00
2018-11-29 00:56:17 +00:00
var contents = args . contents ;
2018-11-03 18:33:35 +00:00
2018-11-29 00:56:17 +00:00
delete args . contents ;
2018-11-03 18:33:35 +00:00
2018-11-29 00:56:17 +00:00
var fetchOptions = {
body : contents ,
method : 'POST' ,
headers : {
Authorization : 'Bearer ' + accessToken ,
'Content-Type' : 'application/octet-stream' ,
'Dropbox-API-Arg' : httpHeaderSafeJson ( args )
}
} ;
2018-11-03 18:33:35 +00:00
2018-11-29 00:56:17 +00:00
if ( options ) {
if ( options . selectUser ) {
fetchOptions . headers [ 'Dropbox-API-Select-User' ] = options . selectUser ;
}
if ( options . selectAdmin ) {
fetchOptions . headers [ 'Dropbox-API-Select-Admin' ] = options . selectAdmin ;
}
2019-07-08 09:59:04 +00:00
if ( options . pathRoot ) {
fetchOptions . headers [ 'Dropbox-API-Path-Root' ] = options . pathRoot ;
}
2018-11-03 18:33:35 +00:00
}
2018-11-29 00:56:17 +00:00
return fetch ( getBaseURL ( host ) + path , fetchOptions ) . then ( function ( res ) {
return parseBodyToType$1 ( res ) ;
} ) . then ( function ( _ref ) {
var _ref2 = slicedToArray ( _ref , 2 ) ,
res = _ref2 [ 0 ] ,
data = _ref2 [ 1 ] ;
// maintaining existing API for error codes not equal to 200 range
if ( ! res . ok ) {
// eslint-disable-next-line no-throw-literal
throw {
error : data ,
response : res ,
status : res . status
} ;
}
2018-11-03 18:33:35 +00:00
2018-11-29 00:56:17 +00:00
return data ;
} ) ;
} ;
2018-11-03 18:33:35 +00:00
}
function createCommonjsModule ( fn , module ) {
return module = { exports : { } } , fn ( module , module . exports ) , module . exports ;
}
var byteLength _1 = byteLength ;
var toByteArray _1 = toByteArray ;
var fromByteArray _1 = fromByteArray ;
var lookup = [ ] ;
var revLookup = [ ] ;
var Arr = typeof Uint8Array !== 'undefined' ? Uint8Array : Array ;
var code = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/' ;
for ( var i = 0 , len = code . length ; i < len ; ++ i ) {
lookup [ i ] = code [ i ] ;
revLookup [ code . charCodeAt ( i ) ] = i ;
}
revLookup [ '-' . charCodeAt ( 0 ) ] = 62 ;
revLookup [ '_' . charCodeAt ( 0 ) ] = 63 ;
function placeHoldersCount ( b64 ) {
var len = b64 . length ;
if ( len % 4 > 0 ) {
throw new Error ( 'Invalid string. Length must be a multiple of 4' )
}
// the number of equal signs (place holders)
// if there are two placeholders, than the two characters before it
// represent one byte
// if there is only one, then the three characters before it represent 2 bytes
// this is just a cheap hack to not do indexOf twice
return b64 [ len - 2 ] === '=' ? 2 : b64 [ len - 1 ] === '=' ? 1 : 0
}
function byteLength ( b64 ) {
// base64 is 4/3 + up to two characters of the original data
return ( b64 . length * 3 / 4 ) - placeHoldersCount ( b64 )
}
function toByteArray ( b64 ) {
var i , l , tmp , placeHolders , arr ;
var len = b64 . length ;
placeHolders = placeHoldersCount ( b64 ) ;
arr = new Arr ( ( len * 3 / 4 ) - placeHolders ) ;
// if there are placeholders, only get up to the last complete 4 chars
l = placeHolders > 0 ? len - 4 : len ;
var L = 0 ;
for ( i = 0 ; i < l ; i += 4 ) {
tmp = ( revLookup [ b64 . charCodeAt ( i ) ] << 18 ) | ( revLookup [ b64 . charCodeAt ( i + 1 ) ] << 12 ) | ( revLookup [ b64 . charCodeAt ( i + 2 ) ] << 6 ) | revLookup [ b64 . charCodeAt ( i + 3 ) ] ;
arr [ L ++ ] = ( tmp >> 16 ) & 0xFF ;
arr [ L ++ ] = ( tmp >> 8 ) & 0xFF ;
arr [ L ++ ] = tmp & 0xFF ;
}
if ( placeHolders === 2 ) {
tmp = ( revLookup [ b64 . charCodeAt ( i ) ] << 2 ) | ( revLookup [ b64 . charCodeAt ( i + 1 ) ] >> 4 ) ;
arr [ L ++ ] = tmp & 0xFF ;
} else if ( placeHolders === 1 ) {
tmp = ( revLookup [ b64 . charCodeAt ( i ) ] << 10 ) | ( revLookup [ b64 . charCodeAt ( i + 1 ) ] << 4 ) | ( revLookup [ b64 . charCodeAt ( i + 2 ) ] >> 2 ) ;
arr [ L ++ ] = ( tmp >> 8 ) & 0xFF ;
arr [ L ++ ] = tmp & 0xFF ;
}
return arr
}
function tripletToBase64 ( num ) {
return lookup [ num >> 18 & 0x3F ] + lookup [ num >> 12 & 0x3F ] + lookup [ num >> 6 & 0x3F ] + lookup [ num & 0x3F ]
}
function encodeChunk ( uint8 , start , end ) {
var tmp ;
var output = [ ] ;
for ( var i = start ; i < end ; i += 3 ) {
tmp = ( uint8 [ i ] << 16 ) + ( uint8 [ i + 1 ] << 8 ) + ( uint8 [ i + 2 ] ) ;
output . push ( tripletToBase64 ( tmp ) ) ;
}
return output . join ( '' )
}
function fromByteArray ( uint8 ) {
var tmp ;
var len = uint8 . length ;
var extraBytes = len % 3 ; // if we have 1 byte left, pad 2 bytes
var output = '' ;
var parts = [ ] ;
var maxChunkLength = 16383 ; // must be multiple of 3
// go through the array every three bytes, we'll deal with trailing stuff later
for ( var i = 0 , len2 = len - extraBytes ; i < len2 ; i += maxChunkLength ) {
parts . push ( encodeChunk ( uint8 , i , ( i + maxChunkLength ) > len2 ? len2 : ( i + maxChunkLength ) ) ) ;
}
// pad the end with zeros, but make sure to not forget the extra bytes
if ( extraBytes === 1 ) {
tmp = uint8 [ len - 1 ] ;
output += lookup [ tmp >> 2 ] ;
output += lookup [ ( tmp << 4 ) & 0x3F ] ;
output += '==' ;
} else if ( extraBytes === 2 ) {
tmp = ( uint8 [ len - 2 ] << 8 ) + ( uint8 [ len - 1 ] ) ;
output += lookup [ tmp >> 10 ] ;
output += lookup [ ( tmp >> 4 ) & 0x3F ] ;
output += lookup [ ( tmp << 2 ) & 0x3F ] ;
output += '=' ;
}
parts . push ( output ) ;
return parts . join ( '' )
}
var base64Js = {
byteLength : byteLength _1 ,
toByteArray : toByteArray _1 ,
fromByteArray : fromByteArray _1
} ;
var read = function ( buffer , offset , isLE , mLen , nBytes ) {
var e , m ;
var eLen = nBytes * 8 - mLen - 1 ;
var eMax = ( 1 << eLen ) - 1 ;
var eBias = eMax >> 1 ;
var nBits = - 7 ;
var i = isLE ? ( nBytes - 1 ) : 0 ;
var d = isLE ? - 1 : 1 ;
var s = buffer [ offset + i ] ;
i += d ;
e = s & ( ( 1 << ( - nBits ) ) - 1 ) ;
s >>= ( - nBits ) ;
nBits += eLen ;
for ( ; nBits > 0 ; e = e * 256 + buffer [ offset + i ] , i += d , nBits -= 8 ) { }
m = e & ( ( 1 << ( - nBits ) ) - 1 ) ;
e >>= ( - nBits ) ;
nBits += mLen ;
for ( ; nBits > 0 ; m = m * 256 + buffer [ offset + i ] , i += d , nBits -= 8 ) { }
if ( e === 0 ) {
e = 1 - eBias ;
} else if ( e === eMax ) {
return m ? NaN : ( ( s ? - 1 : 1 ) * Infinity )
} else {
m = m + Math . pow ( 2 , mLen ) ;
e = e - eBias ;
}
return ( s ? - 1 : 1 ) * m * Math . pow ( 2 , e - mLen )
} ;
var write = function ( buffer , value , offset , isLE , mLen , nBytes ) {
var e , m , c ;
var eLen = nBytes * 8 - mLen - 1 ;
var eMax = ( 1 << eLen ) - 1 ;
var eBias = eMax >> 1 ;
var rt = ( mLen === 23 ? Math . pow ( 2 , - 24 ) - Math . pow ( 2 , - 77 ) : 0 ) ;
var i = isLE ? 0 : ( nBytes - 1 ) ;
var d = isLE ? 1 : - 1 ;
var s = value < 0 || ( value === 0 && 1 / value < 0 ) ? 1 : 0 ;
value = Math . abs ( value ) ;
if ( isNaN ( value ) || value === Infinity ) {
m = isNaN ( value ) ? 1 : 0 ;
e = eMax ;
} else {
e = Math . floor ( Math . log ( value ) / Math . LN2 ) ;
if ( value * ( c = Math . pow ( 2 , - e ) ) < 1 ) {
e -- ;
c *= 2 ;
}
if ( e + eBias >= 1 ) {
value += rt / c ;
} else {
value += rt * Math . pow ( 2 , 1 - eBias ) ;
}
if ( value * c >= 2 ) {
e ++ ;
c /= 2 ;
}
if ( e + eBias >= eMax ) {
m = 0 ;
e = eMax ;
} else if ( e + eBias >= 1 ) {
m = ( value * c - 1 ) * Math . pow ( 2 , mLen ) ;
e = e + eBias ;
} else {
m = value * Math . pow ( 2 , eBias - 1 ) * Math . pow ( 2 , mLen ) ;
e = 0 ;
}
}
for ( ; mLen >= 8 ; buffer [ offset + i ] = m & 0xff , i += d , m /= 256 , mLen -= 8 ) { }
e = ( e << mLen ) | m ;
eLen += mLen ;
for ( ; eLen > 0 ; buffer [ offset + i ] = e & 0xff , i += d , e /= 256 , eLen -= 8 ) { }
buffer [ offset + i - d ] |= s * 128 ;
} ;
var ieee754 = {
read : read ,
write : write
} ;
var buffer = createCommonjsModule ( function ( module , exports ) {
/ * !
* The buffer module from node . js , for the browser .
*
* @ author Feross Aboukhadijeh < https : //feross.org>
* @ license MIT
* /
/* eslint-disable no-proto */
'use strict' ;
exports . Buffer = Buffer ;
exports . SlowBuffer = SlowBuffer ;
exports . INSPECT _MAX _BYTES = 50 ;
var K _MAX _LENGTH = 0x7fffffff ;
exports . kMaxLength = K _MAX _LENGTH ;
/ * *
* If ` Buffer.TYPED_ARRAY_SUPPORT ` :
* === true Use Uint8Array implementation ( fastest )
* === false Print warning and recommend using ` buffer ` v4 . x which has an Object
* implementation ( most compatible , even IE6 )
*
* Browsers that support typed arrays are IE 10 + , Firefox 4 + , Chrome 7 + , Safari 5.1 + ,
* Opera 11.6 + , iOS 4.2 + .
*
* We report that the browser does not support typed arrays if the are not subclassable
* using _ _proto _ _ . Firefox 4 - 29 lacks support for adding new properties to ` Uint8Array `
* ( See : https : //bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 lacks support
* for _ _proto _ _ and has a buggy typed array implementation .
* /
Buffer . TYPED _ARRAY _SUPPORT = typedArraySupport ( ) ;
if ( ! Buffer . TYPED _ARRAY _SUPPORT && typeof console !== 'undefined' &&
typeof console . error === 'function' ) {
console . error (
'This browser lacks typed array (Uint8Array) support which is required by ' +
'`buffer` v5.x. Use `buffer` v4.x if you require old browser support.'
) ;
}
function typedArraySupport ( ) {
// Can typed array instances can be augmented?
try {
var arr = new Uint8Array ( 1 ) ;
arr . _ _proto _ _ = { _ _proto _ _ : Uint8Array . prototype , foo : function ( ) { return 42 } } ;
return arr . foo ( ) === 42
} catch ( e ) {
return false
}
}
function createBuffer ( length ) {
if ( length > K _MAX _LENGTH ) {
throw new RangeError ( 'Invalid typed array length' )
}
// Return an augmented `Uint8Array` instance
var buf = new Uint8Array ( length ) ;
buf . _ _proto _ _ = Buffer . prototype ;
return buf
}
/ * *
* The Buffer constructor returns instances of ` Uint8Array ` that have their
* prototype changed to ` Buffer.prototype ` . Furthermore , ` Buffer ` is a subclass of
* ` Uint8Array ` , so the returned instances will have all the node ` Buffer ` methods
* and the ` Uint8Array ` methods . Square bracket notation works as expected -- it
* returns a single octet .
*
* The ` Uint8Array ` prototype remains unmodified .
* /
function Buffer ( arg , encodingOrOffset , length ) {
// Common case.
if ( typeof arg === 'number' ) {
if ( typeof encodingOrOffset === 'string' ) {
throw new Error (
'If encoding is specified then the first argument must be a string'
)
}
return allocUnsafe ( arg )
}
return from ( arg , encodingOrOffset , length )
}
// Fix subarray() in ES2016. See: https://github.com/feross/buffer/pull/97
if ( typeof Symbol !== 'undefined' && Symbol . species &&
Buffer [ Symbol . species ] === Buffer ) {
Object . defineProperty ( Buffer , Symbol . species , {
value : null ,
configurable : true ,
enumerable : false ,
writable : false
} ) ;
}
Buffer . poolSize = 8192 ; // not used by this implementation
function from ( value , encodingOrOffset , length ) {
if ( typeof value === 'number' ) {
throw new TypeError ( '"value" argument must not be a number' )
}
if ( isArrayBuffer ( value ) ) {
return fromArrayBuffer ( value , encodingOrOffset , length )
}
if ( typeof value === 'string' ) {
return fromString ( value , encodingOrOffset )
}
return fromObject ( value )
}
/ * *
* Functionally equivalent to Buffer ( arg , encoding ) but throws a TypeError
* if value is a number .
* Buffer . from ( str [ , encoding ] )
* Buffer . from ( array )
* Buffer . from ( buffer )
* Buffer . from ( arrayBuffer [ , byteOffset [ , length ] ] )
* * /
Buffer . from = function ( value , encodingOrOffset , length ) {
return from ( value , encodingOrOffset , length )
} ;
// Note: Change prototype *after* Buffer.from is defined to workaround Chrome bug:
// https://github.com/feross/buffer/pull/148
Buffer . prototype . _ _proto _ _ = Uint8Array . prototype ;
Buffer . _ _proto _ _ = Uint8Array ;
function assertSize ( size ) {
if ( typeof size !== 'number' ) {
throw new TypeError ( '"size" argument must be a number' )
} else if ( size < 0 ) {
throw new RangeError ( '"size" argument must not be negative' )
}
}
function alloc ( size , fill , encoding ) {
assertSize ( size ) ;
if ( size <= 0 ) {
return createBuffer ( size )
}
if ( fill !== undefined ) {
// Only pay attention to encoding if it's a string. This
// prevents accidentally sending in a number that would
// be interpretted as a start offset.
return typeof encoding === 'string'
? createBuffer ( size ) . fill ( fill , encoding )
: createBuffer ( size ) . fill ( fill )
}
return createBuffer ( size )
}
/ * *
* Creates a new filled Buffer instance .
* alloc ( size [ , fill [ , encoding ] ] )
* * /
Buffer . alloc = function ( size , fill , encoding ) {
return alloc ( size , fill , encoding )
} ;
function allocUnsafe ( size ) {
assertSize ( size ) ;
return createBuffer ( size < 0 ? 0 : checked ( size ) | 0 )
}
/ * *
* Equivalent to Buffer ( num ) , by default creates a non - zero - filled Buffer instance .
* * /
Buffer . allocUnsafe = function ( size ) {
return allocUnsafe ( size )
} ;
/ * *
* Equivalent to SlowBuffer ( num ) , by default creates a non - zero - filled Buffer instance .
* /
Buffer . allocUnsafeSlow = function ( size ) {
return allocUnsafe ( size )
} ;
function fromString ( string , encoding ) {
if ( typeof encoding !== 'string' || encoding === '' ) {
encoding = 'utf8' ;
}
if ( ! Buffer . isEncoding ( encoding ) ) {
throw new TypeError ( '"encoding" must be a valid string encoding' )
}
var length = byteLength ( string , encoding ) | 0 ;
var buf = createBuffer ( length ) ;
var actual = buf . write ( string , encoding ) ;
if ( actual !== length ) {
// Writing a hex string, for example, that contains invalid characters will
// cause everything after the first invalid character to be ignored. (e.g.
// 'abxxcd' will be treated as 'ab')
buf = buf . slice ( 0 , actual ) ;
}
return buf
}
function fromArrayLike ( array ) {
var length = array . length < 0 ? 0 : checked ( array . length ) | 0 ;
var buf = createBuffer ( length ) ;
for ( var i = 0 ; i < length ; i += 1 ) {
buf [ i ] = array [ i ] & 255 ;
}
return buf
}
function fromArrayBuffer ( array , byteOffset , length ) {
if ( byteOffset < 0 || array . byteLength < byteOffset ) {
throw new RangeError ( '\'offset\' is out of bounds' )
}
if ( array . byteLength < byteOffset + ( length || 0 ) ) {
throw new RangeError ( '\'length\' is out of bounds' )
}
var buf ;
if ( byteOffset === undefined && length === undefined ) {
buf = new Uint8Array ( array ) ;
} else if ( length === undefined ) {
buf = new Uint8Array ( array , byteOffset ) ;
} else {
buf = new Uint8Array ( array , byteOffset , length ) ;
}
// Return an augmented `Uint8Array` instance
buf . _ _proto _ _ = Buffer . prototype ;
return buf
}
function fromObject ( obj ) {
if ( Buffer . isBuffer ( obj ) ) {
var len = checked ( obj . length ) | 0 ;
var buf = createBuffer ( len ) ;
if ( buf . length === 0 ) {
return buf
}
obj . copy ( buf , 0 , 0 , len ) ;
return buf
}
if ( obj ) {
if ( isArrayBufferView ( obj ) || 'length' in obj ) {
if ( typeof obj . length !== 'number' || numberIsNaN ( obj . length ) ) {
return createBuffer ( 0 )
}
return fromArrayLike ( obj )
}
if ( obj . type === 'Buffer' && Array . isArray ( obj . data ) ) {
return fromArrayLike ( obj . data )
}
}
throw new TypeError ( 'First argument must be a string, Buffer, ArrayBuffer, Array, or array-like object.' )
}
function checked ( length ) {
// Note: cannot use `length < K_MAX_LENGTH` here because that fails when
// length is NaN (which is otherwise coerced to zero.)
if ( length >= K _MAX _LENGTH ) {
throw new RangeError ( 'Attempt to allocate Buffer larger than maximum ' +
'size: 0x' + K _MAX _LENGTH . toString ( 16 ) + ' bytes' )
}
return length | 0
}
function SlowBuffer ( length ) {
if ( + length != length ) { // eslint-disable-line eqeqeq
length = 0 ;
}
return Buffer . alloc ( + length )
}
Buffer . isBuffer = function isBuffer ( b ) {
return b != null && b . _isBuffer === true
} ;
Buffer . compare = function compare ( a , b ) {
if ( ! Buffer . isBuffer ( a ) || ! Buffer . isBuffer ( b ) ) {
throw new TypeError ( 'Arguments must be Buffers' )
}
if ( a === b ) return 0
var x = a . length ;
var y = b . length ;
for ( var i = 0 , len = Math . min ( x , y ) ; i < len ; ++ i ) {
if ( a [ i ] !== b [ i ] ) {
x = a [ i ] ;
y = b [ i ] ;
break
}
}
if ( x < y ) return - 1
if ( y < x ) return 1
return 0
} ;
Buffer . isEncoding = function isEncoding ( encoding ) {
switch ( String ( encoding ) . toLowerCase ( ) ) {
case 'hex' :
case 'utf8' :
case 'utf-8' :
case 'ascii' :
case 'latin1' :
case 'binary' :
case 'base64' :
case 'ucs2' :
case 'ucs-2' :
case 'utf16le' :
case 'utf-16le' :
return true
default :
return false
}
} ;
Buffer . concat = function concat ( list , length ) {
if ( ! Array . isArray ( list ) ) {
throw new TypeError ( '"list" argument must be an Array of Buffers' )
}
if ( list . length === 0 ) {
return Buffer . alloc ( 0 )
}
var i ;
if ( length === undefined ) {
length = 0 ;
for ( i = 0 ; i < list . length ; ++ i ) {
length += list [ i ] . length ;
}
}
var buffer = Buffer . allocUnsafe ( length ) ;
var pos = 0 ;
for ( i = 0 ; i < list . length ; ++ i ) {
var buf = list [ i ] ;
if ( ! Buffer . isBuffer ( buf ) ) {
throw new TypeError ( '"list" argument must be an Array of Buffers' )
}
buf . copy ( buffer , pos ) ;
pos += buf . length ;
}
return buffer
} ;
function byteLength ( string , encoding ) {
if ( Buffer . isBuffer ( string ) ) {
return string . length
}
if ( isArrayBufferView ( string ) || isArrayBuffer ( string ) ) {
return string . byteLength
}
if ( typeof string !== 'string' ) {
string = '' + string ;
}
var len = string . length ;
if ( len === 0 ) return 0
// Use a for loop to avoid recursion
var loweredCase = false ;
for ( ; ; ) {
switch ( encoding ) {
case 'ascii' :
case 'latin1' :
case 'binary' :
return len
case 'utf8' :
case 'utf-8' :
case undefined :
return utf8ToBytes ( string ) . length
case 'ucs2' :
case 'ucs-2' :
case 'utf16le' :
case 'utf-16le' :
return len * 2
case 'hex' :
return len >>> 1
case 'base64' :
return base64ToBytes ( string ) . length
default :
if ( loweredCase ) return utf8ToBytes ( string ) . length // assume utf8
encoding = ( '' + encoding ) . toLowerCase ( ) ;
loweredCase = true ;
}
}
}
Buffer . byteLength = byteLength ;
function slowToString ( encoding , start , end ) {
var loweredCase = false ;
// No need to verify that "this.length <= MAX_UINT32" since it's a read-only
// property of a typed array.
// This behaves neither like String nor Uint8Array in that we set start/end
// to their upper/lower bounds if the value passed is out of range.
// undefined is handled specially as per ECMA-262 6th Edition,
// Section 13.3.3.7 Runtime Semantics: KeyedBindingInitialization.
if ( start === undefined || start < 0 ) {
start = 0 ;
}
// Return early if start > this.length. Done here to prevent potential uint32
// coercion fail below.
if ( start > this . length ) {
return ''
}
if ( end === undefined || end > this . length ) {
end = this . length ;
}
if ( end <= 0 ) {
return ''
}
// Force coersion to uint32. This will also coerce falsey/NaN values to 0.
end >>>= 0 ;
start >>>= 0 ;
if ( end <= start ) {
return ''
}
if ( ! encoding ) encoding = 'utf8' ;
while ( true ) {
switch ( encoding ) {
case 'hex' :
return hexSlice ( this , start , end )
case 'utf8' :
case 'utf-8' :
return utf8Slice ( this , start , end )
case 'ascii' :
return asciiSlice ( this , start , end )
case 'latin1' :
case 'binary' :
return latin1Slice ( this , start , end )
case 'base64' :
return base64Slice ( this , start , end )
case 'ucs2' :
case 'ucs-2' :
case 'utf16le' :
case 'utf-16le' :
return utf16leSlice ( this , start , end )
default :
if ( loweredCase ) throw new TypeError ( 'Unknown encoding: ' + encoding )
encoding = ( encoding + '' ) . toLowerCase ( ) ;
loweredCase = true ;
}
}
}
// This property is used by `Buffer.isBuffer` (and the `is-buffer` npm package)
// to detect a Buffer instance. It's not possible to use `instanceof Buffer`
// reliably in a browserify context because there could be multiple different
// copies of the 'buffer' package in use. This method works even for Buffer
// instances that were created from another copy of the `buffer` package.
// See: https://github.com/feross/buffer/issues/154
Buffer . prototype . _isBuffer = true ;
function swap ( b , n , m ) {
var i = b [ n ] ;
b [ n ] = b [ m ] ;
b [ m ] = i ;
}
Buffer . prototype . swap16 = function swap16 ( ) {
var len = this . length ;
if ( len % 2 !== 0 ) {
throw new RangeError ( 'Buffer size must be a multiple of 16-bits' )
}
for ( var i = 0 ; i < len ; i += 2 ) {
swap ( this , i , i + 1 ) ;
}
return this
} ;
Buffer . prototype . swap32 = function swap32 ( ) {
var len = this . length ;
if ( len % 4 !== 0 ) {
throw new RangeError ( 'Buffer size must be a multiple of 32-bits' )
}
for ( var i = 0 ; i < len ; i += 4 ) {
swap ( this , i , i + 3 ) ;
swap ( this , i + 1 , i + 2 ) ;
}
return this
} ;
Buffer . prototype . swap64 = function swap64 ( ) {
var len = this . length ;
if ( len % 8 !== 0 ) {
throw new RangeError ( 'Buffer size must be a multiple of 64-bits' )
}
for ( var i = 0 ; i < len ; i += 8 ) {
swap ( this , i , i + 7 ) ;
swap ( this , i + 1 , i + 6 ) ;
swap ( this , i + 2 , i + 5 ) ;
swap ( this , i + 3 , i + 4 ) ;
}
return this
} ;
Buffer . prototype . toString = function toString ( ) {
var length = this . length ;
if ( length === 0 ) return ''
if ( arguments . length === 0 ) return utf8Slice ( this , 0 , length )
return slowToString . apply ( this , arguments )
} ;
Buffer . prototype . equals = function equals ( b ) {
if ( ! Buffer . isBuffer ( b ) ) throw new TypeError ( 'Argument must be a Buffer' )
if ( this === b ) return true
return Buffer . compare ( this , b ) === 0
} ;
Buffer . prototype . inspect = function inspect ( ) {
var str = '' ;
var max = exports . INSPECT _MAX _BYTES ;
if ( this . length > 0 ) {
str = this . toString ( 'hex' , 0 , max ) . match ( /.{2}/g ) . join ( ' ' ) ;
if ( this . length > max ) str += ' ... ' ;
}
return '<Buffer ' + str + '>'
} ;
Buffer . prototype . compare = function compare ( target , start , end , thisStart , thisEnd ) {
if ( ! Buffer . isBuffer ( target ) ) {
throw new TypeError ( 'Argument must be a Buffer' )
}
if ( start === undefined ) {
start = 0 ;
}
if ( end === undefined ) {
end = target ? target . length : 0 ;
}
if ( thisStart === undefined ) {
thisStart = 0 ;
}
if ( thisEnd === undefined ) {
thisEnd = this . length ;
}
if ( start < 0 || end > target . length || thisStart < 0 || thisEnd > this . length ) {
throw new RangeError ( 'out of range index' )
}
if ( thisStart >= thisEnd && start >= end ) {
return 0
}
if ( thisStart >= thisEnd ) {
return - 1
}
if ( start >= end ) {
return 1
}
start >>>= 0 ;
end >>>= 0 ;
thisStart >>>= 0 ;
thisEnd >>>= 0 ;
if ( this === target ) return 0
var x = thisEnd - thisStart ;
var y = end - start ;
var len = Math . min ( x , y ) ;
var thisCopy = this . slice ( thisStart , thisEnd ) ;
var targetCopy = target . slice ( start , end ) ;
for ( var i = 0 ; i < len ; ++ i ) {
if ( thisCopy [ i ] !== targetCopy [ i ] ) {
x = thisCopy [ i ] ;
y = targetCopy [ i ] ;
break
}
}
if ( x < y ) return - 1
if ( y < x ) return 1
return 0
} ;
// Finds either the first index of `val` in `buffer` at offset >= `byteOffset`,
// OR the last index of `val` in `buffer` at offset <= `byteOffset`.
//
// Arguments:
// - buffer - a Buffer to search
// - val - a string, Buffer, or number
// - byteOffset - an index into `buffer`; will be clamped to an int32
// - encoding - an optional encoding, relevant is val is a string
// - dir - true for indexOf, false for lastIndexOf
function bidirectionalIndexOf ( buffer , val , byteOffset , encoding , dir ) {
// Empty buffer means no match
if ( buffer . length === 0 ) return - 1
// Normalize byteOffset
if ( typeof byteOffset === 'string' ) {
encoding = byteOffset ;
byteOffset = 0 ;
} else if ( byteOffset > 0x7fffffff ) {
byteOffset = 0x7fffffff ;
} else if ( byteOffset < - 0x80000000 ) {
byteOffset = - 0x80000000 ;
}
byteOffset = + byteOffset ; // Coerce to Number.
if ( numberIsNaN ( byteOffset ) ) {
// byteOffset: it it's undefined, null, NaN, "foo", etc, search whole buffer
byteOffset = dir ? 0 : ( buffer . length - 1 ) ;
}
// Normalize byteOffset: negative offsets start from the end of the buffer
if ( byteOffset < 0 ) byteOffset = buffer . length + byteOffset ;
if ( byteOffset >= buffer . length ) {
if ( dir ) return - 1
else byteOffset = buffer . length - 1 ;
} else if ( byteOffset < 0 ) {
if ( dir ) byteOffset = 0 ;
else return - 1
}
// Normalize val
if ( typeof val === 'string' ) {
val = Buffer . from ( val , encoding ) ;
}
// Finally, search either indexOf (if dir is true) or lastIndexOf
if ( Buffer . isBuffer ( val ) ) {
// Special case: looking for empty string/buffer always fails
if ( val . length === 0 ) {
return - 1
}
return arrayIndexOf ( buffer , val , byteOffset , encoding , dir )
} else if ( typeof val === 'number' ) {
val = val & 0xFF ; // Search for a byte value [0-255]
if ( typeof Uint8Array . prototype . indexOf === 'function' ) {
if ( dir ) {
return Uint8Array . prototype . indexOf . call ( buffer , val , byteOffset )
} else {
return Uint8Array . prototype . lastIndexOf . call ( buffer , val , byteOffset )
}
}
return arrayIndexOf ( buffer , [ val ] , byteOffset , encoding , dir )
}
throw new TypeError ( 'val must be string, number or Buffer' )
}
function arrayIndexOf ( arr , val , byteOffset , encoding , dir ) {
var indexSize = 1 ;
var arrLength = arr . length ;
var valLength = val . length ;
if ( encoding !== undefined ) {
encoding = String ( encoding ) . toLowerCase ( ) ;
if ( encoding === 'ucs2' || encoding === 'ucs-2' ||
encoding === 'utf16le' || encoding === 'utf-16le' ) {
if ( arr . length < 2 || val . length < 2 ) {
return - 1
}
indexSize = 2 ;
arrLength /= 2 ;
valLength /= 2 ;
byteOffset /= 2 ;
}
}
function read ( buf , i ) {
if ( indexSize === 1 ) {
return buf [ i ]
} else {
return buf . readUInt16BE ( i * indexSize )
}
}
var i ;
if ( dir ) {
var foundIndex = - 1 ;
for ( i = byteOffset ; i < arrLength ; i ++ ) {
if ( read ( arr , i ) === read ( val , foundIndex === - 1 ? 0 : i - foundIndex ) ) {
if ( foundIndex === - 1 ) foundIndex = i ;
if ( i - foundIndex + 1 === valLength ) return foundIndex * indexSize
} else {
if ( foundIndex !== - 1 ) i -= i - foundIndex ;
foundIndex = - 1 ;
}
}
} else {
if ( byteOffset + valLength > arrLength ) byteOffset = arrLength - valLength ;
for ( i = byteOffset ; i >= 0 ; i -- ) {
var found = true ;
for ( var j = 0 ; j < valLength ; j ++ ) {
if ( read ( arr , i + j ) !== read ( val , j ) ) {
found = false ;
break
}
}
if ( found ) return i
}
}
return - 1
}
Buffer . prototype . includes = function includes ( val , byteOffset , encoding ) {
return this . indexOf ( val , byteOffset , encoding ) !== - 1
} ;
Buffer . prototype . indexOf = function indexOf ( val , byteOffset , encoding ) {
return bidirectionalIndexOf ( this , val , byteOffset , encoding , true )
} ;
Buffer . prototype . lastIndexOf = function lastIndexOf ( val , byteOffset , encoding ) {
return bidirectionalIndexOf ( this , val , byteOffset , encoding , false )
} ;
function hexWrite ( buf , string , offset , length ) {
offset = Number ( offset ) || 0 ;
var remaining = buf . length - offset ;
if ( ! length ) {
length = remaining ;
} else {
length = Number ( length ) ;
if ( length > remaining ) {
length = remaining ;
}
}
// must be an even number of digits
var strLen = string . length ;
if ( strLen % 2 !== 0 ) throw new TypeError ( 'Invalid hex string' )
if ( length > strLen / 2 ) {
length = strLen / 2 ;
}
for ( var i = 0 ; i < length ; ++ i ) {
var parsed = parseInt ( string . substr ( i * 2 , 2 ) , 16 ) ;
if ( numberIsNaN ( parsed ) ) return i
buf [ offset + i ] = parsed ;
}
return i
}
function utf8Write ( buf , string , offset , length ) {
return blitBuffer ( utf8ToBytes ( string , buf . length - offset ) , buf , offset , length )
}
function asciiWrite ( buf , string , offset , length ) {
return blitBuffer ( asciiToBytes ( string ) , buf , offset , length )
}
function latin1Write ( buf , string , offset , length ) {
return asciiWrite ( buf , string , offset , length )
}
function base64Write ( buf , string , offset , length ) {
return blitBuffer ( base64ToBytes ( string ) , buf , offset , length )
}
function ucs2Write ( buf , string , offset , length ) {
return blitBuffer ( utf16leToBytes ( string , buf . length - offset ) , buf , offset , length )
}
Buffer . prototype . write = function write ( string , offset , length , encoding ) {
// Buffer#write(string)
if ( offset === undefined ) {
encoding = 'utf8' ;
length = this . length ;
offset = 0 ;
// Buffer#write(string, encoding)
} else if ( length === undefined && typeof offset === 'string' ) {
encoding = offset ;
length = this . length ;
offset = 0 ;
// Buffer#write(string, offset[, length][, encoding])
} else if ( isFinite ( offset ) ) {
offset = offset >>> 0 ;
if ( isFinite ( length ) ) {
length = length >>> 0 ;
if ( encoding === undefined ) encoding = 'utf8' ;
} else {
encoding = length ;
length = undefined ;
}
} else {
throw new Error (
'Buffer.write(string, encoding, offset[, length]) is no longer supported'
)
}
var remaining = this . length - offset ;
if ( length === undefined || length > remaining ) length = remaining ;
if ( ( string . length > 0 && ( length < 0 || offset < 0 ) ) || offset > this . length ) {
throw new RangeError ( 'Attempt to write outside buffer bounds' )
}
if ( ! encoding ) encoding = 'utf8' ;
var loweredCase = false ;
for ( ; ; ) {
switch ( encoding ) {
case 'hex' :
return hexWrite ( this , string , offset , length )
case 'utf8' :
case 'utf-8' :
return utf8Write ( this , string , offset , length )
case 'ascii' :
return asciiWrite ( this , string , offset , length )
case 'latin1' :
case 'binary' :
return latin1Write ( this , string , offset , length )
case 'base64' :
// Warning: maxLength not taken into account in base64Write
return base64Write ( this , string , offset , length )
case 'ucs2' :
case 'ucs-2' :
case 'utf16le' :
case 'utf-16le' :
return ucs2Write ( this , string , offset , length )
default :
if ( loweredCase ) throw new TypeError ( 'Unknown encoding: ' + encoding )
encoding = ( '' + encoding ) . toLowerCase ( ) ;
loweredCase = true ;
}
}
} ;
Buffer . prototype . toJSON = function toJSON ( ) {
return {
type : 'Buffer' ,
data : Array . prototype . slice . call ( this . _arr || this , 0 )
}
} ;
function base64Slice ( buf , start , end ) {
if ( start === 0 && end === buf . length ) {
return base64Js . fromByteArray ( buf )
} else {
return base64Js . fromByteArray ( buf . slice ( start , end ) )
}
}
function utf8Slice ( buf , start , end ) {
end = Math . min ( buf . length , end ) ;
var res = [ ] ;
var i = start ;
while ( i < end ) {
var firstByte = buf [ i ] ;
var codePoint = null ;
var bytesPerSequence = ( firstByte > 0xEF ) ? 4
: ( firstByte > 0xDF ) ? 3
: ( firstByte > 0xBF ) ? 2
: 1 ;
if ( i + bytesPerSequence <= end ) {
var secondByte , thirdByte , fourthByte , tempCodePoint ;
switch ( bytesPerSequence ) {
case 1 :
if ( firstByte < 0x80 ) {
codePoint = firstByte ;
}
break
case 2 :
secondByte = buf [ i + 1 ] ;
if ( ( secondByte & 0xC0 ) === 0x80 ) {
tempCodePoint = ( firstByte & 0x1F ) << 0x6 | ( secondByte & 0x3F ) ;
if ( tempCodePoint > 0x7F ) {
codePoint = tempCodePoint ;
}
}
break
case 3 :
secondByte = buf [ i + 1 ] ;
thirdByte = buf [ i + 2 ] ;
if ( ( secondByte & 0xC0 ) === 0x80 && ( thirdByte & 0xC0 ) === 0x80 ) {
tempCodePoint = ( firstByte & 0xF ) << 0xC | ( secondByte & 0x3F ) << 0x6 | ( thirdByte & 0x3F ) ;
if ( tempCodePoint > 0x7FF && ( tempCodePoint < 0xD800 || tempCodePoint > 0xDFFF ) ) {
codePoint = tempCodePoint ;
}
}
break
case 4 :
secondByte = buf [ i + 1 ] ;
thirdByte = buf [ i + 2 ] ;
fourthByte = buf [ i + 3 ] ;
if ( ( secondByte & 0xC0 ) === 0x80 && ( thirdByte & 0xC0 ) === 0x80 && ( fourthByte & 0xC0 ) === 0x80 ) {
tempCodePoint = ( firstByte & 0xF ) << 0x12 | ( secondByte & 0x3F ) << 0xC | ( thirdByte & 0x3F ) << 0x6 | ( fourthByte & 0x3F ) ;
if ( tempCodePoint > 0xFFFF && tempCodePoint < 0x110000 ) {
codePoint = tempCodePoint ;
}
}
}
}
if ( codePoint === null ) {
// we did not generate a valid codePoint so insert a
// replacement char (U+FFFD) and advance only 1 byte
codePoint = 0xFFFD ;
bytesPerSequence = 1 ;
} else if ( codePoint > 0xFFFF ) {
// encode to utf16 (surrogate pair dance)
codePoint -= 0x10000 ;
res . push ( codePoint >>> 10 & 0x3FF | 0xD800 ) ;
codePoint = 0xDC00 | codePoint & 0x3FF ;
}
res . push ( codePoint ) ;
i += bytesPerSequence ;
}
return decodeCodePointsArray ( res )
}
// Based on http://stackoverflow.com/a/22747272/680742, the browser with
// the lowest limit is Chrome, with 0x10000 args.
// We go 1 magnitude less, for safety
var MAX _ARGUMENTS _LENGTH = 0x1000 ;
function decodeCodePointsArray ( codePoints ) {
var len = codePoints . length ;
if ( len <= MAX _ARGUMENTS _LENGTH ) {
return String . fromCharCode . apply ( String , codePoints ) // avoid extra slice()
}
// Decode in chunks to avoid "call stack size exceeded".
var res = '' ;
var i = 0 ;
while ( i < len ) {
res += String . fromCharCode . apply (
String ,
codePoints . slice ( i , i += MAX _ARGUMENTS _LENGTH )
) ;
}
return res
}
function asciiSlice ( buf , start , end ) {
var ret = '' ;
end = Math . min ( buf . length , end ) ;
for ( var i = start ; i < end ; ++ i ) {
ret += String . fromCharCode ( buf [ i ] & 0x7F ) ;
}
return ret
}
function latin1Slice ( buf , start , end ) {
var ret = '' ;
end = Math . min ( buf . length , end ) ;
for ( var i = start ; i < end ; ++ i ) {
ret += String . fromCharCode ( buf [ i ] ) ;
}
return ret
}
function hexSlice ( buf , start , end ) {
var len = buf . length ;
if ( ! start || start < 0 ) start = 0 ;
if ( ! end || end < 0 || end > len ) end = len ;
var out = '' ;
for ( var i = start ; i < end ; ++ i ) {
out += toHex ( buf [ i ] ) ;
}
return out
}
function utf16leSlice ( buf , start , end ) {
var bytes = buf . slice ( start , end ) ;
var res = '' ;
for ( var i = 0 ; i < bytes . length ; i += 2 ) {
res += String . fromCharCode ( bytes [ i ] + ( bytes [ i + 1 ] * 256 ) ) ;
}
return res
}
Buffer . prototype . slice = function slice ( start , end ) {
var len = this . length ;
start = ~ ~ start ;
end = end === undefined ? len : ~ ~ end ;
if ( start < 0 ) {
start += len ;
if ( start < 0 ) start = 0 ;
} else if ( start > len ) {
start = len ;
}
if ( end < 0 ) {
end += len ;
if ( end < 0 ) end = 0 ;
} else if ( end > len ) {
end = len ;
}
if ( end < start ) end = start ;
var newBuf = this . subarray ( start , end ) ;
// Return an augmented `Uint8Array` instance
newBuf . _ _proto _ _ = Buffer . prototype ;
return newBuf
} ;
/ *
* Need to make sure that buffer isn ' t trying to write out of bounds .
* /
function checkOffset ( offset , ext , length ) {
if ( ( offset % 1 ) !== 0 || offset < 0 ) throw new RangeError ( 'offset is not uint' )
if ( offset + ext > length ) throw new RangeError ( 'Trying to access beyond buffer length' )
}
Buffer . prototype . readUIntLE = function readUIntLE ( offset , byteLength , noAssert ) {
offset = offset >>> 0 ;
byteLength = byteLength >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , byteLength , this . length ) ;
var val = this [ offset ] ;
var mul = 1 ;
var i = 0 ;
while ( ++ i < byteLength && ( mul *= 0x100 ) ) {
val += this [ offset + i ] * mul ;
}
return val
} ;
Buffer . prototype . readUIntBE = function readUIntBE ( offset , byteLength , noAssert ) {
offset = offset >>> 0 ;
byteLength = byteLength >>> 0 ;
if ( ! noAssert ) {
checkOffset ( offset , byteLength , this . length ) ;
}
var val = this [ offset + -- byteLength ] ;
var mul = 1 ;
while ( byteLength > 0 && ( mul *= 0x100 ) ) {
val += this [ offset + -- byteLength ] * mul ;
}
return val
} ;
Buffer . prototype . readUInt8 = function readUInt8 ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 1 , this . length ) ;
return this [ offset ]
} ;
Buffer . prototype . readUInt16LE = function readUInt16LE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 2 , this . length ) ;
return this [ offset ] | ( this [ offset + 1 ] << 8 )
} ;
Buffer . prototype . readUInt16BE = function readUInt16BE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 2 , this . length ) ;
return ( this [ offset ] << 8 ) | this [ offset + 1 ]
} ;
Buffer . prototype . readUInt32LE = function readUInt32LE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 4 , this . length ) ;
return ( ( this [ offset ] ) |
( this [ offset + 1 ] << 8 ) |
( this [ offset + 2 ] << 16 ) ) +
( this [ offset + 3 ] * 0x1000000 )
} ;
Buffer . prototype . readUInt32BE = function readUInt32BE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 4 , this . length ) ;
return ( this [ offset ] * 0x1000000 ) +
( ( this [ offset + 1 ] << 16 ) |
( this [ offset + 2 ] << 8 ) |
this [ offset + 3 ] )
} ;
Buffer . prototype . readIntLE = function readIntLE ( offset , byteLength , noAssert ) {
offset = offset >>> 0 ;
byteLength = byteLength >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , byteLength , this . length ) ;
var val = this [ offset ] ;
var mul = 1 ;
var i = 0 ;
while ( ++ i < byteLength && ( mul *= 0x100 ) ) {
val += this [ offset + i ] * mul ;
}
mul *= 0x80 ;
if ( val >= mul ) val -= Math . pow ( 2 , 8 * byteLength ) ;
return val
} ;
Buffer . prototype . readIntBE = function readIntBE ( offset , byteLength , noAssert ) {
offset = offset >>> 0 ;
byteLength = byteLength >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , byteLength , this . length ) ;
var i = byteLength ;
var mul = 1 ;
var val = this [ offset + -- i ] ;
while ( i > 0 && ( mul *= 0x100 ) ) {
val += this [ offset + -- i ] * mul ;
}
mul *= 0x80 ;
if ( val >= mul ) val -= Math . pow ( 2 , 8 * byteLength ) ;
return val
} ;
Buffer . prototype . readInt8 = function readInt8 ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 1 , this . length ) ;
if ( ! ( this [ offset ] & 0x80 ) ) return ( this [ offset ] )
return ( ( 0xff - this [ offset ] + 1 ) * - 1 )
} ;
Buffer . prototype . readInt16LE = function readInt16LE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 2 , this . length ) ;
var val = this [ offset ] | ( this [ offset + 1 ] << 8 ) ;
return ( val & 0x8000 ) ? val | 0xFFFF0000 : val
} ;
Buffer . prototype . readInt16BE = function readInt16BE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 2 , this . length ) ;
var val = this [ offset + 1 ] | ( this [ offset ] << 8 ) ;
return ( val & 0x8000 ) ? val | 0xFFFF0000 : val
} ;
Buffer . prototype . readInt32LE = function readInt32LE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 4 , this . length ) ;
return ( this [ offset ] ) |
( this [ offset + 1 ] << 8 ) |
( this [ offset + 2 ] << 16 ) |
( this [ offset + 3 ] << 24 )
} ;
Buffer . prototype . readInt32BE = function readInt32BE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 4 , this . length ) ;
return ( this [ offset ] << 24 ) |
( this [ offset + 1 ] << 16 ) |
( this [ offset + 2 ] << 8 ) |
( this [ offset + 3 ] )
} ;
Buffer . prototype . readFloatLE = function readFloatLE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 4 , this . length ) ;
return ieee754 . read ( this , offset , true , 23 , 4 )
} ;
Buffer . prototype . readFloatBE = function readFloatBE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 4 , this . length ) ;
return ieee754 . read ( this , offset , false , 23 , 4 )
} ;
Buffer . prototype . readDoubleLE = function readDoubleLE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 8 , this . length ) ;
return ieee754 . read ( this , offset , true , 52 , 8 )
} ;
Buffer . prototype . readDoubleBE = function readDoubleBE ( offset , noAssert ) {
offset = offset >>> 0 ;
if ( ! noAssert ) checkOffset ( offset , 8 , this . length ) ;
return ieee754 . read ( this , offset , false , 52 , 8 )
} ;
function checkInt ( buf , value , offset , ext , max , min ) {
if ( ! Buffer . isBuffer ( buf ) ) throw new TypeError ( '"buffer" argument must be a Buffer instance' )
if ( value > max || value < min ) throw new RangeError ( '"value" argument is out of bounds' )
if ( offset + ext > buf . length ) throw new RangeError ( 'Index out of range' )
}
Buffer . prototype . writeUIntLE = function writeUIntLE ( value , offset , byteLength , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
byteLength = byteLength >>> 0 ;
if ( ! noAssert ) {
var maxBytes = Math . pow ( 2 , 8 * byteLength ) - 1 ;
checkInt ( this , value , offset , byteLength , maxBytes , 0 ) ;
}
var mul = 1 ;
var i = 0 ;
this [ offset ] = value & 0xFF ;
while ( ++ i < byteLength && ( mul *= 0x100 ) ) {
this [ offset + i ] = ( value / mul ) & 0xFF ;
}
return offset + byteLength
} ;
Buffer . prototype . writeUIntBE = function writeUIntBE ( value , offset , byteLength , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
byteLength = byteLength >>> 0 ;
if ( ! noAssert ) {
var maxBytes = Math . pow ( 2 , 8 * byteLength ) - 1 ;
checkInt ( this , value , offset , byteLength , maxBytes , 0 ) ;
}
var i = byteLength - 1 ;
var mul = 1 ;
this [ offset + i ] = value & 0xFF ;
while ( -- i >= 0 && ( mul *= 0x100 ) ) {
this [ offset + i ] = ( value / mul ) & 0xFF ;
}
return offset + byteLength
} ;
Buffer . prototype . writeUInt8 = function writeUInt8 ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 1 , 0xff , 0 ) ;
this [ offset ] = ( value & 0xff ) ;
return offset + 1
} ;
Buffer . prototype . writeUInt16LE = function writeUInt16LE ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 2 , 0xffff , 0 ) ;
this [ offset ] = ( value & 0xff ) ;
this [ offset + 1 ] = ( value >>> 8 ) ;
return offset + 2
} ;
Buffer . prototype . writeUInt16BE = function writeUInt16BE ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 2 , 0xffff , 0 ) ;
this [ offset ] = ( value >>> 8 ) ;
this [ offset + 1 ] = ( value & 0xff ) ;
return offset + 2
} ;
Buffer . prototype . writeUInt32LE = function writeUInt32LE ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 4 , 0xffffffff , 0 ) ;
this [ offset + 3 ] = ( value >>> 24 ) ;
this [ offset + 2 ] = ( value >>> 16 ) ;
this [ offset + 1 ] = ( value >>> 8 ) ;
this [ offset ] = ( value & 0xff ) ;
return offset + 4
} ;
Buffer . prototype . writeUInt32BE = function writeUInt32BE ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 4 , 0xffffffff , 0 ) ;
this [ offset ] = ( value >>> 24 ) ;
this [ offset + 1 ] = ( value >>> 16 ) ;
this [ offset + 2 ] = ( value >>> 8 ) ;
this [ offset + 3 ] = ( value & 0xff ) ;
return offset + 4
} ;
Buffer . prototype . writeIntLE = function writeIntLE ( value , offset , byteLength , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) {
var limit = Math . pow ( 2 , ( 8 * byteLength ) - 1 ) ;
checkInt ( this , value , offset , byteLength , limit - 1 , - limit ) ;
}
var i = 0 ;
var mul = 1 ;
var sub = 0 ;
this [ offset ] = value & 0xFF ;
while ( ++ i < byteLength && ( mul *= 0x100 ) ) {
if ( value < 0 && sub === 0 && this [ offset + i - 1 ] !== 0 ) {
sub = 1 ;
}
this [ offset + i ] = ( ( value / mul ) >> 0 ) - sub & 0xFF ;
}
return offset + byteLength
} ;
Buffer . prototype . writeIntBE = function writeIntBE ( value , offset , byteLength , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) {
var limit = Math . pow ( 2 , ( 8 * byteLength ) - 1 ) ;
checkInt ( this , value , offset , byteLength , limit - 1 , - limit ) ;
}
var i = byteLength - 1 ;
var mul = 1 ;
var sub = 0 ;
this [ offset + i ] = value & 0xFF ;
while ( -- i >= 0 && ( mul *= 0x100 ) ) {
if ( value < 0 && sub === 0 && this [ offset + i + 1 ] !== 0 ) {
sub = 1 ;
}
this [ offset + i ] = ( ( value / mul ) >> 0 ) - sub & 0xFF ;
}
return offset + byteLength
} ;
Buffer . prototype . writeInt8 = function writeInt8 ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 1 , 0x7f , - 0x80 ) ;
if ( value < 0 ) value = 0xff + value + 1 ;
this [ offset ] = ( value & 0xff ) ;
return offset + 1
} ;
Buffer . prototype . writeInt16LE = function writeInt16LE ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 2 , 0x7fff , - 0x8000 ) ;
this [ offset ] = ( value & 0xff ) ;
this [ offset + 1 ] = ( value >>> 8 ) ;
return offset + 2
} ;
Buffer . prototype . writeInt16BE = function writeInt16BE ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 2 , 0x7fff , - 0x8000 ) ;
this [ offset ] = ( value >>> 8 ) ;
this [ offset + 1 ] = ( value & 0xff ) ;
return offset + 2
} ;
Buffer . prototype . writeInt32LE = function writeInt32LE ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 4 , 0x7fffffff , - 0x80000000 ) ;
this [ offset ] = ( value & 0xff ) ;
this [ offset + 1 ] = ( value >>> 8 ) ;
this [ offset + 2 ] = ( value >>> 16 ) ;
this [ offset + 3 ] = ( value >>> 24 ) ;
return offset + 4
} ;
Buffer . prototype . writeInt32BE = function writeInt32BE ( value , offset , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) checkInt ( this , value , offset , 4 , 0x7fffffff , - 0x80000000 ) ;
if ( value < 0 ) value = 0xffffffff + value + 1 ;
this [ offset ] = ( value >>> 24 ) ;
this [ offset + 1 ] = ( value >>> 16 ) ;
this [ offset + 2 ] = ( value >>> 8 ) ;
this [ offset + 3 ] = ( value & 0xff ) ;
return offset + 4
} ;
function checkIEEE754 ( buf , value , offset , ext , max , min ) {
if ( offset + ext > buf . length ) throw new RangeError ( 'Index out of range' )
if ( offset < 0 ) throw new RangeError ( 'Index out of range' )
}
function writeFloat ( buf , value , offset , littleEndian , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) {
checkIEEE754 ( buf , value , offset , 4 , 3.4028234663852886 e + 38 , - 3.4028234663852886 e + 38 ) ;
}
ieee754 . write ( buf , value , offset , littleEndian , 23 , 4 ) ;
return offset + 4
}
Buffer . prototype . writeFloatLE = function writeFloatLE ( value , offset , noAssert ) {
return writeFloat ( this , value , offset , true , noAssert )
} ;
Buffer . prototype . writeFloatBE = function writeFloatBE ( value , offset , noAssert ) {
return writeFloat ( this , value , offset , false , noAssert )
} ;
function writeDouble ( buf , value , offset , littleEndian , noAssert ) {
value = + value ;
offset = offset >>> 0 ;
if ( ! noAssert ) {
checkIEEE754 ( buf , value , offset , 8 , 1.7976931348623157 E + 308 , - 1.7976931348623157 E + 308 ) ;
}
ieee754 . write ( buf , value , offset , littleEndian , 52 , 8 ) ;
return offset + 8
}
Buffer . prototype . writeDoubleLE = function writeDoubleLE ( value , offset , noAssert ) {
return writeDouble ( this , value , offset , true , noAssert )
} ;
Buffer . prototype . writeDoubleBE = function writeDoubleBE ( value , offset , noAssert ) {
return writeDouble ( this , value , offset , false , noAssert )
} ;
// copy(targetBuffer, targetStart=0, sourceStart=0, sourceEnd=buffer.length)
Buffer . prototype . copy = function copy ( target , targetStart , start , end ) {
if ( ! start ) start = 0 ;
if ( ! end && end !== 0 ) end = this . length ;
if ( targetStart >= target . length ) targetStart = target . length ;
if ( ! targetStart ) targetStart = 0 ;
if ( end > 0 && end < start ) end = start ;
// Copy 0 bytes; we're done
if ( end === start ) return 0
if ( target . length === 0 || this . length === 0 ) return 0
// Fatal error conditions
if ( targetStart < 0 ) {
throw new RangeError ( 'targetStart out of bounds' )
}
if ( start < 0 || start >= this . length ) throw new RangeError ( 'sourceStart out of bounds' )
if ( end < 0 ) throw new RangeError ( 'sourceEnd out of bounds' )
// Are we oob?
if ( end > this . length ) end = this . length ;
if ( target . length - targetStart < end - start ) {
end = target . length - targetStart + start ;
}
var len = end - start ;
var i ;
if ( this === target && start < targetStart && targetStart < end ) {
// descending copy from end
for ( i = len - 1 ; i >= 0 ; -- i ) {
target [ i + targetStart ] = this [ i + start ] ;
}
} else if ( len < 1000 ) {
// ascending copy from start
for ( i = 0 ; i < len ; ++ i ) {
target [ i + targetStart ] = this [ i + start ] ;
}
} else {
Uint8Array . prototype . set . call (
target ,
this . subarray ( start , start + len ) ,
targetStart
) ;
}
return len
} ;
// Usage:
// buffer.fill(number[, offset[, end]])
// buffer.fill(buffer[, offset[, end]])
// buffer.fill(string[, offset[, end]][, encoding])
Buffer . prototype . fill = function fill ( val , start , end , encoding ) {
// Handle string cases:
if ( typeof val === 'string' ) {
if ( typeof start === 'string' ) {
encoding = start ;
start = 0 ;
end = this . length ;
} else if ( typeof end === 'string' ) {
encoding = end ;
end = this . length ;
}
if ( val . length === 1 ) {
var code = val . charCodeAt ( 0 ) ;
if ( code < 256 ) {
val = code ;
}
}
if ( encoding !== undefined && typeof encoding !== 'string' ) {
throw new TypeError ( 'encoding must be a string' )
}
if ( typeof encoding === 'string' && ! Buffer . isEncoding ( encoding ) ) {
throw new TypeError ( 'Unknown encoding: ' + encoding )
}
} else if ( typeof val === 'number' ) {
val = val & 255 ;
}
// Invalid ranges are not set to a default, so can range check early.
if ( start < 0 || this . length < start || this . length < end ) {
throw new RangeError ( 'Out of range index' )
}
if ( end <= start ) {
return this
}
start = start >>> 0 ;
end = end === undefined ? this . length : end >>> 0 ;
if ( ! val ) val = 0 ;
var i ;
if ( typeof val === 'number' ) {
for ( i = start ; i < end ; ++ i ) {
this [ i ] = val ;
}
} else {
var bytes = Buffer . isBuffer ( val )
? val
: new Buffer ( val , encoding ) ;
var len = bytes . length ;
for ( i = 0 ; i < end - start ; ++ i ) {
this [ i + start ] = bytes [ i % len ] ;
}
}
return this
} ;
// HELPER FUNCTIONS
// ================
var INVALID _BASE64 _RE = /[^+/0-9A-Za-z-_]/g ;
function base64clean ( str ) {
// Node strips out invalid characters like \n and \t from the string, base64-js does not
str = str . trim ( ) . replace ( INVALID _BASE64 _RE , '' ) ;
// Node converts strings with length < 2 to ''
if ( str . length < 2 ) return ''
// Node allows for non-padded base64 strings (missing trailing ===), base64-js does not
while ( str . length % 4 !== 0 ) {
str = str + '=' ;
}
return str
}
function toHex ( n ) {
if ( n < 16 ) return '0' + n . toString ( 16 )
return n . toString ( 16 )
}
function utf8ToBytes ( string , units ) {
units = units || Infinity ;
var codePoint ;
var length = string . length ;
var leadSurrogate = null ;
var bytes = [ ] ;
for ( var i = 0 ; i < length ; ++ i ) {
codePoint = string . charCodeAt ( i ) ;
// is surrogate component
if ( codePoint > 0xD7FF && codePoint < 0xE000 ) {
// last char was a lead
if ( ! leadSurrogate ) {
// no lead yet
if ( codePoint > 0xDBFF ) {
// unexpected trail
if ( ( units -= 3 ) > - 1 ) bytes . push ( 0xEF , 0xBF , 0xBD ) ;
continue
} else if ( i + 1 === length ) {
// unpaired lead
if ( ( units -= 3 ) > - 1 ) bytes . push ( 0xEF , 0xBF , 0xBD ) ;
continue
}
// valid lead
leadSurrogate = codePoint ;
continue
}
// 2 leads in a row
if ( codePoint < 0xDC00 ) {
if ( ( units -= 3 ) > - 1 ) bytes . push ( 0xEF , 0xBF , 0xBD ) ;
leadSurrogate = codePoint ;
continue
}
// valid surrogate pair
codePoint = ( leadSurrogate - 0xD800 << 10 | codePoint - 0xDC00 ) + 0x10000 ;
} else if ( leadSurrogate ) {
// valid bmp char, but last char was a lead
if ( ( units -= 3 ) > - 1 ) bytes . push ( 0xEF , 0xBF , 0xBD ) ;
}
leadSurrogate = null ;
// encode utf8
if ( codePoint < 0x80 ) {
if ( ( units -= 1 ) < 0 ) break
bytes . push ( codePoint ) ;
} else if ( codePoint < 0x800 ) {
if ( ( units -= 2 ) < 0 ) break
bytes . push (
codePoint >> 0x6 | 0xC0 ,
codePoint & 0x3F | 0x80
) ;
} else if ( codePoint < 0x10000 ) {
if ( ( units -= 3 ) < 0 ) break
bytes . push (
codePoint >> 0xC | 0xE0 ,
codePoint >> 0x6 & 0x3F | 0x80 ,
codePoint & 0x3F | 0x80
) ;
} else if ( codePoint < 0x110000 ) {
if ( ( units -= 4 ) < 0 ) break
bytes . push (
codePoint >> 0x12 | 0xF0 ,
codePoint >> 0xC & 0x3F | 0x80 ,
codePoint >> 0x6 & 0x3F | 0x80 ,
codePoint & 0x3F | 0x80
) ;
} else {
throw new Error ( 'Invalid code point' )
}
}
return bytes
}
function asciiToBytes ( str ) {
var byteArray = [ ] ;
for ( var i = 0 ; i < str . length ; ++ i ) {
// Node's code seems to be doing this and not & 0x7F..
byteArray . push ( str . charCodeAt ( i ) & 0xFF ) ;
}
return byteArray
}
function utf16leToBytes ( str , units ) {
var c , hi , lo ;
var byteArray = [ ] ;
for ( var i = 0 ; i < str . length ; ++ i ) {
if ( ( units -= 2 ) < 0 ) break
c = str . charCodeAt ( i ) ;
hi = c >> 8 ;
lo = c % 256 ;
byteArray . push ( lo ) ;
byteArray . push ( hi ) ;
}
return byteArray
}
function base64ToBytes ( str ) {
return base64Js . toByteArray ( base64clean ( str ) )
}
function blitBuffer ( src , dst , offset , length ) {
for ( var i = 0 ; i < length ; ++ i ) {
if ( ( i + offset >= dst . length ) || ( i >= src . length ) ) break
dst [ i + offset ] = src [ i ] ;
}
return i
}
// ArrayBuffers from another context (i.e. an iframe) do not pass the `instanceof` check
// but they should be treated as valid. See: https://github.com/feross/buffer/issues/166
function isArrayBuffer ( obj ) {
return obj instanceof ArrayBuffer ||
( obj != null && obj . constructor != null && obj . constructor . name === 'ArrayBuffer' &&
typeof obj . byteLength === 'number' )
}
// Node 0.10 supports `ArrayBuffer` but lacks `ArrayBuffer.isView`
function isArrayBufferView ( obj ) {
return ( typeof ArrayBuffer . isView === 'function' ) && ArrayBuffer . isView ( obj )
}
function numberIsNaN ( obj ) {
return obj !== obj // eslint-disable-line no-self-compare
}
} ) ;
var buffer _1 = buffer . Buffer ;
function parseBodyToType$2 ( res ) {
2018-11-29 00:56:17 +00:00
if ( res . headers . get ( 'Content-Type' ) === 'application/json' ) {
return res . json ( ) . then ( function ( data ) {
return [ res , data ] ;
2018-11-03 18:33:35 +00:00
} ) ;
2018-11-29 00:56:17 +00:00
}
return res . text ( ) . then ( function ( data ) {
2018-11-03 18:33:35 +00:00
return [ res , data ] ;
} ) ;
}
2018-11-29 00:56:17 +00:00
function rpcRequest ( fetch ) {
return function rpcRequestWithFetch ( path , body , auth , host , accessToken , options ) {
var fetchOptions = {
method : 'POST' ,
body : body ? JSON . stringify ( body ) : null
} ;
var headers = { } ;
if ( body ) {
headers [ 'Content-Type' ] = 'application/json' ;
2018-11-03 18:33:35 +00:00
}
2018-11-29 00:56:17 +00:00
var authHeader = '' ;
switch ( auth ) {
case 'app' :
if ( ! options . clientId || ! options . clientSecret ) {
throw new Error ( 'A client id and secret is required for this function' ) ;
}
authHeader = new buffer _1 ( options . clientId + ':' + options . clientSecret ) . toString ( 'base64' ) ;
headers . Authorization = 'Basic ' + authHeader ;
break ;
case 'team' :
case 'user' :
headers . Authorization = 'Bearer ' + accessToken ;
break ;
case 'noauth' :
break ;
default :
throw new Error ( 'Unhandled auth type: ' + auth ) ;
2018-11-03 18:33:35 +00:00
}
2018-11-29 00:56:17 +00:00
if ( options ) {
if ( options . selectUser ) {
headers [ 'Dropbox-API-Select-User' ] = options . selectUser ;
}
if ( options . selectAdmin ) {
headers [ 'Dropbox-API-Select-Admin' ] = options . selectAdmin ;
}
2019-07-08 09:59:04 +00:00
if ( options . pathRoot ) {
headers [ 'Dropbox-API-Path-Root' ] = options . pathRoot ;
}
2018-11-03 18:33:35 +00:00
}
2018-11-29 00:56:17 +00:00
fetchOptions . headers = headers ;
return fetch ( getBaseURL ( host ) + path , fetchOptions ) . then ( function ( res ) {
return parseBodyToType$2 ( res ) ;
} ) . then ( function ( _ref ) {
var _ref2 = slicedToArray ( _ref , 2 ) ,
res = _ref2 [ 0 ] ,
data = _ref2 [ 1 ] ;
// maintaining existing API for error codes not equal to 200 range
if ( ! res . ok ) {
// eslint-disable-next-line no-throw-literal
throw {
error : data ,
response : res ,
status : res . status
} ;
}
return data ;
} ) ;
} ;
2018-11-03 18:33:35 +00:00
}
/* eslint-disable */
// Polyfill object.assign for legacy browsers
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign
if ( typeof Object . assign !== 'function' ) {
( function ( ) {
Object . assign = function ( target ) {
'use strict' ;
var output ;
var index ;
var source ;
var nextKey ;
if ( target === undefined || target === null ) {
throw new TypeError ( 'Cannot convert undefined or null to object' ) ;
}
output = Object ( target ) ;
for ( index = 1 ; index < arguments . length ; index ++ ) {
source = arguments [ index ] ;
if ( source !== undefined && source !== null ) {
for ( nextKey in source ) {
if ( source . hasOwnProperty ( nextKey ) ) {
output [ nextKey ] = source [ nextKey ] ;
}
}
}
}
return output ;
} ;
} ) ( ) ;
}
// Polyfill Array.includes for legacy browsers
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes
// https://tc39.github.io/ecma262/#sec-array.prototype.includes
if ( ! Array . prototype . includes ) {
Object . defineProperty ( Array . prototype , 'includes' , {
value : function value ( searchElement , fromIndex ) {
if ( this == null ) {
throw new TypeError ( '"this" is null or not defined' ) ;
}
// 1. Let O be ? ToObject(this value).
var o = Object ( this ) ;
// 2. Let len be ? ToLength(? Get(O, "length")).
var len = o . length >>> 0 ;
// 3. If len is 0, return false.
if ( len === 0 ) {
return false ;
}
// 4. Let n be ? ToInteger(fromIndex).
// (If fromIndex is undefined, this step produces the value 0.)
var n = fromIndex | 0 ;
// 5. If n ≥ 0, then
// a. Let k be n.
// 6. Else n < 0,
// a. Let k be len + n.
// b. If k < 0, let k be 0.
var k = Math . max ( n >= 0 ? n : len - Math . abs ( n ) , 0 ) ;
function sameValueZero ( x , y ) {
return x === y || typeof x === 'number' && typeof y === 'number' && isNaN ( x ) && isNaN ( y ) ;
}
// 7. Repeat, while k < len
while ( k < len ) {
// a. Let elementK be the result of ? Get(O, ! ToString(k)).
// b. If SameValueZero(searchElement, elementK) is true, return true.
if ( sameValueZero ( o [ k ] , searchElement ) ) {
return true ;
}
// c. Increase k by 1.
k ++ ;
}
// 8. Return false
return false ;
}
} ) ;
}
/* eslint-enable */
/ * *
* @ private
* @ class DropboxBase
* @ classdesc The main Dropbox SDK class . This contains the methods that are
* shared between Dropbox and DropboxTeam classes . It is marked as private so
* that it doesn ' t show up in the docs because it is never used directly .
* @ arg { Object } options
2018-11-29 00:56:17 +00:00
* @ arg { Function } [ options . fetch ] - fetch library for making requests .
2018-11-03 18:33:35 +00:00
* @ arg { String } [ options . accessToken ] - An access token for making authenticated
* requests .
* @ arg { String } [ options . clientId ] - The client id for your app . Used to create
* authentication URL .
* @ arg { String } [ options . clientSecret ] - The client secret for your app .
* @ arg { Number } [ options . selectUser ] - User that the team access token would like
* to act as .
* @ arg { String } [ options . selectAdmin ] - Team admin that the team access token would like
* to act as .
2019-07-08 09:59:04 +00:00
* @ arg { String } [ options . pathRoot ] - root pass to access other namespaces
* Use to access team folders for example
2018-11-03 18:33:35 +00:00
* /
function parseBodyToType ( res ) {
var clone = res . clone ( ) ;
return new Promise ( function ( resolve ) {
res . json ( ) . then ( function ( data ) {
return resolve ( data ) ;
} ) . catch ( function ( ) {
return clone . text ( ) . then ( function ( data ) {
return resolve ( data ) ;
} ) ;
} ) ;
} ) . then ( function ( data ) {
return [ res , data ] ;
} ) ;
}
var DropboxBase = function ( ) {
function DropboxBase ( options ) {
classCallCheck ( this , DropboxBase ) ;
options = options || { } ;
this . accessToken = options . accessToken ;
this . clientId = options . clientId ;
this . clientSecret = options . clientSecret ;
this . selectUser = options . selectUser ;
this . selectAdmin = options . selectAdmin ;
2018-11-29 00:56:17 +00:00
this . fetch = options . fetch || fetch ;
2019-07-08 09:59:04 +00:00
this . pathRoot = options . pathRoot ;
2018-11-29 00:56:17 +00:00
if ( ! options . fetch ) {
console . warn ( 'Global fetch is deprecated and will be unsupported in a future version. Please pass fetch function as option when instantiating dropbox instance: new Dropbox({fetch})' ) ;
} // eslint-disable-line no-console
2018-11-03 18:33:35 +00:00
}
/ * *
* Set the access token used to authenticate requests to the API .
* @ arg { String } accessToken - An access token
* @ returns { undefined }
* /
createClass ( DropboxBase , [ {
key : 'setAccessToken' ,
value : function setAccessToken ( accessToken ) {
this . accessToken = accessToken ;
}
/ * *
* Get the access token
* @ returns { String } Access token
* /
} , {
key : 'getAccessToken' ,
value : function getAccessToken ( ) {
return this . accessToken ;
}
/ * *
* Set the client id , which is used to help gain an access token .
* @ arg { String } clientId - Your apps client id
* @ returns { undefined }
* /
} , {
key : 'setClientId' ,
value : function setClientId ( clientId ) {
this . clientId = clientId ;
}
/ * *
* Get the client id
* @ returns { String } Client id
* /
} , {
key : 'getClientId' ,
value : function getClientId ( ) {
return this . clientId ;
}
/ * *
* Set the client secret
* @ arg { String } clientSecret - Your app ' s client secret
* @ returns { undefined }
* /
} , {
key : 'setClientSecret' ,
value : function setClientSecret ( clientSecret ) {
this . clientSecret = clientSecret ;
}
/ * *
* Get the client secret
* @ returns { String } Client secret
* /
} , {
key : 'getClientSecret' ,
value : function getClientSecret ( ) {
return this . clientSecret ;
}
/ * *
* Get a URL that can be used to authenticate users for the Dropbox API .
* @ arg { String } redirectUri - A URL to redirect the user to after
* authenticating . This must be added to your app through the admin interface .
* @ arg { String } [ state ] - State that will be returned in the redirect URL to help
* prevent cross site scripting attacks .
* @ arg { String } [ authType ] - auth type , defaults to 'token' , other option is 'code'
* @ returns { String } Url to send user to for Dropbox API authentication
* /
} , {
key : 'getAuthenticationUrl' ,
value : function getAuthenticationUrl ( redirectUri , state ) {
var authType = arguments . length > 2 && arguments [ 2 ] !== undefined ? arguments [ 2 ] : 'token' ;
var clientId = this . getClientId ( ) ;
var baseUrl = 'https://www.dropbox.com/oauth2/authorize' ;
if ( ! clientId ) {
throw new Error ( 'A client id is required. You can set the client id using .setClientId().' ) ;
}
if ( authType !== 'code' && ! redirectUri ) {
throw new Error ( 'A redirect uri is required.' ) ;
}
if ( ! [ 'code' , 'token' ] . includes ( authType ) ) {
throw new Error ( 'Authorization type must be code or token' ) ;
}
var authUrl = void 0 ;
if ( authType === 'code' ) {
authUrl = baseUrl + '?response_type=code&client_id=' + clientId ;
} else {
authUrl = baseUrl + '?response_type=token&client_id=' + clientId ;
}
if ( redirectUri ) {
authUrl += '&redirect_uri=' + redirectUri ;
}
if ( state ) {
authUrl += '&state=' + state ;
}
return authUrl ;
}
/ * *
* Get an OAuth2 access token from an OAuth2 Code .
* @ arg { String } redirectUri - A URL to redirect the user to after
* authenticating . This must be added to your app through the admin interface .
* @ arg { String } code - An OAuth2 code .
* /
} , {
key : 'getAccessTokenFromCode' ,
value : function getAccessTokenFromCode ( redirectUri , code ) {
var clientId = this . getClientId ( ) ;
var clientSecret = this . getClientSecret ( ) ;
if ( ! clientId ) {
throw new Error ( 'A client id is required. You can set the client id using .setClientId().' ) ;
}
if ( ! clientSecret ) {
throw new Error ( 'A client secret is required. You can set the client id using .setClientSecret().' ) ;
}
var path = 'https://api.dropboxapi.com/oauth2/token?code=' + code + '&grant_type=authorization_code&redirect_uri=' + redirectUri + '&client_id=' + clientId + '&client_secret=' + clientSecret ;
var fetchOptions = {
method : 'POST' ,
headers : {
'Content-Type' : 'application/x-www-form-urlencoded'
}
} ;
2018-11-29 00:56:17 +00:00
return this . fetch ( path , fetchOptions ) . then ( function ( res ) {
2018-11-03 18:33:35 +00:00
return parseBodyToType ( res ) ;
} ) . then ( function ( _ref ) {
var _ref2 = slicedToArray ( _ref , 2 ) ,
res = _ref2 [ 0 ] ,
data = _ref2 [ 1 ] ;
// maintaining existing API for error codes not equal to 200 range
if ( ! res . ok ) {
// eslint-disable-next-line no-throw-literal
throw {
error : data ,
response : res ,
status : res . status
} ;
}
return data . access _token ;
} ) ;
}
/ * *
* Called when the authentication succeed
* @ callback successCallback
* @ param { string } access _token The application ' s access token
* /
/ * *
* Called when the authentication failed .
* @ callback errorCallback
* /
/ * *
* An authentication process that works with cordova applications .
* @ param { successCallback } successCallback
* @ param { errorCallback } errorCallback
* /
} , {
key : 'authenticateWithCordova' ,
value : function authenticateWithCordova ( successCallback , errorCallback ) {
var redirectUrl = 'https://www.dropbox.com/1/oauth2/redirect_receiver' ;
var url = this . getAuthenticationUrl ( redirectUrl ) ;
var removed = false ;
var browser = window . open ( url , '_blank' ) ;
2019-07-08 09:59:04 +00:00
function onLoadError ( event ) {
if ( event . code !== - 999 ) {
// Workaround to fix wrong behavior on cordova-plugin-inappbrowser
// Try to avoid a browser crash on browser.close().
window . setTimeout ( function ( ) {
browser . close ( ) ;
} , 10 ) ;
errorCallback ( ) ;
}
2018-11-03 18:33:35 +00:00
}
function onLoadStop ( event ) {
var errorLabel = '&error=' ;
var errorIndex = event . url . indexOf ( errorLabel ) ;
if ( errorIndex > - 1 ) {
// Try to avoid a browser crash on browser.close().
window . setTimeout ( function ( ) {
browser . close ( ) ;
} , 10 ) ;
errorCallback ( ) ;
} else {
var tokenLabel = '#access_token=' ;
var tokenIndex = event . url . indexOf ( tokenLabel ) ;
var tokenTypeIndex = event . url . indexOf ( '&token_type=' ) ;
if ( tokenIndex > - 1 ) {
tokenIndex += tokenLabel . length ;
// Try to avoid a browser crash on browser.close().
window . setTimeout ( function ( ) {
browser . close ( ) ;
} , 10 ) ;
var accessToken = event . url . substring ( tokenIndex , tokenTypeIndex ) ;
successCallback ( accessToken ) ;
}
}
}
function onExit ( ) {
if ( removed ) {
return ;
}
browser . removeEventListener ( 'loaderror' , onLoadError ) ;
browser . removeEventListener ( 'loadstop' , onLoadStop ) ;
browser . removeEventListener ( 'exit' , onExit ) ;
removed = true ;
}
browser . addEventListener ( 'loaderror' , onLoadError ) ;
browser . addEventListener ( 'loadstop' , onLoadStop ) ;
browser . addEventListener ( 'exit' , onExit ) ;
}
} , {
key : 'request' ,
value : function request ( path , args , auth , host , style ) {
var request = null ;
switch ( style ) {
case RPC :
request = this . getRpcRequest ( ) ;
break ;
case DOWNLOAD :
request = this . getDownloadRequest ( ) ;
break ;
case UPLOAD :
request = this . getUploadRequest ( ) ;
break ;
default :
throw new Error ( 'Invalid request style: ' + style ) ;
}
var options = {
selectUser : this . selectUser ,
selectAdmin : this . selectAdmin ,
clientId : this . getClientId ( ) ,
2019-07-08 09:59:04 +00:00
clientSecret : this . getClientSecret ( ) ,
pathRoot : this . pathRoot
2018-11-03 18:33:35 +00:00
} ;
return request ( path , args , auth , host , this . getAccessToken ( ) , options ) ;
}
} , {
key : 'setRpcRequest' ,
value : function setRpcRequest ( newRpcRequest ) {
this . rpcRequest = newRpcRequest ;
}
} , {
key : 'getRpcRequest' ,
value : function getRpcRequest ( ) {
if ( this . rpcRequest === undefined ) {
2018-11-29 00:56:17 +00:00
this . rpcRequest = rpcRequest ( this . fetch ) ;
2018-11-03 18:33:35 +00:00
}
return this . rpcRequest ;
}
} , {
key : 'setDownloadRequest' ,
value : function setDownloadRequest ( newDownloadRequest ) {
this . downloadRequest = newDownloadRequest ;
}
} , {
key : 'getDownloadRequest' ,
value : function getDownloadRequest ( ) {
if ( this . downloadRequest === undefined ) {
2018-11-29 00:56:17 +00:00
this . downloadRequest = downloadRequest ( this . fetch ) ;
2018-11-03 18:33:35 +00:00
}
return this . downloadRequest ;
}
} , {
key : 'setUploadRequest' ,
value : function setUploadRequest ( newUploadRequest ) {
this . uploadRequest = newUploadRequest ;
}
} , {
key : 'getUploadRequest' ,
value : function getUploadRequest ( ) {
if ( this . uploadRequest === undefined ) {
2018-11-29 00:56:17 +00:00
this . uploadRequest = uploadRequest ( this . fetch ) ;
2018-11-03 18:33:35 +00:00
}
return this . uploadRequest ;
}
} ] ) ;
return DropboxBase ;
} ( ) ;
/ * *
* @ class Dropbox
* @ extends DropboxBase
* @ classdesc The Dropbox SDK class that provides methods to read , write and
* create files or folders in a user ' s Dropbox .
* @ arg { Object } options
2018-11-29 00:56:17 +00:00
* @ arg { Function } [ options . fetch ] - fetch library for making requests .
2018-11-03 18:33:35 +00:00
* @ arg { String } [ options . accessToken ] - An access token for making authenticated
* requests .
* @ arg { String } [ options . clientId ] - The client id for your app . Used to create
* authentication URL .
* @ arg { String } [ options . selectUser ] - Select user is only used by DropboxTeam .
* It specifies which user the team access token should be acting as .
2019-07-08 09:59:04 +00:00
* @ arg { String } [ options . pathRoot ] - root pass to access other namespaces
* Use to access team folders for example
2018-11-03 18:33:35 +00:00
* /
var Dropbox = function ( _DropboxBase ) {
inherits ( Dropbox , _DropboxBase ) ;
function Dropbox ( options ) {
classCallCheck ( this , Dropbox ) ;
var _this = possibleConstructorReturn ( this , ( Dropbox . _ _proto _ _ || Object . getPrototypeOf ( Dropbox ) ) . call ( this , options ) ) ;
Object . assign ( _this , routes ) ;
return _this ;
}
createClass ( Dropbox , [ {
key : 'filesGetSharedLinkFile' ,
value : function filesGetSharedLinkFile ( arg ) {
return this . request ( 'sharing/get_shared_link_file' , arg , 'api' , 'download' ) ;
}
} ] ) ;
return Dropbox ;
} ( DropboxBase ) ;
var dropbox = Object . freeze ( {
Dropbox : Dropbox
} ) ;
// Auto-generated by Stone, do not modify.
var routes$1 = { } ;
/ * *
* List all device sessions of a team ' s member .
* @ function DropboxTeam # teamDevicesListMemberDevices
* @ arg { TeamListMemberDevicesArg } arg - The request parameters .
* @ returns { Promise . < TeamListMemberDevicesResult , Error . < TeamListMemberDevicesError >> }
* /
routes$1 . teamDevicesListMemberDevices = function ( arg ) {
return this . request ( 'team/devices/list_member_devices' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* List all device sessions of a team . Permission : Team member file access .
2018-11-03 18:33:35 +00:00
* @ function DropboxTeam # teamDevicesListMembersDevices
* @ arg { TeamListMembersDevicesArg } arg - The request parameters .
* @ returns { Promise . < TeamListMembersDevicesResult , Error . < TeamListMembersDevicesError >> }
* /
routes$1 . teamDevicesListMembersDevices = function ( arg ) {
return this . request ( 'team/devices/list_members_devices' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* List all device sessions of a team . Permission : Team member file access .
2018-11-03 18:33:35 +00:00
* @ function DropboxTeam # teamDevicesListTeamDevices
* @ deprecated
* @ arg { TeamListTeamDevicesArg } arg - The request parameters .
* @ returns { Promise . < TeamListTeamDevicesResult , Error . < TeamListTeamDevicesError >> }
* /
routes$1 . teamDevicesListTeamDevices = function ( arg ) {
return this . request ( 'team/devices/list_team_devices' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Revoke a device session of a team ' s member .
* @ function DropboxTeam # teamDevicesRevokeDeviceSession
* @ arg { TeamRevokeDeviceSessionArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < TeamRevokeDeviceSessionError >> }
* /
routes$1 . teamDevicesRevokeDeviceSession = function ( arg ) {
return this . request ( 'team/devices/revoke_device_session' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Revoke a list of device sessions of team members .
* @ function DropboxTeam # teamDevicesRevokeDeviceSessionBatch
* @ arg { TeamRevokeDeviceSessionBatchArg } arg - The request parameters .
* @ returns { Promise . < TeamRevokeDeviceSessionBatchResult , Error . < TeamRevokeDeviceSessionBatchError >> }
* /
routes$1 . teamDevicesRevokeDeviceSessionBatch = function ( arg ) {
return this . request ( 'team/devices/revoke_device_session_batch' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get the values for one or more featues . This route allows you to check your
* account ' s capability for what feature you can access or what value you have
* for certain features . Permission : Team information .
* @ function DropboxTeam # teamFeaturesGetValues
* @ arg { TeamFeaturesGetValuesBatchArg } arg - The request parameters .
* @ returns { Promise . < TeamFeaturesGetValuesBatchResult , Error . < TeamFeaturesGetValuesBatchError >> }
* /
routes$1 . teamFeaturesGetValues = function ( arg ) {
return this . request ( 'team/features/get_values' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Retrieves information about a team .
* @ function DropboxTeam # teamGetInfo
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < TeamTeamGetInfoResult , Error . < void >> }
* /
routes$1 . teamGetInfo = function ( arg ) {
return this . request ( 'team/get_info' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Creates a new , empty group , with a requested name . Permission : Team member
* management .
* @ function DropboxTeam # teamGroupsCreate
* @ arg { TeamGroupCreateArg } arg - The request parameters .
* @ returns { Promise . < TeamGroupFullInfo , Error . < TeamGroupCreateError >> }
* /
routes$1 . teamGroupsCreate = function ( arg ) {
return this . request ( 'team/groups/create' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Deletes a group . The group is deleted immediately . However the revoking of
* group - owned resources may take additional time . Use the groups / job _status / get
* to determine whether this process has completed . Permission : Team member
* management .
* @ function DropboxTeam # teamGroupsDelete
* @ arg { TeamGroupSelector } arg - The request parameters .
* @ returns { Promise . < AsyncLaunchEmptyResult , Error . < TeamGroupDeleteError >> }
* /
routes$1 . teamGroupsDelete = function ( arg ) {
return this . request ( 'team/groups/delete' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Retrieves information about one or more groups . Note that the optional field
* GroupFullInfo . members is not returned for system - managed groups . Permission :
* Team Information .
* @ function DropboxTeam # teamGroupsGetInfo
* @ arg { TeamGroupsSelector } arg - The request parameters .
* @ returns { Promise . < Object , Error . < TeamGroupsGetInfoError >> }
* /
routes$1 . teamGroupsGetInfo = function ( arg ) {
return this . request ( 'team/groups/get_info' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once an async _job _id is returned from groups / delete , groups / members / add , or
* groups / members / remove use this method to poll the status of granting / revoking
* group members ' access to group - owned resources . Permission : Team member
* management .
* @ function DropboxTeam # teamGroupsJobStatusGet
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < AsyncPollEmptyResult , Error . < TeamGroupsPollError >> }
* /
routes$1 . teamGroupsJobStatusGet = function ( arg ) {
return this . request ( 'team/groups/job_status/get' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Lists groups on a team . Permission : Team Information .
* @ function DropboxTeam # teamGroupsList
* @ arg { TeamGroupsListArg } arg - The request parameters .
* @ returns { Promise . < TeamGroupsListResult , Error . < void >> }
* /
routes$1 . teamGroupsList = function ( arg ) {
return this . request ( 'team/groups/list' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from groups / list , use this to paginate
* through all groups . Permission : Team Information .
* @ function DropboxTeam # teamGroupsListContinue
* @ arg { TeamGroupsListContinueArg } arg - The request parameters .
* @ returns { Promise . < TeamGroupsListResult , Error . < TeamGroupsListContinueError >> }
* /
routes$1 . teamGroupsListContinue = function ( arg ) {
return this . request ( 'team/groups/list/continue' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Adds members to a group . The members are added immediately . However the
* granting of group - owned resources may take additional time . Use the
* groups / job _status / get to determine whether this process has completed .
* Permission : Team member management .
* @ function DropboxTeam # teamGroupsMembersAdd
* @ arg { TeamGroupMembersAddArg } arg - The request parameters .
* @ returns { Promise . < TeamGroupMembersChangeResult , Error . < TeamGroupMembersAddError >> }
* /
routes$1 . teamGroupsMembersAdd = function ( arg ) {
return this . request ( 'team/groups/members/add' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Lists members of a group . Permission : Team Information .
* @ function DropboxTeam # teamGroupsMembersList
* @ arg { TeamGroupsMembersListArg } arg - The request parameters .
* @ returns { Promise . < TeamGroupsMembersListResult , Error . < TeamGroupSelectorError >> }
* /
routes$1 . teamGroupsMembersList = function ( arg ) {
return this . request ( 'team/groups/members/list' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from groups / members / list , use this to
* paginate through all members of the group . Permission : Team information .
* @ function DropboxTeam # teamGroupsMembersListContinue
* @ arg { TeamGroupsMembersListContinueArg } arg - The request parameters .
* @ returns { Promise . < TeamGroupsMembersListResult , Error . < TeamGroupsMembersListContinueError >> }
* /
routes$1 . teamGroupsMembersListContinue = function ( arg ) {
return this . request ( 'team/groups/members/list/continue' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Removes members from a group . The members are removed immediately . However
* the revoking of group - owned resources may take additional time . Use the
* groups / job _status / get to determine whether this process has completed . This
* method permits removing the only owner of a group , even in cases where this
* is not possible via the web client . Permission : Team member management .
* @ function DropboxTeam # teamGroupsMembersRemove
* @ arg { TeamGroupMembersRemoveArg } arg - The request parameters .
* @ returns { Promise . < TeamGroupMembersChangeResult , Error . < TeamGroupMembersRemoveError >> }
* /
routes$1 . teamGroupsMembersRemove = function ( arg ) {
return this . request ( 'team/groups/members/remove' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Sets a member ' s access type in a group . Permission : Team member management .
* @ function DropboxTeam # teamGroupsMembersSetAccessType
* @ arg { TeamGroupMembersSetAccessTypeArg } arg - The request parameters .
* @ returns { Promise . < Object , Error . < TeamGroupMemberSetAccessTypeError >> }
* /
routes$1 . teamGroupsMembersSetAccessType = function ( arg ) {
return this . request ( 'team/groups/members/set_access_type' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Updates a group ' s name and / or external ID . Permission : Team member
* management .
* @ function DropboxTeam # teamGroupsUpdate
* @ arg { TeamGroupUpdateArgs } arg - The request parameters .
* @ returns { Promise . < TeamGroupFullInfo , Error . < TeamGroupUpdateError >> }
* /
routes$1 . teamGroupsUpdate = function ( arg ) {
return this . request ( 'team/groups/update' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* List all linked applications of the team member . Note , this endpoint does not
* list any team - linked applications .
* @ function DropboxTeam # teamLinkedAppsListMemberLinkedApps
* @ arg { TeamListMemberAppsArg } arg - The request parameters .
* @ returns { Promise . < TeamListMemberAppsResult , Error . < TeamListMemberAppsError >> }
* /
routes$1 . teamLinkedAppsListMemberLinkedApps = function ( arg ) {
return this . request ( 'team/linked_apps/list_member_linked_apps' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* List all applications linked to the team members ' accounts . Note , this
* endpoint does not list any team - linked applications .
* @ function DropboxTeam # teamLinkedAppsListMembersLinkedApps
* @ arg { TeamListMembersAppsArg } arg - The request parameters .
* @ returns { Promise . < TeamListMembersAppsResult , Error . < TeamListMembersAppsError >> }
* /
routes$1 . teamLinkedAppsListMembersLinkedApps = function ( arg ) {
return this . request ( 'team/linked_apps/list_members_linked_apps' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* List all applications linked to the team members ' accounts . Note , this
* endpoint doesn ' t list any team - linked applications .
* @ function DropboxTeam # teamLinkedAppsListTeamLinkedApps
* @ deprecated
* @ arg { TeamListTeamAppsArg } arg - The request parameters .
* @ returns { Promise . < TeamListTeamAppsResult , Error . < TeamListTeamAppsError >> }
* /
routes$1 . teamLinkedAppsListTeamLinkedApps = function ( arg ) {
return this . request ( 'team/linked_apps/list_team_linked_apps' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Revoke a linked application of the team member .
* @ function DropboxTeam # teamLinkedAppsRevokeLinkedApp
* @ arg { TeamRevokeLinkedApiAppArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < TeamRevokeLinkedAppError >> }
* /
routes$1 . teamLinkedAppsRevokeLinkedApp = function ( arg ) {
return this . request ( 'team/linked_apps/revoke_linked_app' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Revoke a list of linked applications of the team members .
* @ function DropboxTeam # teamLinkedAppsRevokeLinkedAppBatch
* @ arg { TeamRevokeLinkedApiAppBatchArg } arg - The request parameters .
* @ returns { Promise . < TeamRevokeLinkedAppBatchResult , Error . < TeamRevokeLinkedAppBatchError >> }
* /
routes$1 . teamLinkedAppsRevokeLinkedAppBatch = function ( arg ) {
return this . request ( 'team/linked_apps/revoke_linked_app_batch' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Add users to member space limits excluded users list .
* @ function DropboxTeam # teamMemberSpaceLimitsExcludedUsersAdd
* @ arg { TeamExcludedUsersUpdateArg } arg - The request parameters .
* @ returns { Promise . < TeamExcludedUsersUpdateResult , Error . < TeamExcludedUsersUpdateError >> }
* /
routes$1 . teamMemberSpaceLimitsExcludedUsersAdd = function ( arg ) {
return this . request ( 'team/member_space_limits/excluded_users/add' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* List member space limits excluded users .
* @ function DropboxTeam # teamMemberSpaceLimitsExcludedUsersList
* @ arg { TeamExcludedUsersListArg } arg - The request parameters .
* @ returns { Promise . < TeamExcludedUsersListResult , Error . < TeamExcludedUsersListError >> }
* /
routes$1 . teamMemberSpaceLimitsExcludedUsersList = function ( arg ) {
return this . request ( 'team/member_space_limits/excluded_users/list' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Continue listing member space limits excluded users .
* @ function DropboxTeam # teamMemberSpaceLimitsExcludedUsersListContinue
* @ arg { TeamExcludedUsersListContinueArg } arg - The request parameters .
* @ returns { Promise . < TeamExcludedUsersListResult , Error . < TeamExcludedUsersListContinueError >> }
* /
routes$1 . teamMemberSpaceLimitsExcludedUsersListContinue = function ( arg ) {
return this . request ( 'team/member_space_limits/excluded_users/list/continue' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Remove users from member space limits excluded users list .
* @ function DropboxTeam # teamMemberSpaceLimitsExcludedUsersRemove
* @ arg { TeamExcludedUsersUpdateArg } arg - The request parameters .
* @ returns { Promise . < TeamExcludedUsersUpdateResult , Error . < TeamExcludedUsersUpdateError >> }
* /
routes$1 . teamMemberSpaceLimitsExcludedUsersRemove = function ( arg ) {
return this . request ( 'team/member_space_limits/excluded_users/remove' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Get users custom quota . Returns none as the custom quota if none was set . A
* maximum of 1000 members can be specified in a single call .
* @ function DropboxTeam # teamMemberSpaceLimitsGetCustomQuota
* @ arg { TeamCustomQuotaUsersArg } arg - The request parameters .
* @ returns { Promise . < Array . < TeamCustomQuotaResult > , Error . < TeamCustomQuotaError >> }
* /
routes$1 . teamMemberSpaceLimitsGetCustomQuota = function ( arg ) {
return this . request ( 'team/member_space_limits/get_custom_quota' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Remove users custom quota . A maximum of 1000 members can be specified in a
* single call .
* @ function DropboxTeam # teamMemberSpaceLimitsRemoveCustomQuota
* @ arg { TeamCustomQuotaUsersArg } arg - The request parameters .
* @ returns { Promise . < Array . < TeamRemoveCustomQuotaResult > , Error . < TeamCustomQuotaError >> }
* /
routes$1 . teamMemberSpaceLimitsRemoveCustomQuota = function ( arg ) {
return this . request ( 'team/member_space_limits/remove_custom_quota' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Set users custom quota . Custom quota has to be at least 15 GB . A maximum of
* 1000 members can be specified in a single call .
* @ function DropboxTeam # teamMemberSpaceLimitsSetCustomQuota
* @ arg { TeamSetCustomQuotaArg } arg - The request parameters .
* @ returns { Promise . < Array . < TeamCustomQuotaResult > , Error . < TeamSetCustomQuotaError >> }
* /
routes$1 . teamMemberSpaceLimitsSetCustomQuota = function ( arg ) {
return this . request ( 'team/member_space_limits/set_custom_quota' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Adds members to a team . Permission : Team member management A maximum of 20
* members can be specified in a single call . If no Dropbox account exists with
* the email address specified , a new Dropbox account will be created with the
* given email address , and that account will be invited to the team . If a
* personal Dropbox account exists with the email address specified in the call ,
* this call will create a placeholder Dropbox account for the user on the team
* and send an email inviting the user to migrate their existing personal
* account onto the team . Team member management apps are required to set an
* initial given _name and surname for a user to use in the team invitation and
* for 'Perform as team member' actions taken on the user before they become
* 'active' .
* @ function DropboxTeam # teamMembersAdd
* @ arg { TeamMembersAddArg } arg - The request parameters .
* @ returns { Promise . < TeamMembersAddLaunch , Error . < void >> }
* /
routes$1 . teamMembersAdd = function ( arg ) {
return this . request ( 'team/members/add' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once an async _job _id is returned from members / add , use this to poll the
* status of the asynchronous request . Permission : Team member management .
* @ function DropboxTeam # teamMembersAddJobStatusGet
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < TeamMembersAddJobStatus , Error . < AsyncPollError >> }
* /
routes$1 . teamMembersAddJobStatusGet = function ( arg ) {
return this . request ( 'team/members/add/job_status/get' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns information about multiple team members . Permission : Team
* information This endpoint will return MembersGetInfoItem . id _not _found , for
* IDs ( or emails ) that cannot be matched to a valid team member .
* @ function DropboxTeam # teamMembersGetInfo
* @ arg { TeamMembersGetInfoArgs } arg - The request parameters .
* @ returns { Promise . < Object , Error . < TeamMembersGetInfoError >> }
* /
routes$1 . teamMembersGetInfo = function ( arg ) {
return this . request ( 'team/members/get_info' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Lists members of a team . Permission : Team information .
* @ function DropboxTeam # teamMembersList
* @ arg { TeamMembersListArg } arg - The request parameters .
* @ returns { Promise . < TeamMembersListResult , Error . < TeamMembersListError >> }
* /
routes$1 . teamMembersList = function ( arg ) {
return this . request ( 'team/members/list' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from members / list , use this to paginate
* through all team members . Permission : Team information .
* @ function DropboxTeam # teamMembersListContinue
* @ arg { TeamMembersListContinueArg } arg - The request parameters .
* @ returns { Promise . < TeamMembersListResult , Error . < TeamMembersListContinueError >> }
* /
routes$1 . teamMembersListContinue = function ( arg ) {
return this . request ( 'team/members/list/continue' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
2018-11-29 00:56:17 +00:00
/ * *
* Moves removed member ' s files to a different member . This endpoint initiates
* an asynchronous job . To obtain the final result of the job , the client should
* periodically poll members / move _former _member _files / job _status / check .
* Permission : Team member management .
* @ function DropboxTeam # teamMembersMoveFormerMemberFiles
* @ arg { TeamMembersDataTransferArg } arg - The request parameters .
* @ returns { Promise . < AsyncLaunchEmptyResult , Error . < TeamMembersTransferFormerMembersFilesError >> }
* /
routes$1 . teamMembersMoveFormerMemberFiles = function ( arg ) {
return this . request ( 'team/members/move_former_member_files' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once an async _job _id is returned from members / move _former _member _files , use
* this to poll the status of the asynchronous request . Permission : Team member
* management .
* @ function DropboxTeam # teamMembersMoveFormerMemberFilesJobStatusCheck
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < AsyncPollEmptyResult , Error . < AsyncPollError >> }
* /
routes$1 . teamMembersMoveFormerMemberFilesJobStatusCheck = function ( arg ) {
return this . request ( 'team/members/move_former_member_files/job_status/check' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
2018-11-03 18:33:35 +00:00
/ * *
* Recover a deleted member . Permission : Team member management Exactly one of
* team _member _id , email , or external _id must be provided to identify the user
* account .
* @ function DropboxTeam # teamMembersRecover
* @ arg { TeamMembersRecoverArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < TeamMembersRecoverError >> }
* /
routes$1 . teamMembersRecover = function ( arg ) {
return this . request ( 'team/members/recover' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Removes a member from a team . Permission : Team member management Exactly one
* of team _member _id , email , or external _id must be provided to identify the
* user account . Accounts can be recovered via members / recover for a 7 day
* period or until the account has been permanently deleted or transferred to
* another account ( whichever comes first ) . Calling members / add while a user is
* still recoverable on your team will return with
* MemberAddResult . user _already _on _team . Accounts can have their files
* transferred via the admin console for a limited time , based on the version
* history length associated with the team ( 120 days for most teams ) . This
* endpoint may initiate an asynchronous job . To obtain the final result of the
* job , the client should periodically poll members / remove / job _status / get .
* @ function DropboxTeam # teamMembersRemove
* @ arg { TeamMembersRemoveArg } arg - The request parameters .
* @ returns { Promise . < AsyncLaunchEmptyResult , Error . < TeamMembersRemoveError >> }
* /
routes$1 . teamMembersRemove = function ( arg ) {
return this . request ( 'team/members/remove' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once an async _job _id is returned from members / remove , use this to poll the
* status of the asynchronous request . Permission : Team member management .
* @ function DropboxTeam # teamMembersRemoveJobStatusGet
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < AsyncPollEmptyResult , Error . < AsyncPollError >> }
* /
routes$1 . teamMembersRemoveJobStatusGet = function ( arg ) {
return this . request ( 'team/members/remove/job_status/get' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Sends welcome email to pending team member . Permission : Team member
* management Exactly one of team _member _id , email , or external _id must be
* provided to identify the user account . No - op if team member is not pending .
* @ function DropboxTeam # teamMembersSendWelcomeEmail
* @ arg { TeamUserSelectorArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < TeamMembersSendWelcomeError >> }
* /
routes$1 . teamMembersSendWelcomeEmail = function ( arg ) {
return this . request ( 'team/members/send_welcome_email' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Updates a team member ' s permissions . Permission : Team member management .
* @ function DropboxTeam # teamMembersSetAdminPermissions
* @ arg { TeamMembersSetPermissionsArg } arg - The request parameters .
* @ returns { Promise . < TeamMembersSetPermissionsResult , Error . < TeamMembersSetPermissionsError >> }
* /
routes$1 . teamMembersSetAdminPermissions = function ( arg ) {
return this . request ( 'team/members/set_admin_permissions' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Updates a team member ' s profile . Permission : Team member management .
* @ function DropboxTeam # teamMembersSetProfile
* @ arg { TeamMembersSetProfileArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamMemberInfo , Error . < TeamMembersSetProfileError >> }
* /
routes$1 . teamMembersSetProfile = function ( arg ) {
return this . request ( 'team/members/set_profile' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Suspend a member from a team . Permission : Team member management Exactly one
* of team _member _id , email , or external _id must be provided to identify the
* user account .
* @ function DropboxTeam # teamMembersSuspend
* @ arg { TeamMembersDeactivateArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < TeamMembersSuspendError >> }
* /
routes$1 . teamMembersSuspend = function ( arg ) {
return this . request ( 'team/members/suspend' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Unsuspend a member from a team . Permission : Team member management Exactly
* one of team _member _id , email , or external _id must be provided to identify the
* user account .
* @ function DropboxTeam # teamMembersUnsuspend
* @ arg { TeamMembersUnsuspendArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < TeamMembersUnsuspendError >> }
* /
routes$1 . teamMembersUnsuspend = function ( arg ) {
return this . request ( 'team/members/unsuspend' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns a list of all team - accessible namespaces . This list includes team
* folders , shared folders containing team members , team members ' home
* namespaces , and team members ' app folders . Home namespaces and app folders
* are always owned by this team or members of the team , but shared folders may
* be owned by other users or other teams . Duplicates may occur in the list .
* @ function DropboxTeam # teamNamespacesList
* @ arg { TeamTeamNamespacesListArg } arg - The request parameters .
2018-11-29 00:56:17 +00:00
* @ returns { Promise . < TeamTeamNamespacesListResult , Error . < TeamTeamNamespacesListError >> }
2018-11-03 18:33:35 +00:00
* /
routes$1 . teamNamespacesList = function ( arg ) {
return this . request ( 'team/namespaces/list' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from namespaces / list , use this to paginate
* through all team - accessible namespaces . Duplicates may occur in the list .
* @ function DropboxTeam # teamNamespacesListContinue
* @ arg { TeamTeamNamespacesListContinueArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamNamespacesListResult , Error . < TeamTeamNamespacesListContinueError >> }
* /
routes$1 . teamNamespacesListContinue = function ( arg ) {
return this . request ( 'team/namespaces/list/continue' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Permission : Team member file access .
2018-11-03 18:33:35 +00:00
* @ function DropboxTeam # teamPropertiesTemplateAdd
* @ deprecated
* @ arg { FilePropertiesAddTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesAddTemplateResult , Error . < FilePropertiesModifyTemplateError >> }
* /
routes$1 . teamPropertiesTemplateAdd = function ( arg ) {
return this . request ( 'team/properties/template/add' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Permission : Team member file access .
2018-11-03 18:33:35 +00:00
* @ function DropboxTeam # teamPropertiesTemplateGet
* @ deprecated
* @ arg { FilePropertiesGetTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesGetTemplateResult , Error . < FilePropertiesTemplateError >> }
* /
routes$1 . teamPropertiesTemplateGet = function ( arg ) {
return this . request ( 'team/properties/template/get' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Permission : Team member file access .
2018-11-03 18:33:35 +00:00
* @ function DropboxTeam # teamPropertiesTemplateList
* @ deprecated
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < FilePropertiesListTemplateResult , Error . < FilePropertiesTemplateError >> }
* /
routes$1 . teamPropertiesTemplateList = function ( arg ) {
return this . request ( 'team/properties/template/list' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
2019-07-08 09:59:04 +00:00
* Permission : Team member file access .
2018-11-03 18:33:35 +00:00
* @ function DropboxTeam # teamPropertiesTemplateUpdate
* @ deprecated
* @ arg { FilePropertiesUpdateTemplateArg } arg - The request parameters .
* @ returns { Promise . < FilePropertiesUpdateTemplateResult , Error . < FilePropertiesModifyTemplateError >> }
* /
routes$1 . teamPropertiesTemplateUpdate = function ( arg ) {
return this . request ( 'team/properties/template/update' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Retrieves reporting data about a team ' s user activity .
* @ function DropboxTeam # teamReportsGetActivity
* @ arg { TeamDateRange } arg - The request parameters .
* @ returns { Promise . < TeamGetActivityReport , Error . < TeamDateRangeError >> }
* /
routes$1 . teamReportsGetActivity = function ( arg ) {
return this . request ( 'team/reports/get_activity' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Retrieves reporting data about a team ' s linked devices .
* @ function DropboxTeam # teamReportsGetDevices
* @ arg { TeamDateRange } arg - The request parameters .
* @ returns { Promise . < TeamGetDevicesReport , Error . < TeamDateRangeError >> }
* /
routes$1 . teamReportsGetDevices = function ( arg ) {
return this . request ( 'team/reports/get_devices' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Retrieves reporting data about a team ' s membership .
* @ function DropboxTeam # teamReportsGetMembership
* @ arg { TeamDateRange } arg - The request parameters .
* @ returns { Promise . < TeamGetMembershipReport , Error . < TeamDateRangeError >> }
* /
routes$1 . teamReportsGetMembership = function ( arg ) {
return this . request ( 'team/reports/get_membership' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Retrieves reporting data about a team ' s storage usage .
* @ function DropboxTeam # teamReportsGetStorage
* @ arg { TeamDateRange } arg - The request parameters .
* @ returns { Promise . < TeamGetStorageReport , Error . < TeamDateRangeError >> }
* /
routes$1 . teamReportsGetStorage = function ( arg ) {
return this . request ( 'team/reports/get_storage' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Sets an archived team folder ' s status to active . Permission : Team member
* file access .
* @ function DropboxTeam # teamTeamFolderActivate
* @ arg { TeamTeamFolderIdArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamFolderMetadata , Error . < TeamTeamFolderActivateError >> }
* /
routes$1 . teamTeamFolderActivate = function ( arg ) {
return this . request ( 'team/team_folder/activate' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Sets an active team folder ' s status to archived and removes all folder and
* file members . Permission : Team member file access .
* @ function DropboxTeam # teamTeamFolderArchive
* @ arg { TeamTeamFolderArchiveArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamFolderArchiveLaunch , Error . < TeamTeamFolderArchiveError >> }
* /
routes$1 . teamTeamFolderArchive = function ( arg ) {
return this . request ( 'team/team_folder/archive' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns the status of an asynchronous job for archiving a team folder .
* Permission : Team member file access .
* @ function DropboxTeam # teamTeamFolderArchiveCheck
* @ arg { AsyncPollArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamFolderArchiveJobStatus , Error . < AsyncPollError >> }
* /
routes$1 . teamTeamFolderArchiveCheck = function ( arg ) {
return this . request ( 'team/team_folder/archive/check' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Creates a new , active , team folder with no members . Permission : Team member
* file access .
* @ function DropboxTeam # teamTeamFolderCreate
* @ arg { TeamTeamFolderCreateArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamFolderMetadata , Error . < TeamTeamFolderCreateError >> }
* /
routes$1 . teamTeamFolderCreate = function ( arg ) {
return this . request ( 'team/team_folder/create' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Retrieves metadata for team folders . Permission : Team member file access .
* @ function DropboxTeam # teamTeamFolderGetInfo
* @ arg { TeamTeamFolderIdListArg } arg - The request parameters .
* @ returns { Promise . < Array . < TeamTeamFolderGetInfoItem > , Error . < void >> }
* /
routes$1 . teamTeamFolderGetInfo = function ( arg ) {
return this . request ( 'team/team_folder/get_info' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Lists all team folders . Permission : Team member file access .
* @ function DropboxTeam # teamTeamFolderList
* @ arg { TeamTeamFolderListArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamFolderListResult , Error . < TeamTeamFolderListError >> }
* /
routes$1 . teamTeamFolderList = function ( arg ) {
return this . request ( 'team/team_folder/list' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Once a cursor has been retrieved from team _folder / list , use this to paginate
* through all team folders . Permission : Team member file access .
* @ function DropboxTeam # teamTeamFolderListContinue
* @ arg { TeamTeamFolderListContinueArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamFolderListResult , Error . < TeamTeamFolderListContinueError >> }
* /
routes$1 . teamTeamFolderListContinue = function ( arg ) {
return this . request ( 'team/team_folder/list/continue' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Permanently deletes an archived team folder . Permission : Team member file
* access .
* @ function DropboxTeam # teamTeamFolderPermanentlyDelete
* @ arg { TeamTeamFolderIdArg } arg - The request parameters .
* @ returns { Promise . < void , Error . < TeamTeamFolderPermanentlyDeleteError >> }
* /
routes$1 . teamTeamFolderPermanentlyDelete = function ( arg ) {
return this . request ( 'team/team_folder/permanently_delete' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Changes an active team folder ' s name . Permission : Team member file access .
* @ function DropboxTeam # teamTeamFolderRename
* @ arg { TeamTeamFolderRenameArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamFolderMetadata , Error . < TeamTeamFolderRenameError >> }
* /
routes$1 . teamTeamFolderRename = function ( arg ) {
return this . request ( 'team/team_folder/rename' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Updates the sync settings on a team folder or its contents . Use of this
* endpoint requires that the team has team selective sync enabled .
* @ function DropboxTeam # teamTeamFolderUpdateSyncSettings
* @ arg { TeamTeamFolderUpdateSyncSettingsArg } arg - The request parameters .
* @ returns { Promise . < TeamTeamFolderMetadata , Error . < TeamTeamFolderUpdateSyncSettingsError >> }
* /
routes$1 . teamTeamFolderUpdateSyncSettings = function ( arg ) {
return this . request ( 'team/team_folder/update_sync_settings' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* Returns the member profile of the admin who generated the team access token
* used to make the call .
* @ function DropboxTeam # teamTokenGetAuthenticatedAdmin
* @ arg { void } arg - The request parameters .
* @ returns { Promise . < TeamTokenGetAuthenticatedAdminResult , Error . < TeamTokenGetAuthenticatedAdminError >> }
* /
routes$1 . teamTokenGetAuthenticatedAdmin = function ( arg ) {
return this . request ( 'team/token/get_authenticated_admin' , arg , 'team' , 'api' , 'rpc' ) ;
} ;
/ * *
* @ class DropboxTeam
* @ extends DropboxBase
* @ classdesc The Dropbox SDK class that provides access to team endpoints .
* @ arg { Object } options
* @ arg { String } [ options . accessToken ] - An access token for making authenticated
* requests .
* @ arg { String } [ options . clientId ] - The client id for your app . Used to create
* authentication URL .
* /
var DropboxTeam = function ( _DropboxBase ) {
inherits ( DropboxTeam , _DropboxBase ) ;
function DropboxTeam ( options ) {
classCallCheck ( this , DropboxTeam ) ;
var _this = possibleConstructorReturn ( this , ( DropboxTeam . _ _proto _ _ || Object . getPrototypeOf ( DropboxTeam ) ) . call ( this , options ) ) ;
Object . assign ( _this , routes$1 ) ;
return _this ;
}
/ * *
* Returns an instance of Dropbox that can make calls to user api endpoints on
* behalf of the passed user id , using the team access token .
* @ arg { String } userId - The user id to use the Dropbox class as
* @ returns { Dropbox } An instance of Dropbox used to make calls to user api
* endpoints
* /
createClass ( DropboxTeam , [ {
key : 'actAsUser' ,
value : function actAsUser ( userId ) {
return new Dropbox ( {
accessToken : this . accessToken ,
clientId : this . clientId ,
selectUser : userId
} ) ;
}
} ] ) ;
return DropboxTeam ;
} ( DropboxBase ) ;
var dropboxTeam = Object . freeze ( {
DropboxTeam : DropboxTeam
} ) ;
var src = {
Dropbox : dropbox . Dropbox ,
DropboxTeam : dropboxTeam . DropboxTeam
} ;
return src ;
} ) ) ) ;
//# sourceMappingURL=Dropbox-sdk.js.map