dropbox 12.2.4__tar.gz → 12.2.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (124) hide show
  1. {dropbox-12.2.4/dropbox.egg-info → dropbox-12.2.5}/PKG-INFO +45 -1
  2. {dropbox-12.2.4 → dropbox-12.2.5}/README.rst +44 -0
  3. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/__init__.py +1 -0
  4. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/_version.py +3 -3
  5. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/base.py +165 -48
  6. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/base_team.py +65 -59
  7. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/dropbox_client.py +56 -12
  8. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/paper.py +16 -0
  9. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/riviera.py +1171 -10
  10. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/team.py +453 -20
  11. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/team_log.py +38 -6
  12. {dropbox-12.2.4 → dropbox-12.2.5/dropbox.egg-info}/PKG-INFO +45 -1
  13. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox.egg-info/SOURCES.txt +1 -0
  14. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox.egg-info/scm_file_list.json +1 -0
  15. dropbox-12.2.5/dropbox.egg-info/scm_version.json +8 -0
  16. dropbox-12.2.5/test/unit/test_access_token_snapshot.py +354 -0
  17. dropbox-12.2.4/dropbox.egg-info/scm_version.json +0 -8
  18. {dropbox-12.2.4 → dropbox-12.2.5}/.coveragerc +0 -0
  19. {dropbox-12.2.4 → dropbox-12.2.5}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  20. {dropbox-12.2.4 → dropbox-12.2.5}/.github/ISSUE_TEMPLATE/config.yml +0 -0
  21. {dropbox-12.2.4 → dropbox-12.2.5}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  22. {dropbox-12.2.4 → dropbox-12.2.5}/.github/ISSUE_TEMPLATE/question_help.md +0 -0
  23. {dropbox-12.2.4 → dropbox-12.2.5}/.github/dependabot.yml +0 -0
  24. {dropbox-12.2.4 → dropbox-12.2.5}/.github/pull_request_template.md +0 -0
  25. {dropbox-12.2.4 → dropbox-12.2.5}/.github/workflows/ci.yml +0 -0
  26. {dropbox-12.2.4 → dropbox-12.2.5}/.github/workflows/codeql.yml +0 -0
  27. {dropbox-12.2.4 → dropbox-12.2.5}/.github/workflows/coverage.yml +0 -0
  28. {dropbox-12.2.4 → dropbox-12.2.5}/.github/workflows/pypiupload.yml +0 -0
  29. {dropbox-12.2.4 → dropbox-12.2.5}/.github/workflows/spec_update.yml +0 -0
  30. {dropbox-12.2.4 → dropbox-12.2.5}/.gitignore +0 -0
  31. {dropbox-12.2.4 → dropbox-12.2.5}/.gitmodules +0 -0
  32. {dropbox-12.2.4 → dropbox-12.2.5}/.pylintrc +0 -0
  33. {dropbox-12.2.4 → dropbox-12.2.5}/.readthedocs.yml +0 -0
  34. {dropbox-12.2.4 → dropbox-12.2.5}/CODE_OF_CONDUCT.md +0 -0
  35. {dropbox-12.2.4 → dropbox-12.2.5}/CONTRIBUTING.md +0 -0
  36. {dropbox-12.2.4 → dropbox-12.2.5}/LICENSE +0 -0
  37. {dropbox-12.2.4 → dropbox-12.2.5}/MANIFEST.in +0 -0
  38. {dropbox-12.2.4 → dropbox-12.2.5}/UPGRADING.md +0 -0
  39. {dropbox-12.2.4 → dropbox-12.2.5}/codecov.yml +0 -0
  40. {dropbox-12.2.4 → dropbox-12.2.5}/docs/Makefile +0 -0
  41. {dropbox-12.2.4 → dropbox-12.2.5}/docs/_static/.gitkeep +0 -0
  42. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/async.rst +0 -0
  43. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/auth.rst +0 -0
  44. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/common.rst +0 -0
  45. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/contacts.rst +0 -0
  46. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/dropbox.rst +0 -0
  47. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/exceptions.rst +0 -0
  48. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/file_properties.rst +0 -0
  49. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/file_requests.rst +0 -0
  50. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/file_transfer.rst +0 -0
  51. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/files.rst +0 -0
  52. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/oauth.rst +0 -0
  53. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/paper.rst +0 -0
  54. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/seen_state.rst +0 -0
  55. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/sharing.rst +0 -0
  56. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/team.rst +0 -0
  57. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/team_common.rst +0 -0
  58. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/team_log.rst +0 -0
  59. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/team_policies.rst +0 -0
  60. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/users.rst +0 -0
  61. {dropbox-12.2.4 → dropbox-12.2.5}/docs/api/users_common.rst +0 -0
  62. {dropbox-12.2.4 → dropbox-12.2.5}/docs/conf.py +0 -0
  63. {dropbox-12.2.4 → dropbox-12.2.5}/docs/index.rst +0 -0
  64. {dropbox-12.2.4 → dropbox-12.2.5}/docs/make.bat +0 -0
  65. {dropbox-12.2.4 → dropbox-12.2.5}/docs/tutorial.rst +0 -0
  66. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/_http.py +0 -0
  67. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/account.py +0 -0
  68. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/account_id.py +0 -0
  69. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/async.py +0 -0
  70. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/async_.py +0 -0
  71. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/auth.py +0 -0
  72. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/check.py +0 -0
  73. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/common.py +0 -0
  74. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/contacts.py +0 -0
  75. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/content_hash.py +0 -0
  76. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/exceptions.py +0 -0
  77. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/file_properties.py +0 -0
  78. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/file_requests.py +0 -0
  79. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/file_transfer.py +0 -0
  80. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/files.py +0 -0
  81. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/oauth.py +0 -0
  82. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/openid.py +0 -0
  83. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/secondary_emails.py +0 -0
  84. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/seen_state.py +0 -0
  85. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/session.py +0 -0
  86. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/sharing.py +0 -0
  87. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/stone_base.py +0 -0
  88. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/stone_serializers.py +0 -0
  89. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/stone_validators.py +0 -0
  90. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/team_common.py +0 -0
  91. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/team_policies.py +0 -0
  92. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/users.py +0 -0
  93. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox/users_common.py +0 -0
  94. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox.egg-info/dependency_links.txt +0 -0
  95. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox.egg-info/not-zip-safe +0 -0
  96. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox.egg-info/requires.txt +0 -0
  97. {dropbox-12.2.4 → dropbox-12.2.5}/dropbox.egg-info/top_level.txt +0 -0
  98. {dropbox-12.2.4 → dropbox-12.2.5}/example/back-up-and-restore/README.md +0 -0
  99. {dropbox-12.2.4 → dropbox-12.2.5}/example/back-up-and-restore/backup-and-restore-example.py +0 -0
  100. {dropbox-12.2.4 → dropbox-12.2.5}/example/back-up-and-restore/my-file.txt +0 -0
  101. {dropbox-12.2.4 → dropbox-12.2.5}/example/file_transfer.py +0 -0
  102. {dropbox-12.2.4 → dropbox-12.2.5}/example/oauth/commandline-oauth-pkce.py +0 -0
  103. {dropbox-12.2.4 → dropbox-12.2.5}/example/oauth/commandline-oauth-scopes.py +0 -0
  104. {dropbox-12.2.4 → dropbox-12.2.5}/example/oauth/commandline-oauth.py +0 -0
  105. {dropbox-12.2.4 → dropbox-12.2.5}/example/updown.py +0 -0
  106. {dropbox-12.2.4 → dropbox-12.2.5}/generate_base_client.py +0 -0
  107. {dropbox-12.2.4 → dropbox-12.2.5}/generator/dropbox_python_client.stoneg.py +0 -0
  108. {dropbox-12.2.4 → dropbox-12.2.5}/pyproject.toml +0 -0
  109. {dropbox-12.2.4 → dropbox-12.2.5}/requirements.txt +0 -0
  110. {dropbox-12.2.4 → dropbox-12.2.5}/scripts/release_note_generator.sh +0 -0
  111. {dropbox-12.2.4 → dropbox-12.2.5}/scripts/update_version.sh +0 -0
  112. {dropbox-12.2.4 → dropbox-12.2.5}/setup.cfg +0 -0
  113. {dropbox-12.2.4 → dropbox-12.2.5}/test/fixtures/Costa Rican Frog.jpg +0 -0
  114. {dropbox-12.2.4 → dropbox-12.2.5}/test/fixtures/dropbox_song.mp3 +0 -0
  115. {dropbox-12.2.4 → dropbox-12.2.5}/test/fixtures/foo.txt +0 -0
  116. {dropbox-12.2.4 → dropbox-12.2.5}/test/integration/expired-certs.crt +0 -0
  117. {dropbox-12.2.4 → dropbox-12.2.5}/test/integration/test_dropbox.py +0 -0
  118. {dropbox-12.2.4 → dropbox-12.2.5}/test/integration/trusted-certs.crt +0 -0
  119. {dropbox-12.2.4 → dropbox-12.2.5}/test/requirements.txt +0 -0
  120. {dropbox-12.2.4 → dropbox-12.2.5}/test/unit/test_content_hash.py +0 -0
  121. {dropbox-12.2.4 → dropbox-12.2.5}/test/unit/test_dropbox_unit.py +0 -0
  122. {dropbox-12.2.4 → dropbox-12.2.5}/test/unit/test_file_transfer.py +0 -0
  123. {dropbox-12.2.4 → dropbox-12.2.5}/test/unit/test_http.py +0 -0
  124. {dropbox-12.2.4 → dropbox-12.2.5}/tox.ini +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: dropbox
