frameio 0.1.0 → 1.1.3

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 (201) hide show
  1. package/README.md +5 -1
  2. package/dist/cjs/Client.d.ts +2 -2
  3. package/dist/cjs/Client.js +3 -3
  4. package/dist/cjs/api/resources/accountPermissions/client/Client.d.ts +4 -4
  5. package/dist/cjs/api/resources/accountPermissions/client/Client.js +3 -7
  6. package/dist/cjs/api/resources/accounts/client/Client.d.ts +4 -4
  7. package/dist/cjs/api/resources/accounts/client/Client.js +3 -7
  8. package/dist/cjs/api/resources/comments/client/Client.d.ts +16 -9
  9. package/dist/cjs/api/resources/comments/client/Client.js +40 -16
  10. package/dist/cjs/api/resources/comments/client/requests/CommentsShowRequest.d.ts +1 -1
  11. package/dist/cjs/api/resources/comments/client/requests/CreateCommentParams.d.ts +13 -3
  12. package/dist/cjs/api/resources/comments/client/requests/UpdateCommentParams.d.ts +11 -2
  13. package/dist/cjs/api/resources/comments/index.d.ts +1 -0
  14. package/dist/cjs/api/resources/comments/index.js +1 -0
  15. package/dist/cjs/api/resources/comments/types/CommentsShowRequestInclude.d.ts +6 -0
  16. package/dist/cjs/api/resources/comments/types/CommentsShowRequestInclude.js +9 -0
  17. package/dist/cjs/api/resources/comments/types/index.d.ts +1 -0
  18. package/dist/cjs/api/resources/comments/types/index.js +17 -0
  19. package/dist/cjs/api/resources/files/client/Client.d.ts +16 -15
  20. package/dist/cjs/api/resources/files/client/Client.js +33 -20
  21. package/dist/cjs/api/resources/files/client/requests/FileCopyParams.d.ts +3 -0
  22. package/dist/cjs/api/resources/folders/client/Client.d.ts +14 -12
  23. package/dist/cjs/api/resources/folders/client/Client.js +31 -17
  24. package/dist/cjs/api/resources/folders/client/requests/FolderCopyParams.d.ts +3 -0
  25. package/dist/cjs/api/resources/index.d.ts +4 -2
  26. package/dist/cjs/api/resources/index.js +5 -3
  27. package/dist/cjs/api/resources/metadata/client/Client.d.ts +17 -14
  28. package/dist/cjs/api/resources/metadata/client/Client.js +16 -17
  29. package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +13 -10
  30. package/dist/cjs/api/resources/metadataFields/client/Client.d.ts +7 -7
  31. package/dist/cjs/api/resources/metadataFields/client/Client.js +6 -10
  32. package/dist/cjs/api/resources/projectPermissions/client/Client.d.ts +6 -6
  33. package/dist/cjs/api/resources/projectPermissions/client/Client.js +5 -9
  34. package/dist/cjs/api/resources/projects/client/Client.d.ts +15 -12
  35. package/dist/cjs/api/resources/projects/client/Client.js +13 -14
  36. package/dist/cjs/api/resources/projects/client/requests/ProjectParams.d.ts +20 -0
  37. package/dist/cjs/api/resources/projects/client/requests/ProjectUpdateParams.d.ts +31 -0
  38. package/dist/cjs/api/resources/projects/client/requests/ProjectUpdateParams.js +15 -0
  39. package/dist/cjs/api/resources/projects/client/requests/index.d.ts +2 -0
  40. package/dist/cjs/api/resources/shares/client/Client.d.ts +22 -20
  41. package/dist/cjs/api/resources/shares/client/Client.js +21 -23
  42. package/dist/cjs/api/resources/shares/client/requests/AddAssetParams.d.ts +1 -1
  43. package/dist/cjs/api/resources/shares/client/requests/CreateShareParams.d.ts +3 -2
  44. package/dist/cjs/api/resources/shares/client/requests/UpdateShareParams.d.ts +3 -1
  45. package/dist/cjs/api/resources/users/client/Client.d.ts +4 -4
  46. package/dist/cjs/api/resources/users/client/Client.js +3 -7
  47. package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +34 -10
  48. package/dist/cjs/api/resources/versionStacks/client/Client.js +115 -15
  49. package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCopyParams.d.ts +3 -0
  50. package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +2 -2
  51. package/dist/cjs/api/resources/versionStacks/client/requests/VersionStacksShowRequest.d.ts +11 -0
  52. package/dist/cjs/api/resources/versionStacks/client/requests/VersionStacksShowRequest.js +3 -0
  53. package/dist/cjs/api/resources/versionStacks/client/requests/index.d.ts +1 -0
  54. package/dist/cjs/api/resources/versionStacks/index.d.ts +1 -0
  55. package/dist/cjs/api/resources/versionStacks/index.js +1 -0
  56. package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.ts +13 -0
  57. package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.js +16 -0
  58. package/dist/cjs/api/resources/versionStacks/types/index.d.ts +1 -0
  59. package/dist/cjs/api/resources/versionStacks/types/index.js +17 -0
  60. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +7 -7
  61. package/dist/cjs/api/resources/webhooks/client/Client.js +6 -10
  62. package/dist/cjs/api/resources/workspacePermissions/client/Client.d.ts +6 -6
  63. package/dist/cjs/api/resources/workspacePermissions/client/Client.js +5 -9
  64. package/dist/cjs/api/resources/workspaces/client/Client.d.ts +8 -8
  65. package/dist/cjs/api/resources/workspaces/client/Client.js +7 -11
  66. package/dist/cjs/api/types/AssetCommonWithIncludes.d.ts +9 -0
  67. package/dist/cjs/api/types/AssetCommonWithIncludes.js +9 -0
  68. package/dist/cjs/api/types/AssetShareParams.d.ts +1 -0
  69. package/dist/cjs/api/types/Comment.d.ts +6 -2
  70. package/dist/cjs/api/types/DateDefinition.d.ts +16 -0
  71. package/dist/cjs/api/types/DateDefinition.js +13 -0
  72. package/dist/cjs/api/types/EmptyJson.d.ts +4 -0
  73. package/dist/cjs/api/types/EmptyJson.js +3 -0
  74. package/dist/cjs/api/types/FileWithMediaLinksInclude.d.ts +0 -1
  75. package/dist/cjs/api/types/FileWithMediaLinksInclude.js +0 -1
  76. package/dist/cjs/api/types/FolderWithIncludes.d.ts +9 -0
  77. package/dist/cjs/api/types/FolderWithIncludes.js +9 -0
  78. package/dist/cjs/api/types/LongTextDefinition.d.ts +16 -0
  79. package/dist/cjs/api/types/LongTextDefinition.js +17 -0
  80. package/dist/cjs/api/types/MultiUserValue.d.ts +1 -1
  81. package/dist/cjs/api/types/Project.d.ts +12 -0
  82. package/dist/cjs/api/types/Project.js +9 -0
  83. package/dist/cjs/api/types/SelectMultiDefinition.d.ts +16 -0
  84. package/dist/cjs/api/types/SelectMultiDefinition.js +17 -0
  85. package/dist/cjs/api/types/TextDefinition.d.ts +16 -0
  86. package/dist/cjs/api/types/TextDefinition.js +17 -0
  87. package/dist/cjs/api/types/TimeStamp.d.ts +7 -0
  88. package/dist/cjs/api/types/TimeStamp.js +3 -0
  89. package/dist/cjs/api/types/UserMultiDefinition.d.ts +16 -0
  90. package/dist/cjs/api/types/UserMultiDefinition.js +13 -0
  91. package/dist/cjs/api/types/UserSingleDefinition.d.ts +16 -0
  92. package/dist/cjs/api/types/UserSingleDefinition.js +13 -0
  93. package/dist/cjs/api/types/VersionStackWithIncludes.d.ts +9 -0
  94. package/dist/cjs/api/types/VersionStackWithIncludes.js +9 -0
  95. package/dist/cjs/api/types/index.d.ts +3 -2
  96. package/dist/cjs/api/types/index.js +3 -2
  97. package/dist/cjs/version.d.ts +1 -1
  98. package/dist/cjs/version.js +1 -1
  99. package/dist/esm/Client.d.mts +2 -2
  100. package/dist/esm/Client.mjs +3 -3
  101. package/dist/esm/api/resources/accountPermissions/client/Client.d.mts +4 -4
  102. package/dist/esm/api/resources/accountPermissions/client/Client.mjs +3 -7
  103. package/dist/esm/api/resources/accounts/client/Client.d.mts +4 -4
  104. package/dist/esm/api/resources/accounts/client/Client.mjs +3 -7
  105. package/dist/esm/api/resources/comments/client/Client.d.mts +16 -9
  106. package/dist/esm/api/resources/comments/client/Client.mjs +40 -16
  107. package/dist/esm/api/resources/comments/client/requests/CommentsShowRequest.d.mts +1 -1
  108. package/dist/esm/api/resources/comments/client/requests/CreateCommentParams.d.mts +13 -3
  109. package/dist/esm/api/resources/comments/client/requests/UpdateCommentParams.d.mts +11 -2
  110. package/dist/esm/api/resources/comments/index.d.mts +1 -0
  111. package/dist/esm/api/resources/comments/index.mjs +1 -0
  112. package/dist/esm/api/resources/comments/types/CommentsShowRequestInclude.d.mts +6 -0
  113. package/dist/esm/api/resources/comments/types/CommentsShowRequestInclude.mjs +6 -0
  114. package/dist/esm/api/resources/comments/types/index.d.mts +1 -0
  115. package/dist/esm/api/resources/comments/types/index.mjs +1 -0
  116. package/dist/esm/api/resources/files/client/Client.d.mts +16 -15
  117. package/dist/esm/api/resources/files/client/Client.mjs +33 -20
  118. package/dist/esm/api/resources/files/client/requests/FileCopyParams.d.mts +3 -0
  119. package/dist/esm/api/resources/folders/client/Client.d.mts +14 -12
  120. package/dist/esm/api/resources/folders/client/Client.mjs +31 -17
  121. package/dist/esm/api/resources/folders/client/requests/FolderCopyParams.d.mts +3 -0
  122. package/dist/esm/api/resources/index.d.mts +4 -2
  123. package/dist/esm/api/resources/index.mjs +4 -2
  124. package/dist/esm/api/resources/metadata/client/Client.d.mts +17 -14
  125. package/dist/esm/api/resources/metadata/client/Client.mjs +16 -17
  126. package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +13 -10
  127. package/dist/esm/api/resources/metadataFields/client/Client.d.mts +7 -7
  128. package/dist/esm/api/resources/metadataFields/client/Client.mjs +6 -10
  129. package/dist/esm/api/resources/projectPermissions/client/Client.d.mts +6 -6
  130. package/dist/esm/api/resources/projectPermissions/client/Client.mjs +5 -9
  131. package/dist/esm/api/resources/projects/client/Client.d.mts +15 -12
  132. package/dist/esm/api/resources/projects/client/Client.mjs +13 -14
  133. package/dist/esm/api/resources/projects/client/requests/ProjectParams.d.mts +20 -0
  134. package/dist/esm/api/resources/projects/client/requests/ProjectUpdateParams.d.mts +31 -0
  135. package/dist/esm/api/resources/projects/client/requests/ProjectUpdateParams.mjs +12 -0
  136. package/dist/esm/api/resources/projects/client/requests/index.d.mts +2 -0
  137. package/dist/esm/api/resources/shares/client/Client.d.mts +22 -20
  138. package/dist/esm/api/resources/shares/client/Client.mjs +21 -23
  139. package/dist/esm/api/resources/shares/client/requests/AddAssetParams.d.mts +1 -1
  140. package/dist/esm/api/resources/shares/client/requests/CreateShareParams.d.mts +3 -2
  141. package/dist/esm/api/resources/shares/client/requests/UpdateShareParams.d.mts +3 -1
  142. package/dist/esm/api/resources/users/client/Client.d.mts +4 -4
  143. package/dist/esm/api/resources/users/client/Client.mjs +3 -7
  144. package/dist/esm/api/resources/versionStacks/client/Client.d.mts +34 -10
  145. package/dist/esm/api/resources/versionStacks/client/Client.mjs +115 -15
  146. package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCopyParams.d.mts +3 -0
  147. package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +2 -2
  148. package/dist/esm/api/resources/versionStacks/client/requests/VersionStacksShowRequest.d.mts +11 -0
  149. package/dist/esm/api/resources/versionStacks/client/requests/VersionStacksShowRequest.mjs +2 -0
  150. package/dist/esm/api/resources/versionStacks/client/requests/index.d.mts +1 -0
  151. package/dist/esm/api/resources/versionStacks/index.d.mts +1 -0
  152. package/dist/esm/api/resources/versionStacks/index.mjs +1 -0
  153. package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.mts +13 -0
  154. package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.mjs +13 -0
  155. package/dist/esm/api/resources/versionStacks/types/index.d.mts +1 -0
  156. package/dist/esm/api/resources/versionStacks/types/index.mjs +1 -0
  157. package/dist/esm/api/resources/webhooks/client/Client.d.mts +7 -7
  158. package/dist/esm/api/resources/webhooks/client/Client.mjs +6 -10
  159. package/dist/esm/api/resources/workspacePermissions/client/Client.d.mts +6 -6
  160. package/dist/esm/api/resources/workspacePermissions/client/Client.mjs +5 -9
  161. package/dist/esm/api/resources/workspaces/client/Client.d.mts +8 -8
  162. package/dist/esm/api/resources/workspaces/client/Client.mjs +7 -11
  163. package/dist/esm/api/types/AssetCommonWithIncludes.d.mts +9 -0
  164. package/dist/esm/api/types/AssetCommonWithIncludes.mjs +8 -1
  165. package/dist/esm/api/types/AssetShareParams.d.mts +1 -0
  166. package/dist/esm/api/types/Comment.d.mts +6 -2
  167. package/dist/esm/api/types/DateDefinition.d.mts +16 -0
  168. package/dist/esm/api/types/DateDefinition.mjs +13 -0
  169. package/dist/esm/api/types/EmptyJson.d.mts +4 -0
  170. package/dist/esm/api/types/EmptyJson.mjs +2 -0
  171. package/dist/esm/api/types/FileWithMediaLinksInclude.d.mts +0 -1
  172. package/dist/esm/api/types/FileWithMediaLinksInclude.mjs +0 -1
  173. package/dist/esm/api/types/FolderWithIncludes.d.mts +9 -0
  174. package/dist/esm/api/types/FolderWithIncludes.mjs +8 -1
  175. package/dist/esm/api/types/LongTextDefinition.d.mts +16 -0
  176. package/dist/esm/api/types/LongTextDefinition.mjs +16 -1
  177. package/dist/esm/api/types/MultiUserValue.d.mts +1 -1
  178. package/dist/esm/api/types/Project.d.mts +12 -0
  179. package/dist/esm/api/types/Project.mjs +8 -1
  180. package/dist/esm/api/types/SelectMultiDefinition.d.mts +16 -0
  181. package/dist/esm/api/types/SelectMultiDefinition.mjs +16 -1
  182. package/dist/esm/api/types/TextDefinition.d.mts +16 -0
  183. package/dist/esm/api/types/TextDefinition.mjs +16 -1
  184. package/dist/esm/api/types/TimeStamp.d.mts +7 -0
  185. package/dist/esm/api/types/TimeStamp.mjs +2 -0
  186. package/dist/esm/api/types/UserMultiDefinition.d.mts +16 -0
  187. package/dist/esm/api/types/UserMultiDefinition.mjs +13 -0
  188. package/dist/esm/api/types/UserSingleDefinition.d.mts +16 -0
  189. package/dist/esm/api/types/UserSingleDefinition.mjs +13 -0
  190. package/dist/esm/api/types/VersionStackWithIncludes.d.mts +9 -0
  191. package/dist/esm/api/types/VersionStackWithIncludes.mjs +8 -1
  192. package/dist/esm/api/types/index.d.mts +3 -2
  193. package/dist/esm/api/types/index.mjs +3 -2
  194. package/dist/esm/version.d.mts +1 -1
  195. package/dist/esm/version.mjs +1 -1
  196. package/package.json +1 -1
  197. package/reference.md +384 -110
  198. package/dist/cjs/api/types/ProjectParams.d.ts +0 -12
  199. package/dist/esm/api/types/ProjectParams.d.mts +0 -12
  200. /package/dist/cjs/api/{types → resources/projects/client/requests}/ProjectParams.js +0 -0
  201. /package/dist/esm/api/{types → resources/projects/client/requests}/ProjectParams.mjs +0 -0
