frameio 3.2.3 → 4.2.0

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 (279) hide show
  1. package/README.md +159 -4
  2. package/dist/cjs/BaseClient.d.ts +4 -0
  3. package/dist/cjs/BaseClient.js +4 -2
  4. package/dist/cjs/Client.d.ts +6 -0
  5. package/dist/cjs/Client.js +34 -24
  6. package/dist/cjs/api/resources/accountPermissions/client/Client.js +6 -6
  7. package/dist/cjs/api/resources/accounts/client/Client.js +13 -13
  8. package/dist/cjs/api/resources/comments/client/Client.js +48 -48
  9. package/dist/cjs/api/resources/customActions/client/Client.d.ts +145 -0
  10. package/dist/cjs/api/resources/customActions/client/Client.js +443 -0
  11. package/dist/cjs/api/resources/customActions/client/index.d.ts +1 -0
  12. package/dist/cjs/api/resources/customActions/client/index.js +17 -0
  13. package/dist/cjs/api/resources/customActions/client/requests/ActionCreateParams.d.ts +31 -0
  14. package/dist/cjs/api/resources/customActions/client/requests/ActionCreateParams.js +3 -0
  15. package/dist/cjs/api/resources/customActions/client/requests/ActionUpdateParams.d.ts +35 -0
  16. package/dist/cjs/api/resources/customActions/client/requests/ActionUpdateParams.js +3 -0
  17. package/dist/cjs/api/resources/customActions/client/requests/ActionsIndexRequest.d.ts +21 -0
  18. package/dist/cjs/api/resources/customActions/client/requests/ActionsIndexRequest.js +3 -0
  19. package/dist/cjs/api/resources/customActions/client/requests/ActionsShowRequest.d.ts +9 -0
  20. package/dist/cjs/api/resources/customActions/client/requests/ActionsShowRequest.js +3 -0
  21. package/dist/cjs/api/resources/customActions/client/requests/index.d.ts +4 -0
  22. package/dist/cjs/api/resources/customActions/client/requests/index.js +2 -0
  23. package/dist/cjs/api/resources/customActions/exports.d.ts +2 -0
  24. package/dist/cjs/api/resources/customActions/exports.js +21 -0
  25. package/dist/cjs/api/resources/customActions/index.d.ts +1 -0
  26. package/dist/cjs/api/resources/customActions/index.js +17 -0
  27. package/dist/cjs/api/resources/files/client/Client.d.ts +1 -1
  28. package/dist/cjs/api/resources/files/client/Client.js +78 -78
  29. package/dist/cjs/api/resources/folders/client/Client.js +56 -56
  30. package/dist/cjs/api/resources/groups/client/Client.d.ts +116 -0
  31. package/dist/cjs/api/resources/groups/client/Client.js +368 -0
  32. package/dist/cjs/api/resources/groups/client/index.d.ts +1 -0
  33. package/dist/cjs/api/resources/groups/client/index.js +17 -0
  34. package/dist/cjs/api/resources/groups/client/requests/CreateGroupParams.d.ts +20 -0
  35. package/dist/cjs/api/resources/groups/client/requests/CreateGroupParams.js +3 -0
  36. package/dist/cjs/api/resources/groups/client/requests/GroupsIndexRequest.d.ts +24 -0
  37. package/dist/cjs/api/resources/groups/client/requests/GroupsIndexRequest.js +3 -0
  38. package/dist/cjs/api/resources/groups/client/requests/GroupsShowRequest.d.ts +9 -0
  39. package/dist/cjs/api/resources/groups/client/requests/GroupsShowRequest.js +3 -0
  40. package/dist/cjs/api/resources/groups/client/requests/UpdateGroupParams.d.ts +20 -0
  41. package/dist/cjs/api/resources/groups/client/requests/UpdateGroupParams.js +3 -0
  42. package/dist/cjs/api/resources/groups/client/requests/index.d.ts +4 -0
  43. package/dist/cjs/api/resources/groups/client/requests/index.js +2 -0
  44. package/dist/cjs/api/resources/groups/exports.d.ts +2 -0
  45. package/dist/cjs/api/resources/groups/exports.js +21 -0
  46. package/dist/cjs/api/resources/groups/index.d.ts +2 -0
  47. package/dist/cjs/api/resources/groups/index.js +18 -0
  48. package/dist/cjs/api/resources/groups/types/GroupsIndexRequestSort.d.ts +10 -0
  49. package/dist/cjs/api/resources/groups/types/GroupsIndexRequestSort.js +13 -0
  50. package/dist/cjs/api/resources/groups/types/index.d.ts +1 -0
  51. package/dist/cjs/api/resources/groups/types/index.js +17 -0
  52. package/dist/cjs/api/resources/index.d.ts +5 -0
  53. package/dist/cjs/api/resources/index.js +6 -1
  54. package/dist/cjs/api/resources/metadata/client/Client.d.ts +4 -4
  55. package/dist/cjs/api/resources/metadata/client/Client.js +18 -18
  56. package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +4 -4
  57. package/dist/cjs/api/resources/metadataFields/client/Client.js +28 -28
  58. package/dist/cjs/api/resources/projectPermissions/client/Client.js +20 -20
  59. package/dist/cjs/api/resources/projects/client/Client.js +34 -34
  60. package/dist/cjs/api/resources/shares/client/Client.d.ts +4 -4
  61. package/dist/cjs/api/resources/shares/client/Client.js +72 -72
  62. package/dist/cjs/api/resources/shares/client/requests/AddAssetParams.d.ts +1 -1
  63. package/dist/cjs/api/resources/shares/client/requests/CreateShareParams.d.ts +2 -2
  64. package/dist/cjs/api/resources/shares/client/requests/UpdateShareParams.d.ts +1 -1
  65. package/dist/cjs/api/resources/users/client/Client.js +7 -7
  66. package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +1 -1
  67. package/dist/cjs/api/resources/versionStacks/client/Client.js +43 -43
  68. package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +1 -1
  69. package/dist/cjs/api/resources/webhooks/client/Client.js +34 -34
  70. package/dist/cjs/api/resources/workspacePermissions/client/Client.js +20 -20
  71. package/dist/cjs/api/resources/workspaces/client/Client.js +34 -34
  72. package/dist/cjs/api/types/Account.d.ts +0 -2
  73. package/dist/cjs/api/types/Action.d.ts +25 -0
  74. package/dist/cjs/api/types/Action.js +3 -0
  75. package/dist/cjs/api/types/ActionCreateResponse.d.ts +13 -0
  76. package/dist/cjs/api/types/ActionCreateResponse.js +3 -0
  77. package/dist/cjs/api/types/ActionInclude.d.ts +4 -0
  78. package/dist/cjs/api/types/ActionInclude.js +3 -0
  79. package/dist/cjs/api/types/ActionResponse.d.ts +7 -0
  80. package/dist/cjs/api/types/ActionResponse.js +3 -0
  81. package/dist/cjs/api/types/ActionWithIncludes.d.ts +4 -0
  82. package/dist/cjs/api/types/ActionWithIncludes.js +3 -0
  83. package/dist/cjs/api/types/ActionWithIncludesResponse.d.ts +7 -0
  84. package/dist/cjs/api/types/ActionWithIncludesResponse.js +3 -0
  85. package/dist/cjs/api/types/ActionsWithIncludesResponse.d.ts +11 -0
  86. package/dist/cjs/api/types/ActionsWithIncludesResponse.js +3 -0
  87. package/dist/cjs/api/types/AuditLogwithIncludes.d.ts +7 -0
  88. package/dist/cjs/api/types/AuditLogwithIncludes.js +7 -0
  89. package/dist/cjs/api/types/Filters.d.ts +7 -0
  90. package/dist/cjs/api/types/Filters.js +7 -0
  91. package/dist/cjs/api/types/GroupCommon.d.ts +16 -0
  92. package/dist/cjs/api/types/GroupCommon.js +3 -0
  93. package/dist/cjs/api/types/GroupCommonWithIncludes.d.ts +4 -0
  94. package/dist/cjs/api/types/GroupCommonWithIncludes.js +3 -0
  95. package/dist/cjs/api/types/GroupResponse.d.ts +4 -0
  96. package/dist/cjs/api/types/GroupResponse.js +3 -0
  97. package/dist/cjs/api/types/GroupWithIncludes.d.ts +13 -0
  98. package/dist/cjs/api/types/GroupWithIncludes.js +3 -0
  99. package/dist/cjs/api/types/GroupWithIncludesResponse.d.ts +4 -0
  100. package/dist/cjs/api/types/GroupWithIncludesResponse.js +3 -0
  101. package/dist/cjs/api/types/GroupsInclude.d.ts +4 -0
  102. package/dist/cjs/api/types/GroupsInclude.js +3 -0
  103. package/dist/cjs/api/types/GroupsSort.d.ts +10 -0
  104. package/dist/cjs/api/types/GroupsSort.js +13 -0
  105. package/dist/cjs/api/types/GroupsWithIncludesResponse.d.ts +8 -0
  106. package/dist/cjs/api/types/GroupsWithIncludesResponse.js +3 -0
  107. package/dist/cjs/api/types/SingleUserValue.d.ts +1 -1
  108. package/dist/cjs/api/types/SyncGroupWithIncludes.d.ts +15 -0
  109. package/dist/cjs/api/types/SyncGroupWithIncludes.js +14 -0
  110. package/dist/cjs/api/types/index.d.ts +16 -0
  111. package/dist/cjs/api/types/index.js +16 -0
  112. package/dist/cjs/index.d.ts +4 -0
  113. package/dist/cjs/index.js +21 -1
  114. package/dist/cjs/oauth/BaseAuth.d.ts +66 -0
  115. package/dist/cjs/oauth/BaseAuth.js +113 -0
  116. package/dist/cjs/oauth/NativeAppAuth.d.ts +32 -0
  117. package/dist/cjs/oauth/NativeAppAuth.js +35 -0
  118. package/dist/cjs/oauth/SPAAuth.d.ts +38 -0
  119. package/dist/cjs/oauth/SPAAuth.js +96 -0
  120. package/dist/cjs/oauth/ServerToServerAuth.d.ts +17 -0
  121. package/dist/cjs/oauth/ServerToServerAuth.js +49 -0
  122. package/dist/cjs/oauth/TokenManager.d.ts +83 -0
  123. package/dist/cjs/oauth/TokenManager.js +174 -0
  124. package/dist/cjs/oauth/WebAppAuth.d.ts +29 -0
  125. package/dist/cjs/oauth/WebAppAuth.js +88 -0
  126. package/dist/cjs/oauth/errors.d.ts +41 -0
  127. package/dist/cjs/oauth/errors.js +83 -0
  128. package/dist/cjs/oauth/http.d.ts +70 -0
  129. package/dist/cjs/oauth/http.js +280 -0
  130. package/dist/cjs/oauth/index.d.ts +34 -0
  131. package/dist/cjs/oauth/index.js +47 -0
  132. package/dist/cjs/oauth/logger.d.ts +17 -0
  133. package/dist/cjs/oauth/logger.js +18 -0
  134. package/dist/cjs/oauth/pkce.d.ts +30 -0
  135. package/dist/cjs/oauth/pkce.js +102 -0
  136. package/dist/cjs/oauth/validation.d.ts +17 -0
  137. package/dist/cjs/oauth/validation.js +55 -0
  138. package/dist/cjs/version.d.ts +1 -1
  139. package/dist/cjs/version.js +1 -1
  140. package/dist/esm/BaseClient.d.mts +4 -0
  141. package/dist/esm/BaseClient.mjs +4 -2
  142. package/dist/esm/Client.d.mts +6 -0
  143. package/dist/esm/Client.mjs +10 -0
  144. package/dist/esm/api/resources/accountPermissions/client/Client.mjs +7 -7
  145. package/dist/esm/api/resources/accounts/client/Client.mjs +13 -13
  146. package/dist/esm/api/resources/comments/client/Client.mjs +49 -49
  147. package/dist/esm/api/resources/customActions/client/Client.d.mts +145 -0
  148. package/dist/esm/api/resources/customActions/client/Client.mjs +406 -0
  149. package/dist/esm/api/resources/customActions/client/index.d.mts +1 -0
  150. package/dist/esm/api/resources/customActions/client/index.mjs +1 -0
  151. package/dist/esm/api/resources/customActions/client/requests/ActionCreateParams.d.mts +31 -0
  152. package/dist/esm/api/resources/customActions/client/requests/ActionCreateParams.mjs +2 -0
  153. package/dist/esm/api/resources/customActions/client/requests/ActionUpdateParams.d.mts +35 -0
  154. package/dist/esm/api/resources/customActions/client/requests/ActionUpdateParams.mjs +2 -0
  155. package/dist/esm/api/resources/customActions/client/requests/ActionsIndexRequest.d.mts +21 -0
  156. package/dist/esm/api/resources/customActions/client/requests/ActionsIndexRequest.mjs +2 -0
  157. package/dist/esm/api/resources/customActions/client/requests/ActionsShowRequest.d.mts +9 -0
  158. package/dist/esm/api/resources/customActions/client/requests/ActionsShowRequest.mjs +2 -0
  159. package/dist/esm/api/resources/customActions/client/requests/index.d.mts +4 -0
  160. package/dist/esm/api/resources/customActions/client/requests/index.mjs +1 -0
  161. package/dist/esm/api/resources/customActions/exports.d.mts +2 -0
  162. package/dist/esm/api/resources/customActions/exports.mjs +3 -0
  163. package/dist/esm/api/resources/customActions/index.d.mts +1 -0
  164. package/dist/esm/api/resources/customActions/index.mjs +1 -0
  165. package/dist/esm/api/resources/files/client/Client.d.mts +1 -1
  166. package/dist/esm/api/resources/files/client/Client.mjs +79 -79
  167. package/dist/esm/api/resources/folders/client/Client.mjs +57 -57
  168. package/dist/esm/api/resources/groups/client/Client.d.mts +116 -0
  169. package/dist/esm/api/resources/groups/client/Client.mjs +331 -0
  170. package/dist/esm/api/resources/groups/client/index.d.mts +1 -0
  171. package/dist/esm/api/resources/groups/client/index.mjs +1 -0
  172. package/dist/esm/api/resources/groups/client/requests/CreateGroupParams.d.mts +20 -0
  173. package/dist/esm/api/resources/groups/client/requests/CreateGroupParams.mjs +2 -0
  174. package/dist/esm/api/resources/groups/client/requests/GroupsIndexRequest.d.mts +24 -0
  175. package/dist/esm/api/resources/groups/client/requests/GroupsIndexRequest.mjs +2 -0
  176. package/dist/esm/api/resources/groups/client/requests/GroupsShowRequest.d.mts +9 -0
  177. package/dist/esm/api/resources/groups/client/requests/GroupsShowRequest.mjs +2 -0
  178. package/dist/esm/api/resources/groups/client/requests/UpdateGroupParams.d.mts +20 -0
  179. package/dist/esm/api/resources/groups/client/requests/UpdateGroupParams.mjs +2 -0
  180. package/dist/esm/api/resources/groups/client/requests/index.d.mts +4 -0
  181. package/dist/esm/api/resources/groups/client/requests/index.mjs +1 -0
  182. package/dist/esm/api/resources/groups/exports.d.mts +2 -0
  183. package/dist/esm/api/resources/groups/exports.mjs +3 -0
  184. package/dist/esm/api/resources/groups/index.d.mts +2 -0
  185. package/dist/esm/api/resources/groups/index.mjs +2 -0
  186. package/dist/esm/api/resources/groups/types/GroupsIndexRequestSort.d.mts +10 -0
  187. package/dist/esm/api/resources/groups/types/GroupsIndexRequestSort.mjs +10 -0
  188. package/dist/esm/api/resources/groups/types/index.d.mts +1 -0
  189. package/dist/esm/api/resources/groups/types/index.mjs +1 -0
  190. package/dist/esm/api/resources/index.d.mts +5 -0
  191. package/dist/esm/api/resources/index.mjs +5 -0
  192. package/dist/esm/api/resources/metadata/client/Client.d.mts +4 -4
  193. package/dist/esm/api/resources/metadata/client/Client.mjs +19 -19
  194. package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +4 -4
  195. package/dist/esm/api/resources/metadataFields/client/Client.mjs +29 -29
  196. package/dist/esm/api/resources/projectPermissions/client/Client.mjs +21 -21
  197. package/dist/esm/api/resources/projects/client/Client.mjs +35 -35
  198. package/dist/esm/api/resources/shares/client/Client.d.mts +4 -4
  199. package/dist/esm/api/resources/shares/client/Client.mjs +73 -73
  200. package/dist/esm/api/resources/shares/client/requests/AddAssetParams.d.mts +1 -1
  201. package/dist/esm/api/resources/shares/client/requests/CreateShareParams.d.mts +2 -2
  202. package/dist/esm/api/resources/shares/client/requests/UpdateShareParams.d.mts +1 -1
  203. package/dist/esm/api/resources/users/client/Client.mjs +8 -8
  204. package/dist/esm/api/resources/versionStacks/client/Client.d.mts +1 -1
  205. package/dist/esm/api/resources/versionStacks/client/Client.mjs +44 -44
  206. package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +1 -1
  207. package/dist/esm/api/resources/webhooks/client/Client.mjs +35 -35
  208. package/dist/esm/api/resources/workspacePermissions/client/Client.mjs +21 -21
  209. package/dist/esm/api/resources/workspaces/client/Client.mjs +35 -35
  210. package/dist/esm/api/types/Account.d.mts +0 -2
  211. package/dist/esm/api/types/Action.d.mts +25 -0
  212. package/dist/esm/api/types/Action.mjs +2 -0
  213. package/dist/esm/api/types/ActionCreateResponse.d.mts +13 -0
  214. package/dist/esm/api/types/ActionCreateResponse.mjs +2 -0
  215. package/dist/esm/api/types/ActionInclude.d.mts +4 -0
  216. package/dist/esm/api/types/ActionInclude.mjs +2 -0
  217. package/dist/esm/api/types/ActionResponse.d.mts +7 -0
  218. package/dist/esm/api/types/ActionResponse.mjs +2 -0
  219. package/dist/esm/api/types/ActionWithIncludes.d.mts +4 -0
  220. package/dist/esm/api/types/ActionWithIncludes.mjs +2 -0
  221. package/dist/esm/api/types/ActionWithIncludesResponse.d.mts +7 -0
  222. package/dist/esm/api/types/ActionWithIncludesResponse.mjs +2 -0
  223. package/dist/esm/api/types/ActionsWithIncludesResponse.d.mts +11 -0
  224. package/dist/esm/api/types/ActionsWithIncludesResponse.mjs +2 -0
  225. package/dist/esm/api/types/AuditLogwithIncludes.d.mts +7 -0
  226. package/dist/esm/api/types/AuditLogwithIncludes.mjs +7 -0
  227. package/dist/esm/api/types/Filters.d.mts +7 -0
  228. package/dist/esm/api/types/Filters.mjs +7 -0
  229. package/dist/esm/api/types/GroupCommon.d.mts +16 -0
  230. package/dist/esm/api/types/GroupCommon.mjs +2 -0
  231. package/dist/esm/api/types/GroupCommonWithIncludes.d.mts +4 -0
  232. package/dist/esm/api/types/GroupCommonWithIncludes.mjs +2 -0
  233. package/dist/esm/api/types/GroupResponse.d.mts +4 -0
  234. package/dist/esm/api/types/GroupResponse.mjs +2 -0
  235. package/dist/esm/api/types/GroupWithIncludes.d.mts +13 -0
  236. package/dist/esm/api/types/GroupWithIncludes.mjs +2 -0
  237. package/dist/esm/api/types/GroupWithIncludesResponse.d.mts +4 -0
  238. package/dist/esm/api/types/GroupWithIncludesResponse.mjs +2 -0
  239. package/dist/esm/api/types/GroupsInclude.d.mts +4 -0
  240. package/dist/esm/api/types/GroupsInclude.mjs +2 -0
  241. package/dist/esm/api/types/GroupsSort.d.mts +10 -0
  242. package/dist/esm/api/types/GroupsSort.mjs +10 -0
  243. package/dist/esm/api/types/GroupsWithIncludesResponse.d.mts +8 -0
  244. package/dist/esm/api/types/GroupsWithIncludesResponse.mjs +2 -0
  245. package/dist/esm/api/types/SingleUserValue.d.mts +1 -1
  246. package/dist/esm/api/types/SyncGroupWithIncludes.d.mts +15 -0
  247. package/dist/esm/api/types/SyncGroupWithIncludes.mjs +11 -0
  248. package/dist/esm/api/types/index.d.mts +16 -0
  249. package/dist/esm/api/types/index.mjs +16 -0
  250. package/dist/esm/index.d.mts +4 -0
  251. package/dist/esm/index.mjs +6 -0
  252. package/dist/esm/oauth/BaseAuth.d.mts +66 -0
  253. package/dist/esm/oauth/BaseAuth.mjs +109 -0
  254. package/dist/esm/oauth/NativeAppAuth.d.mts +32 -0
  255. package/dist/esm/oauth/NativeAppAuth.mjs +31 -0
  256. package/dist/esm/oauth/SPAAuth.d.mts +38 -0
  257. package/dist/esm/oauth/SPAAuth.mjs +92 -0
  258. package/dist/esm/oauth/ServerToServerAuth.d.mts +17 -0
  259. package/dist/esm/oauth/ServerToServerAuth.mjs +45 -0
  260. package/dist/esm/oauth/TokenManager.d.mts +83 -0
  261. package/dist/esm/oauth/TokenManager.mjs +170 -0
  262. package/dist/esm/oauth/WebAppAuth.d.mts +29 -0
  263. package/dist/esm/oauth/WebAppAuth.mjs +84 -0
  264. package/dist/esm/oauth/errors.d.mts +41 -0
  265. package/dist/esm/oauth/errors.mjs +72 -0
  266. package/dist/esm/oauth/http.d.mts +70 -0
  267. package/dist/esm/oauth/http.mjs +274 -0
  268. package/dist/esm/oauth/index.d.mts +34 -0
  269. package/dist/esm/oauth/index.mjs +30 -0
  270. package/dist/esm/oauth/logger.d.mts +17 -0
  271. package/dist/esm/oauth/logger.mjs +15 -0
  272. package/dist/esm/oauth/pkce.d.mts +30 -0
  273. package/dist/esm/oauth/pkce.mjs +98 -0
  274. package/dist/esm/oauth/validation.d.mts +17 -0
  275. package/dist/esm/oauth/validation.mjs +51 -0
  276. package/dist/esm/version.d.mts +1 -1
  277. package/dist/esm/version.mjs +1 -1
  278. package/package.json +23 -1
  279. package/reference.md +1318 -586