3
- Version: 12.2.4
3
+ Version: 12.2.5
4
4
  Summary: Official Dropbox API Client
5
5
  Author-email: Dropbox <dev-platform@dropbox.com>
6
6
  License-Expression: MIT
@@ -99,6 +99,50 @@ We provide `Examples`_ to help get you started with a lot of the basic functiona
99
99
  - `Reliable file transfer <https://github.com/dropbox/dropbox-sdk-python/blob/main/example/file_transfer.py>`_ - Downloads and uploads files with retry, progress, and content validation helpers.
100
100
  - `Backup and Restore <https://github.com/dropbox/dropbox-sdk-python/tree/main/example/back-up-and-restore>`_ - Sample application that shows how you can backup a file and restore previous versions if the file was modified/corrupted in any way.
101
101
 
102
+ Reusing Cached Access Tokens
103
+ ============================
104
+
105
+ ``Dropbox.get_access_token_snapshot()`` and
106
+ ``DropboxTeam.get_access_token_snapshot()`` read local cached credentials without
107
+ HTTP requests or refreshing. They return an immutable ``AccessTokenSnapshot``
108
+ with ``access_token`` and ``expires_at``, or ``None`` if no access token is cached.
109
+ Expiration is a ``datetime`` using the constructor's expiration convention
110
+ (naive UTC for SDK refreshes), or ``None`` when unknown.
111
+
112
+ .. code-block:: python
113
+
114
+ import dropbox
115
+
116
+ # Load refresh credentials separately from your application's secure storage.
117
+ dbx = dropbox.Dropbox(
118
+ oauth2_refresh_token=refresh_token,
119
+ app_key=app_key,
120
+ app_secret=app_secret,
121
+ )
122
+ dbx.users_get_current_account() # Automatically refreshes when needed.
123
+ snapshot = dbx.get_access_token_snapshot()
124
+ if snapshot is not None:
125
+ # Persist snapshot.access_token and snapshot.expires_at securely.
126
+ next_dbx = dropbox.Dropbox(
127
+ oauth2_access_token=snapshot.access_token,
128
+ oauth2_access_token_expiration=snapshot.expires_at,
129
+ oauth2_refresh_token=refresh_token,
130
+ app_key=app_key,
131
+ app_secret=app_secret,
132
+ )
133
+ next_dbx.users_get_current_account()
134
+
135
+ An explicit ``dbx.refresh_access_token()`` also updates the cache. Reading a
136
+ snapshot never refreshes credentials: tokens may be expired or revoked, and an
137
+ unknown expiration does not imply unlimited lifetime. Store access tokens securely
138
+ and never log them. Snapshots never include refresh tokens.
139
+
140
+ ``clone()``, ``with_path_root()``, ``as_user()``, and ``as_admin()`` copy the cached
141
+ credentials at creation. Each client subsequently refreshes independently;
142
+ unlike the .NET SDK, these clients do not share mutable credential state.
143
+ Concurrent refreshes remain independent requests; each successful completion
144
+ publishes a complete token/expiration pair, and failures preserve the cache.
145
+
102
146
  Reliable File Transfers