package/reference.md CHANGED
@@ -14,7 +14,7 @@
14
14
  <dl>
15
15
  <dd>
16
16
 
17
- Delete account level custom field definitions. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
17
+ Delete account level custom field definitions. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
18
18
 
19
19
  </dd>
20
20
  </dl>
@@ -88,7 +88,7 @@ await client.metadataFields.metadataFieldDefinitionsDelete(
88
88
  <dl>
89
89
  <dd>
90
90
 
91
- Update account level custom field definitions. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
91
+ Update account level custom field definitions. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
92
92
 
93
93
  </dd>
94
94
  </dl>
@@ -187,7 +187,7 @@ await client.metadataFields.metadataFieldDefinitionsUpdate(
187
187
  <dl>
188
188
  <dd>
189
189
 
190
- List account level field definitions. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
190
+ List account level field definitions. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
191
191
 
192
192
  </dd>
193
193
  </dl>
@@ -263,7 +263,7 @@ await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8b
263
263
  <dl>
264
264
  <dd>
265
265
 
266
- Create account level field definitions. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
266
+ Create account level field definitions. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
267
267
 
268
268
  </dd>
269
269
  </dl>
@@ -352,7 +352,7 @@ await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8
352
352
  <dl>
353
353
  <dd>
354
354
 
355
- List user roles for a given project. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
355
+ List user roles for a given project. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
356
356
 
357
357
  </dd>
358
358
  </dl>
@@ -368,12 +368,34 @@ List user roles for a given project. <br><br>Rate Limits: 100 calls per 1.00 min
368
368
  <dd>
369
369
 
370
370
  ```typescript
371
- await client.projectPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
372
- include_deactivated: true,
373
- after: "<opaque_cursor>",
374
- page_size: 10,
375
- include_total_count: false,
376
- });
371
+ const response = await client.projectPermissions.index(
372
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
373
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
374
+ {
375
+ include_deactivated: true,
376
+ after: "<opaque_cursor>",
377
+ page_size: 10,
378
+ include_total_count: false,
379
+ },
380
+ );
381
+ for await (const item of response) {
382
+ console.log(item);
383
+ }
384
+
385
+ // Or you can manually iterate page-by-page
386
+ let page = await client.projectPermissions.index(
387
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
388
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
389
+ {
390
+ include_deactivated: true,
391
+ after: "<opaque_cursor>",
392
+ page_size: 10,
393
+ include_total_count: false,
394
+ },
395
+ );
396
+ while (page.hasNextPage()) {
397
+ page = page.getNextPage();
398
+ }
377
399
  ```
378
400
 
379
401
  </dd>
@@ -436,7 +458,7 @@ await client.projectPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b
436
458
  <dl>
437
459
  <dd>
438
460
 
439
- Remove a user from a given project. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
461
+ Remove a user from a given project. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
440
462
 
441
463
  </dd>
442
464
  </dl>
@@ -520,7 +542,7 @@ await client.projectPermissions.delete(
520
542
  <dd>
521
543
 
522
544
  Update user roles for the given project if the user is already added to the project. If the user is
523
- not added to the project, the user will be added with the given role. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
545
+ not added to the project, the user will be added with the given role. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
524
546
 
525
547
  </dd>
526
548
  </dl>
@@ -618,7 +640,7 @@ await client.projectPermissions.projectUserRolesUpdate(
618
640
  <dl>
619
641
  <dd>
620
642
 
621
- Show folder details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
643
+ Show folder details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
622
644
 
623
645
  </dd>
624
646
  </dl>
@@ -699,7 +721,7 @@ await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
699
721
  <dl>
700
722
  <dd>
701
723
 
702
- Delete folder by id.
724
+ Delete folder by id. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
703
725
 
704
726
  </dd>
705
727
  </dl>
@@ -770,7 +792,7 @@ await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
770
792
  <dl>
771
793
  <dd>
772
794
 
773
- Update folder details.
795
+ Update folder details. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
774
796
 
775
797
  </dd>
776
798
  </dl>
@@ -854,9 +876,9 @@ await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
854
876
  <dd>
855
877
 
856
878
  List the children in the given folder.
857
- <br><br>
879
+ <br>
858
880
  Use the `include` query parameter to selectively include additional properties in the response.
859
- <br><br>
881
+ <br>
860
882
  Note: if you include `media_links.original` and the user does not have permission to download files
861
883
  in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
862
884
  If the content is inaccessible because watermarking is required for this user and isn't supported by
@@ -865,6 +887,7 @@ Similarly, if a requested transcode link does not exist for a particular file (e
865
887
  `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
866
888
  (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
867
889
  null in the response payload. In short, the client must handle null media links gracefully.
890
+ <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
868
891
 
869
892
  </dd>
870
893
  </dl>
@@ -949,7 +972,7 @@ await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
949
972
  <dl>
950
973
  <dd>
951
974
 
952
- Copy folder. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
975
+ Copy folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
953
976
 
954
977
  </dd>
955
978
  </dl>
@@ -966,6 +989,7 @@ Copy folder. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
966
989
 
967
990
  ```typescript
968
991
  await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
992
+ copy_metadata: true,
969
993
  data: {
970
994
  parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
971
995
  },
@@ -1032,7 +1056,7 @@ await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1032
1056
  <dl>
1033
1057
  <dd>
1034
1058
 
1035
- List folders in a given folder. <br><br>Rate Limits: 5 calls per 1 second(s) per account
1059
+ List folders in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per account_user
1036
1060
 
1037
1061
  </dd>
1038
1062
  </dl>
@@ -1116,7 +1140,7 @@ await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1116
1140
  <dl>
1117
1141
  <dd>
1118
1142
 
1119
- Create a new folder inside the given <i>folder_id</i> path param. <br><br>Rate Limits: 3 calls per 1 second(s) per account
1143
+ Create a new folder inside the given <i>folder_id</i> path param. <br>Rate Limits: 3 calls per 1 second(s) per account_user
1120
1144
 
1121
1145
  </dd>
1122
1146
  </dl>
@@ -1199,7 +1223,7 @@ await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
1199
1223
  <dl>
1200
1224
  <dd>
1201
1225
 
1202
- Move folder to a folder. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
1226
+ Move folder to a folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1203
1227
 
1204
1228
  </dd>
1205
1229
  </dl>
@@ -1285,9 +1309,9 @@ await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1285
1309
  <dd>
1286
1310
 
1287
1311
  List the children (files) in a given version stack.
1288
- <br><br>
1312
+ <br>
1289
1313
  Use the `include` query parameter to selectively include additional properties in the response.
1290
- <br><br>
1314
+ <br>
1291
1315
  Note: if you include `media_links.original` and the user does not have permission to download files
1292
1316
  in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
1293
1317
  If the content is inaccessible because watermarking is required for this user and isn't supported by
@@ -1296,6 +1320,7 @@ Similarly, if a requested transcode link does not exist for a particular file (e
1296
1320
  `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
1297
1321
  (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
1298
1322
  null in the response payload. In short, the client must handle null media links gracefully.
1323
+ <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1299
1324
 
1300
1325
  </dd>
1301
1326
  </dl>
@@ -1367,6 +1392,87 @@ await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
1367
1392
  </dl>
1368
1393
  </details>
1369
1394
 
1395
+ <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">show</a>(accountId, versionStackId, { ...params }) -> Frameio.VersionStackWithIncludesResponse</code></summary>
1396
+ <dl>
1397
+ <dd>
1398
+
1399
+ #### 📝 Description
1400
+
1401
+ <dl>
1402
+ <dd>
1403
+
1404
+ <dl>
1405
+ <dd>
1406
+
1407
+ Show version stack details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1408
+
1409
+ </dd>
1410
+ </dl>
1411
+ </dd>
1412
+ </dl>
1413
+
1414
+ #### 🔌 Usage
1415
+
1416
+ <dl>
1417
+ <dd>
1418
+
1419
+ <dl>
1420
+ <dd>
1421
+
1422
+ ```typescript
1423
+ await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1424
+ include: "media_links",
1425
+ });
1426
+ ```
1427
+
1428
+ </dd>
1429
+ </dl>
1430
+ </dd>
1431
+ </dl>
1432
+
1433
+ #### ⚙️ Parameters
1434
+
1435
+ <dl>
1436
+ <dd>
1437
+
1438
+ <dl>
1439
+ <dd>
1440
+
1441
+ **accountId:** `Frameio.Uuid` —
1442
+
1443
+ </dd>
1444
+ </dl>
1445
+
1446
+ <dl>
1447
+ <dd>
1448
+
1449
+ **versionStackId:** `Frameio.Uuid` —
1450
+
1451
+ </dd>
1452
+ </dl>
1453
+
1454
+ <dl>
1455
+ <dd>
1456
+
1457
+ **request:** `Frameio.VersionStacksShowRequest`
1458
+
1459
+ </dd>
1460
+ </dl>
1461
+
1462
+ <dl>
1463
+ <dd>
1464
+
1465
+ **requestOptions:** `VersionStacks.RequestOptions`
1466
+
1467
+ </dd>
1468
+ </dl>
1469
+ </dd>
1470
+ </dl>
1471
+
1472
+ </dd>
1473
+ </dl>
1474
+ </details>
1475
+
1370
1476
  <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">copy</a>(accountId, versionStackId, { ...params }) -> Frameio.VersionStackCopyResponse</code></summary>
1371
1477
  <dl>
1372
1478
  <dd>
@@ -1379,7 +1485,7 @@ await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
1379
1485
  <dl>
1380
1486
  <dd>
1381
1487
 
1382
- Copy version stack. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
1488
+ Copy version stack. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1383
1489
 
1384
1490
  </dd>
1385
1491
  </dl>
@@ -1396,6 +1502,7 @@ Copy version stack. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
1396
1502
 
1397
1503
  ```typescript
1398
1504
  await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1505
+ copy_metadata: true,
1399
1506
  data: {
1400
1507
  parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
1401
1508
  },
@@ -1462,7 +1569,7 @@ await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1462
1569
  <dl>
1463
1570
  <dd>
1464
1571
 
1465
- List version stacks in a given folder
1572
+ List version stacks in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per account_user
1466
1573
 
1467
1574
  </dd>
1468
1575
  </dl>
@@ -1546,7 +1653,7 @@ await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1546
1653
  <dl>
1547
1654
  <dd>
1548
1655
 
1549
- Create a new Version Stack under the parent folder. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
1656
+ Create a new Version Stack under the parent folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1550
1657
 
1551
1658
  </dd>
1552
1659
  </dl>
@@ -1564,7 +1671,7 @@ Create a new Version Stack under the parent folder. <br><br>Rate Limits: 10 call
1564
1671
  ```typescript
1565
1672
  await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1566
1673
  data: {
1567
- file_ids: ["42ea4547-c102-4f10-afc7-712c1aa0cf44", "77776eea-0d9e-486d-8880-7b63f5e5d83b"],
1674
+ file_ids: ["f964b3e0-7286-4187-9c10-2aef68111366", "2b805a91-0a5b-47fd-93c9-87e41da01fe4"],
1568
1675
  },
1569
1676
  });
1570
1677
  ```
@@ -1629,7 +1736,7 @@ await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702
1629
1736
  <dl>
1630
1737
  <dd>
1631
1738
 
1632
- Move version stack to a folder. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
1739
+ Move version stack to a folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1633
1740
 
1634
1741
  </dd>
1635
1742
  </dl>
@@ -1714,7 +1821,7 @@ await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1714
1821
  <dl>
1715
1822
  <dd>
1716
1823
 
1717
- List user roles for a given account. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
1824
+ List user roles for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1718
1825
 
1719
1826
  </dd>
1720
1827
  </dl>
@@ -1730,12 +1837,26 @@ List user roles for a given account. <br><br>Rate Limits: 100 calls per 1.00 min
1730
1837
  <dd>
1731
1838
 
1732
1839
  ```typescript
1733
- await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1840
+ const response = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1734
1841
  include_deactivated: true,
1735
1842
  after: "<opaque_cursor>",
1736
1843
  page_size: 10,
1737
1844
  include_total_count: false,
1738
1845
  });
1846
+ for await (const item of response) {
1847
+ console.log(item);
1848
+ }
1849
+
1850
+ // Or you can manually iterate page-by-page
1851
+ let page = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1852
+ include_deactivated: true,
1853
+ after: "<opaque_cursor>",
1854
+ page_size: 10,
1855
+ include_total_count: false,
1856
+ });
1857
+ while (page.hasNextPage()) {
1858
+ page = page.getNextPage();
1859
+ }
1739
1860
  ```
1740
1861
 
1741
1862
  </dd>
@@ -1792,7 +1913,7 @@ await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1792
1913
  <dl>
1793
1914
  <dd>
1794
1915
 
1795
- List accounts for the current user. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
1916
+ List accounts for the current user. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1796
1917
 
1797
1918
  </dd>
1798
1919
  </dl>
@@ -1808,11 +1929,24 @@ List accounts for the current user. <br><br>Rate Limits: 100 calls per 1.00 minu
1808
1929
  <dd>
1809
1930
 
1810
1931
  ```typescript
1811
- await client.accounts.index({
1932
+ const response = await client.accounts.index({
1812
1933
  after: "<opaque_cursor>",
1813
1934
  page_size: 10,
1814
1935
  include_total_count: false,
1815
1936
  });
1937
+ for await (const item of response) {
1938
+ console.log(item);
1939
+ }
1940
+
1941
+ // Or you can manually iterate page-by-page
1942
+ let page = await client.accounts.index({
1943
+ after: "<opaque_cursor>",
1944
+ page_size: 10,
1945
+ include_total_count: false,
1946
+ });
1947
+ while (page.hasNextPage()) {
1948
+ page = page.getNextPage();
1949
+ }
1816
1950
  ```
1817
1951
 
1818
1952
  </dd>
@@ -1861,7 +1995,7 @@ await client.accounts.index({
1861
1995
  <dl>
1862
1996
  <dd>
1863
1997
 
1864
- Show a single comment on a file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
1998
+ Show a single comment on a file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1865
1999
 
1866
2000
  </dd>
1867
2001
  </dl>
@@ -1942,7 +2076,7 @@ await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
1942
2076
  <dl>
1943
2077
  <dd>
1944
2078
 
1945
- Delete comment from an asset. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
2079
+ Delete comment from an asset. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
1946
2080
 
1947
2081
  </dd>
1948
2082
  </dl>
@@ -2013,7 +2147,7 @@ await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2013
2147
  <dl>
2014
2148
  <dd>
2015
2149
 
2016
- Update comment on given asset. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
2150
+ Update comment on given asset. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
2017
2151
 
2018
2152
  </dd>
2019
2153
  </dl>
@@ -2030,7 +2164,11 @@ Update comment on given asset. <br><br>Rate Limits: 10 calls per 1.00 minute(s)
2030
2164
 
2031
2165
  ```typescript
2032
2166
  await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2167
+ timestamp_as_timecode: true,
2033
2168
  data: {
2169
+ annotation:
2170
+ '[{"tool":"rect","color":"#F22237","size":8,"x":0.277726001863933,"y":0.12909555568499534,"w":0.3153168321877913,"h":0.5308131407269339,"ix":0.277726001863933,"iy":0.12909555568499534,"radius":8}]',
2171
+ completed: false,
2034
2172
  page: 4,
2035
2173
  text: "This is great!",
2036
2174
  },
@@ -2097,7 +2235,7 @@ await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2097
2235
  <dl>
2098
2236
  <dd>
2099
2237
 
2100
- List comments on a given asset. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
2238
+ List comments on a given asset. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2101
2239
 
2102
2240
  </dd>
2103
2241
  </dl>
@@ -2113,12 +2251,30 @@ List comments on a given asset. <br><br>Rate Limits: 100 calls per 1.00 minute(s
2113
2251
  <dd>
2114
2252
 
2115
2253
  ```typescript
2116
- await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2254
+ const response = await client.comments.index(
2255
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
2256
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
2257
+ {
2258
+ include: "owner",
2259
+ after: "<opaque_cursor>",
2260
+ page_size: 10,
2261
+ include_total_count: false,
2262
+ },
2263
+ );
2264
+ for await (const item of response) {
2265
+ console.log(item);
2266
+ }
2267
+
2268
+ // Or you can manually iterate page-by-page
2269
+ let page = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2117
2270
  include: "owner",
2118
2271
  after: "<opaque_cursor>",
2119
2272
  page_size: 10,
2120
2273
  include_total_count: false,
2121
2274
  });
2275
+ while (page.hasNextPage()) {
2276
+ page = page.getNextPage();
2277
+ }
2122
2278
  ```
2123
2279
 
2124
2280
  </dd>
@@ -2181,7 +2337,7 @@ await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
2181
2337
  <dl>
2182
2338
  <dd>
2183
2339
 
2184
- Create a comment on a file. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
2340
+ Create a comment on a file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2185
2341
 
2186
2342
  </dd>
2187
2343
  </dl>
@@ -2198,9 +2354,14 @@ Create a comment on a file. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per
2198
2354
 
2199
2355
  ```typescript
2200
2356
  await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2357
+ timestamp_as_timecode: true,
2201
2358
  data: {
2359
+ annotation:
2360
+ '[{"tool":"rect","color":"#F22237","size":8,"x":0.277726001863933,"y":0.12909555568499534,"w":0.3153168321877913,"h":0.5308131407269339,"ix":0.277726001863933,"iy":0.12909555568499534,"radius":8}]',
2361
+ completed: false,
2202
2362
  page: 4,
2203
2363
  text: "This is great!",
2364
+ timestamp: "00:00:02:12",
2204
2365
  },
2205
2366
  });
2206
2367
  ```
@@ -2267,7 +2428,7 @@ await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2267
2428
  <dl>
2268
2429
  <dd>
2269
2430
 
2270
- List webhooks for the given workspace. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
2431
+ List webhooks for the given workspace. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2271
2432
 
2272
2433
  </dd>
2273
2434
  </dl>
@@ -2283,12 +2444,30 @@ List webhooks for the given workspace. <br><br>Rate Limits: 100 calls per 1.00 m
2283
2444
  <dd>
2284
2445
 
2285
2446
  ```typescript
2286
- await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2447
+ const response = await client.webhooks.index(
2448
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
2449
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
2450
+ {
2451
+ include: "creator",
2452
+ after: "<opaque_cursor>",
2453
+ page_size: 10,
2454
+ include_total_count: false,
2455
+ },
2456
+ );
2457
+ for await (const item of response) {
2458
+ console.log(item);
2459
+ }
2460
+
2461
+ // Or you can manually iterate page-by-page
2462
+ let page = await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2287
2463
  include: "creator",
2288
2464
  after: "<opaque_cursor>",
2289
2465
  page_size: 10,
2290
2466
  include_total_count: false,
2291
2467
  });
