// Auto-generated by Stone, do not modify. import { account, async, auth, check, common, contacts, file_properties, file_requests, files, openid, paper, riviera, secondary_emails, seen_state, sharing, team, team_common, team_log, team_policies, users, users_common } from './dropbox_types'; export * from './dropbox_types'; /** * Optional transport settings for a single Dropbox API request. */ export interface DropboxRequestOptions { /** An AbortSignal used to cancel the request. */ signal?: AbortSignal; /** Maximum request duration in milliseconds. */ timeout?: number; /** Additional HTTP headers for this request. */ extraHeaders?: Record; } /** Binary download content returned by the SDK in Node.js environments. */ export interface DropboxFileBinary extends Uint8Array { toString(encoding?: string, start?: number, end?: number): string; } /** Blob download content returned by the SDK in browser and Worker environments. */ export interface DropboxFileBlob { readonly size: number; readonly type: string; arrayBuffer(): Promise; slice(start?: number, end?: number, contentType?: string): DropboxFileBlob; stream(): any; text(): Promise; } /** API result augmented with the downloaded file content for the current environment. */ export type DropboxDownloadResult = T & ( | { fileBinary: DropboxFileBinary; fileBlob?: never } | { fileBinary?: never; fileBlob: DropboxFileBlob } ); /** Progress reported by the local file download helper. */ export interface DropboxFileDownloadProgress { /** Cumulative bytes written to local storage. */ bytesWritten: number; /** Expected total bytes from Dropbox metadata, when known. */ totalBytes: number; /** Byte offset from an existing .part file. */ resumedFrom: number; } export interface DropboxFileDownloaderOptions { /** Maximum number of download attempts. Defaults to 3. */ maxAttempts?: number; /** Number of parallel ranged downloads for fresh downloads. Defaults to 1. */ parallelDownloads?: number; /** Initial retry delay in milliseconds. Defaults to 500. */ retryDelay?: number; /** Receives cumulative download progress updates. */ progress?: (progress: DropboxFileDownloadProgress) => void; /** An AbortSignal used to cancel Dropbox requests. */ signal?: AbortSignal; /** Maximum duration for each Dropbox request in milliseconds. Must be a positive integer. */ timeout?: number; } export interface DropboxFileDownloadResult { /** Metadata returned by filesDownload. */ metadata: files.FileMetadata; /** Byte offset used to resume from an existing .part file. */ resumedFrom: number; } export class DropboxFileDownloader { constructor(client: Dropbox, options?: DropboxFileDownloaderOptions); downloadFile(remotePath: string, localPath: string): Promise; } export function downloadFile( client: Dropbox, remotePath: string, localPath: string, options?: DropboxFileDownloaderOptions, ): Promise; export interface DropboxAuthOptions { // An access token for making authenticated requests. accessToken?: string; // The time at which the access token expires. accessTokenExpiresAt?: Date; // A refresh token for retrieving access tokens refreshToken?: string; // The client id for your app. Used to create authentication URL. clientId?: string; // The client secret for your app. Used for refresh and token exchange. clientSecret?: string; // The fetch library for making requests. fetch?: Function; // A custom domain to use when making api requests. This should only be used for testing as scaffolding to avoid making network requests. domain?: string; // A custom delimiter to use when separating domain from subdomain. This should only be used for testing as scaffolding. domainDelimiter?: string; // An object (in the form of header: value) designed to set custom headers to use during a request. customHeaders?: object; // Whether request data is sent on body or as URL params. Defaults to false. dataOnBody?: boolean; } export class DropboxAuth { /** * The DropboxAuth class that provides methods to manage, acquire, and refresh tokens. */ constructor(); /** * The DropboxAuth class that provides methods to manage, acquire, and refresh tokens. */ constructor(options: DropboxAuthOptions); /** * Get the access token * @returns {String} Access token */ getAccessToken(): string; /** * Get an OAuth2 access token from an OAuth2 Code. * @param redirectUri A URL to redirect the user to after authenticating. * This must be added to your app through the admin interface. * @param code An OAuth2 code. * @returns {Object} An object containing the token and related info (if applicable) */ getAccessTokenFromCode(redirectUri: string, code: string): Promise>; /** * 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' * @arg {String} [tokenAccessType] - type of token to request. From the following: * null - creates a token with the app default (either legacy or online) * legacy - creates one long-lived token with no expiration * online - create one short-lived token with an expiration * offline - create one short-lived token with an expiration with a refresh token * @arg {Array} [scope] - scopes to request for the grant * @arg {String} [includeGrantedScopes] - whether or not to include previously granted scopes. * From the following: * user - include user scopes in the grant * team - include team scopes in the grant * Note: if this user has never linked the app, include_granted_scopes must be None * @arg {boolean} [usePKCE] - Whether or not to use Sha256 based PKCE. PKCE should be only use on * client apps which doesn't call your server. It is less secure than non-PKCE flow but * can be used if you are unable to safely retrieve your app secret * @returns {Promise} - Url to send user to for Dropbox API authentication * returned in a promise */ getAuthenticationUrl(redirectUri: string, state?: string, authType?: 'token' | 'code', tokenAccessType?: null | 'legacy' | 'offline' | 'online', scope?: Array, includeGrantedScopes?: 'none' | 'user' | 'team', usePKCE?: boolean): Promise; /** * Get the client id * @returns {String} Client id */ getClientId(): string; /** * Set the access token used to authenticate requests to the API. * @param accessToken An access token. */ setAccessToken(accessToken: string): void; /** * Set the client id, which is used to help gain an access token. * @param clientId Your app's client ID. */ setClientId(clientId: string): void; /** * Set the client secret * @param clientSecret Your app's client secret. */ setClientSecret(clientSecret: string): void; /** * Sets the refresh token * @param refreshToken - A refresh token */ setRefreshToken(refreshToken: string): void; /** * Gets the refresh token * @returns {String} Refresh token */ getRefreshToken(): string; /** * Sets the access token's expiration date * @param accessTokenExpiresAt - new expiration date */ setAccessTokenExpiresAt(accessTokenExpiresAt: Date): void; /** * Gets the access token's expiration date * @returns {Date} date of token expiration */ getAccessTokenExpiresAt(): Date; /** * Sets the code verifier for PKCE flow * @param {String} codeVerifier - new code verifier */ setCodeVerifier(codeVerifier: string): void; /** * Gets the code verifier for PKCE flow * @returns {String} - code verifier for PKCE */ getCodeVerifier(): string; /** * Checks if a token is needed, can be refreshed and if the token is expired. * If so, attempts to refresh access token * @returns {Promise} */ checkAndRefreshAccessToken(): Promise; /** * Refreshes the access token using the refresh token, if available * @arg {List} scope - a subset of scopes from the original * refresh to acquire with an access token * @returns {Promise} */ refreshAccessToken(scope?: Array): Promise; } export interface DropboxOptions { // Select user is only used for team functionality. It specifies which user the team access token should be acting as. selectUser?: string; // Select admin is only used by team functionality. It specifies which team admin the team access token should be acting as. selectAdmin?: string; // Root path to access other namespaces. Use to access team folders for example pathRoot?: string; // The DropboxAuth object used to authenticate requests. If this is set, the remaining parameters will be ignored. auth?: DropboxAuth | null; // An access token for making authenticated requests. accessToken?: string; // The time at which the access token expires. accessTokenExpiresAt?: Date; // A refresh token for retrieving access tokens refreshToken?: string; // The client id for your app. Used to create authentication URL. clientId?: string; // The client secret for your app. Used for refresh and token exchange. clientSecret?: string; // The fetch library for making requests. fetch?: Function; // A custom domain to use when making api requests. This should only be used for testing as scaffolding to avoid making network requests. domain?: string; // A custom delimiter to use when separating domain subdomain. This should only be used for testing as scaffolding. domainDelimiter?: string; // An object (in the form of header: value) designed to set custom headers to use during a request. customHeaders?: object; } export class DropboxResponseError { /** * The response class of HTTP errors from API calls using the Dropbox SDK. */ constructor(status: number, headers: any, error: T); /** * HTTP Status code of the call */ status: number; /** * Headers returned from the call. Set as any to support both node and browser. */ headers: any; /** * Serialized Error of the call */ error: T; } export class DropboxResponse { /** * The response class of all successful API calls using the Dropbox SDK. */ constructor(status: number, headers: any, result: T); /** * HTTP Status code of the call */ status: number; /** * Headers returned from the call. Set as any to support both node and browser. */ headers: any; /** * Serialized Result of the call */ result: T; } export class Dropbox { /** * The Dropbox SDK class that provides methods to read, write and * create files or folders in a user or team's Dropbox. */ constructor(); /** * The Dropbox SDK class that provides methods to read, write and * create files or folders in a user or team's Dropbox. */ constructor(options: DropboxOptions); /*ROUTES*/ /** * Deletes the current user's profile photo. * * Route attributes: * scope: account_info.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public accountDeleteProfilePhoto(arg: account.DeleteProfilePhotoArg, options?: DropboxRequestOptions): Promise>; /** * This lovely endpoint gets the account photo of a given user. * * Route attributes: * scope: account_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public accountGetPhoto(arg: account.AccountPhotoGetArg, options?: DropboxRequestOptions): Promise>>; /** * Sets a user's profile photo. * * Route attributes: * scope: account_info.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public accountSetProfilePhoto(arg: account.SetProfilePhotoArg, options?: DropboxRequestOptions): Promise>; /** * Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access * token. * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public authTokenFromOauth1(arg: auth.TokenFromOAuth1Arg, options?: DropboxRequestOptions): Promise>; /** * Disables the access token used to authenticate the call. If there is a * corresponding refresh token for the access token, this disables that * refresh token, as well as any other access tokens for that refresh token. * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public authTokenRevoke(options?: DropboxRequestOptions): Promise>; /** * This endpoint performs App Authentication, validating the supplied app * key and secret, and returns the supplied string, to allow you to test * your code and connection to the Dropbox API. It has no other effect. If * you receive an HTTP 200 response with the supplied query, it indicates at * least part of the Dropbox API infrastructure is working and that the app * key and secret valid. * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public checkApp(arg: check.EchoArg, options?: DropboxRequestOptions): Promise>; /** * This endpoint performs User Authentication, validating the supplied * access token, and returns the supplied string, to allow you to test your * code and connection to the Dropbox API. It has no other effect. If you * receive an HTTP 200 response with the supplied query, it indicates at * least part of the Dropbox API infrastructure is working and that the * access token is valid. * * Route attributes: * scope: account_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public checkUser(arg: check.EchoArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: contacts.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public contactsDeleteManualContacts(options?: DropboxRequestOptions): Promise>; /** * Removes manually added contacts from the given list. * * Route attributes: * scope: contacts.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public contactsDeleteManualContactsBatch(arg: contacts.DeleteManualContactsArg, options?: DropboxRequestOptions): Promise>; /** * Add property groups to a Dropbox file. See templatesAddForUser() or * templatesAddForTeam() to create new templates. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesPropertiesAdd(arg: file_properties.AddPropertiesArg, options?: DropboxRequestOptions): Promise>; /** * Overwrite property groups associated with a file. This endpoint should be * used instead of propertiesUpdate() 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 * propertiesUpdate() will only delete fields that are explicitly marked for * deletion. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesPropertiesOverwrite(arg: file_properties.OverwritePropertyGroupArg, options?: DropboxRequestOptions): Promise>; /** * Permanently removes the specified property group from the file. To remove * specific property field key value pairs, see propertiesUpdate(). To * update a template, see templatesUpdateForUser() or * templatesUpdateForTeam(). To remove a template, see * templatesRemoveForUser() or templatesRemoveForTeam(). * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesPropertiesRemove(arg: file_properties.RemovePropertiesArg, options?: DropboxRequestOptions): Promise>; /** * Search across property templates for particular property field values. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesPropertiesSearch(arg: file_properties.PropertiesSearchArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from propertiesSearch(), use this to * paginate through all search results. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesPropertiesSearchContinue(arg: file_properties.PropertiesSearchContinueArg, options?: DropboxRequestOptions): Promise>; /** * Add, update or remove properties associated with the supplied file and * templates. This endpoint should be used instead of propertiesOverwrite() * 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 propertiesOverwrite() will delete * any fields that are omitted from a property group. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesPropertiesUpdate(arg: file_properties.UpdatePropertiesArg, options?: DropboxRequestOptions): Promise>; /** * Add a template associated with a team. See propertiesAdd() to add * properties to a file or folder. Note: this endpoint will create * team-owned templates. * * Route attributes: * scope: files.team_metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesAddForTeam(arg: file_properties.AddTemplateArg, options?: DropboxRequestOptions): Promise>; /** * Add a template associated with a user. See propertiesAdd() to add * properties to a file. This endpoint can't be called on a team member or * admin's behalf. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesAddForUser(arg: file_properties.AddTemplateArg, options?: DropboxRequestOptions): Promise>; /** * Get the schema for a specified template. * * Route attributes: * scope: files.team_metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesGetForTeam(arg: file_properties.GetTemplateArg, options?: DropboxRequestOptions): Promise>; /** * Get the schema for a specified template. This endpoint can't be called on * a team member or admin's behalf. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesGetForUser(arg: file_properties.GetTemplateArg, options?: DropboxRequestOptions): Promise>; /** * Get the template identifiers for a team. To get the schema of each * template use templatesGetForTeam(). * * Route attributes: * scope: files.team_metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesListForTeam(options?: DropboxRequestOptions): Promise>; /** * Get the template identifiers for a team. To get the schema of each * template use templatesGetForUser(). This endpoint can't be called on a * team member or admin's behalf. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesListForUser(options?: DropboxRequestOptions): Promise>; /** * Permanently removes the specified template created from * templatesAddForUser(). All properties associated with the template will * also be removed. This action cannot be undone. * * Route attributes: * scope: files.team_metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesRemoveForTeam(arg: file_properties.RemoveTemplateArg, options?: DropboxRequestOptions): Promise>; /** * Permanently removes the specified template created from * templatesAddForUser(). All properties associated with the template will * also be removed. This action cannot be undone. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesRemoveForUser(arg: file_properties.RemoveTemplateArg, options?: DropboxRequestOptions): Promise>; /** * Update a template associated with a team. This route can update the * template name, the template description and add optional properties to * templates. * * Route attributes: * scope: files.team_metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesUpdateForTeam(arg: file_properties.UpdateTemplateArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filePropertiesTemplatesUpdateForUser(arg: file_properties.UpdateTemplateArg, options?: DropboxRequestOptions): Promise>; /** * Returns the total number of file requests owned by this user. Includes * both open and closed file requests. * * Route attributes: * scope: file_requests.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public fileRequestsCount(options?: DropboxRequestOptions): Promise>; /** * Creates a file request for this user. * * Route attributes: * scope: file_requests.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public fileRequestsCreate(arg: file_requests.CreateFileRequestArgs, options?: DropboxRequestOptions): Promise>; /** * Delete a batch of closed file requests. * * Route attributes: * scope: file_requests.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public fileRequestsDelete(arg: file_requests.DeleteFileRequestArgs, options?: DropboxRequestOptions): Promise>; /** * Delete all closed file requests owned by this user. * * Route attributes: * scope: file_requests.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public fileRequestsDeleteAllClosed(options?: DropboxRequestOptions): Promise>; /** * Returns the specified file request. * * Route attributes: * scope: file_requests.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public fileRequestsGet(arg: file_requests.GetFileRequestArgs, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: file_requests.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public fileRequestsList(options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: file_requests.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public fileRequestsListV2(arg: file_requests.ListFileRequestsArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from listV2(), use this to paginate * through all file requests. The cursor must come from a previous call to * listV2() or listContinue(). * * Route attributes: * scope: file_requests.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public fileRequestsListContinue(arg: file_requests.ListFileRequestsContinueArg, options?: DropboxRequestOptions): Promise>; /** * Update a file request. * * Route attributes: * scope: file_requests.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public fileRequestsUpdate(arg: file_requests.UpdateFileRequestArgs, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesAlphaGetMetadata(arg: files.AlphaGetMetadataArg, options?: DropboxRequestOptions): Promise>; /** * Create a new file with the contents provided in the request. Note that * the behavior of this alpha endpoint is unstable and subject to change. Do * not use this to upload a file larger than 150 MiB. Instead, create an * upload session with uploadSessionStart(). * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesAlphaUpload(arg: files.UploadArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCopy(arg: files.RelocationArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCopyV2(arg: files.RelocationArg, options?: DropboxRequestOptions): Promise>; /** * Copy multiple files or folders to different locations at once in the * user's Dropbox. This route will return job ID immediately and do the * async copy job in background. Please use copyBatchCheck() to check the * job status. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCopyBatch(arg: files.RelocationBatchArg, options?: DropboxRequestOptions): Promise>; /** * Copy multiple files or folders to different locations at once in the * user's Dropbox. This route will replace copyBatch(). The main difference * is this route will return status for each entry, while copyBatch() 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 * copyBatchCheckV2() to check the job status. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCopyBatchV2(arg: files.CopyBatchArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for copyBatch(). If success, it * returns list of results for each entry. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCopyBatchCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for copyBatchV2(). It returns * list of results for each entry. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCopyBatchCheckV2(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * 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 copyReferenceSave(). * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCopyReferenceGet(arg: files.GetCopyReferenceArg, options?: DropboxRequestOptions): Promise>; /** * Save a copy reference returned by copyReferenceGet() to the user's * Dropbox. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCopyReferenceSave(arg: files.SaveCopyReferenceArg, options?: DropboxRequestOptions): Promise>; /** * Create a folder at a given path. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCreateFolder(arg: files.CreateFolderArg, options?: DropboxRequestOptions): Promise>; /** * Create a folder at a given path. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCreateFolderV2(arg: files.CreateFolderArg, options?: DropboxRequestOptions): Promise>; /** * 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 * createFolderBatchCheck() to check the job status. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCreateFolderBatch(arg: files.CreateFolderBatchArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for createFolderBatch(). If * success, it returns list of result for each entry. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesCreateFolderBatchCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesDelete(arg: files.DeleteArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesDeleteV2(arg: files.DeleteArg, options?: DropboxRequestOptions): Promise>; /** * Delete multiple files/folders at once. This route is asynchronous, which * returns a job ID immediately and runs the delete batch asynchronously. * Use deleteBatchCheck() to check the job status. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesDeleteBatch(arg: files.DeleteBatchArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for deleteBatch(). If success, * it returns list of result for each entry. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesDeleteBatchCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Download a file from a user's Dropbox. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesDownload(arg: files.DownloadArg, options?: DropboxRequestOptions): Promise>>; /** * Download a folder from the user's Dropbox, as a zip file. The folder must * be less than 20 GB in size and any single file within must be less than 4 * GB in size. The resulting zip must have fewer than 10,000 total file and * folder entries, including the top level folder. The input cannot be a * single file. Note: this endpoint does not support HTTP range requests. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesDownloadZip(arg: files.DownloadZipArg, options?: DropboxRequestOptions): Promise>>; /** * Export a file from a user's Dropbox. This route only supports exporting * files that cannot be downloaded directly and whose * ExportResult.file_metadata has ExportInfo.export_as populated. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesExport(arg: files.ExportArg, options?: DropboxRequestOptions): Promise>>; /** * Return the lock metadata for the given list of paths. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesGetFileLockBatch(arg: files.LockFileBatchArg, options?: DropboxRequestOptions): Promise>; /** * Returns the metadata for a file or folder. Note: Metadata for the root * folder is unsupported. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesGetMetadata(arg: files.GetMetadataArg, options?: DropboxRequestOptions): Promise>; /** * Get a preview for a file. Currently, PDF previews are generated for files * with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, * .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf. HTML * previews are generated for .csv, .ods, .xls, .xlsm, .gsheet, .xlsx. Other * formats will return an unsupported extension error. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesGetPreview(arg: files.PreviewArg, options?: DropboxRequestOptions): Promise>>; /** * Get a temporary link to stream content of a file. This link will expire * in four hours and afterwards you will get 410 Gone. This URL should not * be used to display content directly in the browser. The Content-Type of * the link is determined automatically by the file's mime type. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesGetTemporaryLink(arg: files.GetTemporaryLinkArg, options?: DropboxRequestOptions): Promise>; /** * 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 getTemporaryUploadLink() but evaluated only upon * consumption. Hence, errors stemming from invalid CommitInfo with respect * to the state of the user's Dropbox will only be communicated at * consumption time. Additionally, these errors are surfaced as generic HTTP * 409 Conflict responses, potentially hiding issue details. The maximum * temporary upload link duration is 4 hours. Upon consumption or * expiration, a new link will have to be generated. Multiple links may * exist for a specific upload path at any given time. The POST request on * the temporary upload link must have its Content-Type set to * "application/octet-stream". Example temporary upload link consumption * request: curl -X POST * https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND --header * "Content-Type: application/octet-stream" --data-binary @local_file.txt A * successful temporary upload link consumption request returns the content * hash of the uploaded data in JSON format. Example successful 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesGetTemporaryUploadLink(arg: files.GetTemporaryUploadLinkArg, options?: DropboxRequestOptions): Promise>; /** * Get a thumbnail for an image. This method currently supports files with * the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm * and bmp. Photos that are larger than 20MB in size won't be converted to a * thumbnail. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesGetThumbnail(arg: files.ThumbnailArg, options?: DropboxRequestOptions): Promise>>; /** * Get a thumbnail for an image. This method currently supports files with * the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm * and bmp. Photos that are larger than 20MB in size won't be converted to a * thumbnail. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesGetThumbnailV2(arg: files.ThumbnailV2Arg, options?: DropboxRequestOptions): Promise>>; /** * 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, webp, ppm and bmp. * Photos that are larger than 20MB in size won't be converted to a * thumbnail. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesGetThumbnailBatch(arg: files.GetThumbnailBatchArg, options?: DropboxRequestOptions): Promise>; /** * Starts returning the contents of a folder. If the result's * ListFolderResult.has_more field is true, call listFolderContinue() 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 listFolder() or listFolderContinue() 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. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesListFolder(arg: files.ListFolderArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from listFolder(), use this to paginate * through all files and retrieve updates to the folder, following the same * rules as documented for listFolder(). * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesListFolderContinue(arg: files.ListFolderContinueArg, options?: DropboxRequestOptions): Promise>; /** * A way to quickly get a cursor for the folder's state. Unlike * listFolder(), listFolderGetLatestCursor() 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. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesListFolderGetLatestCursor(arg: files.ListFolderArg, options?: DropboxRequestOptions): Promise>; /** * A longpoll endpoint to wait for changes on an account. In conjunction * with listFolderContinue(), 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. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesListFolderLongpoll(arg: files.ListFolderLongpollArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesListRevisions(arg: files.ListRevisionsArg, options?: DropboxRequestOptions): Promise>; /** * Lock the files at the given paths. A locked file will be writable only by * the lock holder. A successful response indicates that the file has been * locked. Returns a list of the locked file paths and their metadata after * this operation. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesLockFileBatch(arg: files.LockFileBatchArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesMove(arg: files.RelocationArg, options?: DropboxRequestOptions): Promise>; /** * Move a file or folder to a different location in the user's Dropbox. If * the source path is a folder all its contents will be moved. Note that we * do not currently support case-only renaming. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesMoveV2(arg: files.RelocationArg, options?: DropboxRequestOptions): Promise>; /** * Move multiple files or folders to different locations at once in the * user's Dropbox. This route will return job ID immediately and do the * async moving job in background. Please use moveBatchCheck() to check the * job status. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesMoveBatch(arg: files.RelocationBatchArg, options?: DropboxRequestOptions): Promise>; /** * Move multiple files or folders to different locations at once in the * user's Dropbox. Note that we do not currently support case-only renaming. * This route will replace moveBatch(). The main difference is this route * will return status for each entry, while moveBatch() 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 * moveBatchCheckV2() to check the job status. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesMoveBatchV2(arg: files.MoveBatchArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for moveBatch(). If success, it * returns list of results for each entry. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesMoveBatchCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for moveBatchV2(). It returns * list of results for each entry. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesMoveBatchCheckV2(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Creates a new Paper doc with the provided content. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesPaperCreate(arg: files.PaperCreateArg, options?: DropboxRequestOptions): Promise>; /** * Updates an existing Paper doc with the provided content. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesPaperUpdate(arg: files.PaperUpdateArg, options?: DropboxRequestOptions): Promise>; /** * Permanently delete the file or folder at a given path (see * https://www.dropbox.com/en/help/40). If the given file or folder is not * yet deleted, this route will first delete it. It is possible for this * route to successfully delete, then fail to permanently delete. Note: This * endpoint is only available for Dropbox Business apps. * * Route attributes: * scope: files.permanent_delete * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesPermanentlyDelete(arg: files.DeleteArg, options?: DropboxRequestOptions): Promise>; /** * Add property groups to a Dropbox file. See templates/add_for_user or * templates/add_for_team to create new templates. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesPropertiesAdd(arg: file_properties.AddPropertiesArg, options?: DropboxRequestOptions): Promise>; /** * Overwrite property groups associated with a file. This endpoint should be * used instead of properties/update when property groups are being * overwritten rather than updated via a "delta". * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesPropertiesOverwrite(arg: file_properties.OverwritePropertyGroupArg, options?: DropboxRequestOptions): Promise>; /** * 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 * overwriting all properties of a file. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesPropertiesUpdate(arg: file_properties.UpdatePropertiesArg, options?: DropboxRequestOptions): Promise>; /** * Restore a specific revision of a file to the given path. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesRestore(arg: files.RestoreArg, options?: DropboxRequestOptions): Promise>; /** * Save the data from a specified URL into a file in user's Dropbox. Note * that the transfer from the URL must complete within 15 minutes, or the * operation will time out and the job will fail. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesSaveUrl(arg: files.SaveUrlArg, options?: DropboxRequestOptions): Promise>; /** * Check the status of a saveUrl() job. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesSaveUrlCheckJobStatus(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Searches for files and folders. Note: Recent changes will be reflected in * search results within a few seconds and older revisions of existing files * may still match your query for up to a few days. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesSearch(arg: files.SearchArg, options?: DropboxRequestOptions): Promise>; /** * Searches for files and folders. Note: searchV2() along with * searchContinueV2() can only be used to retrieve a maximum of 10,000 * matches. Recent changes may not immediately be reflected in search * results due to a short delay in indexing. Duplicate results may be * returned across pages. Some results may not be returned. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesSearchV2(arg: files.SearchV2Arg, options?: DropboxRequestOptions): Promise>; /** * Fetches the next page of search results returned from searchV2(). Note: * searchV2() along with searchContinueV2() can only be used to retrieve a * maximum of 10,000 matches. Recent changes may not immediately be * reflected in search results due to a short delay in indexing. Duplicate * results may be returned across pages. Some results may not be returned. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesSearchContinueV2(arg: files.SearchV2ContinueArg, options?: DropboxRequestOptions): Promise>; /** * Add a tag to an item. A tag is a string. The strings are automatically * converted to lowercase letters. No more than 20 tags can be added to a * given item. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesTagsAdd(arg: files.AddTagArg, options?: DropboxRequestOptions): Promise>; /** * Get list of tags assigned to items. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesTagsGet(arg: files.GetTagsArg, options?: DropboxRequestOptions): Promise>; /** * Remove a tag from an item. * * Route attributes: * scope: files.metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesTagsRemove(arg: files.RemoveTagArg, options?: DropboxRequestOptions): Promise>; /** * Unlock the files at the given paths. A locked file can only be unlocked * by the lock holder or, if a business account, a team admin. A successful * response indicates that the file has been unlocked. Returns a list of the * unlocked file paths and their metadata after this operation. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUnlockFileBatch(arg: files.UnlockFileBatchArg, options?: DropboxRequestOptions): Promise>; /** * Create a new file with the contents provided in the request. Do not use * this to upload a file larger than 150 MiB. Instead, create an upload * session with uploadSessionStart(). 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUpload(arg: files.UploadArg, options?: DropboxRequestOptions): Promise>; /** * Append more data to an upload session. A single request should not upload * more than 150 MiB. The maximum size of a file one can upload to an upload * session is 2^41 - 2^22 (2,199,019,061,248) bytes. 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUploadSessionAppend(arg: files.UploadSessionCursor, options?: DropboxRequestOptions): Promise>; /** * 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 MiB. The maximum size of a file one can upload to an upload * session is 2^41 - 2^22 (2,199,019,061,248) bytes. 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUploadSessionAppendV2(arg: files.UploadSessionAppendArg, options?: DropboxRequestOptions): Promise>; /** * Append more data to multiple upload sessions. Each piece of file content * to append to each upload session should be concatenated in the request * body, in the order delineated by UploadSessionAppendBatchArg.entries and * their individual lengths indicated by * UploadSessionAppendBatchArgEntry.length. A single request should not * upload more than 150 MiB. The maximum size of a file one can upload to an * upload session is 2^41 - 2^22 (2,199,019,061,248) bytes. 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUploadSessionAppendBatch(arg: files.UploadSessionAppendBatchArg, options?: DropboxRequestOptions): Promise>; /** * Finish an upload session and save the uploaded data to the given file * path. A single request should not upload more than 150 MiB. The maximum * size of a file one can upload to an upload session is 2^41 - 2^22 * (2,199,019,061,248) bytes. 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUploadSessionFinish(arg: files.UploadSessionFinishArg, options?: DropboxRequestOptions): Promise>; /** * This route helps you commit many files at once into a user's Dropbox. Use * uploadSessionStart() and uploadSessionAppendV2() to upload file contents. * We recommend uploading many files in parallel to increase throughput. * Once the file contents have been uploaded, rather than calling * uploadSessionFinish(), 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 * uploadSessionStart() or uploadSessionAppendV2() call. The maximum size of * a file one can upload to an upload session is 2^41 - 2^22 * (2,199,019,061,248) bytes. This route will return a job_id immediately * and do the async commit job in background. Use * uploadSessionFinishBatchCheck() to check the job status. For the same * account, this route should be executed serially. That means you should * not start the next job before current job finishes. We allow up to 1000 * entries in a single request. Calls to this endpoint will count as data * transport calls for any Dropbox Business teams with a limit on the number * of data transport calls allowed per month. For more information, see the * Data transport limit page * https://www.dropbox.com/developers/reference/data-transport-limit. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUploadSessionFinishBatch(arg: files.UploadSessionFinishBatchArg, options?: DropboxRequestOptions): Promise>; /** * This route helps you commit many files at once into a user's Dropbox. Use * uploadSessionStart() and uploadSessionAppendV2() to upload file contents. * We recommend uploading many files in parallel to increase throughput. * Once the file contents have been uploaded, rather than calling * uploadSessionFinish(), 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 * uploadSessionStart() or uploadSessionAppendV2() call of each upload * session. The maximum size of a file one can upload to an upload session * is 2^41 - 2^22 (2,199,019,061,248) bytes. We allow up to 1000 entries in * a single request. Calls to this endpoint will count as data transport * calls for any Dropbox Business teams with a limit on the number of data * transport calls allowed per month. For more information, see the Data * transport limit page * https://www.dropbox.com/developers/reference/data-transport-limit. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUploadSessionFinishBatchV2(arg: files.UploadSessionFinishBatchArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for uploadSessionFinishBatch(). * If success, it returns list of result for each entry. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUploadSessionFinishBatchCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * 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 MiB. * This call starts a new upload session with the given data. You can then * use uploadSessionAppendV2() or uploadSessionAppendBatch() to add more * data, then uploadSessionFinish() or uploadSessionFinishBatchV2() to save * all the data to a file in Dropbox. A single request should not upload * more than 150 MiB. The maximum size of a file one can upload to an upload * session is 2^41 - 2^22 (2,199,019,061,248) bytes. An upload session can * be used for a maximum of 7 days. Attempting to use a * UploadSessionStartResult.session_id with uploadSessionAppendV2() or other * upload session routes more than 7 days after its creation will return * 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. By * default, upload sessions require you to send content of the file in * sequential order via consecutive uploadSessionStart(), * uploadSessionAppendV2(), and uploadSessionFinish() calls (or their batch * variants). For better performance, you can optionally set * UploadSessionStartArg.session_type to UploadSessionType.concurrent to * start a concurrent upload session. Concurrent upload sessions may upload * file data in concurrent uploadSessionAppendV2() requests, with a few * caveats. After all of the requests are complete, finish the session with * uploadSessionFinish() as normal. You can not send data in a * uploadSessionStart() or uploadSessionFinish() call, only with * uploadSessionAppendV2() or uploadSessionAppendBatch(). Also, the length * of the uploaded data in a call to uploadSessionAppendV2() or * uploadSessionAppendBatch() must be a multiple of 2^22 (4,194,304) bytes, * except for the final append request with UploadSessionAppendArg.close or * UploadSessionAppendBatchArgEntry.close set to true that may contain any * remaining data. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUploadSessionStart(arg: files.UploadSessionStartArg, options?: DropboxRequestOptions): Promise>; /** * Start a batch of upload sessions. See uploadSessionStart(). 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. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public filesUploadSessionStartBatch(arg: files.UploadSessionStartBatchArg, options?: DropboxRequestOptions): Promise>; /** * This route is used for refreshing the info that is found in the id_token * during the OIDC flow. This route doesn't require any arguments and will * use the scopes approved for the given access token. * * Route attributes: * scope: openid * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public openidUserinfo(arg: openid.UserInfoArgs, options?: DropboxRequestOptions): Promise>; /** * Marks the given Paper doc as archived. This action can be performed or * undone by anyone with edit permissions to the doc. Note that this * endpoint will continue to work for content created by users on the older * version of Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. This endpoint will be * retired in September 2020. Refer to the [Paper Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for more information. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsArchive(arg: paper.RefPaperDoc, options?: DropboxRequestOptions): Promise>; /** * Creates a new Paper doc with the provided content. Note that this * endpoint will continue to work for content created by users on the older * version of Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. This endpoint will be * retired in September 2020. Refer to the [Paper Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for more information. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsCreate(arg: paper.PaperDocCreateArgs, options?: DropboxRequestOptions): Promise>; /** * Exports and downloads Paper doc either as HTML or markdown. Note that * this endpoint will continue to work for content created by users on the * older version of Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. Refer to the [Paper * Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsDownload(arg: paper.PaperDocExport, options?: DropboxRequestOptions): Promise>>; /** * 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. Note that this endpoint will * continue to work for content created by users on the older version of * Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. Refer to the [Paper * Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsFolderUsersList(arg: paper.ListUsersOnFolderArgs, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from docsFolderUsersList(), use this to * paginate through all users on the Paper folder. Note that this endpoint * will continue to work for content created by users on the older version * of Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. Refer to the [Paper * Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsFolderUsersListContinue(arg: paper.ListUsersOnFolderContinueArgs, options?: DropboxRequestOptions): Promise>; /** * 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. If the Paper doc is not in any folder (aka * unfiled) the response will be empty. Note that this endpoint will * continue to work for content created by users on the older version of * Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. Refer to the [Paper * Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsGetFolderInfo(arg: paper.RefPaperDoc, options?: DropboxRequestOptions): Promise>; /** * Returns metadata for a Paper doc or Cloud Doc. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsGetMetadata(arg: paper.GetDocMetadataArg, options?: DropboxRequestOptions): Promise>; /** * Return the list of all Paper docs according to the argument * specifications. To iterate over through the full pagination, pass the * cursor to docsListContinue(). Note that this endpoint will continue to * work for content created by users on the older version of Paper. To check * which version of Paper a user is on, use /users/features/get_values. If * the paper_as_files feature is enabled, then the user is running the new * version of Paper. Refer to the [Paper Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsList(arg: paper.ListPaperDocsArgs, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from docsList(), use this to paginate * through all Paper doc. Note that this endpoint will continue to work for * content created by users on the older version of Paper. To check which * version of Paper a user is on, use /users/features/get_values. If the * paper_as_files feature is enabled, then the user is running the new * version of Paper. Refer to the [Paper Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: files.metadata.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsListContinue(arg: paper.ListPaperDocsContinueArgs, options?: DropboxRequestOptions): Promise>; /** * Permanently deletes the given Paper doc. This operation is final as the * doc cannot be recovered. This action can be performed only by the doc * owner. Note that this endpoint will continue to work for content created * by users on the older version of Paper. To check which version of Paper a * user is on, use /users/features/get_values. If the paper_as_files feature * is enabled, then the user is running the new version of Paper. Refer to * the [Paper Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: files.permanent_delete * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsPermanentlyDelete(arg: paper.RefPaperDoc, options?: DropboxRequestOptions): Promise>; /** * Gets the default sharing policy for the given Paper doc. Note that this * endpoint will continue to work for content created by users on the older * version of Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. Refer to the [Paper * Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsSharingPolicyGet(arg: paper.RefPaperDoc, options?: DropboxRequestOptions): Promise>; /** * 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. The 'public_sharing_policy' policy can't be set to the * value 'disabled' because this setting can be changed only via the team * admin console. Note that this endpoint will continue to work for content * created by users on the older version of Paper. To check which version of * Paper a user is on, use /users/features/get_values. If the paper_as_files * feature is enabled, then the user is running the new version of Paper. * Refer to the [Paper Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsSharingPolicySet(arg: paper.PaperDocSharingPolicy, options?: DropboxRequestOptions): Promise>; /** * Updates an existing Paper doc with the provided content. Note that this * endpoint will continue to work for content created by users on the older * version of Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. This endpoint will be * retired in September 2020. Refer to the [Paper Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for more information. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsUpdate(arg: paper.PaperDocUpdateArgs, options?: DropboxRequestOptions): Promise>; /** * Allows an owner or editor to add users to a Paper doc or change their * permissions using their email address or Dropbox account ID. The doc * owner's permissions cannot be changed. Note that this endpoint will * continue to work for content created by users on the older version of * Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. Refer to the [Paper * Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsUsersAdd(arg: paper.AddPaperDocUser, options?: DropboxRequestOptions): Promise>>; /** * 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. Note that this endpoint will continue to work for content * created by users on the older version of Paper. To check which version of * Paper a user is on, use /users/features/get_values. If the paper_as_files * feature is enabled, then the user is running the new version of Paper. * Refer to the [Paper Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsUsersList(arg: paper.ListUsersOnPaperDocArgs, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from docsUsersList(), use this to * paginate through all users on the Paper doc. Note that this endpoint will * continue to work for content created by users on the older version of * Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. Refer to the [Paper * Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsUsersListContinue(arg: paper.ListUsersOnPaperDocContinueArgs, options?: DropboxRequestOptions): Promise>; /** * Allows an owner or editor to remove users from a Paper doc using their * email address or Dropbox account ID. The doc owner cannot be removed. * Note that this endpoint will continue to work for content created by * users on the older version of Paper. To check which version of Paper a * user is on, use /users/features/get_values. If the paper_as_files feature * is enabled, then the user is running the new version of Paper. Refer to * the [Paper Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperDocsUsersRemove(arg: paper.RemovePaperDocUser, options?: DropboxRequestOptions): Promise>; /** * Create a new Paper folder with the provided info. Note that this endpoint * will continue to work for content created by users on the older version * of Paper. To check which version of Paper a user is on, use * /users/features/get_values. If the paper_as_files feature is enabled, * then the user is running the new version of Paper. Refer to the [Paper * Migration Guide]{@link * https://www.dropbox.com/lp/developers/reference/paper-migration-guide} * for migration information. * * Route attributes: * scope: files.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public paperFoldersCreate(arg: paper.PaperFolderCreateArg, options?: DropboxRequestOptions): Promise>; /** * Asynchronous document-to-markdown conversion for supported file formats. * Supported formats: .binder, .docx, .html, .paper, .papert, .pptx, .xlsx, * .gsheet, .ods, .pdf. Unsupported formats return an * `unsupported_format_error`. Size limit: the source file must be at most * 50 MB. Larger files are rejected. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetMarkdownAsync(arg: riviera.GetMarkdownArgs, options?: DropboxRequestOptions): Promise>; /** * Returns the status or result of specified get_markdown_async task. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetMarkdownAsyncCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Asynchronous file metadata extraction for supported file formats. The * kind of metadata returned depends on the file type: - Image (EXIF) * formats: .3fr, .arw, .avif, .bmp, .cr2, .cr3, .crw, .dcr, .dcs, .dng, * .erf, .gif, .heic, .j2c, .j2k, .jp2, .jpc, .jpeg, .jpf, .jpg, .jpg2, * .jpm, .jpx, .kdc, .mef, .mos, .mrw, .nef, .nrw, .orf, .pef, .png, .ppm, * .r3d, .raf, .rw2, .rwl, .sr2, .tga, .tif, .tiff, .wbmp, .web, .webp, * .x3f. - Audio/video (media) formats: .aac, .aif, .aiff, .flac, .m4a, * .m4r, .mp3, .oga, .ogg, .wav, .wma, .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, * .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, * .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. - PDF format: .pdf. - MS * Office formats: .docx, .pptx, .xlsx. Unsupported formats return an * `unsupported_format_error`. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetMetadataAsync(arg: riviera.GetMetadataArgs, options?: DropboxRequestOptions): Promise>; /** * Returns the status or result of specified get_metadata_async task. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetMetadataAsyncCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Asynchronous OCR (optical character recognition) text extraction for * images and PDFs, including scanned / non-text PDFs. Supported formats: - * Image formats: .bmp, .gif, .heic, .jpeg, .jpg, .png, .tif, .tiff, .webp. * - PDF format: .pdf. Unsupported formats return an * `unsupported_format_error`. For the `url` variant only Dropbox shared * links are supported; external URLs return `unsupported_format_error`. * Text-based PDFs already carry a text layer, so OCR is not run against * them and the result is empty; use `get_text_async` to read the embedded * text layer of such a PDF. The result carries the extracted words as plain * text, plus the same content as hOCR with per-word coordinates. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetOcrAsync(arg: riviera.GetOcrArgs, options?: DropboxRequestOptions): Promise>; /** * Returns the status or result of specified get_ocr_async task. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetOcrAsyncCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Asynchronous plain-text extraction from documents. Supported formats * include: - Word processing: .doc, .docx, .docm, .rtf. - Presentations: * .ppt, .pptx, .pptm. - Spreadsheets: .xls, .xlsx, .xlsm. - PDF: .pdf. - * Dropbox document types: .paper, .papert, .binder, .gdoc, .gsheet, * .gslides. - Plain text / subtitles: .txt, .vtt. Unsupported formats * return an `unsupported_format_error`. For the `url` variant only Dropbox * shared links are supported; external URLs return * `unsupported_format_error`. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetTextAsync(arg: riviera.GetTextArgs, options?: DropboxRequestOptions): Promise>; /** * Returns the status or result of specified get_text_async task. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetTextAsyncCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Asynchronous transcript generation for audio and video files. Supported * audio formats: .aac, .aif, .aiff, .flac, .m4a, .m4r, .mp3, .oga, .ogg, * .wav, .wma. Supported video formats: .3gp, .3gpp, .3gpp2, .asf, .avi, * .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, * .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. Unsupported formats return * an `unsupported_format_error`. Size limits: the source file must be at * most 10 GB and its audio track at most 1 hour in duration. Files * exceeding these limits are rejected. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetTranscriptAsync(arg: riviera.GetTranscriptArgs, options?: DropboxRequestOptions): Promise>; /** * Returns the status or result of specified get_transcript_async task. * * Route attributes: * scope: files.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public rivieraGetTranscriptAsyncCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Adds specified members to a file. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingAddFileMember(arg: sharing.AddFileMemberArgs, options?: DropboxRequestOptions): Promise>>; /** * 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 mountFolder() on * their behalf. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingAddFolderMember(arg: sharing.AddFolderMemberArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingCheckJobStatus(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for sharing a folder. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingCheckRemoveMemberJobStatus(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for sharing a folder. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingCheckShareJobStatus(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Create a shared link. If a shared link already exists for the given path, * that link is returned. 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. DEPRECATED: Use create_shared_link_with_settings * instead. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingCreateSharedLink(arg: sharing.CreateSharedLinkArg, options?: DropboxRequestOptions): Promise>; /** * 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). * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingCreateSharedLinkWithSettings(arg: sharing.CreateSharedLinkWithSettingsArg, options?: DropboxRequestOptions): Promise>; /** * Returns shared file metadata. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingGetFileMetadata(arg: sharing.GetFileMetadataArg, options?: DropboxRequestOptions): Promise>; /** * Returns shared file metadata. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingGetFileMetadataBatch(arg: sharing.GetFileMetadataBatchArg, options?: DropboxRequestOptions): Promise>>; /** * Returns shared folder metadata by its folder ID. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingGetFolderMetadata(arg: sharing.GetMetadataArgs, options?: DropboxRequestOptions): Promise>; /** * Download the shared link's file from a user's Dropbox. This is a * download-style endpoint that returns the file content. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingGetSharedLinkFile(arg: sharing.GetSharedLinkFileArg, options?: DropboxRequestOptions): Promise>>; /** * Get the shared link's metadata. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingGetSharedLinkMetadata(arg: sharing.GetSharedLinkMetadataArg, options?: DropboxRequestOptions): Promise>; /** * DEPRECATED: Use list_shared_links instead. This endpoint will be retired * in October 2026. 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. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingGetSharedLinks(arg: sharing.GetSharedLinksArg, options?: DropboxRequestOptions): Promise>; /** * Use to obtain the members who have been invited to a file, both inherited * and uninherited members. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListFileMembers(arg: sharing.ListFileMembersArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListFileMembersBatch(arg: sharing.ListFileMembersBatchArg, options?: DropboxRequestOptions): Promise>>; /** * Once a cursor has been retrieved from listFileMembers() or * listFileMembersBatch(), use this to paginate through all shared file * members. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListFileMembersContinue(arg: sharing.ListFileMembersContinueArg, options?: DropboxRequestOptions): Promise>; /** * Returns shared folder membership by its folder ID. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListFolderMembers(arg: sharing.ListFolderMembersArgs, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from listFolderMembers(), use this to * paginate through all shared folder members. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListFolderMembersContinue(arg: sharing.ListFolderMembersContinueArg, options?: DropboxRequestOptions): Promise>; /** * Return the list of all shared folders the current user has access to. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListFolders(arg: sharing.ListFoldersArgs, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from listFolders(), use this to paginate * through all shared folders. The cursor must come from a previous call to * listFolders() or listFoldersContinue(). * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListFoldersContinue(arg: sharing.ListFoldersContinueArg, options?: DropboxRequestOptions): Promise>; /** * Return the list of all shared folders the current user can mount or * unmount. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListMountableFolders(arg: sharing.ListFoldersArgs, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from listMountableFolders(), use this to * paginate through all mountable shared folders. The cursor must come from * a previous call to listMountableFolders() or * listMountableFoldersContinue(). * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListMountableFoldersContinue(arg: sharing.ListFoldersContinueArg, options?: DropboxRequestOptions): Promise>; /** * Returns a list of all files shared with current user. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListReceivedFiles(arg: sharing.ListFilesArg, options?: DropboxRequestOptions): Promise>; /** * Get more results with a cursor from listReceivedFiles(). * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListReceivedFilesContinue(arg: sharing.ListFilesContinueArg, options?: DropboxRequestOptions): Promise>; /** * List shared links of this user. If no path is given, returns a list of * all shared links for the current user. For members of business teams * using team space and member folders, returns all shared links in the team * member's home folder unless the team space ID is specified in the request * header. 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. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingListSharedLinks(arg: sharing.ListSharedLinksArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingModifySharedLinkSettings(arg: sharing.ModifySharedLinkSettingsArgs, options?: DropboxRequestOptions): Promise>; /** * The current user mounts the designated folder. Mount a shared folder for * a user after they have been added as a member. Once mounted, the shared * folder will appear in their Dropbox. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingMountFolder(arg: sharing.MountFolderArg, options?: DropboxRequestOptions): Promise>; /** * Removes all self-removable access from a file or folder for the current * user. Best-effort and idempotent: attempts to drop link-visitor * associations and explicit ACL membership. * * Route attributes: * scope: private:sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingRelinquishAccess(arg: sharing.RelinquishAccessArg, options?: DropboxRequestOptions): Promise>; /** * The current user relinquishes their membership in the designated file. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingRelinquishFileMembership(arg: sharing.RelinquishFileMembershipArg, options?: DropboxRequestOptions): Promise>; /** * The current user relinquishes their membership in the designated shared * folder and will no longer have access to the folder. A folder owner * cannot relinquish membership in their own folder. This will run * synchronously if leave_a_copy is false, and asynchronously if * leave_a_copy is true. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingRelinquishFolderMembership(arg: sharing.RelinquishFolderMembershipArg, options?: DropboxRequestOptions): Promise>; /** * Identical to remove_file_member_2 but with less information returned. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingRemoveFileMember(arg: sharing.RemoveFileMemberArg, options?: DropboxRequestOptions): Promise>; /** * Removes a specified member from the file. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingRemoveFileMember2(arg: sharing.RemoveFileMemberArg, options?: DropboxRequestOptions): Promise>; /** * Allows an owner or editor (if the ACL update policy allows) of a shared * folder to remove another member. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingRemoveFolderMember(arg: sharing.RemoveFolderMemberArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingRevokeSharedLink(arg: sharing.RevokeSharedLinkArg, options?: DropboxRequestOptions): Promise>; /** * 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 * checkShareJobStatus() until the action completes to get the metadata for * the folder. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingSetAccessInheritance(arg: sharing.SetAccessInheritanceArg, options?: DropboxRequestOptions): Promise>; /** * 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 * checkShareJobStatus() until the action completes to get the metadata for * the folder. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingShareFolder(arg: sharing.ShareFolderArg, options?: DropboxRequestOptions): Promise>; /** * Transfer ownership of a shared folder to a member of the shared folder. * User must have AccessLevel.owner access to the shared folder to perform a * transfer. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingTransferFolder(arg: sharing.TransferFolderArg, options?: DropboxRequestOptions): Promise>; /** * The current user unmounts the designated folder. They can re-mount the * folder at a later time using mountFolder(). * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingUnmountFolder(arg: sharing.UnmountFolderArg, options?: DropboxRequestOptions): Promise>; /** * Remove all members from this file. Does not remove inherited members. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingUnshareFile(arg: sharing.UnshareFileArg, options?: DropboxRequestOptions): Promise>; /** * Allows a shared folder owner to unshare the folder. Unshare will not work * in following cases: The shared folder contains shared folders OR the * shared folder is inside another shared folder. You'll need to call * checkJobStatus() to determine if the action has completed successfully. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingUnshareFolder(arg: sharing.UnshareFolderArg, options?: DropboxRequestOptions): Promise>; /** * Changes a member's access on a shared file. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingUpdateFileMember(arg: sharing.UpdateFileMemberArgs, options?: DropboxRequestOptions): Promise>; /** * Update the viewer info policy of a file. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingUpdateFilePolicy(arg: sharing.UpdateFilePolicyArg, options?: DropboxRequestOptions): Promise>; /** * Allows an owner or editor of a shared folder to update another member's * permissions. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingUpdateFolderMember(arg: sharing.UpdateFolderMemberArg, options?: DropboxRequestOptions): Promise>; /** * Update the sharing policies for a shared folder. User must have * AccessLevel.owner access to the shared folder to update its policies. * * Route attributes: * scope: sharing.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public sharingUpdateFolderPolicy(arg: sharing.UpdateFolderPolicyArg, options?: DropboxRequestOptions): Promise>; /** * List all device sessions of a team's member. * * Route attributes: * scope: sessions.list * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamDevicesListMemberDevices(arg: team.ListMemberDevicesArg, options?: DropboxRequestOptions): Promise>; /** * List all device sessions of a team. Permission : Team member file access. * * Route attributes: * scope: sessions.list * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamDevicesListMembersDevices(arg: team.ListMembersDevicesArg, options?: DropboxRequestOptions): Promise>; /** * List all device sessions of a team. Permission : Team member file access. * * Route attributes: * scope: sessions.list * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamDevicesListTeamDevices(arg: team.ListTeamDevicesArg, options?: DropboxRequestOptions): Promise>; /** * Revoke a device session of a team's member. * * Route attributes: * scope: sessions.modify * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamDevicesRevokeDeviceSession(arg: team.RevokeDeviceSessionArg, options?: DropboxRequestOptions): Promise>; /** * Revoke a list of device sessions of team members. * * Route attributes: * scope: sessions.modify * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamDevicesRevokeDeviceSessionBatch(arg: team.RevokeDeviceSessionBatchArg, options?: DropboxRequestOptions): Promise>; /** * Get the values for one or more features. 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. * * Route attributes: * scope: team_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamFeaturesGetValues(arg: team.FeaturesGetValuesBatchArg, options?: DropboxRequestOptions): Promise>; /** * Retrieves information about a team. * * Route attributes: * scope: team_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public teamGetInfo(options?: DropboxRequestOptions): Promise>; /** * Creates a new, empty group, with a requested name. Permission : Team * member management. * * Route attributes: * scope: groups.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsCreate(arg: team.GroupCreateArg, options?: DropboxRequestOptions): Promise>; /** * Deletes a group. The group is deleted immediately. However the revoking * of group-owned resources may take additional time. Use the * groupsJobStatusGet() to determine whether this process has completed. * Permission : Team member management. * * Route attributes: * scope: groups.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsDelete(arg: team.GroupSelector, options?: DropboxRequestOptions): Promise>; /** * Retrieves information about one or more groups. Note that the optional * field GroupFullInfo.members is not returned for system-managed groups. * Permission : Team Information. * * Route attributes: * scope: groups.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsGetInfo(arg: team.GroupsSelector, options?: DropboxRequestOptions): Promise>; /** * Once an async_job_id is returned from groupsDelete(), groupsMembersAdd() * , or groupsMembersRemove() use this method to poll the status of * granting/revoking group members' access to group-owned resources. * Permission : Team member management. * * Route attributes: * scope: groups.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsJobStatusGet(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Lists groups on a team. Permission : Team Information. * * Route attributes: * scope: groups.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsList(arg: team.GroupsListArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from groupsList(), use this to paginate * through all groups. Permission : Team Information. * * Route attributes: * scope: groups.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsListContinue(arg: team.GroupsListContinueArg, options?: DropboxRequestOptions): Promise>; /** * Adds members to a group. The members are added immediately. However the * granting of group-owned resources may take additional time. Use the * groupsJobStatusGet() to determine whether this process has completed. * Permission : Team member management. * * Route attributes: * scope: groups.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsMembersAdd(arg: team.GroupMembersAddArg, options?: DropboxRequestOptions): Promise>; /** * Lists members of a group. Permission : Team Information. * * Route attributes: * scope: groups.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsMembersList(arg: team.GroupsMembersListArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from groupsMembersList(), use this to * paginate through all members of the group. Permission : Team information. * * Route attributes: * scope: groups.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsMembersListContinue(arg: team.GroupsMembersListContinueArg, options?: DropboxRequestOptions): Promise>; /** * Removes members from a group. The members are removed immediately. * However the revoking of group-owned resources may take additional time. * Use the groupsJobStatusGet() 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. * * Route attributes: * scope: groups.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsMembersRemove(arg: team.GroupMembersRemoveArg, options?: DropboxRequestOptions): Promise>; /** * Sets a member's access type in a group. Permission : Team member * management. * * Route attributes: * scope: groups.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsMembersSetAccessType(arg: team.GroupMembersSetAccessTypeArg, options?: DropboxRequestOptions): Promise>; /** * Updates a group's name and/or external ID. Permission : Team member * management. * * Route attributes: * scope: groups.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamGroupsUpdate(arg: team.GroupUpdateArgs, options?: DropboxRequestOptions): Promise>; /** * Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not * all teams have the feature. Permission : Team member file access. * * Route attributes: * scope: team_data.governance.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLegalHoldsCreatePolicy(arg: team.LegalHoldsPolicyCreateArg, options?: DropboxRequestOptions): Promise>; /** * Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all * teams have the feature. Permission : Team member file access. * * Route attributes: * scope: team_data.governance.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLegalHoldsGetPolicy(arg: team.LegalHoldsGetPolicyArg, options?: DropboxRequestOptions): Promise>; /** * List the file metadata that's under the hold. Note: Legal Holds is a paid * add-on. Not all teams have the feature. Permission : Team member file * access. * * Route attributes: * scope: team_data.governance.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLegalHoldsListHeldRevisions(arg: team.LegalHoldsListHeldRevisionsArg, options?: DropboxRequestOptions): Promise>; /** * Continue listing the file metadata that's under the hold. Note: Legal * Holds is a paid add-on. Not all teams have the feature. Permission : Team * member file access. * * Route attributes: * scope: team_data.governance.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLegalHoldsListHeldRevisionsContinue(arg: team.LegalHoldsListHeldRevisionsContinueArg, options?: DropboxRequestOptions): Promise>; /** * Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all * teams have the feature. Permission : Team member file access. * * Route attributes: * scope: team_data.governance.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLegalHoldsListPolicies(arg: team.LegalHoldsListPoliciesArg, options?: DropboxRequestOptions): Promise>; /** * Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all * teams have the feature. Permission : Team member file access. * * Route attributes: * scope: team_data.governance.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLegalHoldsReleasePolicy(arg: team.LegalHoldsPolicyReleaseArg, options?: DropboxRequestOptions): Promise>; /** * Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams * have the feature. Permission : Team member file access. * * Route attributes: * scope: team_data.governance.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLegalHoldsUpdatePolicy(arg: team.LegalHoldsPolicyUpdateArg, options?: DropboxRequestOptions): Promise>; /** * List all linked applications of the team member. Note, this endpoint does * not list any team-linked applications. * * Route attributes: * scope: sessions.list * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLinkedAppsListMemberLinkedApps(arg: team.ListMemberAppsArg, options?: DropboxRequestOptions): Promise>; /** * List all applications linked to the team members' accounts. Note, this * endpoint does not list any team-linked applications. * * Route attributes: * scope: sessions.list * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLinkedAppsListMembersLinkedApps(arg: team.ListMembersAppsArg, options?: DropboxRequestOptions): Promise>; /** * List all applications linked to the team members' accounts. Note, this * endpoint doesn't list any team-linked applications. * * Route attributes: * scope: sessions.list * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLinkedAppsListTeamLinkedApps(arg: team.ListTeamAppsArg, options?: DropboxRequestOptions): Promise>; /** * Revoke a linked application of the team member. * * Route attributes: * scope: sessions.modify * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLinkedAppsRevokeLinkedApp(arg: team.RevokeLinkedApiAppArg, options?: DropboxRequestOptions): Promise>; /** * Revoke a list of linked applications of the team members. * * Route attributes: * scope: sessions.modify * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLinkedAppsRevokeLinkedAppBatch(arg: team.RevokeLinkedApiAppBatchArg, options?: DropboxRequestOptions): Promise>; /** * Add users to member space limits excluded users list. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMemberSpaceLimitsExcludedUsersAdd(arg: team.ExcludedUsersUpdateArg, options?: DropboxRequestOptions): Promise>; /** * List member space limits excluded users. * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMemberSpaceLimitsExcludedUsersList(arg: team.ExcludedUsersListArg, options?: DropboxRequestOptions): Promise>; /** * Continue listing member space limits excluded users. * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMemberSpaceLimitsExcludedUsersListContinue(arg: team.ExcludedUsersListContinueArg, options?: DropboxRequestOptions): Promise>; /** * Remove users from member space limits excluded users list. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMemberSpaceLimitsExcludedUsersRemove(arg: team.ExcludedUsersUpdateArg, options?: DropboxRequestOptions): Promise>; /** * Get users custom quota. A maximum of 1000 members can be specified in a * single call. Note: to apply a custom space limit, a team admin needs to * set a member space limit for the team first. (the team admin can check * the settings here: https://www.dropbox.com/team/admin/settings/space). * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMemberSpaceLimitsGetCustomQuota(arg: team.CustomQuotaUsersArg, options?: DropboxRequestOptions): Promise>>; /** * Remove users custom quota. A maximum of 1000 members can be specified in * a single call. Note: to apply a custom space limit, a team admin needs to * set a member space limit for the team first. (the team admin can check * the settings here: https://www.dropbox.com/team/admin/settings/space). * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMemberSpaceLimitsRemoveCustomQuota(arg: team.CustomQuotaUsersArg, options?: DropboxRequestOptions): Promise>>; /** * Set users custom quota. Custom quota has to be at least 2GB. A maximum of * 1000 members can be specified in a single call. Note: to apply a custom * space limit, a team admin needs to set a member space limit for the team * first. (the team admin can check the settings here: * https://www.dropbox.com/team/admin/settings/space). * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMemberSpaceLimitsSetCustomQuota(arg: team.SetCustomQuotaArg, options?: DropboxRequestOptions): Promise>>; /** * 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'. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersAdd(arg: team.MembersAddArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersAddV2(arg: team.MembersAddV2Arg, options?: DropboxRequestOptions): Promise>; /** * Once an async_job_id is returned from membersAdd() , use this to poll the * status of the asynchronous request. Permission : Team member management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersAddJobStatusGet(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Once an async_job_id is returned from membersAddV2() , use this to poll * the status of the asynchronous request. Permission : Team member * management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersAddJobStatusGetV2(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Launch a bulk suspend job. The server enforces a maximum of 500 members. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersBulkSuspend(arg: team.BulkSuspendArg, options?: DropboxRequestOptions): Promise>; /** * Poll a previously launched bulk suspend job. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersBulkSuspendJobStatusCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Permanently delete the files of a user who has been removed from the * team. After permanent deletion, those files will not be available to be * transferred to another team member. Permission : Team member management * Exactly one of team_member_id, email, or external_id must be provided to * identify the user account. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersDeleteFormerMemberFiles(arg: team.MembersFormerMemberArg, options?: DropboxRequestOptions): Promise>; /** * Deletes a team member's profile photo. Permission : Team member * management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersDeleteProfilePhoto(arg: team.MembersDeleteProfilePhotoArg, options?: DropboxRequestOptions): Promise>; /** * Deletes a team member's profile photo. Permission : Team member * management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersDeleteProfilePhotoV2(arg: team.MembersDeleteProfilePhotoArg, options?: DropboxRequestOptions): Promise>; /** * Get available TeamMemberRoles for the connected team. To be used with * membersSetAdminPermissionsV2(). Permission : Team member management. * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public teamMembersGetAvailableTeamMemberRoles(options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersGetInfo(arg: team.MembersGetInfoArgs, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersGetInfoV2(arg: team.MembersGetInfoV2Arg, options?: DropboxRequestOptions): Promise>; /** * Lists members of a team. Permission : Team information. * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersList(arg: team.MembersListArg, options?: DropboxRequestOptions): Promise>; /** * Lists members of a team. Permission : Team information. * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersListV2(arg: team.MembersListArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from membersList(), use this to paginate * through all team members. Permission : Team information. * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersListContinue(arg: team.MembersListContinueArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from membersListV2(), use this to * paginate through all team members. Permission : Team information. * * Route attributes: * scope: members.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersListContinueV2(arg: team.MembersListContinueArg, options?: DropboxRequestOptions): Promise>; /** * 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 * membersMoveFormerMemberFilesJobStatusCheck(). Permission : Team member * management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersMoveFormerMemberFiles(arg: team.MembersDataTransferArg, options?: DropboxRequestOptions): Promise>; /** * Once an async_job_id is returned from membersMoveFormerMemberFiles() , * use this to poll the status of the asynchronous request. Permission : * Team member management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersMoveFormerMemberFilesJobStatusCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: members.delete * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersRecover(arg: team.MembersRecoverArg, options?: DropboxRequestOptions): Promise>; /** * 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 membersRecover() for a 7 * day period or until the account has been permanently deleted or * transferred to another account (whichever comes first). Calling * membersAdd() while a user is still recoverable on your team will return * with MemberAddResult.user_already_on_team. Accounts can have their files * transferred via the admin console for a limited time, based on the * version history length associated with the team (180 days for most * teams). Accounts can have their stacks transferred through the admin * console. This only transfers stacks that they have created. This endpoint * may initiate an asynchronous job. To obtain the final result of the job, * the client should periodically poll membersRemoveJobStatusGet(). * * Route attributes: * scope: members.delete * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersRemove(arg: team.MembersRemoveArg, options?: DropboxRequestOptions): Promise>; /** * Once an async_job_id is returned from membersRemove() , use this to poll * the status of the asynchronous request. Permission : Team member * management. * * Route attributes: * scope: members.delete * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersRemoveJobStatusGet(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Add secondary emails to users. Permission : Team member management. * Emails that are on verified domains will be verified automatically. For * each email address not on a verified domain a verification email will be * sent. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSecondaryEmailsAdd(arg: team.AddSecondaryEmailsArg, options?: DropboxRequestOptions): Promise>; /** * Delete secondary emails from users Permission : Team member management. * Users will be notified of deletions of verified secondary emails at both * the secondary email and their primary email. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSecondaryEmailsDelete(arg: team.DeleteSecondaryEmailsArg, options?: DropboxRequestOptions): Promise>; /** * Resend secondary email verification emails. Permission : Team member * management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSecondaryEmailsResendVerificationEmails(arg: team.ResendVerificationEmailArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSendWelcomeEmail(arg: team.UserSelectorArg, options?: DropboxRequestOptions): Promise>; /** * Updates a team member's permissions. Permission : Team member management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSetAdminPermissions(arg: team.MembersSetPermissionsArg, options?: DropboxRequestOptions): Promise>; /** * Updates a team member's permissions. Permission : Team member management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSetAdminPermissionsV2(arg: team.MembersSetPermissions2Arg, options?: DropboxRequestOptions): Promise>; /** * Updates a team member's profile. Permission : Team member management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSetProfile(arg: team.MembersSetProfileArg, options?: DropboxRequestOptions): Promise>; /** * Updates a team member's profile. Permission : Team member management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSetProfileV2(arg: team.MembersSetProfileArg, options?: DropboxRequestOptions): Promise>; /** * Updates a team member's profile photo. Permission : Team member * management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSetProfilePhoto(arg: team.MembersSetProfilePhotoArg, options?: DropboxRequestOptions): Promise>; /** * Updates a team member's profile photo. Permission : Team member * management. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSetProfilePhotoV2(arg: team.MembersSetProfilePhotoArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersSuspend(arg: team.MembersDeactivateArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: members.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamMembersUnsuspend(arg: team.MembersUnsuspendArg, options?: DropboxRequestOptions): Promise>; /** * 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. * * Route attributes: * scope: team_data.member * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamNamespacesList(arg: team.TeamNamespacesListArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from namespacesList(), use this to * paginate through all team-accessible namespaces. Duplicates may occur in * the list. * * Route attributes: * scope: team_data.member * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamNamespacesListContinue(arg: team.TeamNamespacesListContinueArg, options?: DropboxRequestOptions): Promise>; /** * Permission : Team member file access. * * Route attributes: * scope: files.team_metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamPropertiesTemplateAdd(arg: file_properties.AddTemplateArg, options?: DropboxRequestOptions): Promise>; /** * Permission : Team member file access. The scope for the route is * files.team_metadata.write. * * Route attributes: * scope: files.team_metadata.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamPropertiesTemplateGet(arg: file_properties.GetTemplateArg, options?: DropboxRequestOptions): Promise>; /** * Retrieves reporting data about a team's user activity. Deprecated: Will * be removed on July 1st 2021. * * Route attributes: * scope: team_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamReportsGetActivity(arg: team.DateRange, options?: DropboxRequestOptions): Promise>; /** * Retrieves reporting data about a team's linked devices. Deprecated: Will * be removed on July 1st 2021. * * Route attributes: * scope: team_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamReportsGetDevices(arg: team.DateRange, options?: DropboxRequestOptions): Promise>; /** * Retrieves reporting data about a team's membership. Deprecated: Will be * removed on July 1st 2021. * * Route attributes: * scope: team_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamReportsGetMembership(arg: team.DateRange, options?: DropboxRequestOptions): Promise>; /** * Retrieves reporting data about a team's storage usage. Deprecated: Will * be removed on July 1st 2021. * * Route attributes: * scope: team_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @deprecated * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamReportsGetStorage(arg: team.DateRange, options?: DropboxRequestOptions): Promise>; /** * Endpoint adds Approve List entries. Changes are effective immediately. * Changes are committed in transaction. In case of single validation error * - all entries are rejected. Valid domains (RFC-1034/5) and emails * (RFC-5322/822) are accepted. Added entries cannot overflow limit of 10000 * entries per team. Maximum 100 entries per call is allowed. * * Route attributes: * scope: team_info.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamSharingAllowlistAdd(arg: team.SharingAllowlistAddArgs, options?: DropboxRequestOptions): Promise>; /** * Lists Approve List entries for given team, from newest to oldest, * returning up to `limit` entries at a time. If there are more than `limit` * entries associated with the current team, more can be fetched by passing * the returned `cursor` to sharingAllowlistListContinue(). * * Route attributes: * scope: team_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamSharingAllowlistList(arg: team.SharingAllowlistListArg, options?: DropboxRequestOptions): Promise>; /** * Lists entries associated with given team, starting from a the cursor. See * sharingAllowlistList(). * * Route attributes: * scope: team_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamSharingAllowlistListContinue(arg: team.SharingAllowlistListContinueArg, options?: DropboxRequestOptions): Promise>; /** * Endpoint removes Approve List entries. Changes are effective immediately. * Changes are committed in transaction. In case of single validation error * - all entries are rejected. Valid domains (RFC-1034/5) and emails * (RFC-5322/822) are accepted. Entries being removed have to be present on * the list. Maximum 1000 entries per call is allowed. * * Route attributes: * scope: team_info.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamSharingAllowlistRemove(arg: team.SharingAllowlistRemoveArgs, options?: DropboxRequestOptions): Promise>; /** * Sets an archived team folder's status to active. Permission : Team member * file access. * * Route attributes: * scope: team_data.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderActivate(arg: team.TeamFolderIdArg, options?: DropboxRequestOptions): Promise>; /** * Sets an active team folder's status to archived and removes all folder * and file members. This endpoint cannot be used for teams that have a * shared team space. This route will either finish synchronously, or return * a job ID and do the async archive job in background. Please use * team_folder/archive/check to check the job status. Permission : Team * member file access. * * Route attributes: * scope: team_data.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderArchive(arg: team.TeamFolderArchiveArg, options?: DropboxRequestOptions): Promise>; /** * Returns the status of an asynchronous job for archiving a team folder. * The job may show '.tag' as complete, but the team folder could still be * in the process of archiving (indicated by TeamFolderMetadata.status with * 'archive_in_progress'). To confirm that the team folder is fully * archived, check the field TeamFolderMetadata.status in the response for * the value 'archived'. Permission : Team member file access. * * Route attributes: * scope: team_data.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderArchiveCheck(arg: async.PollArg, options?: DropboxRequestOptions): Promise>; /** * Creates a new, active, team folder with no members. This endpoint can * only be used for teams that do not already have a shared team space. * Permission : Team member file access. * * Route attributes: * scope: team_data.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderCreate(arg: team.TeamFolderCreateArg, options?: DropboxRequestOptions): Promise>; /** * Retrieves metadata for team folders. Permission : Team member file * access. * * Route attributes: * scope: team_data.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderGetInfo(arg: team.TeamFolderIdListArg, options?: DropboxRequestOptions): Promise>>; /** * Lists all team folders. Permission : Team member file access. * * Route attributes: * scope: team_data.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderList(arg: team.TeamFolderListArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from teamFolderList(), use this to * paginate through all team folders. Permission : Team member file access. * * Route attributes: * scope: team_data.content.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderListContinue(arg: team.TeamFolderListContinueArg, options?: DropboxRequestOptions): Promise>; /** * Permanently deletes an archived team folder. This endpoint cannot be used * for teams that have a shared team space. Permission : Team member file * access. * * Route attributes: * scope: team_data.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderPermanentlyDelete(arg: team.TeamFolderIdArg, options?: DropboxRequestOptions): Promise>; /** * Changes an active team folder's name. Permission : Team member file * access. * * Route attributes: * scope: team_data.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderRename(arg: team.TeamFolderRenameArg, options?: DropboxRequestOptions): Promise>; /** * Sets an inactive team folder's status to active. Permission: Team member * file access. * * Route attributes: * scope: team_data.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderRestore(arg: team.TeamFolderIdArg, options?: DropboxRequestOptions): Promise>; /** * Updates the sync settings on a team folder or its contents. Use of this * endpoint requires that the team has team selective sync enabled. * * Route attributes: * scope: team_data.content.write * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamTeamFolderUpdateSyncSettings(arg: team.TeamFolderUpdateSyncSettingsArg, options?: DropboxRequestOptions): Promise>; /** * Returns the member profile of the admin who generated the team access * token used to make the call. * * Route attributes: * scope: team_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public teamTokenGetAuthenticatedAdmin(options?: DropboxRequestOptions): Promise>; /** * Retrieves team events. If the result's GetTeamEventsResult.has_more field * is true, call getEventsContinue() with the returned cursor to retrieve * more entries. If end_time is not specified in your request, you may use * the returned cursor to poll getEventsContinue() for new events. Many * attributes note 'may be missing due to historical data gap'. Note that * the file_operations category and & analogous paper events are not * available on all Dropbox Business [plans]{@link * /business/plans-comparison}. Use [features/get_values]{@link * /developers/documentation/http/teams#team-features-get_values} to check * for this feature. Permission : Team Auditing. * * Route attributes: * scope: events.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLogGetEvents(arg: team_log.GetTeamEventsArg, options?: DropboxRequestOptions): Promise>; /** * Once a cursor has been retrieved from getEvents(), use this to paginate * through all events. Permission : Team Auditing. * * Route attributes: * scope: events.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public teamLogGetEventsContinue(arg: team_log.GetTeamEventsContinueArg, options?: DropboxRequestOptions): Promise>; /** * Get a list of feature values that may be configured for the current * account. * * Route attributes: * scope: account_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public usersFeaturesGetValues(arg: users.UserFeaturesGetValuesBatchArg, options?: DropboxRequestOptions): Promise>; /** * Get information about a user's account. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public usersGetAccount(arg: users.GetAccountArg, options?: DropboxRequestOptions): Promise>; /** * Get information about multiple user accounts. At most 300 accounts may be * queried per request. * * Route attributes: * scope: sharing.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param arg The request parameters. * @param options Optional transport settings for this request. */ public usersGetAccountBatch(arg: users.GetAccountBatchArg, options?: DropboxRequestOptions): Promise>; /** * Get information about the current user's account. * * Route attributes: * scope: account_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public usersGetCurrentAccount(options?: DropboxRequestOptions): Promise>; /** * Get the space usage information for the current user's account. * * Route attributes: * scope: account_info.read * * When an error occurs, the route rejects the promise with type * DropboxResponseError. * @param options Optional transport settings for this request. */ public usersGetSpaceUsage(options?: DropboxRequestOptions): Promise>; }