103
147
  =======================
104
148
 
@@ -60,6 +60,50 @@ We provide `Examples`_ to help get you started with a lot of the basic functiona
60
60
  - `Reliable file transfer <https://github.com/dropbox/dropbox-sdk-python/blob/main/example/file_transfer.py>`_ - Downloads and uploads files with retry, progress, and content validation helpers.
61
61
  - `Backup and Restore <https://github.com/dropbox/dropbox-sdk-python/tree/main/example/back-up-and-restore>`_ - Sample application that shows how you can backup a file and restore previous versions if the file was modified/corrupted in any way.
62
62
 
63
+ Reusing Cached Access Tokens
64
+ ============================
65
+
66
+ ``Dropbox.get_access_token_snapshot()`` and
67
+ ``DropboxTeam.get_access_token_snapshot()`` read local cached credentials without
68
+ HTTP requests or refreshing. They return an immutable ``AccessTokenSnapshot``
69
+ with ``access_token`` and ``expires_at``, or ``None`` if no access token is cached.
70
+ Expiration is a ``datetime`` using the constructor's expiration convention
71
+ (naive UTC for SDK refreshes), or ``None`` when unknown.
72
+
73
+ .. code-block:: python
74
+
75
+ import dropbox
76
+
77
+ # Load refresh credentials separately from your application's secure storage.
78
+ dbx = dropbox.Dropbox(
79
+ oauth2_refresh_token=refresh_token,
80
+ app_key=app_key,
81
+ app_secret=app_secret,
82
+ )
83
+ dbx.users_get_current_account() # Automatically refreshes when needed.
84
+ snapshot = dbx.get_access_token_snapshot()
85
+ if snapshot is not None:
86
+ # Persist snapshot.access_token and snapshot.expires_at securely.
87
+ next_dbx = dropbox.Dropbox(
88
+ oauth2_access_token=snapshot.access_token,
89
+ oauth2_access_token_expiration=snapshot.expires_at,
90
+ oauth2_refresh_token=refresh_token,
91
+ app_key=app_key,
92
+ app_secret=app_secret,
93
+ )
94
+ next_dbx.users_get_current_account()
95
+
96
+ An explicit ``dbx.refresh_access_token()`` also updates the cache. Reading a
97
+ snapshot never refreshes credentials: tokens may be expired or revoked, and an
98
+ unknown expiration does not imply unlimited lifetime. Store access tokens securely
99
+ and never log them. Snapshots never include refresh tokens.
100
+
101
+ ``clone()``, ``with_path_root()``, ``as_user()``, and ``as_admin()`` copy the cached
102
+ credentials at creation. Each client subsequently refreshes independently;
103
+ unlike the .NET SDK, these clients do not share mutable credential state.
104
+ Concurrent refreshes remain independent requests; each successful completion
105
+ publishes a complete token/expiration pair, and failures preserve the cache.
106
+
63
107
  Reliable File Transfers