2468
+ while (page.hasNextPage()) {
2469
+ page = page.getNextPage();
2470
+ }
2292
2471
  ```
2293
2472
 
2294
2473
  </dd>
@@ -2497,7 +2676,7 @@ await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2497
2676
  <dl>
2498
2677
  <dd>
2499
2678
 
2500
- Show webhook details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
2679
+ Show webhook details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2501
2680
 
2502
2681
  </dd>
2503
2682
  </dl>
@@ -2578,7 +2757,7 @@ await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2578
2757
  <dl>
2579
2758
  <dd>
2580
2759
 
2581
- Delete a webhook. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
2760
+ Delete a webhook. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
2582
2761
 
2583
2762
  </dd>
2584
2763
  </dl>
@@ -2649,7 +2828,7 @@ await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2649
2828
  <dl>
2650
2829
  <dd>
2651
2830
 
2652
- Update webhook details. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
2831
+ Update webhook details. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
2653
2832
 
2654
2833
  </dd>
2655
2834
  </dl>
@@ -2768,7 +2947,7 @@ await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2768
2947
  <dl>
2769
2948
  <dd>
2770
2949
 
2771
- List user roles for a given workspace. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
2950
+ List user roles for a given workspace. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2772
2951
 
2773
2952
  </dd>
2774
2953
  </dl>
@@ -2784,7 +2963,22 @@ List user roles for a given workspace. <br><br>Rate Limits: 100 calls per 1.00 m
2784
2963
  <dd>
2785
2964
 
2786
2965
  ```typescript