package/reference.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Reference
2
- ## Metadata Fields
3
- <details><summary><code>client.metadataFields.<a href="/src/api/resources/metadataFields/client/Client.ts">metadataFieldDefinitionsDelete</a>(account_id, field_definition_id) -> void</code></summary>
2
+ ## Custom Actions
3
+ <details><summary><code>client.customActions.<a href="/src/api/resources/customActions/client/Client.ts">actionsShow</a>(account_id, action_id, { ...params }) -> Frameio.ActionWithIncludesResponse</code></summary>
4
4
  <dl>
5
5
  <dd>
6
6
 
@@ -12,7 +12,7 @@
12
12
  <dl>
13
13
  <dd>
14
14
 
15
- Delete account level custom field definitions. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
15
+ Show custom action details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
16
16
  </dd>
17
17
  </dl>
18
18
  </dd>
@@ -27,7 +27,9 @@ Delete account level custom field definitions. <br/>Rate Limits: 60 calls per 1.
27
27
  <dd>
28
28
 
29
29
  ```typescript
30
- await client.metadataFields.metadataFieldDefinitionsDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
30
+ await client.customActions.actionsShow("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
31
+ include: "creator"
32
+ });
31
33
 
32
34
  ```
33
35
  </dd>
@@ -51,7 +53,7 @@ await client.metadataFields.metadataFieldDefinitionsDelete("b2702c44-c6da-4bb6-8
51
53
  <dl>
52
54
  <dd>
53
55
 
54
- **field_definition_id:** `Frameio.Uuid` —
56
+ **action_id:** `Frameio.Uuid` —
55
57
 
56
58
  </dd>
57
59
  </dl>
@@ -59,7 +61,15 @@ await client.metadataFields.metadataFieldDefinitionsDelete("b2702c44-c6da-4bb6-8
59
61
  <dl>
60
62
  <dd>
61
63
 
62
- **requestOptions:** `MetadataFieldsClient.RequestOptions`
64
+ **request:** `Frameio.ActionsShowRequest`
65
+
66
+ </dd>
67
+ </dl>
68
+
69
+ <dl>
70
+ <dd>
71
+
72
+ **requestOptions:** `CustomActionsClient.RequestOptions`
63
73
 
64
74
  </dd>
65
75
  </dl>
@@ -71,7 +81,7 @@ await client.metadataFields.metadataFieldDefinitionsDelete("b2702c44-c6da-4bb6-8
71
81
  </dl>
72
82
  </details>
73
83
 
74
- <details><summary><code>client.metadataFields.<a href="/src/api/resources/metadataFields/client/Client.ts">metadataFieldDefinitionsUpdate</a>(account_id, field_definition_id, { ...params }) -> Frameio.FieldDefinitionResponse</code></summary>
84
+ <details><summary><code>client.customActions.<a href="/src/api/resources/customActions/client/Client.ts">actionsDelete</a>(account_id, action_id) -> void</code></summary>
75
85
  <dl>
76
86
  <dd>
77
87
 
@@ -83,7 +93,7 @@ await client.metadataFields.metadataFieldDefinitionsDelete("b2702c44-c6da-4bb6-8
83
93
  <dl>
84
94
  <dd>
85
95
 
86
- Update account level custom field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
96
+ Delete a custom action. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
87
97
  </dd>
88
98
  </dl>
89
99
  </dd>
@@ -98,20 +108,7 @@ Update account level custom field definitions. <br/>Rate Limits: 10 calls per 1.
98
108
  <dd>
99
109
 
100
110
  ```typescript
101
- await client.metadataFields.metadataFieldDefinitionsUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
102
- data: {
103
- field_type: "select",
104
- field_configuration: {
105
- enable_add_new: false,
106
- options: [{
107
- display_name: "Option 1"
108
- }, {
109
- display_name: "Option 2"
110
- }]
111
- },
112
- name: "Updated-Field-Name"
113
- }
114
- });
111
+ await client.customActions.actionsDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
115
112
 
116
113
  ```
117
114
  </dd>
@@ -135,15 +132,7 @@ await client.metadataFields.metadataFieldDefinitionsUpdate("b2702c44-c6da-4bb6-8
135
132
  <dl>
136
133
  <dd>
137
134
 
138
- **field_definition_id:** `Frameio.Uuid` —
139
-
140
- </dd>
141
- </dl>
142
-
143
- <dl>
144
- <dd>
145
-
146
- **request:** `Frameio.UpdateFieldDefinitionParams`
135
+ **action_id:** `Frameio.Uuid` —
147
136
 
148
137
  </dd>
149
138
  </dl>
@@ -151,7 +140,7 @@ await client.metadataFields.metadataFieldDefinitionsUpdate("b2702c44-c6da-4bb6-8
151
140
  <dl>
152
141
  <dd>
153
142
 
154
- **requestOptions:** `MetadataFieldsClient.RequestOptions`
143
+ **requestOptions:** `CustomActionsClient.RequestOptions`
155
144
 
156
145
  </dd>
157
146
  </dl>
@@ -163,7 +152,7 @@ await client.metadataFields.metadataFieldDefinitionsUpdate("b2702c44-c6da-4bb6-8
163
152
  </dl>
164
153
  </details>
165
154
 
166
- <details><summary><code>client.metadataFields.<a href="/src/api/resources/metadataFields/client/Client.ts">metadataFieldDefinitionsIndex</a>(account_id, { ...params }) -> Frameio.FieldDefinitionsWithIncludesResponse</code></summary>
155
+ <details><summary><code>client.customActions.<a href="/src/api/resources/customActions/client/Client.ts">actionsUpdate</a>(account_id, action_id, { ...params }) -> Frameio.ActionResponse</code></summary>
167
156
  <dl>
168
157
  <dd>
169
158
 
@@ -175,7 +164,7 @@ await client.metadataFields.metadataFieldDefinitionsUpdate("b2702c44-c6da-4bb6-8
175
164
  <dl>
176
165
  <dd>
177
166
 
178
- List account level field definitions. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
167
+ Update custom action details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
179
168
  </dd>
180
169
  </dl>
181
170
  </dd>
@@ -190,11 +179,16 @@ List account level field definitions. <br/>Rate Limits: 100 calls per 1.00 minut
190
179
  <dd>
191
180
 
192
181
  ```typescript
193
- await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
194
- include: "creator",
195
- after: "<opaque_cursor>",
196
- page_size: 10,
197
- include_total_count: false
182
+ await client.customActions.actionsUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
183
+ data: {
184
+ active: true,
185
+ description: "customizing our workflow",
186
+ event: "my.event",
187
+ multi_asset: true,
188
+ name: "First Custom Action",
189
+ timeout: 7,
190
+ url: "https://example.com/custom-action"
191
+ }
198
192
  });
199
193
 
200
194
  ```
@@ -219,7 +213,7 @@ await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8b
219
213
  <dl>
220
214
  <dd>
221
215
 
222
- **request:** `Frameio.MetadataFieldDefinitionsIndexRequest`
216
+ **action_id:** `Frameio.Uuid`
223
217
 
224
218
  </dd>
225
219
  </dl>
@@ -227,7 +221,15 @@ await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8b
227
221
  <dl>
228
222
  <dd>
229
223
 
230
- **requestOptions:** `MetadataFieldsClient.RequestOptions`
224
+ **request:** `Frameio.ActionUpdateParams`
225
+
226
+ </dd>
227
+ </dl>
228
+
229
+ <dl>
230
+ <dd>
231
+
232
+ **requestOptions:** `CustomActionsClient.RequestOptions`
231
233
 
232
234
  </dd>
233
235
  </dl>
@@ -239,7 +241,7 @@ await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8b
239
241
  </dl>
240
242
  </details>
241
243
 
242
- <details><summary><code>client.metadataFields.<a href="/src/api/resources/metadataFields/client/Client.ts">metadataFieldDefinitionsCreate</a>(account_id, { ...params }) -> Frameio.FieldDefinitionResponse</code></summary>
244
+ <details><summary><code>client.customActions.<a href="/src/api/resources/customActions/client/Client.ts">actionsIndex</a>(account_id, workspace_id, { ...params }) -> Frameio.ActionsWithIncludesResponse</code></summary>
243
245
  <dl>
244
246
  <dd>
245
247
 
@@ -251,7 +253,7 @@ await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8b
251
253
  <dl>
252
254
  <dd>
253
255
 
254
- Create account level field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
256
+ List actions in a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
255
257
  </dd>
256
258
  </dl>
257
259
  </dd>
@@ -266,19 +268,11 @@ Create account level field definitions. <br/>Rate Limits: 10 calls per 1.00 minu
266
268
  <dd>
267
269
 
268
270
  ```typescript
269
- await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
270
- data: {
271
- field_type: "select",
272
- field_configuration: {
273
- enable_add_new: false,
274
- options: [{
275
- display_name: "Option 1"
276
- }, {
277
- display_name: "Option 2"
278
- }]
279
- },
280
- name: "Fields definition name"
281
- }
271
+ await client.customActions.actionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
272
+ include: "creator",
273
+ after: "<opaque_cursor>",
274
+ page_size: 10,
275
+ include_total_count: false
282
276
  });
283
277
 
284
278
  ```
@@ -303,7 +297,7 @@ await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8
303
297
  <dl>
304
298
  <dd>
305
299
 
306
- **request:** `Frameio.CreateFieldDefinitionParams`
300
+ **workspace_id:** `Frameio.Uuid`
307
301
 
308
302
  </dd>
309
303
  </dl>
@@ -311,7 +305,15 @@ await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8
311
305
  <dl>
312
306
  <dd>
313
307
 
314
- **requestOptions:** `MetadataFieldsClient.RequestOptions`
308
+ **request:** `Frameio.ActionsIndexRequest`
309
+
310
+ </dd>
311
+ </dl>
312
+
313
+ <dl>
314
+ <dd>
315
+
316
+ **requestOptions:** `CustomActionsClient.RequestOptions`
315
317
 
316
318
  </dd>
317
319
  </dl>
@@ -323,8 +325,7 @@ await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8
323
325
  </dl>
324
326
  </details>
325
327
 
326
- ## Project Permissions
327
- <details><summary><code>client.projectPermissions.<a href="/src/api/resources/projectPermissions/client/Client.ts">index</a>(account_id, project_id, { ...params }) -> core.Page&lt;Frameio.UserRole, Frameio.ProjectUserRolesResponse&gt;</code></summary>
328
+ <details><summary><code>client.customActions.<a href="/src/api/resources/customActions/client/Client.ts">actionsCreate</a>(account_id, workspace_id, { ...params }) -> Frameio.ActionCreateResponse</code></summary>
328
329
  <dl>
329
330
  <dd>
330
331
 
@@ -336,7 +337,7 @@ await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8
336
337
  <dl>
337
338
  <dd>
338
339
 
339
- List user roles for a given project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
340
+ Create a custom action in a workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
340
341
  </dd>
341
342
  </dl>
342
343
  </dd>
@@ -351,29 +352,15 @@ List user roles for a given project. <br/>Rate Limits: 100 calls per 1.00 minute
351
352
  <dd>
352
353
 
353
354
  ```typescript
354
- const pageableResponse = await client.projectPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
355
- include_deactivated: true,
356
- after: "<opaque_cursor>",
357
- page_size: 10,
358
- include_total_count: false
359
- });
360
- for await (const item of pageableResponse) {
361
- console.log(item);
362
- }
363
-
364
- // Or you can manually iterate page-by-page
365
- let page = await client.projectPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
366
- include_deactivated: true,
367
- after: "<opaque_cursor>",
368
- page_size: 10,
369
- include_total_count: false
355
+ await client.customActions.actionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
356
+ data: {
357
+ description: "customizing our workflow",
358
+ event: "my.event",
359
+ name: "First Custom Action",
360
+ timeout: 7,
361
+ url: "https://example.com/custom-action"
362
+ }
370
363
  });
371
- while (page.hasNextPage()) {
372
- page = page.getNextPage();
373
- }
374
-
375
- // You can also access the underlying response
376
- const response = page.response;
377
364
 
378
365
  ```
379
366
  </dd>
@@ -397,7 +384,7 @@ const response = page.response;
397
384
  <dl>
398
385
  <dd>
399
386
 
400
- **project_id:** `Frameio.Uuid` —
387
+ **workspace_id:** `Frameio.Uuid` —
401
388
 
402
389
  </dd>
403
390
  </dl>
@@ -405,7 +392,7 @@ const response = page.response;
405
392
  <dl>
406
393
  <dd>
407
394
 
408
- **request:** `Frameio.ProjectPermissionsIndexRequest`
395
+ **request:** `Frameio.ActionCreateParams`
409
396
 
410
397
  </dd>
411
398
  </dl>
@@ -413,7 +400,7 @@ const response = page.response;
413
400
  <dl>
414
401
  <dd>
415
402
 
416
- **requestOptions:** `ProjectPermissionsClient.RequestOptions`
403
+ **requestOptions:** `CustomActionsClient.RequestOptions`
417
404
 
418
405
  </dd>
419
406
  </dl>
@@ -425,7 +412,8 @@ const response = page.response;
425
412
  </dl>
426
413
  </details>
427
414
 
428
- <details><summary><code>client.projectPermissions.<a href="/src/api/resources/projectPermissions/client/Client.ts">delete</a>(account_id, project_id, user_id) -> void</code></summary>
415
+ ## Metadata Fields
416
+ <details><summary><code>client.metadataFields.<a href="/src/api/resources/metadataFields/client/Client.ts">metadataFieldDefinitionsDelete</a>(account_id, field_definition_id) -> void</code></summary>
429
417
  <dl>
430
418
  <dd>
431
419
 
@@ -437,7 +425,7 @@ const response = page.response;
437
425
  <dl>
438
426
  <dd>
439
427
 
440
- Remove a user from a given project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
428
+ Delete account level custom field definitions. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
441
429
  </dd>
442
430
  </dl>
443
431
  </dd>
@@ -452,7 +440,7 @@ Remove a user from a given project. <br/>Rate Limits: 60 calls per 1.00 minute(s
452
440
  <dd>
453
441
 
454
442
  ```typescript
455
- await client.projectPermissions.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
443
+ await client.metadataFields.metadataFieldDefinitionsDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
456
444
 
457
445
  ```
458
446
  </dd>
@@ -476,15 +464,7 @@ await client.projectPermissions.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
476
464
  <dl>
477
465
  <dd>
478
466
 
479
- **project_id:** `Frameio.Uuid` —
480
-
481
- </dd>
482
- </dl>
483
-
484
- <dl>
485
- <dd>
486
-
487
- **user_id:** `Frameio.Uuid` —
467
+ **field_definition_id:** `Frameio.Uuid` —
488
468
 
489
469
  </dd>
490
470
  </dl>
@@ -492,7 +472,7 @@ await client.projectPermissions.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
492
472
  <dl>
493
473
  <dd>
494
474
 
495
- **requestOptions:** `ProjectPermissionsClient.RequestOptions`
475
+ **requestOptions:** `MetadataFieldsClient.RequestOptions`
496
476
 
497
477
  </dd>
498
478
  </dl>
@@ -504,7 +484,7 @@ await client.projectPermissions.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
504
484
  </dl>
505
485
  </details>
506
486
 
507
- <details><summary><code>client.projectPermissions.<a href="/src/api/resources/projectPermissions/client/Client.ts">projectUserRolesUpdate</a>(account_id, project_id, user_id, { ...params }) -> Frameio.UpdateUserRolesResponse</code></summary>
487
+ <details><summary><code>client.metadataFields.<a href="/src/api/resources/metadataFields/client/Client.ts">metadataFieldDefinitionsUpdate</a>(account_id, field_definition_id, { ...params }) -> Frameio.FieldDefinitionResponse</code></summary>
508
488
  <dl>
509
489
  <dd>
510
490
 
@@ -516,8 +496,7 @@ await client.projectPermissions.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
516
496
  <dl>
517
497
  <dd>
518
498
 
519
- Update user roles for the given project if the user is already added to the project. If the user is
520
- 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
499
+ Update account level custom field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
521
500
  </dd>
522
501
  </dl>
523
502
  </dd>
@@ -532,9 +511,18 @@ Update user roles for the given project if the user is already added to the proj
532
511
  <dd>
533
512
 
534
513
  ```typescript
535
- await client.projectPermissions.projectUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
514
+ await client.metadataFields.metadataFieldDefinitionsUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
536
515
  data: {
537
- role: "editor"
516
+ field_type: "select",
517
+ field_configuration: {
518
+ enable_add_new: false,
519
+ options: [{
520
+ display_name: "Option 1"
521
+ }, {
522
+ display_name: "Option 2"
523
+ }]
524
+ },
525
+ name: "Updated-Field-Name"
538
526
  }
539
527
  });
540
528
 
@@ -560,15 +548,7 @@ await client.projectPermissions.projectUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-
560
548
  <dl>
561
549
  <dd>
562
550
 
563
- **project_id:** `Frameio.Uuid` —
564
-
565
- </dd>
566
- </dl>
567
-
568
- <dl>
569
- <dd>
570
-
571
- **user_id:** `Frameio.Uuid` —
551
+ **field_definition_id:** `Frameio.Uuid` —
572
552
 
573
553
  </dd>
574
554
  </dl>
@@ -576,7 +556,7 @@ await client.projectPermissions.projectUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-
576
556
  <dl>
577
557
  <dd>
578
558
 
579
- **request:** `Frameio.UpdateUserRolesParams`
559
+ **request:** `Frameio.UpdateFieldDefinitionParams`
580
560
 
581
561
  </dd>
582
562
  </dl>
@@ -584,7 +564,7 @@ await client.projectPermissions.projectUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-
584
564
  <dl>
585
565
  <dd>
586
566
 
587
- **requestOptions:** `ProjectPermissionsClient.RequestOptions`
567
+ **requestOptions:** `MetadataFieldsClient.RequestOptions`
588
568
 
589
569
  </dd>
590
570
  </dl>
@@ -596,8 +576,7 @@ await client.projectPermissions.projectUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-
596
576
  </dl>
597
577
  </details>
598
578
 
599
- ## Folders
600
- <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">show</a>(account_id, folder_id, { ...params }) -> Frameio.FolderWithIncludesResponse</code></summary>
579
+ <details><summary><code>client.metadataFields.<a href="/src/api/resources/metadataFields/client/Client.ts">metadataFieldDefinitionsIndex</a>(account_id, { ...params }) -> Frameio.FieldDefinitionsWithIncludesResponse</code></summary>
601
580
  <dl>
602
581
  <dd>
603
582
 
@@ -609,7 +588,7 @@ await client.projectPermissions.projectUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-
609
588
  <dl>
610
589
  <dd>
611
590
 
612
- Show folder details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
591
+ List account level field definitions. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
613
592
  </dd>
614
593
  </dl>
615
594
  </dd>
@@ -624,8 +603,11 @@ Show folder details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_
624
603
  <dd>
625
604
 
626
605
  ```typescript
627
- await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
628
- include: "creator"
606
+ await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
607
+ include: "creator",
608
+ after: "<opaque_cursor>",
609
+ page_size: 10,
610
+ include_total_count: false
629
611
  });
630
612
 
631
613
  ```
@@ -650,15 +632,7 @@ await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
650
632
  <dl>
651
633
  <dd>
652
634
 
653
- **folder_id:** `Frameio.Uuid`
654
-
655
- </dd>
656
- </dl>
657
-
658
- <dl>
659
- <dd>
660
-
661
- **request:** `Frameio.FoldersShowRequest`
635
+ **request:** `Frameio.MetadataFieldDefinitionsIndexRequest`
662
636
 
663
637
  </dd>
664
638
  </dl>
@@ -666,7 +640,7 @@ await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
666
640
  <dl>
667
641
  <dd>
668
642
 
669
- **requestOptions:** `FoldersClient.RequestOptions`
643
+ **requestOptions:** `MetadataFieldsClient.RequestOptions`
670
644
 
671
645
  </dd>
672
646
  </dl>
@@ -678,7 +652,7 @@ await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
678
652
  </dl>
679
653
  </details>
680
654
 
681
- <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">delete</a>(account_id, folder_id) -> void</code></summary>
655
+ <details><summary><code>client.metadataFields.<a href="/src/api/resources/metadataFields/client/Client.ts">metadataFieldDefinitionsCreate</a>(account_id, { ...params }) -> Frameio.FieldDefinitionResponse</code></summary>
682
656
  <dl>
683
657
  <dd>
684
658
 
@@ -690,7 +664,7 @@ await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
690
664
  <dl>
691
665
  <dd>
692
666
 
693
- Delete folder by id. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
667
+ Create account level field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
694
668
  </dd>
695
669
  </dl>
696
670
  </dd>
@@ -705,7 +679,20 @@ Delete folder by id. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_u
705
679
  <dd>
706
680
 
707
681
  ```typescript
708
- await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
682
+ await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
683
+ data: {
684
+ field_type: "select",
685
+ field_configuration: {
686
+ enable_add_new: false,
687
+ options: [{
688
+ display_name: "Option 1"
689
+ }, {
690
+ display_name: "Option 2"
691
+ }]
692
+ },
693
+ name: "Fields definition name"
694
+ }
695
+ });
709
696
 
710
697
  ```
711
698
  </dd>
@@ -729,7 +716,7 @@ await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
729
716
  <dl>
730
717
  <dd>
731
718
 
732
- **folder_id:** `Frameio.Uuid`
719
+ **request:** `Frameio.CreateFieldDefinitionParams`
733
720
 
734
721
  </dd>
735
722
  </dl>
@@ -737,7 +724,7 @@ await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
737
724
  <dl>
738
725
  <dd>
739
726
 
740
- **requestOptions:** `FoldersClient.RequestOptions`
727
+ **requestOptions:** `MetadataFieldsClient.RequestOptions`
741
728
 
742
729
  </dd>
743
730
  </dl>
@@ -749,7 +736,8 @@ await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
749
736
  </dl>
750
737
  </details>
751
738
 
752
- <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">update</a>(account_id, folder_id, { ...params }) -> Frameio.FolderResponse</code></summary>
739
+ ## Project Permissions
740
+ <details><summary><code>client.projectPermissions.<a href="/src/api/resources/projectPermissions/client/Client.ts">index</a>(account_id, project_id, { ...params }) -> core.Page&lt;Frameio.UserRole, Frameio.ProjectUserRolesResponse&gt;</code></summary>
753
741
  <dl>
754
742
  <dd>
755
743
 
@@ -761,7 +749,7 @@ await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
761
749
  <dl>
762
750
  <dd>
763
751
 
764
- Update folder details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
752
+ List user roles for a given project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
765
753
  </dd>
766
754
  </dl>
767
755
  </dd>
@@ -776,11 +764,29 @@ Update folder details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account
776
764
  <dd>
777
765
 
778
766
  ```typescript
779
- await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
780
- data: {
781
- name: "Folder name"
782
- }
767
+ const pageableResponse = await client.projectPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
768
+ include_deactivated: true,
769
+ after: "<opaque_cursor>",
770
+ page_size: 10,
771
+ include_total_count: false
772
+ });
773
+ for await (const item of pageableResponse) {
774
+ console.log(item);
775
+ }
776
+
777
+ // Or you can manually iterate page-by-page
778
+ let page = await client.projectPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
779
+ include_deactivated: true,
780
+ after: "<opaque_cursor>",
781
+ page_size: 10,
782
+ include_total_count: false
783
783
  });
784
+ while (page.hasNextPage()) {
785
+ page = page.getNextPage();
786
+ }
787
+
788
+ // You can also access the underlying response
789
+ const response = page.response;
784
790
 
785
791
  ```
786
792
  </dd>
@@ -804,7 +810,7 @@ await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
804
810
  <dl>
805
811
  <dd>
806
812
 
807
- **folder_id:** `Frameio.Uuid` —
813
+ **project_id:** `Frameio.Uuid` —
808
814
 
809
815
  </dd>
810
816
  </dl>
@@ -812,7 +818,7 @@ await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
812
818
  <dl>
813
819
  <dd>
814
820
 
815
- **request:** `Frameio.FolderUpdateParams`
821
+ **request:** `Frameio.ProjectPermissionsIndexRequest`
816
822
 
817
823
  </dd>
818
824
  </dl>
@@ -820,7 +826,7 @@ await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
820
826
  <dl>
821
827
  <dd>
822
828
 
823
- **requestOptions:** `FoldersClient.RequestOptions`
829
+ **requestOptions:** `ProjectPermissionsClient.RequestOptions`
824
830
 
825
831
  </dd>
826
832
  </dl>
@@ -832,7 +838,7 @@ await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
832
838
  </dl>
833
839
  </details>
834
840
 
835
- <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">index</a>(account_id, folder_id, { ...params }) -> Frameio.FolderAssetsWithIncludesResponse</code></summary>
841
+ <details><summary><code>client.projectPermissions.<a href="/src/api/resources/projectPermissions/client/Client.ts">delete</a>(account_id, project_id, user_id) -> void</code></summary>
836
842
  <dl>
837
843
  <dd>
838
844
 
@@ -844,19 +850,7 @@ await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
844
850
  <dl>
845
851
  <dd>
846
852
 
847
- List the children in the given folder.
848
- <br/>
849
- Use the `include` query parameter to selectively include additional properties in the response.
850
- <br/>
851
- Note: if you include `media_links.original` and the user does not have permission to download files
852
- in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
853
- If the content is inaccessible because watermarking is required for this user and isn't supported by
854
- the requested media_links, then the request will succeed but the unsupported media links will be set to null.
855
- Similarly, if a requested transcode link does not exist for a particular file (e.g. including
856
- `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
857
- (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
858
- null in the response payload. In short, the client must handle null media links gracefully.
859
- <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
853
+ Remove a user from a given project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
860
854
  </dd>
861
855
  </dl>
862
856
  </dd>
@@ -871,13 +865,7 @@ null in the response payload. In short, the client must handle null media links
871
865
  <dd>
872
866
 
873
867
  ```typescript
874
- await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
875
- include: "media_links.original",
876
- type: "file,folder,version_stack",
877
- after: "<opaque_cursor>",
878
- page_size: 10,
879
- include_total_count: false
880
- });
868
+ await client.projectPermissions.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
881
869
 
882
870
  ```
883
871
  </dd>
@@ -901,7 +889,7 @@ await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
901
889
  <dl>
902
890
  <dd>
903
891
 
904
- **folder_id:** `Frameio.Uuid` —
892
+ **project_id:** `Frameio.Uuid` —
905
893
 
906
894
  </dd>
907
895
  </dl>
@@ -909,7 +897,7 @@ await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
909
897
  <dl>
910
898
  <dd>
911
899
 
912
- **request:** `Frameio.FoldersIndexRequest`
900
+ **user_id:** `Frameio.Uuid`
913
901
 
914
902
  </dd>
915
903
  </dl>
@@ -917,7 +905,7 @@ await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
917
905
  <dl>
918
906
  <dd>
919
907
 
920
- **requestOptions:** `FoldersClient.RequestOptions`
908
+ **requestOptions:** `ProjectPermissionsClient.RequestOptions`
921
909
 
922
910
  </dd>
923
911
  </dl>
@@ -929,7 +917,7 @@ await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
929
917
  </dl>
930
918
  </details>
931
919
 
932
- <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">copy</a>(account_id, folder_id, { ...params }) -> Frameio.FolderCopyResponse</code></summary>
920
+ <details><summary><code>client.projectPermissions.<a href="/src/api/resources/projectPermissions/client/Client.ts">projectUserRolesUpdate</a>(account_id, project_id, user_id, { ...params }) -> Frameio.UpdateUserRolesResponse</code></summary>
933
921
  <dl>
934
922
  <dd>
935
923
 
@@ -941,7 +929,8 @@ await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
941
929
  <dl>
942
930
  <dd>
943
931
 
944
- Copy folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
932
+ Update user roles for the given project if the user is already added to the project. If the user is
933
+ 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
945
934
  </dd>
946
935
  </dl>
947
936
  </dd>
@@ -956,10 +945,9 @@ Copy folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
956
945
  <dd>
957
946
 
958
947
  ```typescript
959
- await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
960
- copy_metadata: true,
948
+ await client.projectPermissions.projectUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
961
949
  data: {
962
- parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
950
+ role: "editor"
963
951
  }
964
952
  });
965
953
 
@@ -985,7 +973,7 @@ await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
985
973
  <dl>
986
974
  <dd>
987
975
 
988
- **folder_id:** `Frameio.Uuid` —
976
+ **project_id:** `Frameio.Uuid` —
989
977
 
990
978
  </dd>
991
979
  </dl>
@@ -993,7 +981,7 @@ await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
993
981
  <dl>
994
982
  <dd>
995
983
 
996
- **request:** `Frameio.FolderCopyParams`
984
+ **user_id:** `Frameio.Uuid`
997
985
 
998
986
  </dd>
999
987
  </dl>
@@ -1001,7 +989,15 @@ await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1001
989
  <dl>
1002
990
  <dd>
1003
991
 
1004
- **requestOptions:** `FoldersClient.RequestOptions`
992
+ **request:** `Frameio.UpdateUserRolesParams`
993
+
994
+ </dd>
995
+ </dl>
996
+
997
+ <dl>
998
+ <dd>
999
+
1000
+ **requestOptions:** `ProjectPermissionsClient.RequestOptions`
1005
1001
 
1006
1002
  </dd>
1007
1003
  </dl>
@@ -1013,7 +1009,8 @@ await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1013
1009
  </dl>
1014
1010
  </details>
1015
1011
 
1016
- <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">list</a>(account_id, folder_id, { ...params }) -> Frameio.FoldersWithIncludesResponse</code></summary>
1012
+ ## Folders
1013
+ <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">show</a>(account_id, folder_id, { ...params }) -> Frameio.FolderWithIncludesResponse</code></summary>
1017
1014
  <dl>
1018
1015
  <dd>
1019
1016
 
@@ -1025,7 +1022,7 @@ await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1025
1022
  <dl>
1026
1023
  <dd>
1027
1024
 
1028
- List folders in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
1025
+ Show folder details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1029
1026
  </dd>
1030
1027
  </dl>
1031
1028
  </dd>
@@ -1040,11 +1037,8 @@ List folders in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per ac
1040
1037
  <dd>
1041
1038
 
1042
1039
  ```typescript
1043
- await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1044
- include: "creator",
1045
- after: "<opaque_cursor>",
1046
- page_size: 10,
1047
- include_total_count: false
1040
+ await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1041
+ include: "creator"
1048
1042
  });
