`dropbox.file_requests` – File Requests¶

This namespace contains endpoints and data types for file request operations.

class dropbox.file_requests.CountFileRequestsError(tag, value=None)¶

Bases: dropbox.file_requests.GeneralFileRequestsError

There was an error counting the file requests.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

class dropbox.file_requests.CountFileRequestsResult(file_request_count=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Result for dropbox.dropbox_client.Dropbox.file_requests_count().

Variables:	file_requests.CountFileRequestsResult.file_request_count – The number file requests owner by this user.

__init__(file_request_count=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

file_request_count¶

class dropbox.file_requests.CreateFileRequestArgs(title=None, destination=None, deadline=None, open=None, description=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.Dropbox.file_requests_create().

Variables:

file_requests.CreateFileRequestArgs.title – The title of the file request. Must not be empty.
file_requests.CreateFileRequestArgs.destination – The path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
file_requests.CreateFileRequestArgs.deadline – The deadline for the file request. Deadlines can only be set by Professional and Business accounts.
file_requests.CreateFileRequestArgs.open – Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later.
file_requests.CreateFileRequestArgs.description – A description of the file request.

__init__(title=None, destination=None, deadline=None, open=None, description=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

deadline¶

description¶

destination¶

open¶

title¶

class dropbox.file_requests.CreateFileRequestError(tag, value=None)¶

Bases: dropbox.file_requests.FileRequestError

There was an error creating the file request.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:	file_requests.CreateFileRequestError.invalid_location – File requests are not available on the specified folder. file_requests.CreateFileRequestError.rate_limit – The user has reached the rate limit for creating file requests. The limit is currently 4000 file requests total.

invalid_location = CreateFileRequestError(u'invalid_location', None)¶

is_invalid_location()¶

Check if the union tag is invalid_location.

Return type:	bool

is_rate_limit()¶

Check if the union tag is rate_limit.

Return type:	bool

rate_limit = CreateFileRequestError(u'rate_limit', None)¶

class dropbox.file_requests.DeleteAllClosedFileRequestsError(tag, value=None)¶

Bases: dropbox.file_requests.FileRequestError

There was an error deleting all closed file requests.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

class dropbox.file_requests.DeleteAllClosedFileRequestsResult(file_requests=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Result for dropbox.dropbox_client.Dropbox.file_requests_delete_all_closed().

Variables:	file_requests.DeleteAllClosedFileRequestsResult.file_requests – The file requests deleted for this user.

__init__(file_requests=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

file_requests¶

class dropbox.file_requests.DeleteFileRequestArgs(ids=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.Dropbox.file_requests_delete().

Variables:	file_requests.DeleteFileRequestArgs.ids – List IDs of the file requests to delete.

__init__(ids=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

ids¶

class dropbox.file_requests.DeleteFileRequestError(tag, value=None)¶

Bases: dropbox.file_requests.FileRequestError

There was an error deleting these file requests.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:	file_requests.DeleteFileRequestError.file_request_open – One or more file requests currently open.

file_request_open = DeleteFileRequestError(u'file_request_open', None)¶

is_file_request_open()¶

Check if the union tag is file_request_open.

Return type:	bool

class dropbox.file_requests.DeleteFileRequestsResult(file_requests=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Result for dropbox.dropbox_client.Dropbox.file_requests_delete().

Variables:	file_requests.DeleteFileRequestsResult.file_requests – The file requests deleted by the request.

__init__(file_requests=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

file_requests¶

class dropbox.file_requests.FileRequest(id=None, url=None, title=None, created=None, is_open=None, file_count=None, destination=None, deadline=None, description=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

A file request for receiving files into the user’s Dropbox account.

Variables:

file_requests.FileRequest.id – The ID of the file request.
file_requests.FileRequest.url – The URL of the file request.
file_requests.FileRequest.title – The title of the file request.
file_requests.FileRequest.destination – The path of the folder in the Dropbox where uploaded files will be sent. This can be None if the destination was removed. For apps with the app folder permission, this will be relative to the app folder.
file_requests.FileRequest.created – When this file request was created.
file_requests.FileRequest.deadline – The deadline for this file request. Only set if the request has a deadline.
file_requests.FileRequest.is_open – Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions.
file_requests.FileRequest.file_count – The number of files this file request has received.
file_requests.FileRequest.description – A description of the file request.

__init__(id=None, url=None, title=None, created=None, is_open=None, file_count=None, destination=None, deadline=None, description=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

created¶

deadline¶

description¶

destination¶

file_count¶

id¶

is_open¶

title¶

url¶

class dropbox.file_requests.FileRequestDeadline(deadline=None, allow_late_uploads=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:	file_requests.FileRequestDeadline.deadline – The deadline for this file request. file_requests.FileRequestDeadline.allow_late_uploads – If set, allow uploads after the deadline has passed. These uploads will be marked overdue.

__init__(deadline=None, allow_late_uploads=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

allow_late_uploads¶

deadline¶

class dropbox.file_requests.FileRequestError(tag, value=None)¶

Bases: dropbox.file_requests.GeneralFileRequestsError

There is an error with the file request.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

file_requests.FileRequestError.not_found – This file request ID was not found.
file_requests.FileRequestError.not_a_folder – The specified path is not a folder.
file_requests.FileRequestError.app_lacks_access – This file request is not accessible to this app. Apps with the app folder permission can only access file requests in their app folder.
file_requests.FileRequestError.no_permission – This user doesn’t have permission to access or modify this file request.
file_requests.FileRequestError.email_unverified – This user’s email address is not verified. File requests are only available on accounts with a verified email address. Users can verify their email address here.
file_requests.FileRequestError.validation_error – There was an error validating the request. For example, the title was invalid, or there were disallowed characters in the destination path.

app_lacks_access = FileRequestError(u'app_lacks_access', None)¶

email_unverified = FileRequestError(u'email_unverified', None)¶

is_app_lacks_access()¶

Check if the union tag is app_lacks_access.

Return type:	bool

is_email_unverified()¶

Check if the union tag is email_unverified.

Return type:	bool

is_no_permission()¶

Check if the union tag is no_permission.

Return type:	bool

is_not_a_folder()¶

Check if the union tag is not_a_folder.

Return type:	bool

is_not_found()¶

Check if the union tag is not_found.

Return type:	bool

is_validation_error()¶

Check if the union tag is validation_error.

Return type:	bool

no_permission = FileRequestError(u'no_permission', None)¶

not_a_folder = FileRequestError(u'not_a_folder', None)¶

not_found = FileRequestError(u'not_found', None)¶

validation_error = FileRequestError(u'validation_error', None)¶

class dropbox.file_requests.GeneralFileRequestsError(tag, value=None)¶

Bases: stone.backends.python_rsrc.stone_base.Union

There is an error accessing the file requests functionality.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:	file_requests.GeneralFileRequestsError.disabled_for_team – This user’s Dropbox Business team doesn’t allow file requests.

disabled_for_team = GeneralFileRequestsError(u'disabled_for_team', None)¶

is_disabled_for_team()¶

Check if the union tag is disabled_for_team.

Return type:	bool

is_other()¶

Check if the union tag is other.

Return type:	bool

other = GeneralFileRequestsError(u'other', None)¶

class dropbox.file_requests.GetFileRequestArgs(id=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.Dropbox.file_requests_get().

Variables:	file_requests.GetFileRequestArgs.id – The ID of the file request to retrieve.

__init__(id=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

id¶

class dropbox.file_requests.GetFileRequestError(tag, value=None)¶

Bases: dropbox.file_requests.FileRequestError

There was an error retrieving the specified file request.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

class dropbox.file_requests.GracePeriod(tag, value=None)¶

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

always = GracePeriod(u'always', None)¶

is_always()¶

Check if the union tag is always.

Return type:	bool

is_one_day()¶

Check if the union tag is one_day.

Return type:	bool

is_other()¶

Check if the union tag is other.

Return type:	bool

is_seven_days()¶

Check if the union tag is seven_days.

Return type:	bool

is_thirty_days()¶

Check if the union tag is thirty_days.

Return type:	bool

is_two_days()¶

Check if the union tag is two_days.

Return type:	bool

one_day = GracePeriod(u'one_day', None)¶

other = GracePeriod(u'other', None)¶

seven_days = GracePeriod(u'seven_days', None)¶

thirty_days = GracePeriod(u'thirty_days', None)¶

two_days = GracePeriod(u'two_days', None)¶

class dropbox.file_requests.ListFileRequestsArg(limit=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.Dropbox.file_requests_list().

Variables:	file_requests.ListFileRequestsArg.limit – The maximum number of file requests that should be returned per request.

__init__(limit=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

limit¶

class dropbox.file_requests.ListFileRequestsContinueArg(cursor=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:	file_requests.ListFileRequestsContinueArg.cursor – The cursor returned by the previous API call specified in the endpoint description.

__init__(cursor=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

cursor¶

class dropbox.file_requests.ListFileRequestsContinueError(tag, value=None)¶

Bases: dropbox.file_requests.GeneralFileRequestsError

There was an error retrieving the file requests.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:	file_requests.ListFileRequestsContinueError.invalid_cursor – The cursor is invalid.

invalid_cursor = ListFileRequestsContinueError(u'invalid_cursor', None)¶

is_invalid_cursor()¶

Check if the union tag is invalid_cursor.

Return type:	bool

class dropbox.file_requests.ListFileRequestsError(tag, value=None)¶

Bases: dropbox.file_requests.GeneralFileRequestsError

There was an error retrieving the file requests.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

class dropbox.file_requests.ListFileRequestsResult(file_requests=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Result for dropbox.dropbox_client.Dropbox.file_requests_list().

Variables:	file_requests.ListFileRequestsResult.file_requests – The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.

__init__(file_requests=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

file_requests¶

class dropbox.file_requests.ListFileRequestsV2Result(file_requests=None, cursor=None, has_more=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Result for dropbox.dropbox_client.Dropbox.file_requests_list() and dropbox.dropbox_client.Dropbox.file_requests_list_continue().

Variables:

file_requests.ListFileRequestsV2Result.file_requests – The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.
file_requests.ListFileRequestsV2Result.cursor – Pass the cursor into dropbox.dropbox_client.Dropbox.file_requests_list_continue() to obtain additional file requests.
file_requests.ListFileRequestsV2Result.has_more – Is true if there are additional file requests that have not been returned yet. An additional call to :route:list/continue` can retrieve them.

__init__(file_requests=None, cursor=None, has_more=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

cursor¶

file_requests¶

has_more¶

class dropbox.file_requests.UpdateFileRequestArgs(id=None, title=None, destination=None, deadline=None, open=None, description=None)¶

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.Dropbox.file_requests_update().

Variables:

file_requests.UpdateFileRequestArgs.id – The ID of the file request to update.
file_requests.UpdateFileRequestArgs.title – The new title of the file request. Must not be empty.
file_requests.UpdateFileRequestArgs.destination – The new path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
file_requests.UpdateFileRequestArgs.deadline – The new deadline for the file request. Deadlines can only be set by Professional and Business accounts.
file_requests.UpdateFileRequestArgs.open – Whether to set this file request as open or closed.
file_requests.UpdateFileRequestArgs.description – The description of the file request.

__init__(id=None, title=None, destination=None, deadline=None, open=None, description=None)¶: x.__init__(…) initializes x; see help(type(x)) for signature

deadline¶

description¶

destination¶

id¶

open¶

title¶

class dropbox.file_requests.UpdateFileRequestDeadline(tag, value=None)¶

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:	file_requests.UpdateFileRequestDeadline.no_update – Do not change the file request’s deadline.

:ivar Optional[FileRequestDeadline]: file_requests.UpdateFileRequestDeadline.update: If :val:`null`, the file request’s deadline is cleared.

get_update()¶

If None, the file request’s deadline is cleared.

Only call this if is_update() is true.

Return type:	FileRequestDeadline

is_no_update()¶

Check if the union tag is no_update.

Return type:	bool

is_other()¶

Check if the union tag is other.

Return type:	bool

is_update()¶

Check if the union tag is update.

Return type:	bool

no_update = UpdateFileRequestDeadline(u'no_update', None)¶

other = UpdateFileRequestDeadline(u'other', None)¶

classmethod update(val)¶

Create an instance of this class set to the update tag with value val.

Parameters:	val (FileRequestDeadline) –
Return type:	UpdateFileRequestDeadline

class dropbox.file_requests.UpdateFileRequestError(tag, value=None)¶

Bases: dropbox.file_requests.FileRequestError

There is an error updating the file request.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

dropbox.file_requests – File Requests¶

`dropbox.file_requests` – File Requests¶