2787
- await client.workspacePermissions.index(
2966
+ const response = await client.workspacePermissions.index(
2967
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
2968
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
2969
+ {
2970
+ include_deactivated: true,
2971
+ after: "<opaque_cursor>",
2972
+ page_size: 10,
2973
+ include_total_count: false,
2974
+ },
2975
+ );
2976
+ for await (const item of response) {
2977
+ console.log(item);
2978
+ }
2979
+
2980
+ // Or you can manually iterate page-by-page
2981
+ let page = await client.workspacePermissions.index(
2788
2982
  "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
2789
2983
  "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
2790
2984
  {
@@ -2794,6 +2988,9 @@ await client.workspacePermissions.index(
2794
2988
  include_total_count: false,
2795
2989
  },
2796
2990
  );
2991
+ while (page.hasNextPage()) {
2992
+ page = page.getNextPage();
2993
+ }
2797
2994
  ```
2798
2995
 
2799
2996
  </dd>
@@ -2856,7 +3053,7 @@ await client.workspacePermissions.index(
2856
3053
  <dl>
2857
3054
  <dd>
2858
3055
 
2859
- Remove a user from a given workspace. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
3056
+ Remove a user from a given workspace. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
2860
3057
 
2861
3058
  </dd>
2862
3059
  </dl>
@@ -2940,7 +3137,7 @@ await client.workspacePermissions.workspaceUserRolesDelete(
2940
3137
  <dd>
2941
3138
 
2942
3139
  Update user roles for the given workspace if the user is already added to the workspace. If the user is
2943
- not added to the workspace, the user will be added with the given role. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
3140
+ not added to the workspace, the user will be added with the given role. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
2944
3141
 
2945
3142
  </dd>
2946
3143
  </dl>
@@ -3038,7 +3235,7 @@ await client.workspacePermissions.workspaceUserRolesUpdate(
3038
3235
  <dl>
3039
3236
  <dd>
3040
3237
 
3041
- Show a single Share. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
3238
+ Show a single Share. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3042
3239
 
3043
3240
  </dd>
3044
3241
  </dl>
@@ -3109,7 +3306,7 @@ await client.shares.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-
3109
3306
  <dl>
3110
3307
  <dd>
3111
3308
 
3112
- Delete a share. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
3309
+ Delete a share. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
3113
3310
 
3114
3311
  </dd>
3115
3312
  </dl>
@@ -3180,7 +3377,7 @@ await client.shares.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
3180
3377
  <dl>
3181
3378
  <dd>
3182
3379
 
3183
- Update share. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
3380
+ Update share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3184
3381
 
3185
3382
  </dd>
3186
3383
  </dl>
@@ -3200,7 +3397,8 @@ await client.shares.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
3200
3397
  data: {
3201
3398
  access: "public",
3202
3399
  description: "A descriptive summary of the share",
3203
- expiration: "2025-09-24T00:35:53Z",
3400
+ downloading_enabled: true,
3401
+ expiration: "2025-12-17T02:04:49Z",
3204
3402
  name: "Share Name",
3205
3403
  passphrase: "as!dfj39sd(*",
3206
3404
  },
@@ -3267,7 +3465,7 @@ await client.shares.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
3267
3465
  <dl>
3268
3466
  <dd>
3269
3467
 
3270
- List share reviewers. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
3468
+ List share reviewers. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3271
3469
 
3272
3470
  </dd>
3273
3471
  </dl>
@@ -3283,11 +3481,32 @@ List share reviewers. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per accou
3283
3481
  <dd>
3284
3482
 
3285
3483
  ```typescript
3286
- await client.shares.listReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3287
- after: "<opaque_cursor>",
3288
- page_size: 10,
3289
- include_total_count: false,
3290
- });
3484
+ const response = await client.shares.listReviewers(
3485
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3486
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3487
+ {
3488
+ after: "<opaque_cursor>",
3489
+ page_size: 10,
3490
+ include_total_count: false,
3491
+ },
3492
+ );
3493
+ for await (const item of response) {
3494
+ console.log(item);
3495
+ }
3496
+
3497
+ // Or you can manually iterate page-by-page
3498
+ let page = await client.shares.listReviewers(
3499
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3500
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3501
+ {
3502
+ after: "<opaque_cursor>",
3503
+ page_size: 10,
3504
+ include_total_count: false,
3505
+ },
3506
+ );
3507
+ while (page.hasNextPage()) {
3508
+ page = page.getNextPage();
3509
+ }
3291
3510
  ```
3292
3511
 
3293
3512
  </dd>
@@ -3351,11 +3570,11 @@ await client.shares.listReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702
3351
3570
  <dd>
3352
3571
 
3353
3572
  Add reviewers to secure share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
3354
- <br><br>
3573
+ <br>
3355
3574
  A request can only include one identifier type parameter.
3356
- <br><br>
3575
+ <br>
3357
3576
  `email` is the only identifier able to add reviewers to a Share who don't have a Frame account member on the account where the Share belongs.
3358
- <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
3577
+ <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3359
3578
 
3360
3579
  </dd>
3361
3580
  </dl>
@@ -3442,9 +3661,9 @@ await client.shares.addReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
3442
3661
  <dd>
3443
3662
 
3444
3663
  Removes reviewers from secure Share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
3445
- <br><br>
3664
+ <br>
3446
3665
  A request can only include one identifier type parameter.
3447
- <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
3666
+ <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3448
3667
 
3449
3668
  </dd>
3450
3669
  </dl>
@@ -3529,7 +3748,7 @@ await client.shares.removeReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b27
3529
3748
  <dl>
3530
3749
  <dd>
3531
3750
 
3532
- Remove an asset currently in the share from that share. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
3751
+ Remove an asset currently in the share from that share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3533
3752
 
3534
3753
  </dd>
3535
3754
  </dl>
@@ -3612,7 +3831,7 @@ await client.shares.removeAsset(
3612
3831
  <dl>
3613
3832
  <dd>
3614
3833
 
3615
- Add new asset share. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
3834
+ Add new asset share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3616
3835
 
3617
3836
  </dd>
3618
3837
  </dl>
@@ -3630,7 +3849,7 @@ Add new asset share. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per accoun
3630
3849
  ```typescript