1049
1043
 
1050
1044
  ```
@@ -1077,7 +1071,7 @@ await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1077
1071
  <dl>
1078
1072
  <dd>
1079
1073
 
1080
- **request:** `Frameio.FoldersListRequest`
1074
+ **request:** `Frameio.FoldersShowRequest`
1081
1075
 
1082
1076
  </dd>
1083
1077
  </dl>
@@ -1097,7 +1091,7 @@ await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1097
1091
  </dl>
1098
1092
  </details>
1099
1093
 
1100
- <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">create</a>(account_id, folder_id, { ...params }) -> Frameio.FolderResponse</code></summary>
1094
+ <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">delete</a>(account_id, folder_id) -> void</code></summary>
1101
1095
  <dl>
1102
1096
  <dd>
1103
1097
 
@@ -1109,7 +1103,7 @@ await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1109
1103
  <dl>
1110
1104
  <dd>
1111
1105
 
1112
- 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
1106
+ Delete folder by id. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
1113
1107
  </dd>
1114
1108
  </dl>
1115
1109
  </dd>
@@ -1124,11 +1118,7 @@ Create a new folder inside the given <i>folder_id</i> path param. <br/>Rate Limi
1124
1118
  <dd>
1125
1119
 
1126
1120
  ```typescript
1127
- await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1128
- data: {
1129
- name: "Folder name"
1130
- }
1131
- });
1121
+ await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
1132
1122
 
