Module paper

Available on crate features sync_routes and dbx_paper only.

Structs

AddMember

AddPaperDocUser

AddPaperDocUserMemberResult

Per-member result for docs_users_add().

Cursor

Folder

Data structure representing a Paper folder.

FoldersContainingPaperDoc

Metadata about Paper folders containing the specififed Paper doc.

InviteeInfoWithPermissionLevel

ListPaperDocsArgs

ListPaperDocsContinueArgs

ListPaperDocsResponse

ListUsersOnFolderArgs

ListUsersOnFolderContinueArgs

ListUsersOnFolderResponse

ListUsersOnPaperDocArgs

ListUsersOnPaperDocContinueArgs

ListUsersOnPaperDocResponse

PaperDocCreateArgs

PaperDocCreateUpdateResult

PaperDocExport

PaperDocExportResult

PaperDocSharingPolicy

PaperDocUpdateArgs

PaperFolderCreateArg

PaperFolderCreateResult

RefPaperDoc

RemovePaperDocUser

SharingPolicy

Sharing policy of Paper doc.

UserInfoWithPermissionLevel

Enums

AddPaperDocUserResult

DocLookupError

DocSubscriptionLevel

The subscription level of a Paper doc.

ExportFormat

The desired export format of the Paper doc.

FolderSharingPolicyType

The sharing policy of a Paper folder. The sharing policy of subfolders is inherited from the root folder.

FolderSubscriptionLevel

The subscription level of a Paper folder.

ImportFormat

The import format of the incoming data.

ListDocsCursorError

ListPaperDocsFilterBy

ListPaperDocsSortBy

ListPaperDocsSortOrder

ListUsersCursorError

PaperApiBaseError

PaperApiCursorError

PaperDocCreateError

PaperDocPermissionLevel

PaperDocUpdateError

PaperDocUpdatePolicy

PaperFolderCreateError

SharingPublicPolicyType

SharingTeamPolicyType

The sharing policy type of the Paper doc.

UserOnPaperDocFilter

Functions

docs_archiveDeprecated

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 for more information.

docs_createDeprecated

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 for more information.

docs_downloadDeprecated

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 for migration information.

docs_folder_users_listDeprecated

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 for migration information.

docs_folder_users_list_continueDeprecated

Once a cursor has been retrieved from docs_folder_users_list(), 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 for migration information.

docs_get_folder_infoDeprecated

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.

docs_listDeprecated

Return the list of all Paper docs according to the argument specifications. To iterate over through the full pagination, pass the cursor to docs_list_continue(). 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 for migration information.

docs_list_continueDeprecated

Once a cursor has been retrieved from docs_list(), 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 for migration information.

docs_permanently_deleteDeprecated

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 for migration information.

docs_sharing_policy_getDeprecated

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 for migration information.

docs_sharing_policy_setDeprecated

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 for migration information.

docs_updateDeprecated

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 for more information.

docs_users_addDeprecated

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 for migration information.

docs_users_listDeprecated

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 for migration information.

docs_users_list_continueDeprecated

Once a cursor has been retrieved from docs_users_list(), 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 for migration information.

docs_users_removeDeprecated

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 for migration information.

folders_createDeprecated

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 for migration information.

Type Aliases

PaperDocId