3631
3850
  await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3632
3851
  data: {
3633
- asset_id: "246c7f46-b3c5-432d-8c54-e3b9d81abf41",
3852
+ asset_id: "68f9a51b-d4e1-43be-bfce-08adac91e4e1",
3634
3853
  },
3635
3854
  });
3636
3855
  ```
@@ -3695,7 +3914,7 @@ await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
3695
3914
  <dl>
3696
3915
  <dd>
3697
3916
 
3698
- List shares on a project. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
3917
+ List shares on a project. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3699
3918
 
3700
3919
  </dd>
3701
3920
  </dl>
@@ -3711,11 +3930,28 @@ List shares on a project. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per
3711
3930
  <dd>
3712
3931
 
3713
3932
  ```typescript
3714
- await client.shares.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3933
+ const response = await client.shares.index(
3934
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3935
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3936
+ {
3937
+ after: "<opaque_cursor>",
3938
+ page_size: 10,
3939
+ include_total_count: false,
3940
+ },
3941
+ );
3942
+ for await (const item of response) {
3943
+ console.log(item);
3944
+ }
3945
+
3946
+ // Or you can manually iterate page-by-page
3947
+ let page = await client.shares.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3715
3948
  after: "<opaque_cursor>",
3716
3949
  page_size: 10,