1133
1123
  ```
1134
1124
  </dd>
@@ -1160,14 +1150,6 @@ await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
1160
1150
  <dl>
1161
1151
  <dd>
1162
1152
 
1163
- **request:** `Frameio.FolderCreateParams`
1164
-
1165
- </dd>
1166
- </dl>
1167
-
1168
- <dl>
1169
- <dd>
1170
-
1171
1153
  **requestOptions:** `FoldersClient.RequestOptions`
1172
1154
 
1173
1155
  </dd>
@@ -1180,7 +1162,7 @@ await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
1180
1162
  </dl>
1181
1163
  </details>
1182
1164
 
1183
- <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">move</a>(account_id, folder_id, { ...params }) -> Frameio.FolderResponse</code></summary>
1165
+ <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">update</a>(account_id, folder_id, { ...params }) -> Frameio.FolderResponse</code></summary>
1184
1166
  <dl>
1185
1167
  <dd>
1186
1168
 
@@ -1192,7 +1174,7 @@ await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
1192
1174
  <dl>
1193
1175
  <dd>
1194
1176
 
1195
- Move folder to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1177
+ Update folder details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1196
1178
  </dd>
1197
1179
  </dl>
1198
1180
  </dd>
@@ -1207,9 +1189,9 @@ Move folder to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per accou
1207
1189
  <dd>
1208
1190
 
1209
1191
  ```typescript
1210
- await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1192
+ await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1211
1193
  data: {
1212
- parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
1194
+ name: "Folder name"
1213
1195
  }
1214
1196
  });
1215
1197
 
@@ -1243,7 +1225,7 @@ await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1243
1225
  <dl>
1244
1226
  <dd>
1245
1227
 
1246
- **request:** `Frameio.FolderMoveParams`
1228
+ **request:** `Frameio.FolderUpdateParams`
1247
1229
 
1248
1230
  </dd>
1249
1231
  </dl>
@@ -1263,8 +1245,7 @@ await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1263
1245
  </dl>
1264
1246
  </details>
1265
1247
 
1266
- ## Version Stacks
1267
- <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">index</a>(account_id, version_stack_id, { ...params }) -> Frameio.VersionStackAssetsWithIncludesResponse</code></summary>
1248
+ <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">index</a>(account_id, folder_id, { ...params }) -> Frameio.FolderAssetsWithIncludesResponse</code></summary>
1268
1249
  <dl>
1269
1250
  <dd>
1270
1251
 
@@ -1276,7 +1257,7 @@ await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
1276
1257
  <dl>
1277
1258
  <dd>
1278
1259
 
1279
- List the children (files) in a given version stack.
1260
+ List the children in the given folder.
1280
1261
  <br/>
1281
1262
  Use the `include` query parameter to selectively include additional properties in the response.
1282
1263
  <br/>
@@ -1303,8 +1284,9 @@ null in the response payload. In short, the client must handle null media links
1303
1284
  <dd>
1304
1285
 
1305
1286
  ```typescript
1306
- await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1287
+ await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1307
1288
  include: "media_links.original",
1289
+ type: "file,folder,version_stack",
1308
1290
  after: "<opaque_cursor>",
1309
1291
  page_size: 10,
1310
1292
  include_total_count: false
@@ -1332,7 +1314,7 @@ await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
1332
1314
  <dl>
1333
1315
  <dd>
1334
1316
 
1335
- **version_stack_id:** `Frameio.Uuid` —
1317
+ **folder_id:** `Frameio.Uuid` —
1336
1318
 
1337
1319
  </dd>
1338
1320
  </dl>
@@ -1340,7 +1322,7 @@ await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
1340
1322
  <dl>
1341
1323
  <dd>
1342
1324
 
1343
- **request:** `Frameio.VersionStacksIndexRequest`
1325
+ **request:** `Frameio.FoldersIndexRequest`
1344
1326
 
1345
1327
  </dd>
1346
1328
  </dl>
@@ -1348,7 +1330,7 @@ await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
1348
1330
  <dl>
1349
1331
  <dd>
1350
1332
 
1351
- **requestOptions:** `VersionStacksClient.RequestOptions`
1333
+ **requestOptions:** `FoldersClient.RequestOptions`
1352
1334
 
1353
1335
  </dd>
1354
1336
  </dl>
@@ -1360,7 +1342,7 @@ await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
1360
1342
  </dl>
1361
1343
  </details>
1362
1344
 
1363
- <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">show</a>(account_id, version_stack_id, { ...params }) -> Frameio.VersionStackWithIncludesResponse</code></summary>
1345
+ <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">copy</a>(account_id, folder_id, { ...params }) -> Frameio.FolderCopyResponse</code></summary>
1364
1346
  <dl>
1365
1347
  <dd>
1366
1348
 
@@ -1372,7 +1354,7 @@ await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
1372
1354
  <dl>
1373
1355
  <dd>
1374
1356
 
1375
- Show version stack details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1357
+ Copy folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1376
1358
  </dd>
1377
1359
  </dl>
1378
1360
  </dd>
@@ -1387,8 +1369,11 @@ Show version stack details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per a
1387
1369
  <dd>
1388
1370
 
1389
1371
  ```typescript
1390
- await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1391
- include: "media_links.original"
1372
+ await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1373
+ copy_metadata: true,
1374
+ data: {
1375
+ parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
1376
+ }
1392
1377
  });
1393
1378
 
1394
1379
  ```
@@ -1413,7 +1398,7 @@ await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1413
1398
  <dl>
1414
1399
  <dd>
1415
1400
 
1416
- **version_stack_id:** `Frameio.Uuid` —
1401
+ **folder_id:** `Frameio.Uuid` —
1417
1402
 
1418
1403
  </dd>
1419
1404
  </dl>
@@ -1421,7 +1406,7 @@ await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1421
1406
  <dl>
1422
1407
  <dd>
1423
1408
 
1424
- **request:** `Frameio.VersionStacksShowRequest`
1409
+ **request:** `Frameio.FolderCopyParams`
1425
1410
 
1426
1411
  </dd>
1427
1412
  </dl>
@@ -1429,7 +1414,7 @@ await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1429
1414
  <dl>
1430
1415
  <dd>
1431
1416
 
1432
- **requestOptions:** `VersionStacksClient.RequestOptions`
1417
+ **requestOptions:** `FoldersClient.RequestOptions`
1433
1418
 
1434
1419
  </dd>
1435
1420
  </dl>
@@ -1441,7 +1426,7 @@ await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1441
1426
  </dl>
1442
1427
  </details>
1443
1428
 
1444
- <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">copy</a>(account_id, version_stack_id, { ...params }) -> Frameio.VersionStackCopyResponse</code></summary>
1429
+ <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">list</a>(account_id, folder_id, { ...params }) -> Frameio.FoldersWithIncludesResponse</code></summary>
1445
1430
  <dl>
1446
1431
  <dd>
1447
1432
 
@@ -1453,11 +1438,7 @@ await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1453
1438
  <dl>
1454
1439
  <dd>
1455
1440
 
1456
- Copy version stack. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user<br><br>
1457
-
1458
- Currently, copying version stacks between Adobe storage backed projects is not supported. Copying individual
1459
- files within a version stack and then restacking them is currently the supported method for copying version
1460
- stacks for these projects.
1441
+ List folders in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
1461
1442
  </dd>
1462
1443
  </dl>
1463
1444
  </dd>
@@ -1472,11 +1453,11 @@ stacks for these projects.
1472
1453
  <dd>
1473
1454
 
1474
1455
  ```typescript
1475
- await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1476
- copy_metadata: true,
1477
- data: {
1478
- parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
1479
- }
1456
+ await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1457
+ include: "creator",
1458
+ after: "<opaque_cursor>",
1459
+ page_size: 10,
1460
+ include_total_count: false
1480
1461
  });
1481
1462
 
1482
1463
  ```
@@ -1501,7 +1482,7 @@ await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1501
1482
  <dl>
1502
1483
  <dd>
1503
1484
 
1504
- **version_stack_id:** `Frameio.Uuid` —
1485
+ **folder_id:** `Frameio.Uuid` —
1505
1486
 
1506
1487
  </dd>
1507
1488
  </dl>
@@ -1509,7 +1490,7 @@ await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1509
1490
  <dl>
1510
1491
  <dd>
1511
1492
 
1512
- **request:** `Frameio.VersionStackCopyParams`
1493
+ **request:** `Frameio.FoldersListRequest`
1513
1494
 
1514
1495
  </dd>
1515
1496
  </dl>
@@ -1517,7 +1498,7 @@ await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1517
1498
  <dl>
1518
1499
  <dd>
1519
1500
 
1520
- **requestOptions:** `VersionStacksClient.RequestOptions`
1501
+ **requestOptions:** `FoldersClient.RequestOptions`
1521
1502
 
1522
1503
  </dd>
1523
1504
  </dl>
@@ -1529,7 +1510,7 @@ await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1529
1510
  </dl>
1530
1511
  </details>
1531
1512
 
1532
- <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">list</a>(account_id, folder_id, { ...params }) -> Frameio.VersionStacksWithIncludesResponse</code></summary>
1513
+ <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">create</a>(account_id, folder_id, { ...params }) -> Frameio.FolderResponse</code></summary>
1533
1514
  <dl>
1534
1515
  <dd>
1535
1516
 
@@ -1541,7 +1522,7 @@ await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1541
1522
  <dl>
1542
1523
  <dd>
1543
1524
 
1544
- List version stacks in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
1525
+ 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
1545
1526
  </dd>
1546
1527
  </dl>
1547
1528
  </dd>
@@ -1556,11 +1537,10 @@ List version stacks in a given folder. <br/>Rate Limits: 5 calls per 1 second(s
1556
1537
  <dd>
1557
1538
 
1558
1539
  ```typescript
1559
- await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1560
- include: "media_links.original",
1561
- after: "<opaque_cursor>",
1562
- page_size: 10,
1563
- include_total_count: false
1540
+ await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1541
+ data: {
1542
+ name: "Folder name"
1543
+ }
1564
1544
  });
1565
1545
 
1566
1546
  ```
@@ -1593,7 +1573,7 @@ await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1593
1573
  <dl>
1594
1574
  <dd>
1595
1575
 
1596
- **request:** `Frameio.VersionStacksListRequest`
1576
+ **request:** `Frameio.FolderCreateParams`
1597
1577
 
1598
1578
  </dd>
1599
1579
  </dl>
@@ -1601,7 +1581,7 @@ await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1601
1581
  <dl>
1602
1582
  <dd>
1603
1583
 
1604
- **requestOptions:** `VersionStacksClient.RequestOptions`
1584
+ **requestOptions:** `FoldersClient.RequestOptions`
1605
1585
 
1606
1586
  </dd>
1607
1587
  </dl>
@@ -1613,7 +1593,7 @@ await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1613
1593
  </dl>
1614
1594
  </details>
1615
1595
 
1616
- <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">create</a>(account_id, folder_id, { ...params }) -> Frameio.VersionStackWithIncludesResponse</code></summary>
1596
+ <details><summary><code>client.folders.<a href="/src/api/resources/folders/client/Client.ts">move</a>(account_id, folder_id, { ...params }) -> Frameio.FolderResponse</code></summary>
1617
1597
  <dl>
1618
1598
  <dd>
1619
1599
 
@@ -1625,7 +1605,7 @@ await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1625
1605
  <dl>
1626
1606
  <dd>
1627
1607
 
1628
- Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1608
+ Move folder to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1629
1609
  </dd>
1630
1610
  </dl>
1631
1611
  </dd>
@@ -1640,9 +1620,9 @@ Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls p
1640
1620
  <dd>
1641
1621
 
1642
1622
  ```typescript
1643
- await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1623
+ await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1644
1624
  data: {
1645
- file_ids: ["caeb2589-1ce1-45f4-ab94-3f5f87527cfa", "e768892b-dafe-4634-abf6-6e0e63624100"]
1625
+ parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
1646
1626
  }
1647
1627
  });
1648
1628
 
@@ -1676,7 +1656,7 @@ await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702
1676
1656
  <dl>
1677
1657
  <dd>
1678
1658
 
1679
- **request:** `Frameio.VersionStackCreateParams`
1659
+ **request:** `Frameio.FolderMoveParams`
1680
1660
 
1681
1661
  </dd>
1682
1662
  </dl>
@@ -1684,7 +1664,7 @@ await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702
1684
1664
  <dl>
1685
1665
  <dd>
1686
1666
 
1687
- **requestOptions:** `VersionStacksClient.RequestOptions`
1667
+ **requestOptions:** `FoldersClient.RequestOptions`
1688
1668
 
1689
1669
  </dd>
1690
1670
  </dl>
@@ -1696,7 +1676,8 @@ await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702
1696
1676
  </dl>
1697
1677
  </details>
1698
1678
 
1699
- <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">move</a>(account_id, version_stack_id, { ...params }) -> Frameio.VersionStackResponse</code></summary>
1679
+ ## Version Stacks
1680
+ <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">index</a>(account_id, version_stack_id, { ...params }) -> Frameio.VersionStackAssetsWithIncludesResponse</code></summary>
1700
1681
  <dl>
1701
1682
  <dd>
1702
1683
 
@@ -1708,7 +1689,19 @@ await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702
1708
1689
  <dl>
1709
1690
  <dd>
1710
1691
 
1711
- Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1692
+ List the children (files) in a given version stack.
1693
+ <br/>
1694
+ Use the `include` query parameter to selectively include additional properties in the response.
1695
+ <br/>
1696
+ Note: if you include `media_links.original` and the user does not have permission to download files
1697
+ in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
1698
+ If the content is inaccessible because watermarking is required for this user and isn't supported by
1699
+ the requested media_links, then the request will succeed but the unsupported media links will be set to null.
1700
+ Similarly, if a requested transcode link does not exist for a particular file (e.g. including
1701
+ `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
1702
+ (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
1703
+ null in the response payload. In short, the client must handle null media links gracefully.
1704
+ <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1712
1705
  </dd>
1713
1706
  </dl>
1714
1707
  </dd>
@@ -1723,10 +1716,11 @@ Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) pe
1723
1716
  <dd>
1724
1717
 
1725
1718
  ```typescript
1726
- await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1727
- data: {
1728
- parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
1729
- }
1719
+ await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1720
+ include: "media_links.original",
1721
+ after: "<opaque_cursor>",
1722
+ page_size: 10,
1723
+ include_total_count: false
1730
1724
  });
1731
1725
 
1732
1726
  ```
@@ -1759,7 +1753,7 @@ await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1759
1753
  <dl>
1760
1754
  <dd>
1761
1755
 
1762
- **request:** `Frameio.VersionStackMoveParams`
1756
+ **request:** `Frameio.VersionStacksIndexRequest`
1763
1757
 
1764
1758
  </dd>
1765
1759
  </dl>
@@ -1779,8 +1773,7 @@ await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1779
1773
  </dl>
1780
1774
  </details>
1781
1775
 
1782
- ## Account Permissions
1783
- <details><summary><code>client.accountPermissions.<a href="/src/api/resources/accountPermissions/client/Client.ts">index</a>(account_id, { ...params }) -> core.Page&lt;Frameio.AccountUserRole, Frameio.AccountUserRolesResponse&gt;</code></summary>
1776
+ <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">show</a>(account_id, version_stack_id, { ...params }) -> Frameio.VersionStackWithIncludesResponse</code></summary>
1784
1777
  <dl>
1785
1778
  <dd>
1786
1779
 
@@ -1792,7 +1785,7 @@ await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
1792
1785
  <dl>
1793
1786
  <dd>
1794
1787
 
1795
- List user roles for a given account. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1788
+ Show version stack details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
1796
1789
  </dd>
1797
1790
  </dl>
1798
1791
  </dd>
@@ -1807,29 +1800,9 @@ List user roles for a given account. <br/>Rate Limits: 100 calls per 1.00 minute
1807
1800
  <dd>
1808
1801
 
1809
1802
  ```typescript
1810
- const pageableResponse = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1811
- include_deactivated: true,
1812
- after: "<opaque_cursor>",
1813
- page_size: 10,
1814
- include_total_count: false
1815
- });
1816
- for await (const item of pageableResponse) {
1817
- console.log(item);
1818
- }
1819
-
1820
- // Or you can manually iterate page-by-page
1821
- let page = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1822
- include_deactivated: true,
1823
- after: "<opaque_cursor>",
1824
- page_size: 10,
1825
- include_total_count: false
1803
+ await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1804
+ include: "media_links.original"
1826
1805
  });
1827
- while (page.hasNextPage()) {
1828
- page = page.getNextPage();
1829
- }
1830
-
1831
- // You can also access the underlying response
1832
- const response = page.response;
1833
1806
 
