frameio 0.0.23__py3-none-any.whl

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.

Potentially problematic release.


This version of frameio might be problematic. Click here for more details.

Files changed (363) hide show
  1. frameio/__init__.py +1115 -0
  2. frameio/account_permissions/__init__.py +4 -0
  3. frameio/account_permissions/client.py +182 -0
  4. frameio/account_permissions/raw_client.py +301 -0
  5. frameio/accounts/__init__.py +4 -0
  6. frameio/accounts/client.py +151 -0
  7. frameio/accounts/raw_client.py +281 -0
  8. frameio/client.py +439 -0
  9. frameio/comments/__init__.py +34 -0
  10. frameio/comments/client.py +596 -0
  11. frameio/comments/raw_client.py +1252 -0
  12. frameio/comments/types/__init__.py +38 -0
  13. frameio/comments/types/create_comment_params_data.py +25 -0
  14. frameio/comments/types/update_comment_params_data.py +25 -0
  15. frameio/core/__init__.py +110 -0
  16. frameio/core/api_error.py +23 -0
  17. frameio/core/client_wrapper.py +87 -0
  18. frameio/core/datetime_utils.py +28 -0
  19. frameio/core/file.py +67 -0
  20. frameio/core/force_multipart.py +18 -0
  21. frameio/core/http_client.py +543 -0
  22. frameio/core/http_response.py +55 -0
  23. frameio/core/jsonable_encoder.py +100 -0
  24. frameio/core/pagination.py +82 -0
  25. frameio/core/pydantic_utilities.py +258 -0
  26. frameio/core/query_encoder.py +58 -0
  27. frameio/core/remove_none_from_dict.py +11 -0
  28. frameio/core/request_options.py +35 -0
  29. frameio/core/serialization.py +276 -0
  30. frameio/environment.py +7 -0
  31. frameio/errors/__init__.py +53 -0
  32. frameio/errors/bad_request_error.py +11 -0
  33. frameio/errors/forbidden_error.py +11 -0
  34. frameio/errors/not_found_error.py +11 -0
  35. frameio/errors/too_many_requests_error.py +11 -0
  36. frameio/errors/unauthorized_error.py +11 -0
  37. frameio/errors/unprocessable_entity_error.py +10 -0
  38. frameio/files/__init__.py +55 -0
  39. frameio/files/client.py +1136 -0
  40. frameio/files/raw_client.py +2492 -0
  41. frameio/files/types/__init__.py +53 -0
  42. frameio/files/types/file_copy_params_data.py +15 -0
  43. frameio/files/types/file_create_local_upload_params_data.py +20 -0
  44. frameio/files/types/file_create_params_data.py +31 -0
  45. frameio/files/types/file_create_remote_upload_params_data.py +20 -0
  46. frameio/files/types/file_move_params_data.py +15 -0
  47. frameio/files/types/file_update_params_data.py +15 -0
  48. frameio/folders/__init__.py +39 -0
  49. frameio/folders/client.py +988 -0
  50. frameio/folders/raw_client.py +2058 -0
  51. frameio/folders/types/__init__.py +42 -0
  52. frameio/folders/types/folder_copy_params_data.py +15 -0
  53. frameio/folders/types/folder_create_params_data.py +15 -0
  54. frameio/folders/types/folder_move_params_data.py +15 -0
  55. frameio/folders/types/folder_update_params_data.py +15 -0
  56. frameio/metadata/__init__.py +37 -0
  57. frameio/metadata/client.py +291 -0
  58. frameio/metadata/raw_client.py +509 -0
  59. frameio/metadata/types/__init__.py +38 -0
  60. frameio/metadata/types/bulk_update_metadata_params_data.py +23 -0
  61. frameio/metadata/types/bulk_update_metadata_params_data_values_item.py +13 -0
  62. frameio/metadata_fields/__init__.py +103 -0
  63. frameio/metadata_fields/client.py +536 -0
  64. frameio/metadata_fields/raw_client.py +996 -0
  65. frameio/metadata_fields/types/__init__.py +105 -0
  66. frameio/metadata_fields/types/create_field_definition_params_data.py +108 -0
  67. frameio/metadata_fields/types/update_field_definition_params_data.py +114 -0
  68. frameio/project_permissions/__init__.py +4 -0
  69. frameio/project_permissions/client.py +415 -0
  70. frameio/project_permissions/raw_client.py +789 -0
  71. frameio/projects/__init__.py +4 -0
  72. frameio/projects/client.py +582 -0
  73. frameio/projects/raw_client.py +1250 -0
  74. frameio/py.typed +0 -0
  75. frameio/shares/__init__.py +64 -0
  76. frameio/shares/client.py +1192 -0
  77. frameio/shares/raw_client.py +2446 -0
  78. frameio/shares/types/__init__.py +61 -0
  79. frameio/shares/types/add_asset_params_data.py +15 -0
  80. frameio/shares/types/add_reviewers_to_share_params_data.py +18 -0
  81. frameio/shares/types/add_reviewers_to_share_params_data_reviewers.py +27 -0
  82. frameio/shares/types/create_share_params_data.py +25 -0
  83. frameio/shares/types/remove_reviewer_params_data.py +13 -0
  84. frameio/shares/types/remove_reviewer_params_data_reviewers.py +27 -0
  85. frameio/shares/types/update_share_params_data.py +33 -0
  86. frameio/shares/types/update_share_params_data_access.py +5 -0
  87. frameio/types/__init__.py +959 -0
  88. frameio/types/account.py +65 -0
  89. frameio/types/account_roles_item.py +5 -0
  90. frameio/types/account_user_role.py +23 -0
  91. frameio/types/account_user_role_role.py +5 -0
  92. frameio/types/account_user_roles_response.py +27 -0
  93. frameio/types/accounts_response.py +23 -0
  94. frameio/types/add_asset_response.py +13 -0
  95. frameio/types/add_asset_response_data.py +15 -0
  96. frameio/types/asset_common.py +48 -0
  97. frameio/types/asset_common_type.py +5 -0
  98. frameio/types/asset_common_with_includes.py +56 -0
  99. frameio/types/asset_include.py +5 -0
  100. frameio/types/asset_share_params.py +38 -0
  101. frameio/types/asset_share_params_access.py +5 -0
  102. frameio/types/asset_with_includes.py +72 -0
  103. frameio/types/assets_with_includes_response.py +23 -0
  104. frameio/types/bad_request.py +13 -0
  105. frameio/types/bad_request_errors_item.py +15 -0
  106. frameio/types/bad_request_errors_item_source.py +12 -0
  107. frameio/types/boolean_value.py +12 -0
  108. frameio/types/children_type.py +3 -0
  109. frameio/types/comment.py +52 -0
  110. frameio/types/comment_include.py +5 -0
  111. frameio/types/comment_response.py +13 -0
  112. frameio/types/comment_with_includes.py +17 -0
  113. frameio/types/comment_with_includes_response.py +13 -0
  114. frameio/types/comments_with_includes_response.py +23 -0
  115. frameio/types/date_definition.py +43 -0
  116. frameio/types/date_definition_field_configuration.py +21 -0
  117. frameio/types/date_definition_field_configuration_display_format.py +7 -0
  118. frameio/types/date_definition_field_configuration_time_format.py +5 -0
  119. frameio/types/date_definition_params.py +17 -0
  120. frameio/types/date_definition_params_field_configuration.py +23 -0
  121. frameio/types/date_definition_params_field_configuration_display_format.py +7 -0
  122. frameio/types/date_definition_params_field_configuration_time_format.py +7 -0
  123. frameio/types/date_definition_with_includes.py +13 -0
  124. frameio/types/date_value.py +12 -0
  125. frameio/types/email.py +3 -0
  126. frameio/types/field_definition.py +163 -0
  127. frameio/types/field_definition_include.py +5 -0
  128. frameio/types/field_definition_response.py +13 -0
  129. frameio/types/field_definition_with_includes.py +174 -0
  130. frameio/types/field_definitions_with_includes_response.py +27 -0
  131. frameio/types/field_value_common.py +29 -0
  132. frameio/types/file.py +60 -0
  133. frameio/types/file_copy_response.py +13 -0
  134. frameio/types/file_remote_upload_response.py +17 -0
  135. frameio/types/file_response.py +13 -0
  136. frameio/types/file_status.py +5 -0
  137. frameio/types/file_upload_status.py +41 -0
  138. frameio/types/file_upload_status_response.py +13 -0
  139. frameio/types/file_with_includes.py +25 -0
  140. frameio/types/file_with_includes_response.py +13 -0
  141. frameio/types/file_with_includes_status.py +5 -0
  142. frameio/types/file_with_media_links_include.py +19 -0
  143. frameio/types/file_with_upload_urls.py +16 -0
  144. frameio/types/file_with_upload_urls_response.py +13 -0
  145. frameio/types/folder.py +15 -0
  146. frameio/types/folder_copy_response.py +13 -0
  147. frameio/types/folder_response.py +13 -0
  148. frameio/types/folder_with_includes.py +61 -0
  149. frameio/types/folder_with_includes_response.py +13 -0
  150. frameio/types/folders_with_includes_response.py +23 -0
  151. frameio/types/forbidden.py +13 -0
  152. frameio/types/forbidden_errors_item.py +15 -0
  153. frameio/types/forbidden_errors_item_source.py +12 -0
  154. frameio/types/include.py +5 -0
  155. frameio/types/include_total_count.py +3 -0
  156. frameio/types/integer_value.py +12 -0
  157. frameio/types/json_error_response.py +13 -0
  158. frameio/types/json_error_response_errors_item.py +15 -0
  159. frameio/types/json_error_response_errors_item_source.py +12 -0
  160. frameio/types/links.py +22 -0
  161. frameio/types/long_text_definition.py +43 -0
  162. frameio/types/long_text_definition_field_configuration.py +10 -0
  163. frameio/types/long_text_definition_params.py +15 -0
  164. frameio/types/long_text_definition_with_includes.py +13 -0
  165. frameio/types/media_link_common.py +17 -0
  166. frameio/types/media_links_collection.py +23 -0
  167. frameio/types/metadata_field.py +145 -0
  168. frameio/types/metadata_response.py +13 -0
  169. frameio/types/metadata_with_definition.py +21 -0
  170. frameio/types/multi_select_value.py +14 -0
  171. frameio/types/multi_user_value.py +20 -0
  172. frameio/types/multi_user_value_member_options_type.py +5 -0
  173. frameio/types/no_content.py +3 -0
  174. frameio/types/not_found.py +13 -0
  175. frameio/types/not_found_errors_item.py +15 -0
  176. frameio/types/not_found_errors_item_source.py +12 -0
  177. frameio/types/number_definition.py +43 -0
  178. frameio/types/number_definition_field_configuration.py +21 -0
  179. frameio/types/number_definition_field_configuration_number_format.py +7 -0
  180. frameio/types/number_definition_params.py +17 -0
  181. frameio/types/number_definition_params_field_configuration.py +23 -0
  182. frameio/types/number_definition_params_field_configuration_number_format.py +7 -0
  183. frameio/types/number_definition_with_includes.py +13 -0
  184. frameio/types/number_value.py +12 -0
  185. frameio/types/original_media_link.py +16 -0
  186. frameio/types/profile.py +34 -0
  187. frameio/types/profile_response.py +17 -0
  188. frameio/types/project.py +55 -0
  189. frameio/types/project_include.py +5 -0
  190. frameio/types/project_params.py +17 -0
  191. frameio/types/project_params_data.py +15 -0
  192. frameio/types/project_response.py +17 -0
  193. frameio/types/project_with_includes.py +18 -0
  194. frameio/types/project_with_includes_response.py +17 -0
  195. frameio/types/projects_with_includes_response.py +27 -0
  196. frameio/types/rating_definition.py +43 -0
  197. frameio/types/rating_definition_field_configuration.py +22 -0
  198. frameio/types/rating_definition_field_configuration_style.py +5 -0
  199. frameio/types/rating_definition_params.py +17 -0
  200. frameio/types/rating_definition_params_field_configuration.py +22 -0
  201. frameio/types/rating_definition_params_field_configuration_style.py +5 -0
  202. frameio/types/rating_definition_with_includes.py +13 -0
  203. frameio/types/remove_asset_response.py +13 -0
  204. frameio/types/remove_asset_response_data.py +15 -0
  205. frameio/types/rendition_media_link.py +19 -0
  206. frameio/types/request_after_opaque_cursor.py +5 -0
  207. frameio/types/request_page_size.py +3 -0
  208. frameio/types/select_definition.py +43 -0
  209. frameio/types/select_definition_field_configuration.py +18 -0
  210. frameio/types/select_definition_field_configuration_options_item.py +22 -0
  211. frameio/types/select_definition_params.py +17 -0
  212. frameio/types/select_definition_params_field_configuration.py +20 -0
  213. frameio/types/select_definition_params_field_configuration_options_item.py +20 -0
  214. frameio/types/select_definition_with_includes.py +13 -0
  215. frameio/types/select_multi_definition.py +43 -0
  216. frameio/types/select_multi_definition_field_configuration.py +18 -0
  217. frameio/types/select_multi_definition_field_configuration_options_item.py +22 -0
  218. frameio/types/select_multi_definition_params.py +17 -0
  219. frameio/types/select_multi_definition_params_field_configuration.py +20 -0
  220. frameio/types/select_multi_definition_params_field_configuration_options_item.py +20 -0
  221. frameio/types/select_multi_definition_with_includes.py +13 -0
  222. frameio/types/select_option.py +20 -0
  223. frameio/types/select_value.py +14 -0
  224. frameio/types/share.py +66 -0
  225. frameio/types/share_access.py +5 -0
  226. frameio/types/share_response.py +13 -0
  227. frameio/types/share_reviewers_response.py +27 -0
  228. frameio/types/shares_response.py +27 -0
  229. frameio/types/single_user_value.py +20 -0
  230. frameio/types/single_user_value_member_options_type.py +5 -0
  231. frameio/types/text_definition.py +43 -0
  232. frameio/types/text_definition_field_configuration.py +10 -0
  233. frameio/types/text_definition_params.py +15 -0
  234. frameio/types/text_definition_with_includes.py +13 -0
  235. frameio/types/text_value.py +12 -0
  236. frameio/types/toggle_definition.py +43 -0
  237. frameio/types/toggle_definition_field_configuration.py +15 -0
  238. frameio/types/toggle_definition_params.py +17 -0
  239. frameio/types/toggle_definition_params_field_configuration.py +15 -0
  240. frameio/types/toggle_definition_with_includes.py +13 -0
  241. frameio/types/too_many_requests.py +13 -0
  242. frameio/types/too_many_requests_errors_item.py +15 -0
  243. frameio/types/too_many_requests_errors_item_source.py +12 -0
  244. frameio/types/unauthorized.py +13 -0
  245. frameio/types/unauthorized_errors_item.py +15 -0
  246. frameio/types/unauthorized_errors_item_source.py +12 -0
  247. frameio/types/unprocessable_entity.py +13 -0
  248. frameio/types/unprocessable_entity_errors_item.py +15 -0
  249. frameio/types/unprocessable_entity_errors_item_source.py +12 -0
  250. frameio/types/update_date_definition_params.py +17 -0
  251. frameio/types/update_date_definition_params_field_configuration.py +25 -0
  252. frameio/types/update_date_definition_params_field_configuration_display_format.py +7 -0
  253. frameio/types/update_date_definition_params_field_configuration_time_format.py +7 -0
  254. frameio/types/update_long_text_definition_params.py +15 -0
  255. frameio/types/update_number_definition_params.py +17 -0
  256. frameio/types/update_number_definition_params_field_configuration.py +25 -0
  257. frameio/types/update_number_definition_params_field_configuration_number_format.py +7 -0
  258. frameio/types/update_rating_definition_params.py +17 -0
  259. frameio/types/update_rating_definition_params_field_configuration.py +24 -0
  260. frameio/types/update_rating_definition_params_field_configuration_style.py +7 -0
  261. frameio/types/update_select_definition_params.py +17 -0
  262. frameio/types/update_select_definition_params_field_configuration.py +20 -0
  263. frameio/types/update_select_definition_params_field_configuration_options_item.py +20 -0
  264. frameio/types/update_select_multi_definition_params.py +19 -0
  265. frameio/types/update_select_multi_definition_params_field_configuration.py +20 -0
  266. frameio/types/update_select_multi_definition_params_field_configuration_options_item.py +20 -0
  267. frameio/types/update_text_definition_params.py +15 -0
  268. frameio/types/update_toggle_definition_params.py +17 -0
  269. frameio/types/update_toggle_definition_params_field_configuration.py +15 -0
  270. frameio/types/update_user_multi_definition_params.py +17 -0
  271. frameio/types/update_user_multi_definition_params_field_configuration.py +25 -0
  272. frameio/types/update_user_multi_definition_params_field_configuration_custom_members_item.py +20 -0
  273. frameio/types/update_user_multi_definition_params_field_configuration_custom_members_item_type.py +7 -0
  274. frameio/types/update_user_multi_definition_params_field_configuration_member_options_type.py +7 -0
  275. frameio/types/update_user_roles_params.py +17 -0
  276. frameio/types/update_user_roles_params_data.py +13 -0
  277. frameio/types/update_user_roles_params_data_role.py +7 -0
  278. frameio/types/update_user_roles_response.py +13 -0
  279. frameio/types/update_user_roles_response_data.py +13 -0
  280. frameio/types/update_user_roles_response_data_role.py +7 -0
  281. frameio/types/update_user_single_definition_params.py +17 -0
  282. frameio/types/update_user_single_definition_params_field_configuration.py +25 -0
  283. frameio/types/update_user_single_definition_params_field_configuration_custom_members_item.py +20 -0
  284. frameio/types/update_user_single_definition_params_field_configuration_custom_members_item_type.py +7 -0
  285. frameio/types/update_user_single_definition_params_field_configuration_member_options_type.py +7 -0
  286. frameio/types/upload_url.py +20 -0
  287. frameio/types/user.py +44 -0
  288. frameio/types/user_multi_definition.py +43 -0
  289. frameio/types/user_multi_definition_field_configuration.py +23 -0
  290. frameio/types/user_multi_definition_field_configuration_custom_members_item.py +20 -0
  291. frameio/types/user_multi_definition_field_configuration_custom_members_item_type.py +7 -0
  292. frameio/types/user_multi_definition_field_configuration_member_options_type.py +7 -0
  293. frameio/types/user_multi_definition_params.py +17 -0
  294. frameio/types/user_multi_definition_params_field_configuration.py +23 -0
  295. frameio/types/user_multi_definition_params_field_configuration_custom_members_item.py +20 -0
  296. frameio/types/user_multi_definition_params_field_configuration_custom_members_item_type.py +7 -0
  297. frameio/types/user_multi_definition_params_field_configuration_member_options_type.py +7 -0
  298. frameio/types/user_multi_definition_with_includes.py +13 -0
  299. frameio/types/user_role.py +19 -0
  300. frameio/types/user_role_role.py +7 -0
  301. frameio/types/user_roles_response.py +27 -0
  302. frameio/types/user_single_definition.py +43 -0
  303. frameio/types/user_single_definition_field_configuration.py +23 -0
  304. frameio/types/user_single_definition_field_configuration_custom_members_item.py +20 -0
  305. frameio/types/user_single_definition_field_configuration_custom_members_item_type.py +7 -0
  306. frameio/types/user_single_definition_field_configuration_member_options_type.py +7 -0
  307. frameio/types/user_single_definition_params.py +17 -0
  308. frameio/types/user_single_definition_params_field_configuration.py +23 -0
  309. frameio/types/user_single_definition_params_field_configuration_custom_members_item.py +20 -0
  310. frameio/types/user_single_definition_params_field_configuration_custom_members_item_type.py +7 -0
  311. frameio/types/user_single_definition_params_field_configuration_member_options_type.py +7 -0
  312. frameio/types/user_single_definition_with_includes.py +13 -0
  313. frameio/types/user_value.py +18 -0
  314. frameio/types/user_value_type.py +5 -0
  315. frameio/types/uuid_.py +3 -0
  316. frameio/types/version_stack.py +50 -0
  317. frameio/types/version_stack_copy_response.py +13 -0
  318. frameio/types/version_stack_response.py +13 -0
  319. frameio/types/version_stack_with_includes.py +58 -0
  320. frameio/types/version_stack_with_includes_response.py +13 -0
  321. frameio/types/version_stacks_with_includes_response.py +19 -0
  322. frameio/types/webhook.py +36 -0
  323. frameio/types/webhook_create_response.py +17 -0
  324. frameio/types/webhook_create_response_data.py +15 -0
  325. frameio/types/webhook_events.py +5 -0
  326. frameio/types/webhook_response.py +13 -0
  327. frameio/types/webhook_with_includes.py +13 -0
  328. frameio/types/webhook_with_includes_response.py +13 -0
  329. frameio/types/webhooks_with_includes_response.py +23 -0
  330. frameio/types/workspace.py +40 -0
  331. frameio/types/workspace_include.py +5 -0
  332. frameio/types/workspace_params.py +17 -0
  333. frameio/types/workspace_params_data.py +15 -0
  334. frameio/types/workspace_response.py +17 -0
  335. frameio/types/workspace_with_includes.py +13 -0
  336. frameio/types/workspace_with_includes_response.py +17 -0
  337. frameio/types/workspaces_with_includes_response.py +27 -0
  338. frameio/users/__init__.py +4 -0
  339. frameio/users/client.py +100 -0
  340. frameio/users/raw_client.py +234 -0
  341. frameio/version.py +3 -0
  342. frameio/version_stacks/__init__.py +38 -0
  343. frameio/version_stacks/client.py +699 -0
  344. frameio/version_stacks/raw_client.py +1359 -0
  345. frameio/version_stacks/types/__init__.py +40 -0
  346. frameio/version_stacks/types/version_stack_copy_params_data.py +15 -0
  347. frameio/version_stacks/types/version_stack_create_params_data.py +19 -0
  348. frameio/version_stacks/types/version_stack_move_params_data.py +15 -0
  349. frameio/webhooks/__init__.py +34 -0
  350. frameio/webhooks/client.py +782 -0
  351. frameio/webhooks/raw_client.py +1312 -0
  352. frameio/webhooks/types/__init__.py +38 -0
  353. frameio/webhooks/types/webhook_create_params_data.py +18 -0
  354. frameio/webhooks/types/webhook_update_params_data.py +23 -0
  355. frameio/workspace_permissions/__init__.py +4 -0
  356. frameio/workspace_permissions/client.py +419 -0
  357. frameio/workspace_permissions/raw_client.py +789 -0
  358. frameio/workspaces/__init__.py +4 -0
  359. frameio/workspaces/client.py +552 -0
  360. frameio/workspaces/raw_client.py +1226 -0
  361. frameio-0.0.23.dist-info/METADATA +255 -0
  362. frameio-0.0.23.dist-info/RECORD +363 -0
  363. frameio-0.0.23.dist-info/WHEEL +4 -0