3717
3950
  include_total_count: false,
3718
3951
  });
3952
+ while (page.hasNextPage()) {
3953
+ page = page.getNextPage();
3954
+ }
3719
3955
  ```
3720
3956
 
3721
3957
  </dd>
@@ -3778,7 +4014,7 @@ await client.shares.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
3778
4014
  <dl>
3779
4015
  <dd>
3780
4016
 
3781
- Create share. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
4017
+ Create share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3782
4018
 
3783
4019
  </dd>
3784
4020
  </dl>
@@ -3798,8 +4034,9 @@ await client.shares.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
3798
4034
  data: {
3799
4035
  type: "asset",
3800
4036
  access: "public",
3801
- asset_ids: ["302354e6-dfe6-47ed-9f81-cfb8d98137a5", "f379ade6-8779-414c-9014-269aaaa14e98"],
3802
- expiration: "2025-09-24T00:35:53Z",
4037
+ asset_ids: ["31771855-14a4-427b-8efe-6355127f983c", "8ed9a3b2-d458-46a6-b494-4b54a3c4d16d"],
4038
+ downloading_enabled: true,
4039
+ expiration: "2025-12-17T02:04:49Z",
3803
4040
  name: "Share Name",
3804
4041
  passphrase: "as!dfj39sd(*",
3805
4042
  },
@@ -3868,7 +4105,7 @@ await client.shares.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
3868
4105
  <dl>
3869
4106
  <dd>
3870
4107
 
3871
- Update metadata values across multiple files. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
4108
+ Update metadata values across multiple files. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3872
4109
 
3873
4110
  </dd>
3874
4111
  </dl>
@@ -3886,19 +4123,20 @@ Update metadata values across multiple files. <br><br>Rate Limits: 10 calls per
3886
4123
  ```typescript