1834
1807
  ```
1835
1808
  </dd>
@@ -1853,7 +1826,7 @@ const response = page.response;
1853
1826
  <dl>
1854
1827
  <dd>
1855
1828
 
1856
- **request:** `Frameio.AccountPermissionsIndexRequest`
1829
+ **version_stack_id:** `Frameio.Uuid`
1857
1830
 
1858
1831
  </dd>
1859
1832
  </dl>
@@ -1861,7 +1834,15 @@ const response = page.response;
1861
1834
  <dl>
1862
1835
  <dd>
1863
1836
 
1864
- **requestOptions:** `AccountPermissionsClient.RequestOptions`
1837
+ **request:** `Frameio.VersionStacksShowRequest`
1838
+
1839
+ </dd>
1840
+ </dl>
1841
+
1842
+ <dl>
1843
+ <dd>
1844
+
1845
+ **requestOptions:** `VersionStacksClient.RequestOptions`
1865
1846
 
1866
1847
  </dd>
1867
1848
  </dl>
@@ -1873,8 +1854,7 @@ const response = page.response;
1873
1854
  </dl>
1874
1855
  </details>
1875
1856
 
1876
- ## Comments
1877
- <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">deleteAttachment</a>(account_id, comment_id, attachment_id) -> void</code></summary>
1857
+ <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">copy</a>(account_id, version_stack_id, { ...params }) -> Frameio.VersionStackCopyResponse</code></summary>
1878
1858
  <dl>
1879
1859
  <dd>
1880
1860
 
@@ -1886,7 +1866,11 @@ const response = page.response;
1886
1866
  <dl>
1887
1867
  <dd>
1888
1868
 
1889
- Delete an attachment from a comment. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
1869
+ Copy version stack. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user<br><br>
1870
+
1871
+ Currently, copying version stacks between Adobe storage backed projects is not supported. Copying individual
1872
+ files within a version stack and then restacking them is currently the supported method for copying version
1873
+ stacks for these projects.
1890
1874
  </dd>
1891
1875
  </dl>
1892
1876
  </dd>
@@ -1901,7 +1885,12 @@ Delete an attachment from a comment. <br/>Rate Limits: 60 calls per 1.00 minute(
1901
1885
  <dd>
1902
1886
 
1903
1887
  ```typescript
1904
- await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
1888
+ await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1889
+ copy_metadata: true,
1890
+ data: {
1891
+ parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
1892
+ }
1893
+ });
1905
1894
 
1906
1895
  ```
1907
1896
  </dd>
@@ -1925,7 +1914,7 @@ await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
1925
1914
  <dl>
1926
1915
  <dd>
1927
1916
 
1928
- **comment_id:** `Frameio.Uuid` —
1917
+ **version_stack_id:** `Frameio.Uuid` —
1929
1918
 
1930
1919
  </dd>
1931
1920
  </dl>
@@ -1933,7 +1922,7 @@ await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
1933
1922
  <dl>
1934
1923
  <dd>
1935
1924
 
1936
- **attachment_id:** `Frameio.Uuid`
1925
+ **request:** `Frameio.VersionStackCopyParams`
1937
1926
 
1938
1927
  </dd>
1939
1928
  </dl>
@@ -1941,7 +1930,7 @@ await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
1941
1930
  <dl>
1942
1931
  <dd>
1943
1932
 
1944
- **requestOptions:** `CommentsClient.RequestOptions`
1933
+ **requestOptions:** `VersionStacksClient.RequestOptions`
1945
1934
 
1946
1935
  </dd>
1947
1936
  </dl>
@@ -1953,7 +1942,7 @@ await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
1953
1942
  </dl>
1954
1943
  </details>
1955
1944
 
1956
- <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">createAttachment</a>(account_id, comment_id, { ...params }) -> Frameio.CommentAttachmentResponse</code></summary>
1945
+ <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">list</a>(account_id, folder_id, { ...params }) -> Frameio.VersionStacksWithIncludesResponse</code></summary>
1957
1946
  <dl>
1958
1947
  <dd>
1959
1948
 
@@ -1965,7 +1954,7 @@ await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
1965
1954
  <dl>
1966
1955
  <dd>
1967
1956
 
1968
- Create an attachment for an existing comment. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
1957
+ List version stacks in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
1969
1958
  </dd>
1970
1959
  </dl>
1971
1960
  </dd>
@@ -1980,12 +1969,11 @@ Create an attachment for an existing comment. <br/>Rate Limits: 10 calls per 1.0
1980
1969
  <dd>
1981
1970
 
1982
1971
  ```typescript
1983
- await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1984
- data: {
1985
- file_size: 1024000,
1986
- media_type: "image/png",
1987
- name: "screenshot.png"
1988
- }
1972
+ await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
1973
+ include: "media_links.original",
1974
+ after: "<opaque_cursor>",
1975
+ page_size: 10,
1976
+ include_total_count: false
1989
1977
  });
1990
1978
 
1991
1979
  ```
@@ -2010,7 +1998,7 @@ await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
2010
1998
  <dl>
2011
1999
  <dd>
2012
2000
 
2013
- **comment_id:** `Frameio.Uuid` —
2001
+ **folder_id:** `Frameio.Uuid` —
2014
2002
 
2015
2003
  </dd>
2016
2004
  </dl>
@@ -2018,7 +2006,7 @@ await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
2018
2006
  <dl>
2019
2007
  <dd>
2020
2008
 
2021
- **request:** `Frameio.CreateAttachmentParams`
2009
+ **request:** `Frameio.VersionStacksListRequest`
2022
2010
 
2023
2011
  </dd>
2024
2012
  </dl>
@@ -2026,7 +2014,7 @@ await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
2026
2014
  <dl>
2027
2015
  <dd>
2028
2016
 
2029
- **requestOptions:** `CommentsClient.RequestOptions`
2017
+ **requestOptions:** `VersionStacksClient.RequestOptions`
2030
2018
 
2031
2019
  </dd>
2032
2020
  </dl>
@@ -2038,7 +2026,7 @@ await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
2038
2026
  </dl>
2039
2027
  </details>
2040
2028
 
2041
- <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">show</a>(account_id, comment_id, { ...params }) -> Frameio.CommentWithIncludesResponse</code></summary>
2029
+ <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">create</a>(account_id, folder_id, { ...params }) -> Frameio.VersionStackWithIncludesResponse</code></summary>
2042
2030
  <dl>
2043
2031
  <dd>
2044
2032
 
@@ -2050,7 +2038,7 @@ await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "
2050
2038
  <dl>
2051
2039
  <dd>
2052
2040
 
2053
- Show a single comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2041
+ Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
2054
2042
  </dd>
2055
2043
  </dl>
2056
2044
  </dd>
@@ -2065,9 +2053,10 @@ Show a single comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s)
2065
2053
  <dd>
2066
2054
 
2067
2055
  ```typescript
2068
- await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2069
- timestamp_as_timecode: true,
2070
- include: "owner"
2056
+ await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2057
+ data: {
2058
+ file_ids: ["aaeb409d-081a-4231-9955-61c3c79125ff", "60588662-df62-412b-bad1-6692811c26bb"]
2059
+ }
2071
2060
  });
2072
2061
 
2073
2062
  ```
@@ -2092,7 +2081,7 @@ await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2092
2081
  <dl>
2093
2082
  <dd>
2094
2083
 
2095
- **comment_id:** `Frameio.Uuid` —
2084
+ **folder_id:** `Frameio.Uuid` —
2096
2085
 
2097
2086
  </dd>
2098
2087
  </dl>
@@ -2100,7 +2089,7 @@ await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2100
2089
  <dl>
2101
2090
  <dd>
2102
2091
 
2103
- **request:** `Frameio.CommentsShowRequest`
2092
+ **request:** `Frameio.VersionStackCreateParams`
2104
2093
 
2105
2094
  </dd>
2106
2095
  </dl>
@@ -2108,7 +2097,7 @@ await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2108
2097
  <dl>
2109
2098
  <dd>
2110
2099
 
2111
- **requestOptions:** `CommentsClient.RequestOptions`
2100
+ **requestOptions:** `VersionStacksClient.RequestOptions`
2112
2101
 
2113
2102
  </dd>
2114
2103
  </dl>
@@ -2120,7 +2109,7 @@ await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2120
2109
  </dl>
2121
2110
  </details>
2122
2111
 
2123
- <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">delete</a>(account_id, comment_id) -> void</code></summary>
2112
+ <details><summary><code>client.versionStacks.<a href="/src/api/resources/versionStacks/client/Client.ts">move</a>(account_id, version_stack_id, { ...params }) -> Frameio.VersionStackResponse</code></summary>
2124
2113
  <dl>
2125
2114
  <dd>
2126
2115
 
@@ -2132,7 +2121,7 @@ await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2132
2121
  <dl>
2133
2122
  <dd>
2134
2123
 
2135
- Delete comment from an asset. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
2124
+ Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
2136
2125
  </dd>
2137
2126
  </dl>
2138
2127
  </dd>
@@ -2147,7 +2136,11 @@ Delete comment from an asset. <br/>Rate Limits: 60 calls per 1.00 minute(s) per
2147
2136
  <dd>
2148
2137
 
2149
2138
  ```typescript
2150
- await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
2139
+ await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2140
+ data: {
2141
+ parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
2142
+ }
2143
+ });
2151
2144
 
2152
2145
  ```
2153
2146
  </dd>
@@ -2171,7 +2164,7 @@ await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2171
2164
  <dl>
2172
2165
  <dd>
2173
2166
 
2174
- **comment_id:** `Frameio.Uuid` —
2167
+ **version_stack_id:** `Frameio.Uuid` —
2175
2168
 
2176
2169
  </dd>
2177
2170
  </dl>
@@ -2179,7 +2172,15 @@ await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2179
2172
  <dl>
2180
2173
  <dd>
2181
2174
 
2182
- **requestOptions:** `CommentsClient.RequestOptions`
2175
+ **request:** `Frameio.VersionStackMoveParams`
2176
+
2177
+ </dd>
2178
+ </dl>
2179
+
2180
+ <dl>
2181
+ <dd>
2182
+
2183
+ **requestOptions:** `VersionStacksClient.RequestOptions`
2183
2184
 
2184
2185
  </dd>
2185
2186
  </dl>
@@ -2191,7 +2192,8 @@ await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2191
2192
  </dl>
2192
2193
  </details>
2193
2194
 
2194
- <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">update</a>(account_id, comment_id, { ...params }) -> Frameio.CommentResponse</code></summary>
2195
+ ## Account Permissions
2196
+ <details><summary><code>client.accountPermissions.<a href="/src/api/resources/accountPermissions/client/Client.ts">index</a>(account_id, { ...params }) -> core.Page&lt;Frameio.AccountUserRole, Frameio.AccountUserRolesResponse&gt;</code></summary>
2195
2197
  <dl>
2196
2198
  <dd>
2197
2199
 
@@ -2203,7 +2205,7 @@ await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2203
2205
  <dl>
2204
2206
  <dd>
2205
2207
 
2206
- Update comment on given asset.<br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
2208
+ List user roles for a given account. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2207
2209
  </dd>
2208
2210
  </dl>
2209
2211
  </dd>
@@ -2218,30 +2220,29 @@ Update comment on given asset.<br/>Rate Limits: 10 calls per 1.00 minute(s) per
2218
2220
  <dd>
2219
2221
 
2220
2222
  ```typescript
2221
- await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2222
- timestamp_as_timecode: true,
2223
- data: {
2224
- anchor: {
2225
- x: 0.5,
2226
- y: 0.5
2227
- },
2228
- annotation: "[{\"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}]",
2229
- completed: false,
2230
- duration: 10,
2231
- links: [{
2232
- end_index: 13,
2233
- start_index: 5,
2234
- url: "https://www.example.com"
2235
- }],
2236
- page: 4,
2237
- text: "This is great!",
2238
- text_review_annotation: {
2239
- selection_text: "existing copy",
2240
- suggested_text: "updated copy"
2241
- },
2242
- timestamp: 100
2243
- }
2223
+ const pageableResponse = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2224
+ include_deactivated: true,
2225
+ after: "<opaque_cursor>",
2226
+ page_size: 10,
2227
+ include_total_count: false
2228
+ });
2229
+ for await (const item of pageableResponse) {
2230
+ console.log(item);
2231
+ }
2232
+
2233
+ // Or you can manually iterate page-by-page
2234
+ let page = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2235
+ include_deactivated: true,
2236
+ after: "<opaque_cursor>",
2237
+ page_size: 10,
2238
+ include_total_count: false
2244
2239
  });
2240
+ while (page.hasNextPage()) {
2241
+ page = page.getNextPage();
2242
+ }
2243
+
2244
+ // You can also access the underlying response
2245
+ const response = page.response;
2245
2246
 
2246
2247
  ```
2247
2248
  </dd>
@@ -2265,15 +2266,7 @@ await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2265
2266
  <dl>
2266
2267
  <dd>
2267
2268
 
2268
- **comment_id:** `Frameio.Uuid`
2269
-
2270
- </dd>
2271
- </dl>
2272
-
2273
- <dl>
2274
- <dd>
2275
-
2276
- **request:** `Frameio.UpdateCommentParams`
2269
+ **request:** `Frameio.AccountPermissionsIndexRequest`
2277
2270
 
2278
2271
  </dd>
2279
2272
  </dl>
@@ -2281,7 +2274,7 @@ await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2281
2274
  <dl>
2282
2275
  <dd>
2283
2276
 
2284
- **requestOptions:** `CommentsClient.RequestOptions`
2277
+ **requestOptions:** `AccountPermissionsClient.RequestOptions`
2285
2278
 
2286
2279
  </dd>
2287
2280
  </dl>
@@ -2293,7 +2286,8 @@ await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2293
2286
  </dl>
2294
2287
  </details>
2295
2288
 
2296
- <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">index</a>(account_id, file_id, { ...params }) -> core.Page&lt;Frameio.CommentWithIncludes, Frameio.CommentsWithIncludesResponse&gt;</code></summary>
2289
+ ## Comments
2290
+ <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">deleteAttachment</a>(account_id, comment_id, attachment_id) -> void</code></summary>
2297
2291
  <dl>
2298
2292
  <dd>
2299
2293
 
@@ -2305,7 +2299,7 @@ await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2305
2299
  <dl>
2306
2300
  <dd>
2307
2301
 
2308
- List comments on a given asset. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2302
+ Delete an attachment from a comment. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
2309
2303
  </dd>
2310
2304
  </dl>
2311
2305
  </dd>
@@ -2320,33 +2314,7 @@ List comments on a given asset. <br/>Rate Limits: 100 calls per 1.00 minute(s) p
2320
2314
  <dd>
2321
2315
 
2322
2316
  ```typescript
2323
- const pageableResponse = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2324
- timestamp_as_timecode: true,
2325
- include: "owner",
2326
- sort: "owner_asc",
2327
- after: "<opaque_cursor>",
2328
- page_size: 10,
2329
- include_total_count: false
2330
- });
2331
- for await (const item of pageableResponse) {
2332
- console.log(item);
2333
- }
2334
-
2335
- // Or you can manually iterate page-by-page
2336
- let page = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2337
- timestamp_as_timecode: true,
2338
- include: "owner",
2339
- sort: "owner_asc",
2340
- after: "<opaque_cursor>",
2341
- page_size: 10,
2342
- include_total_count: false
2343
- });
2344
- while (page.hasNextPage()) {
2345
- page = page.getNextPage();
2346
- }
2347
-
2348
- // You can also access the underlying response
2349
- const response = page.response;
2317
+ await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
2350
2318
 
2351
2319
  ```
2352
2320
  </dd>
@@ -2370,7 +2338,7 @@ const response = page.response;
2370
2338
  <dl>
2371
2339
  <dd>
2372
2340
 
2373
- **file_id:** `Frameio.Uuid` —
2341
+ **comment_id:** `Frameio.Uuid` —
2374
2342
 
2375
2343
  </dd>
2376
2344
  </dl>
@@ -2378,7 +2346,7 @@ const response = page.response;
2378
2346
  <dl>
2379
2347
  <dd>
2380
2348
 
2381
- **request:** `Frameio.CommentsIndexRequest`
2349
+ **attachment_id:** `Frameio.Uuid`
2382
2350
 
2383
2351
  </dd>
2384
2352
  </dl>
@@ -2398,7 +2366,7 @@ const response = page.response;
2398
2366
  </dl>
2399
2367
  </details>
2400
2368
 
2401
- <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">create</a>(account_id, file_id, { ...params }) -> Frameio.CommentResponse</code></summary>
2369
+ <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">createAttachment</a>(account_id, comment_id, { ...params }) -> Frameio.CommentAttachmentResponse</code></summary>
2402
2370
  <dl>
2403
2371
  <dd>
2404
2372
 
@@ -2410,7 +2378,7 @@ const response = page.response;
2410
2378
  <dl>
2411
2379
  <dd>
2412
2380
 
2413
- Create a comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2381
+ Create an attachment for an existing comment. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
2414
2382
  </dd>
2415
2383
  </dl>
2416
2384
  </dd>
@@ -2425,40 +2393,11 @@ Create a comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per a
2425
2393
  <dd>
2426
2394
 
2427
2395
  ```typescript
2428
- await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2429
- timestamp_as_timecode: true,
2396
+ await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2430
2397
  data: {
2431
- anchor: {
2432
- x: 0.5,
2433
- y: 0.5
2434
- },
2435
- annotation: "[{\"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}]",
2436
- attachments: [{
2437
- file_size: 1024000,
2438
- media_type: "image/png",
2439
- name: "screenshot.png"
2440
- }],
2441
- completed: false,
2442
- duration: 10,
2443
- links: [{
2444
- end_index: 13,
2445
- start_index: 5,
2446
- url: "https://www.example.com"
2447
- }],
2448
- page: 4,
2449
- text: "This is great!",
2450
- text_review_annotation: {
2451
- bounds: [{
2452
- height: 42,
2453
- width: 130,
2454
- x: 12.5,
2455
- y: 24
2456
- }],
2457
- selection_text: "existing copy",
2458
- suggested_text: "updated copy",
2459
- text_review_annotation_type: "replace"
2460
- },
2461
- timestamp: "00:00:02:12"
2398
+ file_size: 1024000,
2399
+ media_type: "image/png",
2400
+ name: "screenshot.png"
2462
2401
  }
2463
2402
  });
2464
2403
 
@@ -2484,7 +2423,7 @@ await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2484
2423
  <dl>
2485
2424
  <dd>
2486
2425
 
2487
- **file_id:** `Frameio.Uuid` —
2426
+ **comment_id:** `Frameio.Uuid` —
2488
2427
 
2489
2428
  </dd>
2490
2429
  </dl>