64
108
  =======================
65
109
 
@@ -3,6 +3,7 @@ from __future__ import absolute_import
3
3
  from ._http import build_range_headers as build_range_headers
4
4
  from dropbox.dropbox_client import ( # noqa: F401 # pylint: disable=unused-import
5
5
  __version__,
6
+ AccessTokenSnapshot,
6
7
  Dropbox,
7
8
  DropboxTeam,
8
9
  create_session,
@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
18
18
  commit_id: str | None
19
19
  __commit_id__: str | None
20
20
 
21
- __version__ = version = '12.2.4'
22
- __version_tuple__ = version_tuple = (12, 2, 4)
21
+ __version__ = version = '12.2.5'
22
+ __version_tuple__ = version_tuple = (12, 2, 5)
23
23
 
24
- __commit_id__ = commit_id = 'g51e6b817c'
24
+ __commit_id__ = commit_id = 'g748d76a36'
@@ -1584,8 +1584,7 @@ class DropboxBase(object):
1584
1584
  must be less than 20 GB in size and any single file within must be less
1585
1585
  than 4 GB in size. The resulting zip must have fewer than 10,000 total
1586
1586
  file and folder entries, including the top level folder. The input
1587
- cannot be a single file. Note: this endpoint does not support HTTP range
1588
- requests.
1587
+ cannot be a single file.
1589
1588
 
1590
1589
  Route attributes:
1591
1590
  scope: files.content.read
@@ -1620,8 +1619,7 @@ class DropboxBase(object):
1620
1619
  must be less than 20 GB in size and any single file within must be less
1621
1620
  than 4 GB in size. The resulting zip must have fewer than 10,000 total
1622
1621
  file and folder entries, including the top level folder. The input
1623
- cannot be a single file. Note: this endpoint does not support HTTP range
1624
- requests.
1622
+ cannot be a single file.
1625
1623
 
1626
1624
  Route attributes:
1627
1625
  scope: files.content.read
@@ -4578,24 +4576,92 @@ class DropboxBase(object):
4578
4576
  self._save_body_to_file(download_path, r[1])
4579
4577
  return r[0]
4580
4578
 
4579
+ def riviera_extract_async(self, extract_type, file_id_or_url=None):
4580
+ """
4581
+ Asynchronous content extraction from a single file. One route covers
4582
+ every Riviera extraction. Name the source file in `file_id_or_url`, and
4583
+ say what to extract in `extract_type`, whose variant carries that
4584
+ extraction's options: - `markdown`: a document, converted to markdown
4585
+ that preserves its structure. - `text`: the plain text of a document. -
4586
+ `ocr`: the text of an image or scanned PDF, plus hOCR with per-word
4587
+ coordinates. - `transcript`: the timestamped transcript of an audio or
4588
+ video file. - `keyframes`: one keyframe per scene change in a video. The
4589
+ accepted formats and size limits differ per extraction; see
4590
+ `ExtractType`. Formats the requested extraction does not support fail
4591
+ with `unsupported_format_error`, and files over its size limit fail with
4592
+ `limit_exceeded_error`. The result is not returned by this route. Poll
4593
+ `extract_async/check` with the returned async job ID until it reports
4594
+ `complete` or `failed`. A `complete` result is an `ExtractResult` whose
4595
+ variant matches the requested `extract_type`.
4596
+
4597
+ Route attributes:
4598
+ scope: files.content.read
4599
+
4600
+ :param file_id_or_url: Identifier of the source file. Callers must set
4601
+ exactly one of the `FileIdOrUrl` variants. The file must be in a
4602
+ format the requested `extract_type` supports; see `ExtractType` for
4603
+ the per-type lists.
4604
+ :type file_id_or_url: Nullable[:class:`dropbox.riviera.FileIdOrUrl`]
4605
+ :param extract_type: What to extract, and that extraction's options.
4606
+ Required.
4607
+ :type extract_type: :class:`dropbox.riviera.ExtractType`
4608
+ :rtype: :class:`dropbox.async_.LaunchResultBase`
4609
+ """
4610
+ arg = riviera.ExtractArgs(extract_type, file_id_or_url)
4611
+ r = self.request(
4612
+ riviera.extract_async,
4613
+ "riviera",
4614
+ arg,
4615
+ None,
4616
+ )
4617
+ return r
4618
+
4619
+ def riviera_extract_async_check(self, async_job_id):
4620
+ """
4621
+ Returns the status or result of specified extract_async task.
4622
+
4623
+ Route attributes:
4624
+ scope: files.content.read
4625
+
4626
+ :param async_job_id: Id of the asynchronous job. This is the value of a
4627
+ response returned from the method that launched the job.
4628
+ :type async_job_id: str
4629
+ :rtype: :class:`dropbox.riviera.ExtractAsyncCheckResult`
4630
+ :raises: :class:`.exceptions.ApiError`
4631
+
4632
+ If this raises, ApiError will contain:
4633
+ :class:`dropbox.async_.PollError`
4634
+ """
4635
+ arg = async_.PollArg(async_job_id)
4636
+ r = self.request(
4637
+ riviera.extract_async_check,
4638
+ "riviera",
4639
+ arg,
4640
+ None,
4641
+ )
4642
+ return r
4643
+
4581
4644
  def riviera_get_keyframes_async(
4582
4645
  self, file_id_or_url=None, scene_change_threshold=0.0, include_images=False
4583
4646
  ):
4584
4647
  """
4585
- Asynchronous scene-change keyframe extraction for video files. Detects
4586
- scene changes in the source video and returns one representative
4587
- keyframe per detected scene, each tagged with its timestamp (seconds
4588
- from the start of the video) and scene-change score. Set `include_images
4589
- = true` to also receive each frame as a base64-encoded JPEG; when the
4590
- field is omitted the response carries keyframe metadata only. Supported
4591
- video formats: .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts,
4592
- .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm,
4593
- .ts, .vob, .webm, .wmv. Unsupported formats return an
4594
- `unsupported_format_error`. Limits: the source file must be at most 10
4595
- GB. To keep responses within service limits the number of keyframes and
4596
- the total image payload are bounded; requests that would exceed these
4597
- limits return a `limit_exceeded_error` -- raise `scene_change_threshold`
4598
- or set `include_images = false` to stay within bounds.
4648
+ Deprecated: use :meth:`riviera_extract_async` with `extract_type` set to
4649
+ ``ExtractType.keyframes`` instead, which takes the same options. This
4650
+ route will be turned off by December 31, 2026. Asynchronous scene-change
4651
+ keyframe extraction for video files. Detects scene changes in the source
4652
+ video and returns one representative keyframe per detected scene, each
4653
+ tagged with its timestamp (seconds from the start of the video) and
4654
+ scene-change score. Set `include_images = true` to also receive each
4655
+ frame as a base64-encoded JPEG; when the field is omitted the response
4656
+ carries keyframe metadata only. Supported video formats: .3gp, .3gpp,
4657
+ .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4,
4658
+ .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv.
4659
+ Unsupported formats return an `unsupported_format_error`. Limits: the
4660
+ source file must be at most 10 GB. To keep responses within service
4661
+ limits the number of keyframes and the total image payload are bounded;
4662
+ requests that would exceed these limits return a `limit_exceeded_error`
4663
+ -- raise `scene_change_threshold` or set `include_images = false` to
4664
+ stay within bounds.
4599
4665
 
4600
4666
  Route attributes:
4601
4667
  scope: files.content.read
@@ -4622,6 +4688,10 @@ class DropboxBase(object):
4622
4688
  :type include_images: bool
4623
4689
  :rtype: :class:`dropbox.async_.LaunchResultBase`
4624
4690
  """
4691
+ warnings.warn(
4692
+ "get_keyframes_async is deprecated.",
4693
+ DeprecationWarning,
4694
+ )
4625
4695
  arg = riviera.GetKeyframesArgs(file_id_or_url, scene_change_threshold, include_images)
4626
4696
  r = self.request(
4627
4697
  riviera.get_keyframes_async,
@@ -4647,6 +4717,10 @@ class DropboxBase(object):
4647
4717
  If this raises, ApiError will contain:
4648
4718
  :class:`dropbox.async_.PollError`
4649
4719
  """
4720
+ warnings.warn(
4721
+ "get_keyframes_async/check is deprecated.",
4722
+ DeprecationWarning,
4723
+ )
4650
4724
  arg = async_.PollArg(async_job_id)
4651
4725
  r = self.request(
4652
4726
  riviera.get_keyframes_async_check,
@@ -4658,9 +4732,12 @@ class DropboxBase(object):
4658
4732
 
4659
4733
  def riviera_get_markdown_async(self, file_id_or_url=None, enable_ocr=False, embed_images=False):
4660
4734
  """
4661
- Asynchronous document-to-markdown conversion for supported file formats.
4662
- Supported formats: .binder, .docx, .html, .paper, .papert, .pptx, .xlsx,
4663
- .gsheet, .ods, .pdf. Files in other formats fail with
4735
+ Deprecated: use :meth:`riviera_extract_async` with `extract_type` set to
4736
+ ``ExtractType.markdown`` instead, which takes the same options. This
4737
+ route will be turned off by December 31, 2026. Asynchronous
4738
+ document-to-markdown conversion for supported file formats. Supported
4739
+ formats: .binder, .docx, .html, .paper, .papert, .pptx, .xlsx, .gsheet,
4740
+ .ods, .pdf. Files in other formats fail with
4664
4741
  ``MarkdownConversionApiV2Error.user_error``. Size limit: the source file
4665
4742
  must be at most 50 MB. Larger files fail with
4666
4743
  ``MarkdownConversionApiV2Error.user_error``. The markdown is not
@@ -4687,6 +4764,10 @@ class DropboxBase(object):
4687
4764
  :type embed_images: bool
4688
4765
  :rtype: :class:`dropbox.async_.LaunchResultBase`
4689
4766
  """
4767
+ warnings.warn(
4768
+ "get_markdown_async is deprecated.",
4769
+ DeprecationWarning,
4770
+ )
4690
4771
  arg = riviera.GetMarkdownArgs(file_id_or_url, enable_ocr, embed_images)
4691
4772
  r = self.request(
4692
4773
  riviera.get_markdown_async,
@@ -4712,6 +4793,10 @@ class DropboxBase(object):
4712
4793
  If this raises, ApiError will contain:
4713
4794
  :class:`dropbox.async_.PollError`
4714
4795
  """
4796
+ warnings.warn(
4797
+ "get_markdown_async/check is deprecated.",
4798
+ DeprecationWarning,
4799
+ )
4715
4800
  arg = async_.PollArg(async_job_id)
4716
4801
  r = self.request(
4717
4802
  riviera.get_markdown_async_check,
@@ -4795,16 +4880,19 @@ class DropboxBase(object):
4795
4880
 
4796
4881
  def riviera_get_ocr_async(self, file_id_or_url=None):
4797
4882
  """
4798
- Asynchronous OCR (optical character recognition) text extraction for
4799
- images and PDFs, including scanned / non-text PDFs. Supported formats: -
4800
- Image formats: .bmp, .gif, .heic, .jpeg, .jpg, .png, .tif, .tiff, .webp.
4801
- - PDF format: .pdf. Unsupported formats return an
4802
- `unsupported_format_error`. For the `url` variant only Dropbox shared
4803
- links are supported; external URLs return `unsupported_format_error`.
4804
- Text-based PDFs already carry a text layer, so OCR is not run against
4805
- them and the result is empty; use `get_text_async` to read the embedded
4806
- text layer of such a PDF. The result carries the extracted words as
4807
- plain text, plus the same content as hOCR with per-word coordinates.
4883
+ Deprecated: use :meth:`riviera_extract_async` with `extract_type` set to
4884
+ ``ExtractType.ocr`` instead, which takes the same options. This route
4885
+ will be turned off by December 31, 2026. Asynchronous OCR (optical
4886
+ character recognition) text extraction for images and PDFs, including
4887
+ scanned / non-text PDFs. Supported formats: - Image formats: .bmp, .gif,
4888
+ .heic, .jpeg, .jpg, .png, .tif, .tiff, .webp. - PDF format: .pdf.
4889
+ Unsupported formats return an `unsupported_format_error`. For the `url`
4890
+ variant only Dropbox shared links are supported; external URLs return
4891
+ `unsupported_format_error`. Text-based PDFs already carry a text layer,
4892
+ so OCR is not run against them and the result is empty; use
4893
+ `get_text_async` to read the embedded text layer of such a PDF. The
4894
+ result carries the extracted words as plain text, plus the same content
4895
+ as hOCR with per-word coordinates.
4808
4896
 
4809
4897
  Route attributes:
4810
4898
  scope: files.content.read
@@ -4821,6 +4909,10 @@ class DropboxBase(object):
4821
4909
  :type file_id_or_url: Nullable[:class:`dropbox.riviera.FileIdOrUrl`]
4822
4910
  :rtype: :class:`dropbox.async_.LaunchResultBase`
4823
4911
  """
4912
+ warnings.warn(
4913
+ "get_ocr_async is deprecated.",
4914
+ DeprecationWarning,
4915
+ )
4824
4916
  arg = riviera.GetOcrArgs(file_id_or_url)
4825
4917
  r = self.request(
4826
4918
  riviera.get_ocr_async,
@@ -4846,6 +4938,10 @@ class DropboxBase(object):
4846
4938
  If this raises, ApiError will contain:
4847
4939
  :class:`dropbox.async_.PollError`
4848
4940
  """
4941
+ warnings.warn(
4942
+ "get_ocr_async/check is deprecated.",
4943
+ DeprecationWarning,
4944
+ )
4849
4945
  arg = async_.PollArg(async_job_id)
4850
4946
  r = self.request(
4851
4947
  riviera.get_ocr_async_check,
@@ -4857,14 +4953,16 @@ class DropboxBase(object):
4857
4953
 
4858
4954
  def riviera_get_text_async(self, file_id_or_url=None):
4859
4955
  """
4860
- Asynchronous plain-text extraction from documents. Supported formats
4861
- include: - Word processing: .doc, .docx, .docm, .rtf. - Presentations:
4862
- .ppt, .pptx, .pptm. - Spreadsheets: .xls, .xlsx, .xlsm. - PDF: .pdf. -
4863
- Dropbox document types: .paper, .papert, .binder, .gdoc, .gsheet,
4864
- .gslides. - Plain text / subtitles: .txt, .vtt. Unsupported formats
4865
- return an `unsupported_format_error`. For the `url` variant only Dropbox
4866
- shared links are supported; external URLs return
4867
- `unsupported_format_error`.
4956
+ Deprecated: use :meth:`riviera_extract_async` with `extract_type` set to
4957
+ ``ExtractType.text`` instead, which takes the same options. This route
4958
+ will be turned off by December 31, 2026. Asynchronous plain-text
4959
+ extraction from documents. Supported formats include: - Word processing:
4960
+ .doc, .docx, .docm, .rtf. - Presentations: .ppt, .pptx, .pptm. -
4961
+ Spreadsheets: .xls, .xlsx, .xlsm. - PDF: .pdf. - Dropbox document types:
4962
+ .paper, .papert, .binder, .gdoc, .gsheet, .gslides. - Plain text /
4963
+ subtitles: .txt, .vtt. Unsupported formats return an
4964
+ `unsupported_format_error`. For the `url` variant only Dropbox shared
4965
+ links are supported; external URLs return `unsupported_format_error`.
4868
4966
 
4869
4967
  Route attributes:
4870
4968
  scope: files.content.read
@@ -4882,6 +4980,10 @@ class DropboxBase(object):
4882
4980
  :type file_id_or_url: Nullable[:class:`dropbox.riviera.FileIdOrUrl`]
4883
4981
  :rtype: :class:`dropbox.async_.LaunchResultBase`
4884
4982
  """
4983
+ warnings.warn(
4984
+ "get_text_async is deprecated.",
4985
+ DeprecationWarning,
4986
+ )
4885
4987
  arg = riviera.GetTextArgs(file_id_or_url)
4886
4988
  r = self.request(
4887
4989
  riviera.get_text_async,
@@ -4907,6 +5009,10 @@ class DropboxBase(object):
4907
5009
  If this raises, ApiError will contain:
4908
5010
  :class:`dropbox.async_.PollError`
4909
5011
  """
5012
+ warnings.warn(
5013
+ "get_text_async/check is deprecated.",
5014
+ DeprecationWarning,
5015
+ )
4910
5016
  arg = async_.PollArg(async_job_id)
4911
5017
  r = self.request(
4912
5018
  riviera.get_text_async_check,
@@ -4924,15 +5030,18 @@ class DropboxBase(object):
4924
5030
  audio_language="",
4925
5031
  ):
4926
5032
  """
4927
- Asynchronous transcript generation for audio and video files. Supported
4928
- audio formats: .aac, .aif, .aiff, .flac, .m4a, .m4r, .mp3, .oga, .ogg,
4929
- .wav, .wma. Supported video formats: .3gp, .3gpp, .3gpp2, .asf, .avi,
4930
- .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf,
4931
- .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. Files in other formats
4932
- fail with ``ContentApiV2Error.user_error``. Size limits: the source file
4933
- must be at most 10 GB and its audio track at most 1 hour in duration.
4934
- Files exceeding either limit fail with ``ContentApiV2Error.user_error``.
4935
- The transcript is not returned by this route. Poll
5033
+ Deprecated: use :meth:`riviera_extract_async` with `extract_type` set to
5034
+ ``ExtractType.transcript`` instead, which takes the same options. This
5035
+ route will be turned off by December 31, 2026. Asynchronous transcript
5036
+ generation for audio and video files. Supported audio formats: .aac,
5037
+ .aif, .aiff, .flac, .m4a, .m4r, .mp3, .oga, .ogg, .wav, .wma. Supported
5038
+ video formats: .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts,
5039
+ .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm,
5040
+ .ts, .vob, .webm, .wmv. Files in other formats fail with
5041
+ ``ContentApiV2Error.user_error``. Size limits: the source file must be
5042
+ at most 10 GB and its audio track at most 1 hour in duration. Files
5043
+ exceeding either limit fail with ``ContentApiV2Error.user_error``. The
5044
+ transcript is not returned by this route. Poll
4936
5045
  :meth:`riviera_get_transcript_async_check` with the returned async job
4937
5046
  ID until it reports ``GetTranscriptAsyncCheckResult.complete`` or
4938
5047
  ``GetTranscriptAsyncCheckResult.failed``.
@@ -4964,6 +5073,10 @@ class DropboxBase(object):
4964
5073
  :type audio_language: str
4965
5074
  :rtype: :class:`dropbox.async_.LaunchResultBase`
4966
5075
  """
5076
+ warnings.warn(
5077
+ "get_transcript_async is deprecated.",
5078
+ DeprecationWarning,
5079
+ )
4967
5080
  arg = riviera.GetTranscriptArgs(
4968
5081
  file_id_or_url, timestamp_level, included_special_words, audio_language
4969
5082
  )
@@ -4991,6 +5104,10 @@ class DropboxBase(object):
4991
5104
  If this raises, ApiError will contain:
4992
5105
  :class:`dropbox.async_.PollError`
4993
5106
  """
5107
+ warnings.warn(
5108
+ "get_transcript_async/check is deprecated.",
5109
+ DeprecationWarning,
5110
+ )
4994
5111
  arg = async_.PollArg(async_job_id)
4995
5112
  r = self.request(
4996
5113
  riviera.get_transcript_async_check,
@@ -1422,65 +1422,6 @@ class DropboxTeamBase(object):
1422
1422
  )
1423
1423
  return r
1424
1424
 
1425
- def team_members_bulk_suspend(self, members):
1426
- """
1427
- Deprecated compatibility alias for MembersSuspendBatch.
1428
-
1429
- Route attributes:
1430
- scope: members.write
1431
-
1432
- :param members: Must contain between 1 and 500 targets. The launch
1433
- handler also rejects duplicate client item IDs and duplicate member
1434
- selectors.
1435
- :type members: List[:class:`dropbox.team.MembersSuspendBatchTarget`]
1436
- :rtype: :class:`dropbox.async_.LaunchResultBase`
1437
- :raises: :class:`.exceptions.ApiError`
1438
-
1439
- If this raises, ApiError will contain:
1440
- :class:`dropbox.team.MembersSuspendBatchError`
1441
- """
1442
- warnings.warn(
1443
- "members/bulk_suspend is deprecated.",
1444
- DeprecationWarning,
1445
- )
1446
- arg = team.MembersSuspendBatchArg(members)
1447
- r = self.request(
1448
- team.members_bulk_suspend,
1449
- "team",
1450
- arg,
1451
- None,
1452
- )
1453
- return r
1454
-
1455
- def team_members_bulk_suspend_job_status_check(self, async_job_id):
1456
- """
1457
- Deprecated compatibility alias for MembersSuspendBatchJobStatusCheck.
1458
-
1459
- Route attributes:
1460
- scope: members.write
1461
-
1462
- :param async_job_id: Id of the asynchronous job. This is the value of a
1463
- response returned from the method that launched the job.
1464
- :type async_job_id: str
1465
- :rtype: :class:`dropbox.team.MembersSuspendBatchJobStatus`
1466
- :raises: :class:`.exceptions.ApiError`
1467
-
1468
- If this raises, ApiError will contain:
1469
- :class:`dropbox.async_.PollError`
1470
- """
1471
- warnings.warn(
1472
- "members/bulk_suspend/job_status/check is deprecated.",
1473
- DeprecationWarning,
1474
- )
1475
- arg = async_.PollArg(async_job_id)
1476
- r = self.request(
1477
- team.members_bulk_suspend_job_status_check,
1478
- "team",
1479
- arg,
1480
- None,
1481
- )
1482
- return r
1483
-
1484
1425
  def team_members_delete_former_member_files(self, user):
1485
1426
  """
1486
1427
  Permanently delete the files of a user who has been removed from the
@@ -2961,6 +2902,71 @@ class DropboxTeamBase(object):
2961
2902
  )
2962
2903
  return r
2963
2904
 
2905
+ def team_team_folder_space_limit_get(self, team_folder_id):
2906
+ """
2907
+ Returns the space limit configuration of a team folder. See
2908
+ :class:`dropbox.team.TeamFolderSpaceLimitCapsType` for how space limits
2909
+ are enforced.
2910
+
2911
+ Route attributes:
2912
+ scope: team_data.content.read
2913
+
2914
+ :param team_folder_id: The ID of the team folder.
2915
+ :type team_folder_id: str
2916
+ :rtype: :class:`dropbox.team.TeamFolderGetSpaceLimitResponse`
2917
+ """
2918
+ arg = team.TeamFolderIdArg(team_folder_id)
2919
+ r = self.request(
2920
+ team.team_folder_space_limit_get,
2921
+ "team",
2922
+ arg,
2923
+ None,
2924
+ )
2925
+ return r
2926
+
2927
+ def team_team_folder_space_limit_set(
2928
+ self, team_folder_id, space_limit_bytes, caps_type, notification_target
2929
+ ):
2930
+ """
2931
+ Sets the space limit configuration of a team folder, replacing any
2932
+ existing configuration. See
2933
+ :class:`dropbox.team.TeamFolderSpaceLimitCapsType` for how space limits
2934
+ are enforced.
2935
+
2936
+ Route attributes:
2937
+ scope: team_data.content.write
2938
+
2939
+ :param space_limit_bytes: The maximum total size, in bytes, of all
2940
+ content in the team folder and its subfolders. When ``caps_type`` is
2941
+ ``TeamFolderSpaceLimitCapsType.soft`` or
2942
+ ``TeamFolderSpaceLimitCapsType.hard``, this must be at least 2 GB
2943
+ (2147483648 bytes). It must never exceed the team's total storage
2944
+ capacity. When ``caps_type`` is
2945
+ ``TeamFolderSpaceLimitCapsType.off``, the value is stored but has no
2946
+ effect, and it may be 0.
2947
+ :type space_limit_bytes: int
2948
+ :param caps_type: The caps type to apply to the specified team folder.
2949
+ :type caps_type: :class:`dropbox.team.TeamFolderSpaceLimitCapsType`
2950
+ :param notification_target: Who receives usage notifications for the
2951
+ specified team folder.
2952
+ :type notification_target: :class:`dropbox.team.TeamFolderSpaceLimitNotificationTarget`
2953
+ :rtype: None
2954
+ :raises: :class:`.exceptions.ApiError`
2955
+
2956
+ If this raises, ApiError will contain:
2957
+ :class:`dropbox.team.TeamFolderSetSpaceLimitError`
2958
+ """
2959
+ arg = team.TeamFolderSetSpaceLimitArg(
2960
+ team_folder_id, space_limit_bytes, caps_type, notification_target
2961
+ )
2962
+ r = self.request(
2963
+ team.team_folder_space_limit_set,
2964
+ "team",
2965
+ arg,
2966
+ None,
2967
+ )
2968
+ return None
2969
+
2964
2970
  def team_team_folder_update_sync_settings(
2965
2971
  self, team_folder_id, sync_setting=None, content_sync_settings=None
2966
2972
  ):