3887
4124
  await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3888
4125
  data: {
3889
- file_ids: ["90d56890-76ff-46f0-ba5c-4e3c6eea01e1", "2a20ca3b-b124-4b5e-acc4-51f03dbf10ab"],
4126
+ file_ids: ["8615b40d-f398-470f-8bee-2695cfe9275b", "a9cf461d-aa6d-42f5-880b-d1702ebe8663"],
3890
4127
  values: [
3891
4128
  {
3892
- field_definition_id: "8d4fa2a4-83e1-4adc-81eb-2f10e4f52cc0",
3893
- value: "active",
3894
- },
3895
- {
3896
- field_definition_id: "deca9ec9-9ecb-457c-9c05-fee6d5cfb4dc",
3897
- value: 5,
3898
- },
3899
- {
3900
- field_definition_id: "ecf44d7b-68b7-4ef7-9fb6-3f43bf7c1c25",
3901
- value: "1e6be645-bf76-4914-9de9-c567be3ee2a4",
4129
+ field_definition_id: "2e8ae39f-3647-4b81-a770-9f0d7c2442bf",
4130
+ value: [
4131
+ {
4132
+ id: "de7ba8c7-6147-4d05-9f45-cc3dca6bdd83",
4133
+ type: "user",
4134
+ },
4135
+ {
4136
+ id: "1d28fbed-5f19-406e-9493-1c0bd97a833e",
4137
+ type: "account_user_group",
4138
+ },
4139
+ ],
3902
4140
  },
3903
4141
  ],
3904
4142
  },
@@ -3965,7 +4203,7 @@ await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
3965
4203
  <dl>
3966
4204
  <dd>
3967
4205
 
3968
- Show the metadata of a file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
4206
+ Show the metadata of a file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3969
4207
 
3970
4208
  </dd>
3971
4209
  </dl>
@@ -4048,7 +4286,7 @@ await client.metadata.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
4048
4286
  <dl>
4049
4287
  <dd>
4050
4288
 
4051
- List files in a given folder. <br><br>Rate Limits: 5 calls per 1 second(s) per account
4289
+ List files in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per account_user
4052
4290
 
4053
4291
  </dd>
4054
4292
  </dl>
@@ -4132,7 +4370,7 @@ await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4
4132
4370
  <dl>
4133
4371
  <dd>
4134
4372
 
4135
- Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br><br>Rate Limits: 5 calls per 1 second(s) per account
4373
+ Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br>Rate Limits: 5 calls per 1 second(s) per account_user
4136
4374
 
4137
4375
  </dd>
4138
4376
  </dl>
@@ -4218,9 +4456,9 @@ await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
4218
4456
  <dd>
4219
4457
 
4220
4458
  Show file details.
4221
- <br><br>
4459
+ <br>
4222
4460
  Use the `include` query parameter to selectively include additional properties in the response.
4223
- <br><br>
4461
+ <br>
4224
4462
  Note: if you include `media_links.original` and the user does not have permission to download the file
4225
4463
  then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
4226
4464
  watermarking is required for this user and isn't supported by the requested media_links, then the request will