@@ -2492,7 +2431,7 @@ await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2492
2431
  <dl>
2493
2432
  <dd>
2494
2433
 
2495
- **request:** `Frameio.CreateCommentParams`
2434
+ **request:** `Frameio.CreateAttachmentParams`
2496
2435
 
2497
2436
  </dd>
2498
2437
  </dl>
@@ -2512,8 +2451,7 @@ await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2512
2451
  </dl>
2513
2452
  </details>
2514
2453
 
2515
- ## Accounts
2516
- <details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">index</a>({ ...params }) -> core.Page&lt;Frameio.Account, Frameio.AccountsResponse&gt;</code></summary>
2454
+ <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">show</a>(account_id, comment_id, { ...params }) -> Frameio.CommentWithIncludesResponse</code></summary>
2517
2455
  <dl>
2518
2456
  <dd>
2519
2457
 
@@ -2525,7 +2463,7 @@ await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2525
2463
  <dl>
2526
2464
  <dd>
2527
2465
 
2528
- List accounts for the current user. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2466
+ Show a single comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2529
2467
  </dd>
2530
2468
  </dl>
2531
2469
  </dd>
@@ -2540,27 +2478,833 @@ List accounts for the current user. <br/>Rate Limits: 100 calls per 1.00 minute(
2540
2478
  <dd>
2541
2479
 
2542
2480
  ```typescript
2543
- const pageableResponse = await client.accounts.index({
2544
- after: "<opaque_cursor>",
2545
- page_size: 10,
2546
- include_total_count: false
2481
+ await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2482
+ timestamp_as_timecode: true,
2483
+ include: "owner"
2547
2484
  });
2548
- for await (const item of pageableResponse) {
2549
- console.log(item);
2550
- }
2551
2485
 
2552
- // Or you can manually iterate page-by-page
2553
- let page = await client.accounts.index({
2554
- after: "<opaque_cursor>",
2555
- page_size: 10,
2556
- include_total_count: false
2486
+ ```
2487
+ </dd>
2488
+ </dl>
2489
+ </dd>
2490
+ </dl>
2491
+
2492
+ #### ⚙️ Parameters
2493
+
2494
+ <dl>
2495
+ <dd>
2496
+
2497
+ <dl>
2498
+ <dd>
2499
+
2500
+ **account_id:** `Frameio.Uuid` —
2501
+
2502
+ </dd>
2503
+ </dl>
2504
+
2505
+ <dl>
2506
+ <dd>
2507
+
2508
+ **comment_id:** `Frameio.Uuid` —
2509
+
2510
+ </dd>
2511
+ </dl>
2512
+
2513
+ <dl>
2514
+ <dd>
2515
+
2516
+ **request:** `Frameio.CommentsShowRequest`
2517
+
2518
+ </dd>
2519
+ </dl>
2520
+
2521
+ <dl>
2522
+ <dd>
2523
+
2524
+ **requestOptions:** `CommentsClient.RequestOptions`
2525
+
2526
+ </dd>
2527
+ </dl>
2528
+ </dd>
2529
+ </dl>
2530
+
2531
+
2532
+ </dd>
2533
+ </dl>
2534
+ </details>
2535
+
2536
+ <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">delete</a>(account_id, comment_id) -> void</code></summary>
2537
+ <dl>
2538
+ <dd>
2539
+
2540
+ #### 📝 Description
2541
+
2542
+ <dl>
2543
+ <dd>
2544
+
2545
+ <dl>
2546
+ <dd>
2547
+
2548
+ Delete comment from an asset. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
2549
+ </dd>
2550
+ </dl>
2551
+ </dd>
2552
+ </dl>
2553
+
2554
+ #### 🔌 Usage
2555
+
2556
+ <dl>
2557
+ <dd>
2558
+
2559
+ <dl>
2560
+ <dd>
2561
+
2562
+ ```typescript
2563
+ await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
2564
+
2565
+ ```
2566
+ </dd>
2567
+ </dl>
2568
+ </dd>
2569
+ </dl>
2570
+
2571
+ #### ⚙️ Parameters
2572
+
2573
+ <dl>
2574
+ <dd>
2575
+
2576
+ <dl>
2577
+ <dd>
2578
+
2579
+ **account_id:** `Frameio.Uuid` —
2580
+
2581
+ </dd>
2582
+ </dl>
2583
+
2584
+ <dl>
2585
+ <dd>
2586
+
2587
+ **comment_id:** `Frameio.Uuid` —
2588
+
2589
+ </dd>
2590
+ </dl>
2591
+
2592
+ <dl>
2593
+ <dd>
2594
+
2595
+ **requestOptions:** `CommentsClient.RequestOptions`
2596
+
2597
+ </dd>
2598
+ </dl>
2599
+ </dd>
2600
+ </dl>
2601
+
2602
+
2603
+ </dd>
2604
+ </dl>
2605
+ </details>
2606
+
2607
+ <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">update</a>(account_id, comment_id, { ...params }) -> Frameio.CommentResponse</code></summary>
2608
+ <dl>
2609
+ <dd>
2610
+
2611
+ #### 📝 Description
2612
+
2613
+ <dl>
2614
+ <dd>
2615
+
2616
+ <dl>
2617
+ <dd>
2618
+
2619
+ Update comment on given asset.<br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
2620
+ </dd>
2621
+ </dl>
2622
+ </dd>
2623
+ </dl>
2624
+
2625
+ #### 🔌 Usage
2626
+
2627
+ <dl>
2628
+ <dd>
2629
+
2630
+ <dl>
2631
+ <dd>
2632
+
2633
+ ```typescript
2634
+ await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2635
+ timestamp_as_timecode: true,
2636
+ data: {
2637
+ anchor: {
2638
+ x: 0.5,
2639
+ y: 0.5
2640
+ },
2641
+ annotation: "[{\"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}]",
2642
+ completed: false,
2643
+ duration: 10,
2644
+ links: [{
2645
+ end_index: 13,
2646
+ start_index: 5,
2647
+ url: "https://www.example.com"
2648
+ }],
2649
+ page: 4,
2650
+ text: "This is great!",
2651
+ text_review_annotation: {
2652
+ selection_text: "existing copy",
2653
+ suggested_text: "updated copy"
2654
+ },
2655
+ timestamp: 100
2656
+ }
2657
+ });
2658
+
2659
+ ```
2660
+ </dd>
2661
+ </dl>
2662
+ </dd>
2663
+ </dl>
2664
+
2665
+ #### ⚙️ Parameters
2666
+
2667
+ <dl>
2668
+ <dd>
2669
+
2670
+ <dl>
2671
+ <dd>
2672
+
2673
+ **account_id:** `Frameio.Uuid` —
2674
+
2675
+ </dd>
2676
+ </dl>
2677
+
2678
+ <dl>
2679
+ <dd>
2680
+
2681
+ **comment_id:** `Frameio.Uuid` —
2682
+
2683
+ </dd>
2684
+ </dl>
2685
+
2686
+ <dl>
2687
+ <dd>
2688
+
2689
+ **request:** `Frameio.UpdateCommentParams`
2690
+
2691
+ </dd>
2692
+ </dl>
2693
+
2694
+ <dl>
2695
+ <dd>
2696
+
2697
+ **requestOptions:** `CommentsClient.RequestOptions`
2698
+
2699
+ </dd>
2700
+ </dl>
2701
+ </dd>
2702
+ </dl>
2703
+
2704
+
2705
+ </dd>
2706
+ </dl>
2707
+ </details>
2708
+
2709
+ <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">index</a>(account_id, file_id, { ...params }) -> core.Page&lt;Frameio.CommentWithIncludes, Frameio.CommentsWithIncludesResponse&gt;</code></summary>
2710
+ <dl>
2711
+ <dd>
2712
+
2713
+ #### 📝 Description
2714
+
2715
+ <dl>
2716
+ <dd>
2717
+
2718
+ <dl>
2719
+ <dd>
2720
+
2721
+ List comments on a given asset. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2722
+ </dd>
2723
+ </dl>
2724
+ </dd>
2725
+ </dl>
2726
+
2727
+ #### 🔌 Usage
2728
+
2729
+ <dl>
2730
+ <dd>
2731
+
2732
+ <dl>
2733
+ <dd>
2734
+
2735
+ ```typescript
2736
+ const pageableResponse = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2737
+ timestamp_as_timecode: true,
2738
+ include: "owner",
2739
+ sort: "owner_asc",
2740
+ after: "<opaque_cursor>",
2741
+ page_size: 10,
2742
+ include_total_count: false
2743
+ });
2744
+ for await (const item of pageableResponse) {
2745
+ console.log(item);
2746
+ }
2747
+
2748
+ // Or you can manually iterate page-by-page
2749
+ let page = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2750
+ timestamp_as_timecode: true,
2751
+ include: "owner",
2752
+ sort: "owner_asc",
2753
+ after: "<opaque_cursor>",
2754
+ page_size: 10,
2755
+ include_total_count: false
2756
+ });
2757
+ while (page.hasNextPage()) {
2758
+ page = page.getNextPage();
2759
+ }
2760
+
2761
+ // You can also access the underlying response
2762
+ const response = page.response;
2763
+
2764
+ ```
2765
+ </dd>
2766
+ </dl>
2767
+ </dd>
2768
+ </dl>
2769
+
2770
+ #### ⚙️ Parameters
2771
+
2772
+ <dl>
2773
+ <dd>
2774
+
2775
+ <dl>
2776
+ <dd>
2777
+
2778
+ **account_id:** `Frameio.Uuid` —
2779
+
2780
+ </dd>
2781
+ </dl>
2782
+
2783
+ <dl>
2784
+ <dd>
2785
+
2786
+ **file_id:** `Frameio.Uuid` —
2787
+
2788
+ </dd>
2789
+ </dl>
2790
+
2791
+ <dl>
2792
+ <dd>
2793
+
2794
+ **request:** `Frameio.CommentsIndexRequest`
2795
+
2796
+ </dd>
2797
+ </dl>
2798
+
2799
+ <dl>
2800
+ <dd>
2801
+
2802
+ **requestOptions:** `CommentsClient.RequestOptions`
2803
+
2804
+ </dd>
2805
+ </dl>
2806
+ </dd>
2807
+ </dl>
2808
+
2809
+
2810
+ </dd>
2811
+ </dl>
2812
+ </details>
2813
+
2814
+ <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">create</a>(account_id, file_id, { ...params }) -> Frameio.CommentResponse</code></summary>
2815
+ <dl>
2816
+ <dd>
2817
+
2818
+ #### 📝 Description
2819
+
2820
+ <dl>
2821
+ <dd>
2822
+
2823
+ <dl>
2824
+ <dd>
2825
+
2826
+ Create a comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2827
+ </dd>
2828
+ </dl>
2829
+ </dd>
2830
+ </dl>
2831
+
2832
+ #### 🔌 Usage
2833
+
2834
+ <dl>
2835
+ <dd>
2836
+
2837
+ <dl>
2838
+ <dd>
2839
+
2840
+ ```typescript
2841
+ await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2842
+ timestamp_as_timecode: true,
2843
+ data: {
2844
+ anchor: {
2845
+ x: 0.5,
2846
+ y: 0.5
2847
+ },
2848
+ annotation: "[{\"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}]",
2849
+ attachments: [{
2850
+ file_size: 1024000,
2851
+ media_type: "image/png",
2852
+ name: "screenshot.png"
2853
+ }],
2854
+ completed: false,
2855
+ duration: 10,
2856
+ links: [{
2857
+ end_index: 13,
2858
+ start_index: 5,
2859
+ url: "https://www.example.com"
2860
+ }],
2861
+ page: 4,
2862
+ text: "This is great!",
2863
+ text_review_annotation: {
2864
+ bounds: [{
2865
+ height: 42,
2866
+ width: 130,
2867
+ x: 12.5,
2868
+ y: 24
2869
+ }],
2870
+ selection_text: "existing copy",
2871
+ suggested_text: "updated copy",
2872
+ text_review_annotation_type: "replace"
2873
+ },
2874
+ timestamp: "00:00:02:12"
2875
+ }
2876
+ });
2877
+
2878
+ ```
2879
+ </dd>
2880
+ </dl>
2881
+ </dd>
2882
+ </dl>
2883
+
2884
+ #### ⚙️ Parameters
2885
+
2886
+ <dl>
2887
+ <dd>
2888
+
2889
+ <dl>
2890
+ <dd>
2891
+
2892
+ **account_id:** `Frameio.Uuid` —
2893
+
2894
+ </dd>
2895
+ </dl>
2896
+
2897
+ <dl>
2898
+ <dd>
2899
+
2900
+ **file_id:** `Frameio.Uuid` —
2901
+
2902
+ </dd>
2903
+ </dl>
2904
+
2905
+ <dl>
2906
+ <dd>
2907
+
2908
+ **request:** `Frameio.CreateCommentParams`
2909
+
2910
+ </dd>
2911
+ </dl>
2912
+
2913
+ <dl>
2914
+ <dd>
2915
+
2916
+ **requestOptions:** `CommentsClient.RequestOptions`
2917
+
2918
+ </dd>
2919
+ </dl>
2920
+ </dd>
2921
+ </dl>
2922
+
2923
+
2924
+ </dd>
2925
+ </dl>
2926
+ </details>
2927
+
2928
+ ## Accounts
2929
+ <details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">index</a>({ ...params }) -> core.Page&lt;Frameio.Account, Frameio.AccountsResponse&gt;</code></summary>
2930
+ <dl>
2931
+ <dd>
2932
+
2933
+ #### 📝 Description
2934
+
2935
+ <dl>
2936
+ <dd>
2937
+
2938
+ <dl>
2939
+ <dd>
2940
+
2941
+ List accounts for the current user. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2942
+ </dd>
2943
+ </dl>
2944
+ </dd>
2945
+ </dl>
2946
+
2947
+ #### 🔌 Usage
2948
+
2949
+ <dl>
2950
+ <dd>
2951
+
2952
+ <dl>
2953
+ <dd>
2954
+
2955
+ ```typescript
2956
+ const pageableResponse = await client.accounts.index({
2957
+ after: "<opaque_cursor>",
2958
+ page_size: 10,
2959
+ include_total_count: false
2960
+ });
2961
+ for await (const item of pageableResponse) {
2962
+ console.log(item);
2963
+ }
2964
+
2965
+ // Or you can manually iterate page-by-page
2966
+ let page = await client.accounts.index({
2967
+ after: "<opaque_cursor>",
2968
+ page_size: 10,
2969
+ include_total_count: false
2970
+ });
2971
+ while (page.hasNextPage()) {
2972
+ page = page.getNextPage();
2973
+ }
2974
+
2975
+ // You can also access the underlying response
2976
+ const response = page.response;
2977
+
2978
+ ```
2979
+ </dd>
2980
+ </dl>
2981
+ </dd>
2982
+ </dl>
2983
+
2984
+ #### ⚙️ Parameters
2985
+
2986
+ <dl>
2987
+ <dd>
2988
+
2989
+ <dl>
2990
+ <dd>
2991
+
2992
+ **request:** `Frameio.AccountsIndexRequest`
2993
+
2994
+ </dd>
2995
+ </dl>
2996
+
2997
+ <dl>
2998
+ <dd>
2999
+
3000
+ **requestOptions:** `AccountsClient.RequestOptions`
3001
+
3002
+ </dd>
3003
+ </dl>
3004
+ </dd>
3005
+ </dl>
3006
+
3007
+
3008
+ </dd>
3009
+ </dl>
3010
+ </details>
3011
+
3012
+ <details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">auditlogIndex</a>(account_id, { ...params }) -> Frameio.AuditLogsWithIncludesResponse</code></summary>
3013
+ <dl>
3014
+ <dd>
3015
+
3016
+ #### 📝 Description
3017
+
3018
+ <dl>
3019
+ <dd>
3020
+
3021
+ <dl>
3022
+ <dd>
3023
+
3024
+ List audit logs with filtering capabilities via query params. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3025
+ </dd>
3026
+ </dl>
3027
+ </dd>
3028
+ </dl>
3029
+
3030
+ #### 🔌 Usage
3031
+
3032
+ <dl>
3033
+ <dd>
3034
+
3035
+ <dl>
3036
+ <dd>
3037
+
3038
+ ```typescript
3039
+ await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3040
+ include: "user",
3041
+ after: "<opaque_cursor>",
3042
+ page_size: 10,
3043
+ include_total_count: false
3044
+ });
3045
+
3046
+ ```
3047
+ </dd>
3048
+ </dl>
3049
+ </dd>
3050
+ </dl>
3051
+
3052
+ #### ⚙️ Parameters
3053
+
3054
+ <dl>
3055
+ <dd>
3056
+
3057
+ <dl>
3058
+ <dd>
3059
+
3060
+ **account_id:** `Frameio.Uuid` —
3061
+
3062
+ </dd>
3063
+ </dl>
3064
+
3065
+ <dl>
3066
+ <dd>
3067
+
3068
+ **request:** `Frameio.AuditlogIndexRequest`
3069
+
3070
+ </dd>
3071
+ </dl>
3072
+
3073
+ <dl>
3074
+ <dd>
3075
+
3076
+ **requestOptions:** `AccountsClient.RequestOptions`
3077
+
3078
+ </dd>
3079
+ </dl>
3080
+ </dd>
3081
+ </dl>
3082
+
3083
+
3084
+ </dd>
3085
+ </dl>
3086
+ </details>
3087
+
3088
+ ## Webhooks
3089
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">index</a>(account_id, workspace_id, { ...params }) -> core.Page&lt;Frameio.WebhookWithIncludes, Frameio.WebhooksWithIncludesResponse&gt;</code></summary>
3090
+ <dl>
3091
+ <dd>
3092
+
3093
+ #### 📝 Description
3094
+
3095
+ <dl>
3096
+ <dd>
3097
+
3098
+ <dl>
3099
+ <dd>
3100
+
3101
+ List webhooks for the given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3102
+ </dd>
3103
+ </dl>
3104
+ </dd>
3105
+ </dl>
3106
+
3107
+ #### 🔌 Usage
3108
+
3109
+ <dl>
3110
+ <dd>
3111
+
3112
+ <dl>
3113
+ <dd>
3114
+
3115
+ ```typescript
3116
+ const pageableResponse = await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3117
+ include: "creator",
3118
+ after: "<opaque_cursor>",
3119
+ page_size: 10,
3120
+ include_total_count: false
3121
+ });
3122
+ for await (const item of pageableResponse) {
3123
+ console.log(item);
3124
+ }
3125
+
3126
+ // Or you can manually iterate page-by-page
3127
+ let page = await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3128
+ include: "creator",
3129
+ after: "<opaque_cursor>",
3130
+ page_size: 10,
3131
+ include_total_count: false
3132
+ });
3133
+ while (page.hasNextPage()) {
3134
+ page = page.getNextPage();
3135
+ }
3136
+
3137
+ // You can also access the underlying response
3138
+ const response = page.response;
3139
+
3140
+ ```
3141
+ </dd>
3142
+ </dl>
3143
+ </dd>
3144
+ </dl>
3145
+
3146
+ #### ⚙️ Parameters
3147
+
3148
+ <dl>
3149
+ <dd>
3150
+
3151
+ <dl>
3152
+ <dd>
3153
+
3154
+ **account_id:** `Frameio.Uuid` —
3155
+
3156
+ </dd>
3157
+ </dl>
3158
+
3159
+ <dl>
3160
+ <dd>
3161
+
3162
+ **workspace_id:** `Frameio.Uuid` —
3163
+
3164
+ </dd>
3165
+ </dl>
3166
+
3167
+ <dl>
3168
+ <dd>
3169
+
3170
+ **request:** `Frameio.WebhooksIndexRequest`
3171
+
3172
+ </dd>
3173
+ </dl>
3174
+
3175
+ <dl>
3176
+ <dd>
3177
+
3178
+ **requestOptions:** `WebhooksClient.RequestOptions`
3179
+
3180
+ </dd>
3181
+ </dl>
3182
+ </dd>
3183
+ </dl>
3184
+
3185
+
3186
+ </dd>
3187
+ </dl>
3188
+ </details>
3189
+
3190
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">create</a>(account_id, workspace_id, { ...params }) -> Frameio.WebhookCreateResponse</code></summary>
3191
+ <dl>
3192
+ <dd>
3193
+
3194
+ #### 📝 Description
3195
+
3196
+ <dl>
3197
+ <dd>
3198
+
3199
+ <dl>
3200
+ <dd>
3201
+
3202
+ Creates a single webhook with secret.<br/><br/>Valid events:<p><code>
3203
+ file.created, file.deleted, file.ready, file.updated, file.upload.completed, file.versioned, file.copied, folder.created, folder.deleted, folder.updated, folder.copied, comment.completed, comment.created, comment.deleted, comment.uncompleted, comment.updated, customfield.created, customfield.updated, customfield.deleted, metadata.value.updated, project.created, project.deleted, project.updated, collection.created, collection.updated, collection.deleted, share.created, share.updated, share.deleted, share.viewed
3204
+ </code>
3205
+ </p>. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3206
+ </dd>
3207
+ </dl>
3208
+ </dd>
3209
+ </dl>
3210
+
3211
+ #### 🔌 Usage
3212
+
3213
+ <dl>
3214
+ <dd>
3215
+
3216
+ <dl>
3217
+ <dd>
3218
+
3219
+ ```typescript
3220
+ await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3221
+ data: {
3222
+ events: ["file.created", "file.deleted", "file.ready", "file.updated", "file.upload.completed", "file.versioned", "file.copied", "folder.created", "folder.deleted", "folder.updated", "folder.copied", "comment.completed", "comment.created", "comment.deleted", "comment.uncompleted", "comment.updated", "customfield.created", "customfield.updated", "customfield.deleted", "metadata.value.updated", "project.created", "project.deleted", "project.updated", "collection.created", "collection.updated", "collection.deleted", "share.created", "share.updated", "share.deleted", "share.viewed"],
3223
+ name: "New Webhook",
3224
+ url: "https://url.example.com"
3225
+ }
3226
+ });
3227
+
3228
+ ```
3229
+ </dd>
3230
+ </dl>
3231
+ </dd>
3232
+ </dl>
3233
+
3234
+ #### ⚙️ Parameters
3235
+
3236
+ <dl>
3237
+ <dd>
3238
+
3239
+ <dl>
3240
+ <dd>
3241
+
3242
+ **account_id:** `Frameio.Uuid` —
3243
+
3244
+ </dd>
3245
+ </dl>
3246
+
3247
+ <dl>
3248
+ <dd>
3249
+
3250
+ **workspace_id:** `Frameio.Uuid` —
3251
+
3252
+ </dd>
3253
+ </dl>
3254
+
3255
+ <dl>
3256
+ <dd>
3257
+
3258
+ **request:** `Frameio.WebhookCreateParams`
3259
+
3260
+ </dd>
3261
+ </dl>
3262
+
3263
+ <dl>
3264
+ <dd>
3265
+
3266
+ **requestOptions:** `WebhooksClient.RequestOptions`
3267
+
3268
+ </dd>
3269
+ </dl>
3270
+ </dd>
3271
+ </dl>
3272
+
3273
+
3274
+ </dd>
3275
+ </dl>
3276
+ </details>
3277
+
3278
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">show</a>(account_id, webhook_id, { ...params }) -> Frameio.WebhookWithIncludesResponse</code></summary>
3279
+ <dl>
3280
+ <dd>
3281
+
3282
+ #### 📝 Description
3283
+
3284
+ <dl>
3285
+ <dd>
3286
+
3287
+ <dl>
3288
+ <dd>
3289
+
3290
+ Show webhook details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3291
+ </dd>
3292
+ </dl>
3293
+ </dd>
3294
+ </dl>
3295
+
3296
+ #### 🔌 Usage
3297
+
3298
+ <dl>
3299
+ <dd>
3300
+
3301
+ <dl>
3302
+ <dd>
3303
+
3304
+ ```typescript
3305
+ await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3306
+ include: "creator"
2557
3307
  });
2558
- while (page.hasNextPage()) {
2559
- page = page.getNextPage();
2560
- }
2561
-
2562
- // You can also access the underlying response
2563
- const response = page.response;
2564
3308
 
2565
3309
  ```
2566
3310
  </dd>
@@ -2576,7 +3320,7 @@ const response = page.response;
2576
3320
  <dl>
2577
3321
  <dd>
2578
3322
 
2579
- **request:** `Frameio.AccountsIndexRequest`
3323
+ **account_id:** `Frameio.Uuid`
2580
3324
 
2581
3325
  </dd>
2582
3326
  </dl>
@@ -2584,7 +3328,23 @@ const response = page.response;
2584
3328
  <dl>
2585
3329
  <dd>
2586
3330
 
2587
- **requestOptions:** `AccountsClient.RequestOptions`
3331
+ **webhook_id:** `Frameio.Uuid`
3332
+
3333
+ </dd>
3334
+ </dl>
3335
+
3336
+ <dl>
3337
+ <dd>
3338
+
3339
+ **request:** `Frameio.WebhooksShowRequest`
3340
+
3341
+ </dd>
3342
+ </dl>
3343
+
3344
+ <dl>
3345
+ <dd>
3346
+
3347
+ **requestOptions:** `WebhooksClient.RequestOptions`
2588
3348
 
2589
3349
  </dd>
2590
3350
  </dl>
@@ -2596,7 +3356,7 @@ const response = page.response;
2596
3356
  </dl>
2597
3357
  </details>
2598
3358
 
2599
- <details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">auditlogIndex</a>(account_id, { ...params }) -> Frameio.AuditLogsWithIncludesResponse</code></summary>
3359
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">delete</a>(account_id, webhook_id) -> void</code></summary>
2600
3360
  <dl>
2601
3361
  <dd>
2602
3362
 
@@ -2608,7 +3368,7 @@ const response = page.response;
2608
3368
  <dl>
2609
3369
  <dd>
2610
3370
 
2611
- List audit logs with filtering capabilities via query params. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3371
+ Delete a webhook. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
2612
3372
  </dd>
2613
3373
  </dl>
2614
3374
  </dd>
@@ -2623,12 +3383,7 @@ List audit logs with filtering capabilities via query params. <br/>Rate Limits:
2623
3383
  <dd>
2624
3384
 
2625
3385
  ```typescript
2626
- await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2627
- include: "user",
2628
- after: "<opaque_cursor>",
2629
- page_size: 10,
2630
- include_total_count: false
2631
- });
3386
+ await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
2632
3387
 
2633
3388
  ```
2634
3389
  </dd>
@@ -2652,7 +3407,7 @@ await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2652
3407
  <dl>
2653
3408
  <dd>
2654
3409
 
2655
- **request:** `Frameio.AuditlogIndexRequest`
3410
+ **webhook_id:** `Frameio.Uuid`
2656
3411
 
2657
3412
  </dd>
2658
3413
  </dl>
@@ -2660,7 +3415,7 @@ await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2660
3415
  <dl>
2661
3416
  <dd>
2662
3417
 
2663
- **requestOptions:** `AccountsClient.RequestOptions`
3418
+ **requestOptions:** `WebhooksClient.RequestOptions`
2664
3419
 
2665
3420
  </dd>
2666
3421
  </dl>
@@ -2672,8 +3427,7 @@ await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2672
3427
  </dl>
2673
3428
  </details>
2674
3429
 
2675
- ## Webhooks
2676
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">index</a>(account_id, workspace_id, { ...params }) -> core.Page&lt;Frameio.WebhookWithIncludes, Frameio.WebhooksWithIncludesResponse&gt;</code></summary>
3430
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">update</a>(account_id, webhook_id, { ...params }) -> Frameio.WebhookResponse</code></summary>
2677
3431
  <dl>
2678
3432
  <dd>
2679
3433
 
@@ -2685,7 +3439,7 @@ await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2685
3439
  <dl>
2686
3440
  <dd>
2687
3441
 
2688
- List webhooks for the given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3442
+ Update webhook details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
2689
3443
  </dd>
2690
3444
  </dl>
2691
3445
  </dd>
@@ -2700,29 +3454,14 @@ List webhooks for the given workspace. <br/>Rate Limits: 100 calls per 1.00 minu
2700
3454
  <dd>
2701
3455
 
2702
3456
  ```typescript
2703
- const pageableResponse = await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2704
- include: "creator",
2705
- after: "<opaque_cursor>",
2706
- page_size: 10,
2707
- include_total_count: false
2708
- });
2709
- for await (const item of pageableResponse) {
2710
- console.log(item);
2711
- }
2712
-
2713
- // Or you can manually iterate page-by-page
2714
- let page = await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2715
- include: "creator",
2716
- after: "<opaque_cursor>",
2717
- page_size: 10,
2718
- include_total_count: false
3457
+ await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3458
+ data: {
3459
+ active: true,
3460
+ events: ["file.created", "file.deleted", "file.ready", "file.updated", "file.upload.completed", "file.versioned", "file.copied", "folder.created", "folder.deleted", "folder.updated", "folder.copied", "comment.completed", "comment.created", "comment.deleted", "comment.uncompleted", "comment.updated", "customfield.created", "customfield.updated", "customfield.deleted", "metadata.value.updated", "project.created", "project.deleted", "project.updated", "collection.created", "collection.updated", "collection.deleted", "share.created", "share.updated", "share.deleted", "share.viewed"],
3461
+ name: "Updated Webhook",
3462
+ url: "https://url.example.com"
3463
+ }
2719
3464
  });
2720
- while (page.hasNextPage()) {
2721
- page = page.getNextPage();
2722
- }
2723
-
2724
- // You can also access the underlying response
2725
- const response = page.response;
2726
3465
 
2727
3466
  ```
2728
3467
  </dd>
@@ -2746,7 +3485,7 @@ const response = page.response;
2746
3485
  <dl>
2747
3486
  <dd>
2748
3487
 
2749
- **workspace_id:** `Frameio.Uuid` —
3488
+ **webhook_id:** `Frameio.Uuid` —
2750
3489
 
2751
3490
  </dd>
2752
3491
  </dl>
@@ -2754,7 +3493,7 @@ const response = page.response;
2754
3493
  <dl>
2755
3494
  <dd>
2756
3495
 
2757
- **request:** `Frameio.WebhooksIndexRequest`
3496
+ **request:** `Frameio.WebhookUpdateParams`
2758
3497
 
2759
3498
  </dd>
2760
3499
  </dl>
@@ -2774,7 +3513,8 @@ const response = page.response;
2774
3513
  </dl>
2775
3514
  </details>
2776
3515
 
2777
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">create</a>(account_id, workspace_id, { ...params }) -> Frameio.WebhookCreateResponse</code></summary>
3516
+ ## Workspace Permissions
3517
+ <details><summary><code>client.workspacePermissions.<a href="/src/api/resources/workspacePermissions/client/Client.ts">index</a>(account_id, workspace_id, { ...params }) -> core.Page&lt;Frameio.UserRole, Frameio.WorkspaceUserRolesResponse&gt;</code></summary>
2778
3518
  <dl>
2779
3519
  <dd>
2780
3520
 
@@ -2786,10 +3526,7 @@ const response = page.response;
2786
3526
  <dl>
2787
3527
  <dd>
2788
3528
 
2789
- Creates a single webhook with secret.<br/><br/>Valid events:<p><code>
2790
- file.created, file.deleted, file.ready, file.updated, file.upload.completed, file.versioned, file.copied, folder.created, folder.deleted, folder.updated, folder.copied, comment.completed, comment.created, comment.deleted, comment.uncompleted, comment.updated, customfield.created, customfield.updated, customfield.deleted, metadata.value.updated, project.created, project.deleted, project.updated, collection.created, collection.updated, collection.deleted, share.created, share.updated, share.deleted, share.viewed
2791
- </code>
2792
- </p>. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3529
+ List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
2793
3530
  </dd>
2794
3531
  </dl>
2795
3532
  </dd>
@@ -2804,13 +3541,29 @@ file.created, file.deleted, file.ready, file.updated, file.upload.completed, fil
2804
3541
  <dd>
2805
3542
 
2806
3543
  ```typescript
2807
- await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2808
- data: {
2809
- events: ["file.created", "file.deleted", "file.ready", "file.updated", "file.upload.completed", "file.versioned", "file.copied", "folder.created", "folder.deleted", "folder.updated", "folder.copied", "comment.completed", "comment.created", "comment.deleted", "comment.uncompleted", "comment.updated", "customfield.created", "customfield.updated", "customfield.deleted", "metadata.value.updated", "project.created", "project.deleted", "project.updated", "collection.created", "collection.updated", "collection.deleted", "share.created", "share.updated", "share.deleted", "share.viewed"],
2810
- name: "New Webhook",
2811
- url: "https://url.example.com"
2812
- }
3544
+ const pageableResponse = await client.workspacePermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3545
+ include_deactivated: true,
3546
+ after: "<opaque_cursor>",
3547
+ page_size: 10,
3548
+ include_total_count: false
3549
+ });
3550
+ for await (const item of pageableResponse) {
3551
+ console.log(item);
3552
+ }
3553
+
3554
+ // Or you can manually iterate page-by-page
3555
+ let page = await client.workspacePermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3556
+ include_deactivated: true,
3557
+ after: "<opaque_cursor>",
3558
+ page_size: 10,
3559
+ include_total_count: false
2813
3560
  });
3561
+ while (page.hasNextPage()) {
3562
+ page = page.getNextPage();
3563
+ }
3564
+
3565
+ // You can also access the underlying response
3566
+ const response = page.response;
2814
3567
 
2815
3568
  ```
2816
3569
  </dd>
@@ -2842,7 +3595,7 @@ await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2842
3595
  <dl>
2843
3596
  <dd>
2844
3597
 
2845
- **request:** `Frameio.WebhookCreateParams`
3598
+ **request:** `Frameio.WorkspacePermissionsIndexRequest`
2846
3599
 
2847
3600
  </dd>
2848
3601
  </dl>
@@ -2850,7 +3603,7 @@ await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2850
3603
  <dl>
2851
3604
  <dd>
2852
3605
 
2853
- **requestOptions:** `WebhooksClient.RequestOptions`
3606
+ **requestOptions:** `WorkspacePermissionsClient.RequestOptions`
2854
3607
 
2855
3608
  </dd>
2856
3609
  </dl>
@@ -2862,7 +3615,7 @@ await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2862
3615
  </dl>
2863
3616
  </details>
2864
3617
 
2865
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">show</a>(account_id, webhook_id, { ...params }) -> Frameio.WebhookWithIncludesResponse</code></summary>
3618
+ <details><summary><code>client.workspacePermissions.<a href="/src/api/resources/workspacePermissions/client/Client.ts">workspaceUserRolesDelete</a>(account_id, workspace_id, user_id) -> void</code></summary>
2866
3619
  <dl>
2867
3620
  <dd>
2868
3621
 
@@ -2874,7 +3627,7 @@ await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2874
3627
  <dl>
2875
3628
  <dd>
2876
3629
 
2877
- Show webhook details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3630
+ Remove a user from a given workspace. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
2878
3631
  </dd>
2879
3632
  </dl>
2880
3633
  </dd>
@@ -2889,9 +3642,7 @@ Show webhook details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account
2889
3642
  <dd>
2890
3643
 
2891
3644
  ```typescript
2892
- await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2893
- include: "creator"
2894
- });
3645
+ await client.workspacePermissions.workspaceUserRolesDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
2895
3646
 
2896
3647
  ```
2897
3648
  </dd>
@@ -2915,7 +3666,7 @@ await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2915
3666
  <dl>
2916
3667
  <dd>
2917
3668
 
2918
- **webhook_id:** `Frameio.Uuid` —
3669
+ **workspace_id:** `Frameio.Uuid` —
2919
3670
 
2920
3671
  </dd>
2921
3672
  </dl>
@@ -2923,7 +3674,7 @@ await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2923
3674
  <dl>
2924
3675
  <dd>
2925
3676
 
2926
- **request:** `Frameio.WebhooksShowRequest`
3677
+ **user_id:** `Frameio.Uuid`
2927
3678
 
2928
3679
  </dd>
2929
3680
  </dl>
@@ -2931,7 +3682,7 @@ await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2931
3682
  <dl>
2932
3683
  <dd>
2933
3684
 
2934
- **requestOptions:** `WebhooksClient.RequestOptions`
3685
+ **requestOptions:** `WorkspacePermissionsClient.RequestOptions`
2935
3686
 
2936
3687
  </dd>
2937
3688
  </dl>
@@ -2943,7 +3694,7 @@ await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2943
3694
  </dl>
2944
3695
  </details>
2945
3696
 
2946
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">delete</a>(account_id, webhook_id) -> void</code></summary>
3697
+ <details><summary><code>client.workspacePermissions.<a href="/src/api/resources/workspacePermissions/client/Client.ts">workspaceUserRolesUpdate</a>(account_id, workspace_id, user_id, { ...params }) -> Frameio.UpdateUserRolesResponse</code></summary>
2947
3698
  <dl>
2948
3699
  <dd>
2949
3700
 
@@ -2955,7 +3706,8 @@ await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
2955
3706
  <dl>
2956
3707
  <dd>
2957
3708
 
2958
- Delete a webhook. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
3709
+ Update user roles for the given workspace if the user is already added to the workspace. If the user is
3710
+ 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
2959
3711
  </dd>
2960
3712
  </dl>
2961
3713
  </dd>
@@ -2970,7 +3722,11 @@ Delete a webhook. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
2970
3722
  <dd>
2971
3723
 
2972
3724
  ```typescript
2973
- await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
3725
+ await client.workspacePermissions.workspaceUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3726
+ data: {
3727
+ role: "editor"
3728
+ }
3729
+ });
2974
3730
 
2975
3731
  ```
2976
3732
  </dd>
@@ -2994,7 +3750,7 @@ await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
2994
3750
  <dl>
2995
3751
  <dd>
2996
3752
 
2997
- **webhook_id:** `Frameio.Uuid` —
3753
+ **workspace_id:** `Frameio.Uuid` —
2998
3754
 
2999
3755
  </dd>
3000
3756
  </dl>
@@ -3002,7 +3758,23 @@ await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
3002
3758
  <dl>
3003
3759
  <dd>
3004
3760
 
3005
- **requestOptions:** `WebhooksClient.RequestOptions`
3761
+ **user_id:** `Frameio.Uuid`
3762
+
3763
+ </dd>
3764
+ </dl>
3765
+
3766
+ <dl>
3767
+ <dd>
3768
+
3769
+ **request:** `Frameio.UpdateUserRolesParams`
3770
+
3771
+ </dd>
3772
+ </dl>
3773
+
3774
+ <dl>
3775
+ <dd>
3776
+
3777
+ **requestOptions:** `WorkspacePermissionsClient.RequestOptions`
3006
3778
 
3007
3779
  </dd>
3008
3780
  </dl>
@@ -3014,7 +3786,8 @@ await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
3014
3786
  </dl>
3015
3787
  </details>
3016
3788
 
3017
- <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">update</a>(account_id, webhook_id, { ...params }) -> Frameio.WebhookResponse</code></summary>
3789
+ ## Groups
3790
+ <details><summary><code>client.groups.<a href="/src/api/resources/groups/client/Client.ts">index</a>(account_id, { ...params }) -> Frameio.GroupsWithIncludesResponse</code></summary>
3018
3791
  <dl>
3019
3792
  <dd>
3020
3793
 
@@ -3026,7 +3799,7 @@ await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
3026
3799
  <dl>
3027
3800
  <dd>
3028
3801
 
3029
- Update webhook details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3802
+ List groups in account. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3030
3803
  </dd>
3031
3804
  </dl>
3032
3805
  </dd>
@@ -3041,13 +3814,12 @@ Update webhook details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per accoun
3041
3814
  <dd>
3042
3815
 
3043
3816
  ```typescript
3044
- await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3045
- data: {
3046
- active: true,
3047
- events: ["file.created", "file.deleted", "file.ready", "file.updated", "file.upload.completed", "file.versioned", "file.copied", "folder.created", "folder.deleted", "folder.updated", "folder.copied", "comment.completed", "comment.created", "comment.deleted", "comment.uncompleted", "comment.updated", "customfield.created", "customfield.updated", "customfield.deleted", "metadata.value.updated", "project.created", "project.deleted", "project.updated", "collection.created", "collection.updated", "collection.deleted", "share.created", "share.updated", "share.deleted", "share.viewed"],
3048
- name: "Updated Webhook",
3049
- url: "https://url.example.com"
3050
- }
3817
+ await client.groups.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3818
+ include: "creator",
3819
+ sort: "creator_asc",
3820
+ after: "<opaque_cursor>",
3821
+ page_size: 10,
3822
+ include_total_count: false
3051
3823
  });
3052
3824
 
3053
3825
  ```
@@ -3072,15 +3844,7 @@ await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
3072
3844
  <dl>
3073
3845
  <dd>
3074
3846
 
3075
- **webhook_id:** `Frameio.Uuid`
3076
-
3077
- </dd>
3078
- </dl>
3079
-
3080
- <dl>
3081
- <dd>
3082
-
3083
- **request:** `Frameio.WebhookUpdateParams`
3847
+ **request:** `Frameio.GroupsIndexRequest`
3084
3848
 
3085
3849
  </dd>
3086
3850
  </dl>
@@ -3088,7 +3852,7 @@ await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
3088
3852
  <dl>
3089
3853
  <dd>
3090
3854
 
3091
- **requestOptions:** `WebhooksClient.RequestOptions`
3855
+ **requestOptions:** `GroupsClient.RequestOptions`
3092
3856
 
3093
3857
  </dd>
3094
3858
  </dl>
@@ -3100,8 +3864,7 @@ await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
3100
3864
  </dl>
3101
3865
  </details>
3102
3866
 
3103
- ## Workspace Permissions
3104
- <details><summary><code>client.workspacePermissions.<a href="/src/api/resources/workspacePermissions/client/Client.ts">index</a>(account_id, workspace_id, { ...params }) -> core.Page&lt;Frameio.UserRole, Frameio.WorkspaceUserRolesResponse&gt;</code></summary>
3867
+ <details><summary><code>client.groups.<a href="/src/api/resources/groups/client/Client.ts">create</a>(account_id, { ...params }) -> Frameio.GroupResponse</code></summary>
3105
3868
  <dl>
3106
3869
  <dd>
3107
3870
 
@@ -3113,7 +3876,7 @@ await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
3113
3876
  <dl>
3114
3877
  <dd>
3115
3878
 
3116
- List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3879
+ Create group for the current account. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3117
3880
  </dd>
3118
3881
  </dl>
3119
3882
  </dd>
@@ -3128,29 +3891,12 @@ List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minu
3128
3891
  <dd>
3129
3892
 
3130
3893
  ```typescript
3131
- const pageableResponse = await client.workspacePermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3132
- include_deactivated: true,
3133
- after: "<opaque_cursor>",
3134
- page_size: 10,
3135
- include_total_count: false
3136
- });
3137
- for await (const item of pageableResponse) {
3138
- console.log(item);
3139
- }
3140
-
3141
- // Or you can manually iterate page-by-page
3142
- let page = await client.workspacePermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3143
- include_deactivated: true,
3144
- after: "<opaque_cursor>",
3145
- page_size: 10,
3146
- include_total_count: false
3894
+ await client.groups.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3895
+ data: {
3896
+ emoji: "smile",
3897
+ name: "group-1"
3898
+ }
3147
3899
  });
3148
- while (page.hasNextPage()) {
3149
- page = page.getNextPage();
3150
- }
3151
-
3152
- // You can also access the underlying response
3153
- const response = page.response;
3154
3900
 
3155
3901
  ```
3156
3902
  </dd>
@@ -3174,15 +3920,7 @@ const response = page.response;
3174
3920
  <dl>
3175
3921
  <dd>
3176
3922
 
3177
- **workspace_id:** `Frameio.Uuid`
3178
-
3179
- </dd>
3180
- </dl>
3181
-
3182
- <dl>
3183
- <dd>
3184
-
3185
- **request:** `Frameio.WorkspacePermissionsIndexRequest`
3923
+ **request:** `Frameio.CreateGroupParams`
3186
3924
 
3187
3925
  </dd>
3188
3926
  </dl>
@@ -3190,7 +3928,7 @@ const response = page.response;
3190
3928
  <dl>
3191
3929
  <dd>
3192
3930
 
3193
- **requestOptions:** `WorkspacePermissionsClient.RequestOptions`
3931
+ **requestOptions:** `GroupsClient.RequestOptions`
3194
3932
 
3195
3933
  </dd>
3196
3934
  </dl>
@@ -3202,7 +3940,7 @@ const response = page.response;
3202
3940
  </dl>
3203
3941
  </details>
3204
3942
 
3205
- <details><summary><code>client.workspacePermissions.<a href="/src/api/resources/workspacePermissions/client/Client.ts">workspaceUserRolesDelete</a>(account_id, workspace_id, user_id) -> void</code></summary>
3943
+ <details><summary><code>client.groups.<a href="/src/api/resources/groups/client/Client.ts">show</a>(account_id, group_id, { ...params }) -> Frameio.GroupWithIncludesResponse</code></summary>
3206
3944
  <dl>
3207
3945
  <dd>
3208
3946
 
@@ -3214,7 +3952,7 @@ const response = page.response;
3214
3952
  <dl>
3215
3953
  <dd>
3216
3954
 
3217
- Remove a user from a given workspace. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
3955
+ Show group details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
3218
3956
  </dd>
3219
3957
  </dl>
3220
3958
  </dd>
@@ -3229,7 +3967,9 @@ Remove a user from a given workspace. <br/>Rate Limits: 60 calls per 1.00 minute
3229
3967
  <dd>
3230
3968
 
3231
3969
  ```typescript
3232
- await client.workspacePermissions.workspaceUserRolesDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
3970
+ await client.groups.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3971
+ include: "creator"
3972
+ });
3233
3973
 
3234
3974
  ```
3235
3975
  </dd>
@@ -3253,7 +3993,7 @@ await client.workspacePermissions.workspaceUserRolesDelete("b2702c44-c6da-4bb6-8
3253
3993
  <dl>
3254
3994
  <dd>
3255
3995
 
3256
- **workspace_id:** `Frameio.Uuid` —
3996
+ **group_id:** `Frameio.Uuid` —
3257
3997
 
3258
3998
  </dd>
3259
3999
  </dl>
@@ -3261,7 +4001,7 @@ await client.workspacePermissions.workspaceUserRolesDelete("b2702c44-c6da-4bb6-8
3261
4001
  <dl>
3262
4002
  <dd>
3263
4003
 
3264
- **user_id:** `Frameio.Uuid`
4004
+ **request:** `Frameio.GroupsShowRequest`
3265
4005
 
3266
4006
  </dd>
3267
4007
  </dl>
@@ -3269,7 +4009,7 @@ await client.workspacePermissions.workspaceUserRolesDelete("b2702c44-c6da-4bb6-8
3269
4009
  <dl>
3270
4010
  <dd>
3271
4011
 
3272
- **requestOptions:** `WorkspacePermissionsClient.RequestOptions`
4012
+ **requestOptions:** `GroupsClient.RequestOptions`
3273
4013
 
3274
4014
  </dd>
3275
4015
  </dl>
@@ -3281,7 +4021,7 @@ await client.workspacePermissions.workspaceUserRolesDelete("b2702c44-c6da-4bb6-8
3281
4021
  </dl>
3282
4022
  </details>
3283
4023
 
3284
- <details><summary><code>client.workspacePermissions.<a href="/src/api/resources/workspacePermissions/client/Client.ts">workspaceUserRolesUpdate</a>(account_id, workspace_id, user_id, { ...params }) -> Frameio.UpdateUserRolesResponse</code></summary>
4024
+ <details><summary><code>client.groups.<a href="/src/api/resources/groups/client/Client.ts">update</a>(account_id, group_id, { ...params }) -> Frameio.GroupResponse</code></summary>
3285
4025
  <dl>
3286
4026
  <dd>
3287
4027
 
@@ -3293,8 +4033,7 @@ await client.workspacePermissions.workspaceUserRolesDelete("b2702c44-c6da-4bb6-8
3293
4033
  <dl>
3294
4034
  <dd>
3295
4035
 
3296
- Update user roles for the given workspace if the user is already added to the workspace. If the user is
3297
- 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
4036
+ Update group details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
3298
4037
  </dd>
3299
4038
  </dl>
3300
4039
  </dd>
@@ -3309,9 +4048,10 @@ Update user roles for the given workspace if the user is already added to the wo
3309
4048
  <dd>
3310
4049
 
3311
4050
  ```typescript
3312
- await client.workspacePermissions.workspaceUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
4051
+ await client.groups.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3313
4052
  data: {
3314
- role: "editor"
4053
+ emoji: "smile",
4054
+ name: "group-1"
3315
4055
  }
3316
4056
  });
3317
4057
 
@@ -3337,15 +4077,7 @@ await client.workspacePermissions.workspaceUserRolesUpdate("b2702c44-c6da-4bb6-8
3337
4077
  <dl>
3338
4078
  <dd>
3339
4079
 
3340
- **workspace_id:** `Frameio.Uuid` —
3341
-
3342
- </dd>
3343
- </dl>
3344
-
3345
- <dl>
3346
- <dd>
3347
-
3348
- **user_id:** `Frameio.Uuid` —
4080
+ **group_id:** `Frameio.Uuid` —
3349
4081
 
3350
4082
  </dd>
3351
4083
  </dl>
@@ -3353,7 +4085,7 @@ await client.workspacePermissions.workspaceUserRolesUpdate("b2702c44-c6da-4bb6-8
3353
4085
  <dl>
3354
4086
  <dd>
3355
4087
 
3356
- **request:** `Frameio.UpdateUserRolesParams`
4088
+ **request:** `Frameio.UpdateGroupParams`
3357
4089
 
3358
4090
  </dd>
3359
4091
  </dl>
@@ -3361,7 +4093,7 @@ await client.workspacePermissions.workspaceUserRolesUpdate("b2702c44-c6da-4bb6-8
3361
4093
  <dl>
3362
4094
  <dd>
3363
4095
 
3364
- **requestOptions:** `WorkspacePermissionsClient.RequestOptions`
4096
+ **requestOptions:** `GroupsClient.RequestOptions`
3365
4097
 
3366
4098
  </dd>
3367
4099
  </dl>
@@ -3548,7 +4280,7 @@ await client.shares.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
3548
4280
  access: "public",
3549
4281
  description: "A descriptive summary of the share",
3550
4282
  downloading_enabled: true,
3551
- expiration: "2026-04-01T16:07:14Z",
4283
+ expiration: "2026-05-01T20:40:23Z",
3552
4284
  name: "Share Name",
3553
4285
  passphrase: "as!dfj39sd(*"
3554
4286
  }
@@ -3990,7 +4722,7 @@ Add new asset share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_u
3990
4722
  ```typescript
3991
4723
  await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
3992
4724
  data: {
3993
- asset_id: "b3d93131-3b65-4a23-889b-0981fc8b8973"
4725
+ asset_id: "225d999d-115c-4157-a48c-8d76f999ca40"
3994
4726
  }
3995
4727
  });
3996
4728
 
@@ -4174,9 +4906,9 @@ await client.shares.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
4174
4906
  data: {
4175
4907
  type: "asset",
4176
4908
  access: "public",
4177
- asset_ids: ["2486de9e-ac4b-4490-9dfa-626f038144db", "9eddefaa-2e54-4134-8f1e-b9c8cf7e3541"],
4909
+ asset_ids: ["ec28c8bf-cb39-4ca3-9713-8f80db2daf04", "56a803ee-9b43-41a3-a06a-46594392532f"],
4178
4910
  downloading_enabled: true,
4179
- expiration: "2026-04-01T16:07:14Z",
4911
+ expiration: "2026-05-01T20:40:23Z",
4180
4912
  name: "Share Name",
4181
4913
  passphrase: "as!dfj39sd(*"
4182
4914
  }
@@ -4262,16 +4994,16 @@ Update metadata values across multiple files. <br/>Rate Limits: 10 calls per 1.0
4262
4994
  ```typescript
4263
4995
  await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
4264
4996
  data: {
4265
- file_ids: ["6597eb4d-3137-4760-9c5e-6f59479908b8", "a4f42a72-f640-44fc-b9a9-2533d9d64df1"],
4997
+ file_ids: ["5ae2cb10-9340-4bdb-8681-de8776df1cc8", "8310dcf0-91ba-4ae6-8b3f-e929a1fb050a"],
4266
4998
  values: [{
4267
- field_definition_id: "2626b9ed-d32a-4eab-871e-038a956338c4",
4999
+ field_definition_id: "93a78d3b-e319-4c80-af1d-f5dd0bd39db5",
4268
5000
  value: [
4269
5001
  {
4270
- "id": "e0bfb74f-2139-4b25-81bd-18a8cc22cccc",
5002
+ "id": "5da35091-57b7-4931-bfce-19ce4a6bb311",
4271
5003
  "type": "user"
4272
5004
  },
4273
5005
  {
4274
- "id": "edff6fbf-9b0c-44d8-81f9-f56a42a0263e",
5006
+ "id": "cb9b133e-33bb-4a37-bff5-adc2554d5689",
4275
5007
  "type": "account_user_group"
4276
5008
  }
4277
5009
  ]
@@ -4605,7 +5337,7 @@ Similarly, if a requested transcode link does not exist for a particular file (e
4605
5337
  `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
4606
5338
  (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
4607
5339
  the response payload. In short, the client must handle null media links gracefully.
4608
- <br/>Rate Limits: 5 calls per 1 second(s) per account_user
5340
+ <br/>Rate Limits: 10 calls per 1 second(s) per account_user
4609
5341
  </dd>
4610
5342
  </dl>
4611
5343
  </dd>