@@ -0,0 +1,988 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
6
+ from ..core.request_options import RequestOptions
7
+ from ..types.asset_include import AssetInclude
8
+ from ..types.assets_with_includes_response import AssetsWithIncludesResponse
9
+ from ..types.children_type import ChildrenType
10
+ from ..types.file_with_media_links_include import FileWithMediaLinksInclude
11
+ from ..types.folder_copy_response import FolderCopyResponse
12
+ from ..types.folder_response import FolderResponse
13
+ from ..types.folder_with_includes_response import FolderWithIncludesResponse
14
+ from ..types.folders_with_includes_response import FoldersWithIncludesResponse
15
+ from ..types.include_total_count import IncludeTotalCount
16
+ from ..types.request_after_opaque_cursor import RequestAfterOpaqueCursor
17
+ from ..types.request_page_size import RequestPageSize
18
+ from ..types.uuid_ import Uuid
19
+ from .raw_client import AsyncRawFoldersClient, RawFoldersClient
20
+ from .types.folder_copy_params_data import FolderCopyParamsData
21
+ from .types.folder_create_params_data import FolderCreateParamsData
22
+ from .types.folder_move_params_data import FolderMoveParamsData
23
+ from .types.folder_update_params_data import FolderUpdateParamsData
24
+
25
+ # this is used as the default value for optional parameters
26
+ OMIT = typing.cast(typing.Any, ...)
27
+
28
+
29
+ class FoldersClient:
30
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
31
+ self._raw_client = RawFoldersClient(client_wrapper=client_wrapper)
32
+
33
+ @property
34
+ def with_raw_response(self) -> RawFoldersClient:
35
+ """
36
+ Retrieves a raw implementation of this client that returns raw responses.
37
+
38
+ Returns
39
+ -------
40
+ RawFoldersClient
41
+ """
42
+ return self._raw_client
43
+
44
+ def show(
45
+ self,
46
+ account_id: Uuid,
47
+ folder_id: Uuid,
48
+ *,
49
+ include: typing.Optional[AssetInclude] = None,
50
+ request_options: typing.Optional[RequestOptions] = None,
51
+ ) -> FolderWithIncludesResponse:
52
+ """
53
+ Show folder details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
54
+
55
+ Parameters
56
+ ----------
57
+ account_id : Uuid
58
+
59
+
60
+ folder_id : Uuid
61
+
62
+
63
+ include : typing.Optional[AssetInclude]
64
+
65
+
66
+ request_options : typing.Optional[RequestOptions]
67
+ Request-specific configuration.
68
+
69
+ Returns
70
+ -------
71
+ FolderWithIncludesResponse
72
+ OK
73
+
74
+ Examples
75
+ --------
76
+ from frameio import Frameio
77
+
78
+ client = Frameio(
79
+ token="YOUR_TOKEN",
80
+ )
81
+ client.folders.show(
82
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
83
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
84
+ include="creator",
85
+ )
86
+ """
87
+ _response = self._raw_client.show(account_id, folder_id, include=include, request_options=request_options)
88
+ return _response.data
89
+
90
+ def delete(
91
+ self, account_id: Uuid, folder_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
92
+ ) -> None:
93
+ """
94
+ Delete folder by id.
95
+
96
+ Parameters
97
+ ----------
98
+ account_id : Uuid
99
+
100
+
101
+ folder_id : Uuid
102
+
103
+
104
+ request_options : typing.Optional[RequestOptions]
105
+ Request-specific configuration.
106
+
107
+ Returns
108
+ -------
109
+ None
110
+
111
+ Examples
112
+ --------
113
+ from frameio import Frameio
114
+
115
+ client = Frameio(
116
+ token="YOUR_TOKEN",
117
+ )
118
+ client.folders.delete(
119
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
120
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
121
+ )
122
+ """
123
+ _response = self._raw_client.delete(account_id, folder_id, request_options=request_options)
124
+ return _response.data
125
+
126
+ def update(
127
+ self,
128
+ account_id: Uuid,
129
+ folder_id: Uuid,
130
+ *,
131
+ data: FolderUpdateParamsData,
132
+ request_options: typing.Optional[RequestOptions] = None,
133
+ ) -> FolderResponse:
134
+ """
135
+ Update folder details.
136
+
137
+ Parameters
138
+ ----------
139
+ account_id : Uuid
140
+
141
+
142
+ folder_id : Uuid
143
+
144
+
145
+ data : FolderUpdateParamsData
146
+
147
+ request_options : typing.Optional[RequestOptions]
148
+ Request-specific configuration.
149
+
150
+ Returns
151
+ -------
152
+ FolderResponse
153
+ OK
154
+
155
+ Examples
156
+ --------
157
+ from frameio import Frameio
158
+ from frameio.folders import FolderUpdateParamsData
159
+
160
+ client = Frameio(
161
+ token="YOUR_TOKEN",
162
+ )
163
+ client.folders.update(
164
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
165
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
166
+ data=FolderUpdateParamsData(
167
+ name="Folder name",
168
+ ),
169
+ )
170
+ """
171
+ _response = self._raw_client.update(account_id, folder_id, data=data, request_options=request_options)
172
+ return _response.data
173
+
174
+ def index(
175
+ self,
176
+ account_id: Uuid,
177
+ folder_id: Uuid,
178
+ *,
179
+ include: typing.Optional[FileWithMediaLinksInclude] = None,
180
+ type: typing.Optional[ChildrenType] = None,
181
+ after: typing.Optional[RequestAfterOpaqueCursor] = None,
182
+ page_size: typing.Optional[RequestPageSize] = None,
183
+ include_total_count: typing.Optional[IncludeTotalCount] = None,
184
+ request_options: typing.Optional[RequestOptions] = None,
185
+ ) -> AssetsWithIncludesResponse:
186
+ """
187
+ List the children in the given folder.
188
+ <br><br>
189
+ Use the `include` query parameter to selectively include additional properties in the response.
190
+ <br><br>
191
+ Note: if you include `media_links.original` and the user does not have permission to download files
192
+ in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
193
+ If the content is inaccessible because watermarking is required for this user and isn't supported by
194
+ the requested media_links, then the request will succeed but the unsupported media links will be set to null.
195
+ Similarly, if a requested transcode link does not exist for a particular file (e.g. including
196
+ `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
197
+ (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
198
+ null in the response payload. In short, the client must handle null media links gracefully.
199
+
200
+ Parameters
201
+ ----------
202
+ account_id : Uuid
203
+
204
+
205
+ folder_id : Uuid
206
+
207
+
208
+ include : typing.Optional[FileWithMediaLinksInclude]
209
+
210
+
211
+ type : typing.Optional[ChildrenType]
212
+
213
+
214
+ after : typing.Optional[RequestAfterOpaqueCursor]
215
+ Opaque Cursor query param for requests returning paginated results.
216
+ <br/>
217
+ NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
218
+
219
+ page_size : typing.Optional[RequestPageSize]
220
+
221
+
222
+ include_total_count : typing.Optional[IncludeTotalCount]
223
+
224
+
225
+ request_options : typing.Optional[RequestOptions]
226
+ Request-specific configuration.
227
+
228
+ Returns
229
+ -------
230
+ AssetsWithIncludesResponse
231
+ OK
232
+
233
+ Examples
234
+ --------
235
+ from frameio import Frameio
236
+
237
+ client = Frameio(
238
+ token="YOUR_TOKEN",
239
+ )
240
+ client.folders.index(
241
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
242
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
243
+ include="media_links",
244
+ type="file,folder,version_stack",
245
+ after="<opaque_cursor>",
246
+ page_size=10,
247
+ include_total_count=False,
248
+ )
249
+ """
250
+ _response = self._raw_client.index(
251
+ account_id,
252
+ folder_id,
253
+ include=include,
254
+ type=type,
255
+ after=after,
256
+ page_size=page_size,
257
+ include_total_count=include_total_count,
258
+ request_options=request_options,
259
+ )
260
+ return _response.data
261
+
262
+ def copy(
263
+ self,
264
+ account_id: Uuid,
265
+ folder_id: Uuid,
266
+ *,
267
+ data: typing.Optional[FolderCopyParamsData] = OMIT,
268
+ request_options: typing.Optional[RequestOptions] = None,
269
+ ) -> FolderCopyResponse:
270
+ """
271
+ Copy folder. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
272
+
273
+ Parameters
274
+ ----------
275
+ account_id : Uuid
276
+
277
+
278
+ folder_id : Uuid
279
+
280
+
281
+ data : typing.Optional[FolderCopyParamsData]
282
+
283
+ request_options : typing.Optional[RequestOptions]
284
+ Request-specific configuration.
285
+
286
+ Returns
287
+ -------
288
+ FolderCopyResponse
289
+ OK
290
+
291
+ Examples
292
+ --------
293
+ from frameio import Frameio
294
+ from frameio.folders import FolderCopyParamsData
295
+
296
+ client = Frameio(
297
+ token="YOUR_TOKEN",
298
+ )
299
+ client.folders.copy(
300
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
301
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
302
+ data=FolderCopyParamsData(
303
+ parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
304
+ ),
305
+ )
306
+ """
307
+ _response = self._raw_client.copy(account_id, folder_id, data=data, request_options=request_options)
308
+ return _response.data
309
+
310
+ def list(
311
+ self,
312
+ account_id: Uuid,
313
+ folder_id: Uuid,
314
+ *,
315
+ include: typing.Optional[AssetInclude] = None,
316
+ after: typing.Optional[RequestAfterOpaqueCursor] = None,
317
+ page_size: typing.Optional[RequestPageSize] = None,
318
+ include_total_count: typing.Optional[IncludeTotalCount] = None,
319
+ request_options: typing.Optional[RequestOptions] = None,
320
+ ) -> FoldersWithIncludesResponse:
321
+ """
322
+ List folders in a given folder. <br><br>Rate Limits: 5 calls per 1 second(s) per account
323
+
324
+ Parameters
325
+ ----------
326
+ account_id : Uuid
327
+
328
+
329
+ folder_id : Uuid
330
+
331
+
332
+ include : typing.Optional[AssetInclude]
333
+
334
+
335
+ after : typing.Optional[RequestAfterOpaqueCursor]
336
+ Opaque Cursor query param for requests returning paginated results.
337
+ <br/>
338
+ NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
339
+
340
+ page_size : typing.Optional[RequestPageSize]
341
+
342
+
343
+ include_total_count : typing.Optional[IncludeTotalCount]
344
+
345
+
346
+ request_options : typing.Optional[RequestOptions]
347
+ Request-specific configuration.
348
+
349
+ Returns
350
+ -------
351
+ FoldersWithIncludesResponse
352
+ OK
353
+
354
+ Examples
355
+ --------
356
+ from frameio import Frameio
357
+
358
+ client = Frameio(
359
+ token="YOUR_TOKEN",
360
+ )
361
+ client.folders.list(
362
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
363
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
364
+ include="creator",
365
+ after="<opaque_cursor>",
366
+ page_size=10,
367
+ include_total_count=False,
368
+ )
369
+ """
370
+ _response = self._raw_client.list(
371
+ account_id,
372
+ folder_id,
373
+ include=include,
374
+ after=after,
375
+ page_size=page_size,
376
+ include_total_count=include_total_count,
377
+ request_options=request_options,
378
+ )
379
+ return _response.data
380
+
381
+ def create(
382
+ self,
383
+ account_id: Uuid,
384
+ folder_id: Uuid,
385
+ *,
386
+ data: FolderCreateParamsData,
387
+ request_options: typing.Optional[RequestOptions] = None,
388
+ ) -> FolderResponse:
389
+ """
390
+ Create a new folder inside the given <i>folder_id</i> path param. <br><br>Rate Limits: 3 calls per 1 second(s) per account
391
+
392
+ Parameters
393
+ ----------
394
+ account_id : Uuid
395
+
396
+
397
+ folder_id : Uuid
398
+
399
+
400
+ data : FolderCreateParamsData
401
+
402
+ request_options : typing.Optional[RequestOptions]
403
+ Request-specific configuration.
404
+
405
+ Returns
406
+ -------
407
+ FolderResponse
408
+ Created
409
+
410
+ Examples
411
+ --------
412
+ from frameio import Frameio
413
+ from frameio.folders import FolderCreateParamsData
414
+
415
+ client = Frameio(
416
+ token="YOUR_TOKEN",
417
+ )
418
+ client.folders.create(
419
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
420
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
421
+ data=FolderCreateParamsData(
422
+ name="Folder name",
423
+ ),
424
+ )
425
+ """
426
+ _response = self._raw_client.create(account_id, folder_id, data=data, request_options=request_options)
427
+ return _response.data
428
+
429
+ def move(
430
+ self,
431
+ account_id: Uuid,
432
+ folder_id: Uuid,
433
+ *,
434
+ data: FolderMoveParamsData,
435
+ request_options: typing.Optional[RequestOptions] = None,
436
+ ) -> FolderResponse:
437
+ """
438
+ Move folder to a folder. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
439
+
440
+ Parameters
441
+ ----------
442
+ account_id : Uuid
443
+
444
+
445
+ folder_id : Uuid
446
+
447
+
448
+ data : FolderMoveParamsData
449
+
450
+ request_options : typing.Optional[RequestOptions]
451
+ Request-specific configuration.
452
+
453
+ Returns
454
+ -------
455
+ FolderResponse
456
+ OK
457
+
458
+ Examples
459
+ --------
460
+ from frameio import Frameio
461
+ from frameio.folders import FolderMoveParamsData
462
+
463
+ client = Frameio(
464
+ token="YOUR_TOKEN",
465
+ )
466
+ client.folders.move(
467
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
468
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
469
+ data=FolderMoveParamsData(
470
+ parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
471
+ ),
472
+ )
473
+ """
474
+ _response = self._raw_client.move(account_id, folder_id, data=data, request_options=request_options)
475
+ return _response.data
476
+
477
+
478
+ class AsyncFoldersClient:
479
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
480
+ self._raw_client = AsyncRawFoldersClient(client_wrapper=client_wrapper)
481
+
482
+ @property
483
+ def with_raw_response(self) -> AsyncRawFoldersClient:
484
+ """
485
+ Retrieves a raw implementation of this client that returns raw responses.
486
+
487
+ Returns
488
+ -------
489
+ AsyncRawFoldersClient
490
+ """
491
+ return self._raw_client
492
+
493
+ async def show(
494
+ self,
495
+ account_id: Uuid,
496
+ folder_id: Uuid,
497
+ *,
498
+ include: typing.Optional[AssetInclude] = None,
499
+ request_options: typing.Optional[RequestOptions] = None,
500
+ ) -> FolderWithIncludesResponse:
501
+ """
502
+ Show folder details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
503
+
504
+ Parameters
505
+ ----------
506
+ account_id : Uuid
507
+
508
+
509
+ folder_id : Uuid
510
+
511
+
512
+ include : typing.Optional[AssetInclude]
513
+
514
+
515
+ request_options : typing.Optional[RequestOptions]
516
+ Request-specific configuration.
517
+
518
+ Returns
519
+ -------
520
+ FolderWithIncludesResponse
521
+ OK
522
+
523
+ Examples
524
+ --------
525
+ import asyncio
526
+
527
+ from frameio import AsyncFrameio
528
+
529
+ client = AsyncFrameio(
530
+ token="YOUR_TOKEN",
531
+ )
532
+
533
+
534
+ async def main() -> None:
535
+ await client.folders.show(
536
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
537
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
538
+ include="creator",
539
+ )
540
+
541
+
542
+ asyncio.run(main())
543
+ """
544
+ _response = await self._raw_client.show(account_id, folder_id, include=include, request_options=request_options)
545
+ return _response.data
546
+
547
+ async def delete(
548
+ self, account_id: Uuid, folder_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
549
+ ) -> None:
550
+ """
551
+ Delete folder by id.
552
+
553
+ Parameters
554
+ ----------
555
+ account_id : Uuid
556
+
557
+
558
+ folder_id : Uuid
559
+
560
+
561
+ request_options : typing.Optional[RequestOptions]
562
+ Request-specific configuration.
563
+
564
+ Returns
565
+ -------
566
+ None
567
+
568
+ Examples
569
+ --------
570
+ import asyncio
571
+
572
+ from frameio import AsyncFrameio
573
+
574
+ client = AsyncFrameio(
575
+ token="YOUR_TOKEN",
576
+ )
577
+
578
+
579
+ async def main() -> None:
580
+ await client.folders.delete(
581
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
582
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
583
+ )
584
+
585
+
586
+ asyncio.run(main())
587
+ """
588
+ _response = await self._raw_client.delete(account_id, folder_id, request_options=request_options)
589
+ return _response.data
590
+
591
+ async def update(
592
+ self,
593
+ account_id: Uuid,
594
+ folder_id: Uuid,
595
+ *,
596
+ data: FolderUpdateParamsData,
597
+ request_options: typing.Optional[RequestOptions] = None,
598
+ ) -> FolderResponse:
599
+ """
600
+ Update folder details.
601
+
602
+ Parameters
603
+ ----------
604
+ account_id : Uuid
605
+
606
+
607
+ folder_id : Uuid
608
+
609
+
610
+ data : FolderUpdateParamsData
611
+
612
+ request_options : typing.Optional[RequestOptions]
613
+ Request-specific configuration.
614
+
615
+ Returns
616
+ -------
617
+ FolderResponse
618
+ OK
619
+
620
+ Examples
621
+ --------
622
+ import asyncio
623
+
624
+ from frameio import AsyncFrameio
625
+ from frameio.folders import FolderUpdateParamsData
626
+
627
+ client = AsyncFrameio(
628
+ token="YOUR_TOKEN",
629
+ )
630
+
631
+
632
+ async def main() -> None:
633
+ await client.folders.update(
634
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
635
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
636
+ data=FolderUpdateParamsData(
637
+ name="Folder name",
638
+ ),
639
+ )
640
+
641
+
642
+ asyncio.run(main())
643
+ """
644
+ _response = await self._raw_client.update(account_id, folder_id, data=data, request_options=request_options)
645
+ return _response.data
646
+
647
+ async def index(
648
+ self,
649
+ account_id: Uuid,
650
+ folder_id: Uuid,
651
+ *,
652
+ include: typing.Optional[FileWithMediaLinksInclude] = None,
653
+ type: typing.Optional[ChildrenType] = None,
654
+ after: typing.Optional[RequestAfterOpaqueCursor] = None,
655
+ page_size: typing.Optional[RequestPageSize] = None,
656
+ include_total_count: typing.Optional[IncludeTotalCount] = None,
657
+ request_options: typing.Optional[RequestOptions] = None,
658
+ ) -> AssetsWithIncludesResponse:
659
+ """
660
+ List the children in the given folder.
661
+ <br><br>
662
+ Use the `include` query parameter to selectively include additional properties in the response.
663
+ <br><br>
664
+ Note: if you include `media_links.original` and the user does not have permission to download files
665
+ in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
666
+ If the content is inaccessible because watermarking is required for this user and isn't supported by
667
+ the requested media_links, then the request will succeed but the unsupported media links will be set to null.
668
+ Similarly, if a requested transcode link does not exist for a particular file (e.g. including
669
+ `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
670
+ (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
671
+ null in the response payload. In short, the client must handle null media links gracefully.
672
+
673
+ Parameters
674
+ ----------
675
+ account_id : Uuid
676
+
677
+
678
+ folder_id : Uuid
679
+
680
+
681
+ include : typing.Optional[FileWithMediaLinksInclude]
682
+
683
+
684
+ type : typing.Optional[ChildrenType]
685
+
686
+
687
+ after : typing.Optional[RequestAfterOpaqueCursor]
688
+ Opaque Cursor query param for requests returning paginated results.
689
+ <br/>
690
+ NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
691
+
692
+ page_size : typing.Optional[RequestPageSize]
693
+
694
+
695
+ include_total_count : typing.Optional[IncludeTotalCount]
696
+
697
+
698
+ request_options : typing.Optional[RequestOptions]
699
+ Request-specific configuration.
700
+
701
+ Returns
702
+ -------
703
+ AssetsWithIncludesResponse
704
+ OK
705
+
706
+ Examples
707
+ --------
708
+ import asyncio
709
+
710
+ from frameio import AsyncFrameio
711
+
712
+ client = AsyncFrameio(
713
+ token="YOUR_TOKEN",
714
+ )
715
+
716
+
717
+ async def main() -> None:
718
+ await client.folders.index(
719
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
720
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
721
+ include="media_links",
722
+ type="file,folder,version_stack",
723
+ after="<opaque_cursor>",
724
+ page_size=10,
725
+ include_total_count=False,
726
+ )
727
+
728
+
729
+ asyncio.run(main())
730
+ """
731
+ _response = await self._raw_client.index(
732
+ account_id,
733
+ folder_id,
734
+ include=include,
735
+ type=type,
736
+ after=after,
737
+ page_size=page_size,
738
+ include_total_count=include_total_count,
739
+ request_options=request_options,
740
+ )
741
+ return _response.data
742
+
743
+ async def copy(
744
+ self,
745
+ account_id: Uuid,
746
+ folder_id: Uuid,
747
+ *,
748
+ data: typing.Optional[FolderCopyParamsData] = OMIT,
749
+ request_options: typing.Optional[RequestOptions] = None,
750
+ ) -> FolderCopyResponse:
751
+ """
752
+ Copy folder. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
753
+
754
+ Parameters
755
+ ----------
756
+ account_id : Uuid
757
+
758
+
759
+ folder_id : Uuid
760
+
761
+
762
+ data : typing.Optional[FolderCopyParamsData]
763
+
764
+ request_options : typing.Optional[RequestOptions]
765
+ Request-specific configuration.
766
+
767
+ Returns
768
+ -------
769
+ FolderCopyResponse
770
+ OK
771
+
772
+ Examples
773
+ --------
774
+ import asyncio
775
+
776
+ from frameio import AsyncFrameio
777
+ from frameio.folders import FolderCopyParamsData
778
+
779
+ client = AsyncFrameio(
780
+ token="YOUR_TOKEN",
781
+ )
782
+
783
+
784
+ async def main() -> None:
785
+ await client.folders.copy(
786
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
787
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
788
+ data=FolderCopyParamsData(
789
+ parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
790
+ ),
791
+ )
792
+
793
+
794
+ asyncio.run(main())
795
+ """
796
+ _response = await self._raw_client.copy(account_id, folder_id, data=data, request_options=request_options)
797
+ return _response.data
798
+
799
+ async def list(
800
+ self,
801
+ account_id: Uuid,
802
+ folder_id: Uuid,
803
+ *,
804
+ include: typing.Optional[AssetInclude] = None,
805
+ after: typing.Optional[RequestAfterOpaqueCursor] = None,
806
+ page_size: typing.Optional[RequestPageSize] = None,
807
+ include_total_count: typing.Optional[IncludeTotalCount] = None,
808
+ request_options: typing.Optional[RequestOptions] = None,
809
+ ) -> FoldersWithIncludesResponse:
810
+ """
811
+ List folders in a given folder. <br><br>Rate Limits: 5 calls per 1 second(s) per account
812
+
813
+ Parameters
814
+ ----------
815
+ account_id : Uuid
816
+
817
+
818
+ folder_id : Uuid
819
+
820
+
821
+ include : typing.Optional[AssetInclude]
822
+
823
+
824
+ after : typing.Optional[RequestAfterOpaqueCursor]
825
+ Opaque Cursor query param for requests returning paginated results.
826
+ <br/>
827
+ NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
828
+
829
+ page_size : typing.Optional[RequestPageSize]
830
+
831
+
832
+ include_total_count : typing.Optional[IncludeTotalCount]
833
+
834
+
835
+ request_options : typing.Optional[RequestOptions]
836
+ Request-specific configuration.
837
+
838
+ Returns
839
+ -------
840
+ FoldersWithIncludesResponse
841
+ OK
842
+
843
+ Examples
844
+ --------
845
+ import asyncio
846
+
847
+ from frameio import AsyncFrameio
848
+
849
+ client = AsyncFrameio(
850
+ token="YOUR_TOKEN",
851
+ )
852
+
853
+
854
+ async def main() -> None:
855
+ await client.folders.list(
856
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
857
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
858
+ include="creator",
859
+ after="<opaque_cursor>",
860
+ page_size=10,
861
+ include_total_count=False,
862
+ )
863
+
864
+
865
+ asyncio.run(main())
866
+ """
867
+ _response = await self._raw_client.list(
868
+ account_id,
869
+ folder_id,
870
+ include=include,
871
+ after=after,
872
+ page_size=page_size,
873
+ include_total_count=include_total_count,
874
+ request_options=request_options,
875
+ )
876
+ return _response.data
877
+
878
+ async def create(
879
+ self,
880
+ account_id: Uuid,
881
+ folder_id: Uuid,
882
+ *,
883
+ data: FolderCreateParamsData,
884
+ request_options: typing.Optional[RequestOptions] = None,
885
+ ) -> FolderResponse:
886
+ """
887
+ Create a new folder inside the given <i>folder_id</i> path param. <br><br>Rate Limits: 3 calls per 1 second(s) per account
888
+
889
+ Parameters
890
+ ----------
891
+ account_id : Uuid
892
+
893
+
894
+ folder_id : Uuid
895
+
896
+
897
+ data : FolderCreateParamsData
898
+
899
+ request_options : typing.Optional[RequestOptions]
900
+ Request-specific configuration.
901
+
902
+ Returns
903
+ -------
904
+ FolderResponse
905
+ Created
906
+
907
+ Examples
908
+ --------
909
+ import asyncio
910
+
911
+ from frameio import AsyncFrameio
912
+ from frameio.folders import FolderCreateParamsData
913
+
914
+ client = AsyncFrameio(
915
+ token="YOUR_TOKEN",
916
+ )
917
+
918
+
919
+ async def main() -> None:
920
+ await client.folders.create(
921
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
922
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
923
+ data=FolderCreateParamsData(
924
+ name="Folder name",
925
+ ),
926
+ )
927
+
928
+
929
+ asyncio.run(main())
930
+ """
931
+ _response = await self._raw_client.create(account_id, folder_id, data=data, request_options=request_options)
932
+ return _response.data
933
+
934
+ async def move(
935
+ self,
936
+ account_id: Uuid,
937
+ folder_id: Uuid,
938
+ *,
939
+ data: FolderMoveParamsData,
940
+ request_options: typing.Optional[RequestOptions] = None,
941
+ ) -> FolderResponse:
942
+ """
943
+ Move folder to a folder. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
944
+
945
+ Parameters
946
+ ----------
947
+ account_id : Uuid
948
+
949
+
950
+ folder_id : Uuid
951
+
952
+
953
+ data : FolderMoveParamsData
954
+
955
+ request_options : typing.Optional[RequestOptions]
956
+ Request-specific configuration.
957
+
958
+ Returns
959
+ -------
960
+ FolderResponse
961
+ OK
962
+
963
+ Examples
964
+ --------
965
+ import asyncio
966
+
967
+ from frameio import AsyncFrameio
968
+ from frameio.folders import FolderMoveParamsData
969
+
970
+ client = AsyncFrameio(
971
+ token="YOUR_TOKEN",
972
+ )
973
+
974
+
975
+ async def main() -> None:
976
+ await client.folders.move(
977
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
978
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
979
+ data=FolderMoveParamsData(
980
+ parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
981
+ ),
982
+ )
983
+
984
+
985
+ asyncio.run(main())
986
+ """
987
+ _response = await self._raw_client.move(account_id, folder_id, data=data, request_options=request_options)
988
+ return _response.data