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,1136 @@
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.assets_with_includes_response import AssetsWithIncludesResponse
8
+ from ..types.file_copy_response import FileCopyResponse
9
+ from ..types.file_remote_upload_response import FileRemoteUploadResponse
10
+ from ..types.file_response import FileResponse
11
+ from ..types.file_upload_status_response import FileUploadStatusResponse
12
+ from ..types.file_with_includes_response import FileWithIncludesResponse
13
+ from ..types.file_with_media_links_include import FileWithMediaLinksInclude
14
+ from ..types.file_with_upload_urls_response import FileWithUploadUrlsResponse
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 AsyncRawFilesClient, RawFilesClient
20
+ from .types.file_copy_params_data import FileCopyParamsData
21
+ from .types.file_create_local_upload_params_data import FileCreateLocalUploadParamsData
22
+ from .types.file_create_params_data import FileCreateParamsData
23
+ from .types.file_create_remote_upload_params_data import FileCreateRemoteUploadParamsData
24
+ from .types.file_move_params_data import FileMoveParamsData
25
+ from .types.file_update_params_data import FileUpdateParamsData
26
+
27
+ # this is used as the default value for optional parameters
28
+ OMIT = typing.cast(typing.Any, ...)
29
+
30
+
31
+ class FilesClient:
32
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
33
+ self._raw_client = RawFilesClient(client_wrapper=client_wrapper)
34
+
35
+ @property
36
+ def with_raw_response(self) -> RawFilesClient:
37
+ """
38
+ Retrieves a raw implementation of this client that returns raw responses.
39
+
40
+ Returns
41
+ -------
42
+ RawFilesClient
43
+ """
44
+ return self._raw_client
45
+
46
+ def list(
47
+ self,
48
+ account_id: Uuid,
49
+ folder_id: Uuid,
50
+ *,
51
+ include: typing.Optional[FileWithMediaLinksInclude] = None,
52
+ after: typing.Optional[RequestAfterOpaqueCursor] = None,
53
+ page_size: typing.Optional[RequestPageSize] = None,
54
+ include_total_count: typing.Optional[IncludeTotalCount] = None,
55
+ request_options: typing.Optional[RequestOptions] = None,
56
+ ) -> AssetsWithIncludesResponse:
57
+ """
58
+ List files in a given folder. <br><br>Rate Limits: 5 calls per 1 second(s) per account
59
+
60
+ Parameters
61
+ ----------
62
+ account_id : Uuid
63
+
64
+
65
+ folder_id : Uuid
66
+
67
+
68
+ include : typing.Optional[FileWithMediaLinksInclude]
69
+
70
+
71
+ after : typing.Optional[RequestAfterOpaqueCursor]
72
+ Opaque Cursor query param for requests returning paginated results.
73
+ <br/>
74
+ NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
75
+
76
+ page_size : typing.Optional[RequestPageSize]
77
+
78
+
79
+ include_total_count : typing.Optional[IncludeTotalCount]
80
+
81
+
82
+ request_options : typing.Optional[RequestOptions]
83
+ Request-specific configuration.
84
+
85
+ Returns
86
+ -------
87
+ AssetsWithIncludesResponse
88
+ OK
89
+
90
+ Examples
91
+ --------
92
+ from frameio import Frameio
93
+
94
+ client = Frameio(
95
+ token="YOUR_TOKEN",
96
+ )
97
+ client.files.list(
98
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
99
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
100
+ include="media_links",
101
+ after="<opaque_cursor>",
102
+ page_size=10,
103
+ include_total_count=False,
104
+ )
105
+ """
106
+ _response = self._raw_client.list(
107
+ account_id,
108
+ folder_id,
109
+ include=include,
110
+ after=after,
111
+ page_size=page_size,
112
+ include_total_count=include_total_count,
113
+ request_options=request_options,
114
+ )
115
+ return _response.data
116
+
117
+ def create(
118
+ self,
119
+ account_id: Uuid,
120
+ folder_id: Uuid,
121
+ *,
122
+ data: FileCreateParamsData,
123
+ request_options: typing.Optional[RequestOptions] = None,
124
+ ) -> FileWithUploadUrlsResponse:
125
+ """
126
+ Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br><br>Rate Limits: 5 calls per 1 second(s) per account
127
+
128
+ Parameters
129
+ ----------
130
+ account_id : Uuid
131
+
132
+
133
+ folder_id : Uuid
134
+
135
+
136
+ data : FileCreateParamsData
137
+
138
+ request_options : typing.Optional[RequestOptions]
139
+ Request-specific configuration.
140
+
141
+ Returns
142
+ -------
143
+ FileWithUploadUrlsResponse
144
+ Created
145
+
146
+ Examples
147
+ --------
148
+ from frameio import Frameio
149
+ from frameio.files import FileCreateParamsData
150
+
151
+ client = Frameio(
152
+ token="YOUR_TOKEN",
153
+ )
154
+ client.files.create(
155
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
156
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
157
+ data=FileCreateParamsData(
158
+ file_size=1137444,
159
+ media_type="image/png",
160
+ name="asset.png",
161
+ ),
162
+ )
163
+ """
164
+ _response = self._raw_client.create(account_id, folder_id, data=data, request_options=request_options)
165
+ return _response.data
166
+
167
+ def show(
168
+ self,
169
+ account_id: Uuid,
170
+ file_id: Uuid,
171
+ *,
172
+ include: typing.Optional[FileWithMediaLinksInclude] = None,
173
+ request_options: typing.Optional[RequestOptions] = None,
174
+ ) -> FileWithIncludesResponse:
175
+ """
176
+ Show file details.
177
+ <br><br>
178
+ Use the `include` query parameter to selectively include additional properties in the response.
179
+ <br><br>
180
+ Note: if you include `media_links.original` and the user does not have permission to download the file
181
+ then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
182
+ watermarking is required for this user and isn't supported by the requested media_links, then the request will
183
+ succeed but the unsupported media links will be set to null.
184
+ Similarly, if a requested transcode link does not exist for a particular file (e.g. including
185
+ `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
186
+ (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
187
+ the response payload. In short, the client must handle null media links gracefully.
188
+ <br><br>Rate Limits: 5 calls per 1 second(s) per account
189
+
190
+ Parameters
191
+ ----------
192
+ account_id : Uuid
193
+
194
+
195
+ file_id : Uuid
196
+
197
+
198
+ include : typing.Optional[FileWithMediaLinksInclude]
199
+
200
+
201
+ request_options : typing.Optional[RequestOptions]
202
+ Request-specific configuration.
203
+
204
+ Returns
205
+ -------
206
+ FileWithIncludesResponse
207
+ OK
208
+
209
+ Examples
210
+ --------
211
+ from frameio import Frameio
212
+
213
+ client = Frameio(
214
+ token="YOUR_TOKEN",
215
+ )
216
+ client.files.show(
217
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
218
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
219
+ include="media_links",
220
+ )
221
+ """
222
+ _response = self._raw_client.show(account_id, file_id, include=include, request_options=request_options)
223
+ return _response.data
224
+
225
+ def delete(
226
+ self, account_id: Uuid, file_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
227
+ ) -> None:
228
+ """
229
+ Delete file by ID. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
230
+
231
+ Parameters
232
+ ----------
233
+ account_id : Uuid
234
+
235
+
236
+ file_id : Uuid
237
+
238
+
239
+ request_options : typing.Optional[RequestOptions]
240
+ Request-specific configuration.
241
+
242
+ Returns
243
+ -------
244
+ None
245
+
246
+ Examples
247
+ --------
248
+ from frameio import Frameio
249
+
250
+ client = Frameio(
251
+ token="YOUR_TOKEN",
252
+ )
253
+ client.files.delete(
254
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
255
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
256
+ )
257
+ """
258
+ _response = self._raw_client.delete(account_id, file_id, request_options=request_options)
259
+ return _response.data
260
+
261
+ def update(
262
+ self,
263
+ account_id: Uuid,
264
+ file_id: Uuid,
265
+ *,
266
+ data: FileUpdateParamsData,
267
+ request_options: typing.Optional[RequestOptions] = None,
268
+ ) -> FileResponse:
269
+ """
270
+ Update file details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
271
+
272
+ Parameters
273
+ ----------
274
+ account_id : Uuid
275
+
276
+
277
+ file_id : Uuid
278
+
279
+
280
+ data : FileUpdateParamsData
281
+
282
+ request_options : typing.Optional[RequestOptions]
283
+ Request-specific configuration.
284
+
285
+ Returns
286
+ -------
287
+ FileResponse
288
+ OK
289
+
290
+ Examples
291
+ --------
292
+ from frameio import Frameio
293
+ from frameio.files import FileUpdateParamsData
294
+
295
+ client = Frameio(
296
+ token="YOUR_TOKEN",
297
+ )
298
+ client.files.update(
299
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
300
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
301
+ data=FileUpdateParamsData(
302
+ name="asset.png",
303
+ ),
304
+ )
305
+ """
306
+ _response = self._raw_client.update(account_id, file_id, data=data, request_options=request_options)
307
+ return _response.data
308
+
309
+ def copy(
310
+ self,
311
+ account_id: Uuid,
312
+ file_id: Uuid,
313
+ *,
314
+ data: typing.Optional[FileCopyParamsData] = OMIT,
315
+ request_options: typing.Optional[RequestOptions] = None,
316
+ ) -> FileCopyResponse:
317
+ """
318
+ Copy file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
319
+
320
+ Parameters
321
+ ----------
322
+ account_id : Uuid
323
+
324
+
325
+ file_id : Uuid
326
+
327
+
328
+ data : typing.Optional[FileCopyParamsData]
329
+
330
+ request_options : typing.Optional[RequestOptions]
331
+ Request-specific configuration.
332
+
333
+ Returns
334
+ -------
335
+ FileCopyResponse
336
+ OK
337
+
338
+ Examples
339
+ --------
340
+ from frameio import Frameio
341
+ from frameio.files import FileCopyParamsData
342
+
343
+ client = Frameio(
344
+ token="YOUR_TOKEN",
345
+ )
346
+ client.files.copy(
347
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
348
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
349
+ data=FileCopyParamsData(
350
+ parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
351
+ ),
352
+ )
353
+ """
354
+ _response = self._raw_client.copy(account_id, file_id, data=data, request_options=request_options)
355
+ return _response.data
356
+
357
+ def create_remote_upload(
358
+ self,
359
+ account_id: Uuid,
360
+ folder_id: Uuid,
361
+ *,
362
+ data: FileCreateRemoteUploadParamsData,
363
+ request_options: typing.Optional[RequestOptions] = None,
364
+ ) -> FileRemoteUploadResponse:
365
+ """
366
+ Create new file under parent folder through remote upload. <br><br>Rate Limits: 5 calls per 1 second(s) per account
367
+
368
+ Parameters
369
+ ----------
370
+ account_id : Uuid
371
+
372
+
373
+ folder_id : Uuid
374
+
375
+
376
+ data : FileCreateRemoteUploadParamsData
377
+
378
+ request_options : typing.Optional[RequestOptions]
379
+ Request-specific configuration.
380
+
381
+ Returns
382
+ -------
383
+ FileRemoteUploadResponse
384
+ Accepted
385
+
386
+ Examples
387
+ --------
388
+ from frameio import Frameio
389
+ from frameio.files import FileCreateRemoteUploadParamsData
390
+
391
+ client = Frameio(
392
+ token="YOUR_TOKEN",
393
+ )
394
+ client.files.create_remote_upload(
395
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
396
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
397
+ data=FileCreateRemoteUploadParamsData(
398
+ name="asset.png",
399
+ source_url="https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
400
+ ),
401
+ )
402
+ """
403
+ _response = self._raw_client.create_remote_upload(
404
+ account_id, folder_id, data=data, request_options=request_options
405
+ )
406
+ return _response.data
407
+
408
+ def move(
409
+ self,
410
+ account_id: Uuid,
411
+ file_id: Uuid,
412
+ *,
413
+ data: FileMoveParamsData,
414
+ request_options: typing.Optional[RequestOptions] = None,
415
+ ) -> FileResponse:
416
+ """
417
+ Move file to a folder or version_stack. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
418
+
419
+ Parameters
420
+ ----------
421
+ account_id : Uuid
422
+
423
+
424
+ file_id : Uuid
425
+
426
+
427
+ data : FileMoveParamsData
428
+
429
+ request_options : typing.Optional[RequestOptions]
430
+ Request-specific configuration.
431
+
432
+ Returns
433
+ -------
434
+ FileResponse
435
+ OK
436
+
437
+ Examples
438
+ --------
439
+ from frameio import Frameio
440
+ from frameio.files import FileMoveParamsData
441
+
442
+ client = Frameio(
443
+ token="YOUR_TOKEN",
444
+ )
445
+ client.files.move(
446
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
447
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
448
+ data=FileMoveParamsData(
449
+ parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
450
+ ),
451
+ )
452
+ """
453
+ _response = self._raw_client.move(account_id, file_id, data=data, request_options=request_options)
454
+ return _response.data
455
+
456
+ def create_local_upload(
457
+ self,
458
+ account_id: Uuid,
459
+ folder_id: Uuid,
460
+ *,
461
+ data: FileCreateLocalUploadParamsData,
462
+ request_options: typing.Optional[RequestOptions] = None,
463
+ ) -> FileWithUploadUrlsResponse:
464
+ """
465
+ Create new file under parent folder through local upload. <br><br>Rate Limits: 5 calls per 1 second(s) per account
466
+
467
+ Parameters
468
+ ----------
469
+ account_id : Uuid
470
+
471
+
472
+ folder_id : Uuid
473
+
474
+
475
+ data : FileCreateLocalUploadParamsData
476
+
477
+ request_options : typing.Optional[RequestOptions]
478
+ Request-specific configuration.
479
+
480
+ Returns
481
+ -------
482
+ FileWithUploadUrlsResponse
483
+ Created
484
+
485
+ Examples
486
+ --------
487
+ from frameio import Frameio
488
+ from frameio.files import FileCreateLocalUploadParamsData
489
+
490
+ client = Frameio(
491
+ token="YOUR_TOKEN",
492
+ )
493
+ client.files.create_local_upload(
494
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
495
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
496
+ data=FileCreateLocalUploadParamsData(
497
+ file_size=1137444,
498
+ name="asset.png",
499
+ ),
500
+ )
501
+ """
502
+ _response = self._raw_client.create_local_upload(
503
+ account_id, folder_id, data=data, request_options=request_options
504
+ )
505
+ return _response.data
506
+
507
+ def show_file_upload_status(
508
+ self, account_id: Uuid, file_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
509
+ ) -> FileUploadStatusResponse:
510
+ """
511
+ Show file upload status details. <br><br>Rate Limits: 5 calls per 1 second(s) per account
512
+
513
+ Parameters
514
+ ----------
515
+ account_id : Uuid
516
+
517
+
518
+ file_id : Uuid
519
+
520
+
521
+ request_options : typing.Optional[RequestOptions]
522
+ Request-specific configuration.
523
+
524
+ Returns
525
+ -------
526
+ FileUploadStatusResponse
527
+ OK
528
+
529
+ Examples
530
+ --------
531
+ from frameio import Frameio
532
+
533
+ client = Frameio(
534
+ token="YOUR_TOKEN",
535
+ )
536
+ client.files.show_file_upload_status(
537
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
538
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
539
+ )
540
+ """
541
+ _response = self._raw_client.show_file_upload_status(account_id, file_id, request_options=request_options)
542
+ return _response.data
543
+
544
+
545
+ class AsyncFilesClient:
546
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
547
+ self._raw_client = AsyncRawFilesClient(client_wrapper=client_wrapper)
548
+
549
+ @property
550
+ def with_raw_response(self) -> AsyncRawFilesClient:
551
+ """
552
+ Retrieves a raw implementation of this client that returns raw responses.
553
+
554
+ Returns
555
+ -------
556
+ AsyncRawFilesClient
557
+ """
558
+ return self._raw_client
559
+
560
+ async def list(
561
+ self,
562
+ account_id: Uuid,
563
+ folder_id: Uuid,
564
+ *,
565
+ include: typing.Optional[FileWithMediaLinksInclude] = None,
566
+ after: typing.Optional[RequestAfterOpaqueCursor] = None,
567
+ page_size: typing.Optional[RequestPageSize] = None,
568
+ include_total_count: typing.Optional[IncludeTotalCount] = None,
569
+ request_options: typing.Optional[RequestOptions] = None,
570
+ ) -> AssetsWithIncludesResponse:
571
+ """
572
+ List files in a given folder. <br><br>Rate Limits: 5 calls per 1 second(s) per account
573
+
574
+ Parameters
575
+ ----------
576
+ account_id : Uuid
577
+
578
+
579
+ folder_id : Uuid
580
+
581
+
582
+ include : typing.Optional[FileWithMediaLinksInclude]
583
+
584
+
585
+ after : typing.Optional[RequestAfterOpaqueCursor]
586
+ Opaque Cursor query param for requests returning paginated results.
587
+ <br/>
588
+ NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
589
+
590
+ page_size : typing.Optional[RequestPageSize]
591
+
592
+
593
+ include_total_count : typing.Optional[IncludeTotalCount]
594
+
595
+
596
+ request_options : typing.Optional[RequestOptions]
597
+ Request-specific configuration.
598
+
599
+ Returns
600
+ -------
601
+ AssetsWithIncludesResponse
602
+ OK
603
+
604
+ Examples
605
+ --------
606
+ import asyncio
607
+
608
+ from frameio import AsyncFrameio
609
+
610
+ client = AsyncFrameio(
611
+ token="YOUR_TOKEN",
612
+ )
613
+
614
+
615
+ async def main() -> None:
616
+ await client.files.list(
617
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
618
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
619
+ include="media_links",
620
+ after="<opaque_cursor>",
621
+ page_size=10,
622
+ include_total_count=False,
623
+ )
624
+
625
+
626
+ asyncio.run(main())
627
+ """
628
+ _response = await self._raw_client.list(
629
+ account_id,
630
+ folder_id,
631
+ include=include,
632
+ after=after,
633
+ page_size=page_size,
634
+ include_total_count=include_total_count,
635
+ request_options=request_options,
636
+ )
637
+ return _response.data
638
+
639
+ async def create(
640
+ self,
641
+ account_id: Uuid,
642
+ folder_id: Uuid,
643
+ *,
644
+ data: FileCreateParamsData,
645
+ request_options: typing.Optional[RequestOptions] = None,
646
+ ) -> FileWithUploadUrlsResponse:
647
+ """
648
+ Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br><br>Rate Limits: 5 calls per 1 second(s) per account
649
+
650
+ Parameters
651
+ ----------
652
+ account_id : Uuid
653
+
654
+
655
+ folder_id : Uuid
656
+
657
+
658
+ data : FileCreateParamsData
659
+
660
+ request_options : typing.Optional[RequestOptions]
661
+ Request-specific configuration.
662
+
663
+ Returns
664
+ -------
665
+ FileWithUploadUrlsResponse
666
+ Created
667
+
668
+ Examples
669
+ --------
670
+ import asyncio
671
+
672
+ from frameio import AsyncFrameio
673
+ from frameio.files import FileCreateParamsData
674
+
675
+ client = AsyncFrameio(
676
+ token="YOUR_TOKEN",
677
+ )
678
+
679
+
680
+ async def main() -> None:
681
+ await client.files.create(
682
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
683
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
684
+ data=FileCreateParamsData(
685
+ file_size=1137444,
686
+ media_type="image/png",
687
+ name="asset.png",
688
+ ),
689
+ )
690
+
691
+
692
+ asyncio.run(main())
693
+ """
694
+ _response = await self._raw_client.create(account_id, folder_id, data=data, request_options=request_options)
695
+ return _response.data
696
+
697
+ async def show(
698
+ self,
699
+ account_id: Uuid,
700
+ file_id: Uuid,
701
+ *,
702
+ include: typing.Optional[FileWithMediaLinksInclude] = None,
703
+ request_options: typing.Optional[RequestOptions] = None,
704
+ ) -> FileWithIncludesResponse:
705
+ """
706
+ Show file details.
707
+ <br><br>
708
+ Use the `include` query parameter to selectively include additional properties in the response.
709
+ <br><br>
710
+ Note: if you include `media_links.original` and the user does not have permission to download the file
711
+ then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
712
+ watermarking is required for this user and isn't supported by the requested media_links, then the request will
713
+ succeed but the unsupported media links will be set to null.
714
+ Similarly, if a requested transcode link does not exist for a particular file (e.g. including
715
+ `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
716
+ (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
717
+ the response payload. In short, the client must handle null media links gracefully.
718
+ <br><br>Rate Limits: 5 calls per 1 second(s) per account
719
+
720
+ Parameters
721
+ ----------
722
+ account_id : Uuid
723
+
724
+
725
+ file_id : Uuid
726
+
727
+
728
+ include : typing.Optional[FileWithMediaLinksInclude]
729
+
730
+
731
+ request_options : typing.Optional[RequestOptions]
732
+ Request-specific configuration.
733
+
734
+ Returns
735
+ -------
736
+ FileWithIncludesResponse
737
+ OK
738
+
739
+ Examples
740
+ --------
741
+ import asyncio
742
+
743
+ from frameio import AsyncFrameio
744
+
745
+ client = AsyncFrameio(
746
+ token="YOUR_TOKEN",
747
+ )
748
+
749
+
750
+ async def main() -> None:
751
+ await client.files.show(
752
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
753
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
754
+ include="media_links",
755
+ )
756
+
757
+
758
+ asyncio.run(main())
759
+ """
760
+ _response = await self._raw_client.show(account_id, file_id, include=include, request_options=request_options)
761
+ return _response.data
762
+
763
+ async def delete(
764
+ self, account_id: Uuid, file_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
765
+ ) -> None:
766
+ """
767
+ Delete file by ID. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
768
+
769
+ Parameters
770
+ ----------
771
+ account_id : Uuid
772
+
773
+
774
+ file_id : Uuid
775
+
776
+
777
+ request_options : typing.Optional[RequestOptions]
778
+ Request-specific configuration.
779
+
780
+ Returns
781
+ -------
782
+ None
783
+
784
+ Examples
785
+ --------
786
+ import asyncio
787
+
788
+ from frameio import AsyncFrameio
789
+
790
+ client = AsyncFrameio(
791
+ token="YOUR_TOKEN",
792
+ )
793
+
794
+
795
+ async def main() -> None:
796
+ await client.files.delete(
797
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
798
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
799
+ )
800
+
801
+
802
+ asyncio.run(main())
803
+ """
804
+ _response = await self._raw_client.delete(account_id, file_id, request_options=request_options)
805
+ return _response.data
806
+
807
+ async def update(
808
+ self,
809
+ account_id: Uuid,
810
+ file_id: Uuid,
811
+ *,
812
+ data: FileUpdateParamsData,
813
+ request_options: typing.Optional[RequestOptions] = None,
814
+ ) -> FileResponse:
815
+ """
816
+ Update file details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
817
+
818
+ Parameters
819
+ ----------
820
+ account_id : Uuid
821
+
822
+
823
+ file_id : Uuid
824
+
825
+
826
+ data : FileUpdateParamsData
827
+
828
+ request_options : typing.Optional[RequestOptions]
829
+ Request-specific configuration.
830
+
831
+ Returns
832
+ -------
833
+ FileResponse
834
+ OK
835
+
836
+ Examples
837
+ --------
838
+ import asyncio
839
+
840
+ from frameio import AsyncFrameio
841
+ from frameio.files import FileUpdateParamsData
842
+
843
+ client = AsyncFrameio(
844
+ token="YOUR_TOKEN",
845
+ )
846
+
847
+
848
+ async def main() -> None:
849
+ await client.files.update(
850
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
851
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
852
+ data=FileUpdateParamsData(
853
+ name="asset.png",
854
+ ),
855
+ )
856
+
857
+
858
+ asyncio.run(main())
859
+ """
860
+ _response = await self._raw_client.update(account_id, file_id, data=data, request_options=request_options)
861
+ return _response.data
862
+
863
+ async def copy(
864
+ self,
865
+ account_id: Uuid,
866
+ file_id: Uuid,
867
+ *,
868
+ data: typing.Optional[FileCopyParamsData] = OMIT,
869
+ request_options: typing.Optional[RequestOptions] = None,
870
+ ) -> FileCopyResponse:
871
+ """
872
+ Copy file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
873
+
874
+ Parameters
875
+ ----------
876
+ account_id : Uuid
877
+
878
+
879
+ file_id : Uuid
880
+
881
+
882
+ data : typing.Optional[FileCopyParamsData]
883
+
884
+ request_options : typing.Optional[RequestOptions]
885
+ Request-specific configuration.
886
+
887
+ Returns
888
+ -------
889
+ FileCopyResponse
890
+ OK
891
+
892
+ Examples
893
+ --------
894
+ import asyncio
895
+
896
+ from frameio import AsyncFrameio
897
+ from frameio.files import FileCopyParamsData
898
+
899
+ client = AsyncFrameio(
900
+ token="YOUR_TOKEN",
901
+ )
902
+
903
+
904
+ async def main() -> None:
905
+ await client.files.copy(
906
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
907
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
908
+ data=FileCopyParamsData(
909
+ parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
910
+ ),
911
+ )
912
+
913
+
914
+ asyncio.run(main())
915
+ """
916
+ _response = await self._raw_client.copy(account_id, file_id, data=data, request_options=request_options)
917
+ return _response.data
918
+
919
+ async def create_remote_upload(
920
+ self,
921
+ account_id: Uuid,
922
+ folder_id: Uuid,
923
+ *,
924
+ data: FileCreateRemoteUploadParamsData,
925
+ request_options: typing.Optional[RequestOptions] = None,
926
+ ) -> FileRemoteUploadResponse:
927
+ """
928
+ Create new file under parent folder through remote upload. <br><br>Rate Limits: 5 calls per 1 second(s) per account
929
+
930
+ Parameters
931
+ ----------
932
+ account_id : Uuid
933
+
934
+
935
+ folder_id : Uuid
936
+
937
+
938
+ data : FileCreateRemoteUploadParamsData
939
+
940
+ request_options : typing.Optional[RequestOptions]
941
+ Request-specific configuration.
942
+
943
+ Returns
944
+ -------
945
+ FileRemoteUploadResponse
946
+ Accepted
947
+
948
+ Examples
949
+ --------
950
+ import asyncio
951
+
952
+ from frameio import AsyncFrameio
953
+ from frameio.files import FileCreateRemoteUploadParamsData
954
+
955
+ client = AsyncFrameio(
956
+ token="YOUR_TOKEN",
957
+ )
958
+
959
+
960
+ async def main() -> None:
961
+ await client.files.create_remote_upload(
962
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
963
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
964
+ data=FileCreateRemoteUploadParamsData(
965
+ name="asset.png",
966
+ source_url="https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
967
+ ),
968
+ )
969
+
970
+
971
+ asyncio.run(main())
972
+ """
973
+ _response = await self._raw_client.create_remote_upload(
974
+ account_id, folder_id, data=data, request_options=request_options
975
+ )
976
+ return _response.data
977
+
978
+ async def move(
979
+ self,
980
+ account_id: Uuid,
981
+ file_id: Uuid,
982
+ *,
983
+ data: FileMoveParamsData,
984
+ request_options: typing.Optional[RequestOptions] = None,
985
+ ) -> FileResponse:
986
+ """
987
+ Move file to a folder or version_stack. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
988
+
989
+ Parameters
990
+ ----------
991
+ account_id : Uuid
992
+
993
+
994
+ file_id : Uuid
995
+
996
+
997
+ data : FileMoveParamsData
998
+
999
+ request_options : typing.Optional[RequestOptions]
1000
+ Request-specific configuration.
1001
+
1002
+ Returns
1003
+ -------
1004
+ FileResponse
1005
+ OK
1006
+
1007
+ Examples
1008
+ --------
1009
+ import asyncio
1010
+
1011
+ from frameio import AsyncFrameio
1012
+ from frameio.files import FileMoveParamsData
1013
+
1014
+ client = AsyncFrameio(
1015
+ token="YOUR_TOKEN",
1016
+ )
1017
+
1018
+
1019
+ async def main() -> None:
1020
+ await client.files.move(
1021
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
1022
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
1023
+ data=FileMoveParamsData(
1024
+ parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
1025
+ ),
1026
+ )
1027
+
1028
+
1029
+ asyncio.run(main())
1030
+ """
1031
+ _response = await self._raw_client.move(account_id, file_id, data=data, request_options=request_options)
1032
+ return _response.data
1033
+
1034
+ async def create_local_upload(
1035
+ self,
1036
+ account_id: Uuid,
1037
+ folder_id: Uuid,
1038
+ *,
1039
+ data: FileCreateLocalUploadParamsData,
1040
+ request_options: typing.Optional[RequestOptions] = None,
1041
+ ) -> FileWithUploadUrlsResponse:
1042
+ """
1043
+ Create new file under parent folder through local upload. <br><br>Rate Limits: 5 calls per 1 second(s) per account
1044
+
1045
+ Parameters
1046
+ ----------
1047
+ account_id : Uuid
1048
+
1049
+
1050
+ folder_id : Uuid
1051
+
1052
+
1053
+ data : FileCreateLocalUploadParamsData
1054
+
1055
+ request_options : typing.Optional[RequestOptions]
1056
+ Request-specific configuration.
1057
+
1058
+ Returns
1059
+ -------
1060
+ FileWithUploadUrlsResponse
1061
+ Created
1062
+
1063
+ Examples
1064
+ --------
1065
+ import asyncio
1066
+
1067
+ from frameio import AsyncFrameio
1068
+ from frameio.files import FileCreateLocalUploadParamsData
1069
+
1070
+ client = AsyncFrameio(
1071
+ token="YOUR_TOKEN",
1072
+ )
1073
+
1074
+
1075
+ async def main() -> None:
1076
+ await client.files.create_local_upload(
1077
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
1078
+ folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
1079
+ data=FileCreateLocalUploadParamsData(
1080
+ file_size=1137444,
1081
+ name="asset.png",
1082
+ ),
1083
+ )
1084
+
1085
+
1086
+ asyncio.run(main())
1087
+ """
1088
+ _response = await self._raw_client.create_local_upload(
1089
+ account_id, folder_id, data=data, request_options=request_options
1090
+ )
1091
+ return _response.data
1092
+
1093
+ async def show_file_upload_status(
1094
+ self, account_id: Uuid, file_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
1095
+ ) -> FileUploadStatusResponse:
1096
+ """
1097
+ Show file upload status details. <br><br>Rate Limits: 5 calls per 1 second(s) per account
1098
+
1099
+ Parameters
1100
+ ----------
1101
+ account_id : Uuid
1102
+
1103
+
1104
+ file_id : Uuid
1105
+
1106
+
1107
+ request_options : typing.Optional[RequestOptions]
1108
+ Request-specific configuration.
1109
+
1110
+ Returns
1111
+ -------
1112
+ FileUploadStatusResponse
1113
+ OK
1114
+
1115
+ Examples
1116
+ --------
1117
+ import asyncio
1118
+
1119
+ from frameio import AsyncFrameio
1120
+
1121
+ client = AsyncFrameio(
1122
+ token="YOUR_TOKEN",
1123
+ )
1124
+
1125
+
1126
+ async def main() -> None:
1127
+ await client.files.show_file_upload_status(
1128
+ account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
1129
+ file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
1130
+ )
1131
+
1132
+
1133
+ asyncio.run(main())
1134
+ """
1135
+ _response = await self._raw_client.show_file_upload_status(account_id, file_id, request_options=request_options)
1136
+ return _response.data