@@ -4229,7 +4467,7 @@ Similarly, if a requested transcode link does not exist for a particular file (e
4229
4467
  `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
4230
4468
  (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
4231
4469
  the response payload. In short, the client must handle null media links gracefully.
4232
- <br><br>Rate Limits: 5 calls per 1 second(s) per account
4470
+ <br>Rate Limits: 5 calls per 1 second(s) per account_user
4233
4471
 
4234
4472
  </dd>
4235
4473
  </dl>
@@ -4310,7 +4548,7 @@ await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4
4310
4548
  <dl>
4311
4549
  <dd>
4312
4550
 
4313
- Delete file by ID. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
4551
+ Delete file by ID. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
4314
4552
 
4315
4553
  </dd>
4316
4554
  </dl>
@@ -4381,7 +4619,7 @@ await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
4381
4619
  <dl>
4382
4620
  <dd>
4383
4621
 
4384
- Update file details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
4622
+ Update file details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
4385
4623
 
4386
4624
  </dd>
4387
4625
  </dl>
@@ -4464,7 +4702,7 @@ await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
4464
4702
  <dl>
4465
4703
  <dd>
4466
4704
 
4467
- Copy file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
4705
+ Copy file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
4468
4706
 
4469
4707
  </dd>
4470
4708
  </dl>
@@ -4481,6 +4719,7 @@ Copy file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
4481
4719
 
4482
4720
  ```typescript
4483
4721
  await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
4722
+ copy_metadata: true,
4484
4723
  data: {
4485
4724
  parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4486
4725
  },
@@ -4547,7 +4786,7 @@ await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4
4547
4786
  <dl>
4548
4787
  <dd>
4549
4788
 
4550
- Create new file under parent folder through remote upload. <br><br>Rate Limits: 5 calls per 1 second(s) per account
4789
+ Create new file under parent folder through remote upload. <br>Rate Limits: 5 calls per 1 second(s) per account_user
4551
4790
 
4552
4791
  </dd>
4553
4792
  </dl>
@@ -4631,7 +4870,7 @@ await client.files.createRemoteUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b
4631
4870
  <dl>
4632
4871
  <dd>
4633
4872
 
4634
- Move file to a folder or version_stack. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
4873
+ Move file to a folder or version_stack. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
4635
4874
 
4636
4875
  </dd>
4637
4876
  </dl>
@@ -4714,7 +4953,7 @@ await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4
4714
4953
  <dl>
4715
4954
  <dd>
4716
4955
 
4717
- Create new file under parent folder through local upload. <br><br>Rate Limits: 5 calls per 1 second(s) per account
4956
+ Create new file under parent folder through local upload. <br>Rate Limits: 5 calls per 1 second(s) per account_user
4718
4957
 
4719
4958
  </dd>
4720
4959
  </dl>
@@ -4798,7 +5037,7 @@ await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2
4798
5037
  <dl>
4799
5038
  <dd>
4800
5039
 
4801
- Show file upload status details. <br><br>Rate Limits: 5 calls per 1 second(s) per account
5040
+ Show file upload status details. <br>Rate Limits: 5 calls per 1 second(s) per account_user
4802
5041
 
4803
5042
  </dd>
4804
5043
  </dl>
@@ -4871,7 +5110,7 @@ await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4871
5110
  <dl>
4872
5111
  <dd>
4873
5112
 
4874
- Inspect details of the user associated with the bearer token. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
5113
+ Inspect details of the user associated with the bearer token. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
4875
5114
 
4876
5115
  </dd>
4877
5116
  </dl>
@@ -4928,7 +5167,7 @@ await client.users.show();
4928
5167
  <dl>
4929
5168
  <dd>
4930
5169
 
4931
- Show project details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
5170
+ Show project details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
4932
5171
 
4933
5172
  </dd>
4934
5173
  </dl>
@@ -5009,7 +5248,7 @@ await client.projects.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
5009
5248
  <dl>
5010
5249
  <dd>
5011
5250
 
5012
- Delete a project. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
5251
+ Delete a project. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
5013
5252
 
5014
5253
  </dd>
5015
5254
  </dl>
@@ -5080,7 +5319,7 @@ await client.projects.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
5080
5319
  <dl>
5081
5320
  <dd>
5082
5321
 
5083
- Update project details. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
5322
+ Update project details. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
5084
5323
 
5085
5324
  </dd>
5086
5325
  </dl>
@@ -5099,6 +5338,8 @@ Update project details. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per acc
5099
5338
  await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5100
5339
  data: {
5101
5340
  name: "Project Name",
5341
+ restricted: true,
5342
+ status: "active",
5102
5343
  },
5103
5344
  });
5104
5345
  ```
@@ -5132,7 +5373,7 @@ await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
5132
5373
  <dl>
5133
5374
  <dd>
5134
5375
 
5135
- **request:** `Frameio.ProjectParams`
5376
+ **request:** `Frameio.ProjectUpdateParams`
5136
5377
 
5137
5378
  </dd>
5138
5379
  </dl>
@@ -5163,7 +5404,7 @@ await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
5163
5404
  <dl>
5164
5405
  <dd>
5165
5406
 
5166
- List projects in a given workspace. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
5407
+ List projects in a given workspace. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
5167
5408
 
5168
5409
  </dd>
5169
5410
  </dl>
@@ -5179,12 +5420,30 @@ List projects in a given workspace. <br><br>Rate Limits: 100 calls per 1.00 minu
5179
5420
  <dd>
5180
5421
 
5181
5422
  ```typescript
5182
- await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5423
+ const response = await client.projects.index(
5424
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5425
+ "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5426
+ {
5427
+ include: "owner",
5428
+ after: "<opaque_cursor>",
5429
+ page_size: 10,
5430
+ include_total_count: false,
5431
+ },
5432
+ );
5433
+ for await (const item of response) {
5434
+ console.log(item);
5435
+ }
5436
+
5437
+ // Or you can manually iterate page-by-page
5438
+ let page = await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5183
5439
  include: "owner",
5184
5440
  after: "<opaque_cursor>",
5185
5441
  page_size: 10,
5186
5442
  include_total_count: false,
5187
5443
  });
5444
+ while (page.hasNextPage()) {
5445
+ page = page.getNextPage();
5446
+ }
5188
5447
  ```
5189
5448
 
5190
5449
  </dd>
@@ -5247,7 +5506,7 @@ await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
5247
5506
  <dl>
5248
5507
  <dd>
5249
5508
 
5250
- Create project in a given workspace. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
5509
+ Create project in a given workspace. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
5251
5510
 
5252
5511
  </dd>
5253
5512
  </dl>
@@ -5266,6 +5525,7 @@ Create project in a given workspace. <br><br>Rate Limits: 10 calls per 1.00 minu
5266
5525
  await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5267
5526
  data: {
5268
5527
  name: "Project Name",
5528
+ restricted: true,
5269
5529
  },
5270
5530
  });
5271
5531
  ```
@@ -5332,7 +5592,7 @@ await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
5332
5592
  <dl>
5333
5593
  <dd>
5334
5594
 
5335
- Show workspace details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
5595
+ Show workspace details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
5336
5596
 
5337
5597
  </dd>
5338
5598
  </dl>
@@ -5413,7 +5673,7 @@ await client.workspaces.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
5413
5673
  <dl>
5414
5674
  <dd>
5415
5675
 
5416
- Delete workspace from account. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
5676
+ Delete workspace from account. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
5417
5677
 
5418
5678
  </dd>
5419
5679
  </dl>
@@ -5484,7 +5744,7 @@ await client.workspaces.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44
5484
5744
  <dl>
5485
5745
  <dd>
5486
5746
 
5487
- Update a workspace. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
5747
+ Update a workspace. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
5488
5748
 
5489
5749
  </dd>
5490
5750
  </dl>
@@ -5567,7 +5827,7 @@ await client.workspaces.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44
5567
5827
  <dl>
5568
5828
  <dd>
5569
5829
 
5570
- List workspaces for a given account. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
5830
+ List workspaces for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
5571
5831
 
5572
5832
  </dd>
5573
5833
  </dl>
@@ -5583,12 +5843,26 @@ List workspaces for a given account. <br><br>Rate Limits: 100 calls per 1.00 min
5583
5843
  <dd>
5584
5844
 
5585
5845
  ```typescript
5586
- await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5846
+ const response = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5847
+ include: "creator",
5848
+ after: "<opaque_cursor>",
5849
+ page_size: 10,
5850
+ include_total_count: false,
5851
+ });
5852
+ for await (const item of response) {
5853
+ console.log(item);
5854
+ }
5855
+
5856
+ // Or you can manually iterate page-by-page
5857
+ let page = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5587
5858
  include: "creator",
5588
5859
  after: "<opaque_cursor>",
5589
5860
  page_size: 10,
5590
5861
  include_total_count: false,
5591
5862
  });
5863
+ while (page.hasNextPage()) {
5864
+ page = page.getNextPage();
5865
+ }
5592
5866
  ```
5593
5867
 
5594
5868
  </dd>
@@ -5643,7 +5917,7 @@ await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5643
5917
  <dl>
5644
5918
  <dd>
5645
5919
 
5646
- Create workspace from an account. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
5920
+ Create workspace from an account. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
5647
5921
 
5648
5922
  </dd>
5649
5923
  </dl>