flywheel-sdk 21.2.0__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.
- flywheel/__init__.py +784 -0
- flywheel/api/__init__.py +46 -0
- flywheel/api/acquisitions_api.py +5014 -0
- flywheel/api/analyses_api.py +3848 -0
- flywheel/api/audit_trail_api.py +568 -0
- flywheel/api/auth_api.py +121 -0
- flywheel/api/batch_api.py +630 -0
- flywheel/api/bulk_api.py +140 -0
- flywheel/api/change_log_api.py +254 -0
- flywheel/api/collections_api.py +3913 -0
- flywheel/api/config_api.py +299 -0
- flywheel/api/container_tasks_api.py +137 -0
- flywheel/api/container_type_api.py +137 -0
- flywheel/api/containers_api.py +4784 -0
- flywheel/api/custom_filters_api.py +466 -0
- flywheel/api/data_view_executions_api.py +549 -0
- flywheel/api/dataexplorer_api.py +1192 -0
- flywheel/api/devices_api.py +1071 -0
- flywheel/api/dimse_api.py +814 -0
- flywheel/api/download_api.py +261 -0
- flywheel/api/files_api.py +1868 -0
- flywheel/api/form_responses_api.py +703 -0
- flywheel/api/gears_api.py +1875 -0
- flywheel/api/groups_api.py +2829 -0
- flywheel/api/jobs_api.py +2320 -0
- flywheel/api/jupyterlab_servers_api.py +245 -0
- flywheel/api/modalities_api.py +562 -0
- flywheel/api/packfiles_api.py +121 -0
- flywheel/api/projects_api.py +7820 -0
- flywheel/api/protocols_api.py +757 -0
- flywheel/api/reports_api.py +1057 -0
- flywheel/api/resolve_api.py +276 -0
- flywheel/api/roles_api.py +563 -0
- flywheel/api/sessions_api.py +5296 -0
- flywheel/api/site_api.py +1552 -0
- flywheel/api/staffing_pools_api.py +677 -0
- flywheel/api/subjects_api.py +5349 -0
- flywheel/api/tasks_api.py +897 -0
- flywheel/api/tree_api.py +266 -0
- flywheel/api/uids_api.py +140 -0
- flywheel/api/upload_api.py +842 -0
- flywheel/api/users_api.py +2142 -0
- flywheel/api/views_api.py +1089 -0
- flywheel/api_client.py +748 -0
- flywheel/client.py +291 -0
- flywheel/configuration.py +308 -0
- flywheel/drone_login.py +65 -0
- flywheel/file_spec.py +67 -0
- flywheel/finder.py +168 -0
- flywheel/flywheel.py +9867 -0
- flywheel/gear_context.py +374 -0
- flywheel/models/__init__.py +726 -0
- flywheel/models/access_level.py +30 -0
- flywheel/models/access_permission.py +197 -0
- flywheel/models/access_permission_output.py +192 -0
- flywheel/models/access_permission_update.py +166 -0
- flywheel/models/access_type.py +54 -0
- flywheel/models/accumulator.py +33 -0
- flywheel/models/acquisition.py +25 -0
- flywheel/models/acquisition_container_output.py +34 -0
- flywheel/models/acquisition_copy_input.py +223 -0
- flywheel/models/acquisition_input.py +297 -0
- flywheel/models/acquisition_list_output.py +767 -0
- flywheel/models/acquisition_modify_input.py +299 -0
- flywheel/models/acquisition_node.py +35 -0
- flywheel/models/acquisition_output.py +767 -0
- flywheel/models/acquisition_parents.py +241 -0
- flywheel/models/acquisition_template_options.py +275 -0
- flywheel/models/acquisition_upsert_input.py +383 -0
- flywheel/models/acquisition_upsert_output.py +243 -0
- flywheel/models/action.py +91 -0
- flywheel/models/adhoc_analysis_input.py +247 -0
- flywheel/models/analysis.py +25 -0
- flywheel/models/analysis_container_output.py +34 -0
- flywheel/models/analysis_files_create_ticket_output.py +241 -0
- flywheel/models/analysis_input.py +310 -0
- flywheel/models/analysis_input_legacy.py +25 -0
- flywheel/models/analysis_list_output.py +680 -0
- flywheel/models/analysis_list_output_inflated_job.py +650 -0
- flywheel/models/analysis_modify_input.py +191 -0
- flywheel/models/analysis_node.py +35 -0
- flywheel/models/analysis_output.py +683 -0
- flywheel/models/analysis_output_inflated_job.py +674 -0
- flywheel/models/analysis_parents.py +270 -0
- flywheel/models/analysis_update.py +25 -0
- flywheel/models/api_key_input_with_optional_label.py +191 -0
- flywheel/models/api_key_output.py +297 -0
- flywheel/models/as_storage.py +298 -0
- flywheel/models/assignee.py +192 -0
- flywheel/models/assignee_type.py +29 -0
- flywheel/models/audit_trail_report.py +486 -0
- flywheel/models/audit_trail_report_status.py +32 -0
- flywheel/models/auth0_auth_out.py +323 -0
- flywheel/models/auth0_options_out.py +319 -0
- flywheel/models/auth_out.py +357 -0
- flywheel/models/auth_session_output.py +272 -0
- flywheel/models/avatars.py +218 -0
- flywheel/models/aws_creds.py +191 -0
- flywheel/models/aws_storage.py +354 -0
- flywheel/models/azure_creds.py +190 -0
- flywheel/models/base_aet.py +245 -0
- flywheel/models/base_compute.py +426 -0
- flywheel/models/batch.py +360 -0
- flywheel/models/batch_cancel_output.py +36 -0
- flywheel/models/batch_create_filters.py +220 -0
- flywheel/models/batch_job_analysis_input.py +281 -0
- flywheel/models/batch_jobs_proposal_input.py +36 -0
- flywheel/models/batch_proposal.py +25 -0
- flywheel/models/batch_proposal_detail.py +36 -0
- flywheel/models/batch_proposal_input.py +25 -0
- flywheel/models/body.py +36 -0
- flywheel/models/body_regenerate_key_api_devices_device_id_key_post.py +25 -0
- flywheel/models/body_region.py +46 -0
- flywheel/models/bookmark.py +189 -0
- flywheel/models/bulk_move_input.py +272 -0
- flywheel/models/bulk_move_sessions.py +25 -0
- flywheel/models/callbacks_virus_scan_input.py +36 -0
- flywheel/models/cancelled_batch_output.py +163 -0
- flywheel/models/catalog_list_output.py +407 -0
- flywheel/models/central_out.py +299 -0
- flywheel/models/change.py +379 -0
- flywheel/models/change_log_container_type.py +38 -0
- flywheel/models/change_log_document.py +245 -0
- flywheel/models/change_method.py +33 -0
- flywheel/models/classic_batch_job_output.py +352 -0
- flywheel/models/classic_batch_job_output_inflated_jobs.py +379 -0
- flywheel/models/classic_batch_proposal_input.py +388 -0
- flywheel/models/classic_batch_proposal_output.py +471 -0
- flywheel/models/classification_add_delete.py +36 -0
- flywheel/models/classification_replace.py +36 -0
- flywheel/models/classification_update_input.py +36 -0
- flywheel/models/cohort.py +29 -0
- flywheel/models/collection.py +25 -0
- flywheel/models/collection_container_output.py +32 -0
- flywheel/models/collection_input.py +217 -0
- flywheel/models/collection_input_with_contents.py +248 -0
- flywheel/models/collection_node.py +192 -0
- flywheel/models/collection_node_level.py +31 -0
- flywheel/models/collection_operation.py +193 -0
- flywheel/models/collection_operation_type.py +29 -0
- flywheel/models/collection_output.py +639 -0
- flywheel/models/collection_with_stats.py +637 -0
- flywheel/models/column.py +286 -0
- flywheel/models/column_type.py +32 -0
- flywheel/models/common_classification.py +135 -0
- flywheel/models/common_deleted_count.py +25 -0
- flywheel/models/common_editions.py +25 -0
- flywheel/models/common_info.py +135 -0
- flywheel/models/common_join_origins.py +25 -0
- flywheel/models/common_key.py +36 -0
- flywheel/models/common_modified_count.py +25 -0
- flywheel/models/common_object_created.py +36 -0
- flywheel/models/common_project_settings.py +25 -0
- flywheel/models/common_settings.py +36 -0
- flywheel/models/complete_multipart_upload_output.py +189 -0
- flywheel/models/complete_s3_multipart_upload_input.py +241 -0
- flywheel/models/config_feature_map.py +36 -0
- flywheel/models/config_out.py +381 -0
- flywheel/models/config_output.py +36 -0
- flywheel/models/config_site_config_output.py +36 -0
- flywheel/models/config_site_settings.py +36 -0
- flywheel/models/config_site_settings_input.py +36 -0
- flywheel/models/conflict_types.py +30 -0
- flywheel/models/container_delete_reason.py +39 -0
- flywheel/models/container_filter.py +193 -0
- flywheel/models/container_id_view_input.py +521 -0
- flywheel/models/container_id_view_input_execute_and_save.py +308 -0
- flywheel/models/container_modify.py +536 -0
- flywheel/models/container_new_output.py +25 -0
- flywheel/models/container_node_min.py +350 -0
- flywheel/models/container_output.py +36 -0
- flywheel/models/container_output_with_files.py +283 -0
- flywheel/models/container_parents.py +311 -0
- flywheel/models/container_pipeline_input.py +536 -0
- flywheel/models/container_project_parents.py +25 -0
- flywheel/models/container_reference.py +193 -0
- flywheel/models/container_reference_with_label.py +219 -0
- flywheel/models/container_session_parents.py +25 -0
- flywheel/models/container_subject_parents.py +25 -0
- flywheel/models/container_type.py +39 -0
- flywheel/models/container_uidcheck.py +253 -0
- flywheel/models/container_update.py +135 -0
- flywheel/models/context_input.py +217 -0
- flywheel/models/copy_filter.py +299 -0
- flywheel/models/copy_status.py +32 -0
- flywheel/models/core_models_api_key_api_key_input.py +190 -0
- flywheel/models/core_models_audit_trail_create_report_input.py +273 -0
- flywheel/models/core_models_audit_trail_modify_report_input.py +167 -0
- flywheel/models/core_models_common_source.py +189 -0
- flywheel/models/core_models_jobs_api_key_input.py +191 -0
- flywheel/models/core_models_search_parent_type.py +33 -0
- flywheel/models/core_workflows_form_responses_models_form_parents.py +163 -0
- flywheel/models/core_workflows_form_responses_models_form_response_output.py +440 -0
- flywheel/models/core_workflows_reader_models_reader_task_parents.py +295 -0
- flywheel/models/creds.py +135 -0
- flywheel/models/curator.py +221 -0
- flywheel/models/current_user_output.py +707 -0
- flywheel/models/custom_field.py +437 -0
- flywheel/models/custom_form.py +244 -0
- flywheel/models/cvat_info.py +275 -0
- flywheel/models/cvat_settings.py +272 -0
- flywheel/models/cvat_settings_input.py +272 -0
- flywheel/models/cvat_sync_state.py +30 -0
- flywheel/models/daily_report_usage.py +565 -0
- flywheel/models/data_strategy.py +29 -0
- flywheel/models/data_view.py +25 -0
- flywheel/models/data_view_analysis_file_spec.py +221 -0
- flywheel/models/data_view_analysis_filter_spec.py +221 -0
- flywheel/models/data_view_column_alias.py +337 -0
- flywheel/models/data_view_column_spec.py +286 -0
- flywheel/models/data_view_execution.py +505 -0
- flywheel/models/data_view_execution_state.py +31 -0
- flywheel/models/data_view_file_spec.py +392 -0
- flywheel/models/data_view_group_by.py +166 -0
- flywheel/models/data_view_group_by_column.py +194 -0
- flywheel/models/data_view_name_filter_spec.py +194 -0
- flywheel/models/data_view_output.py +25 -0
- flywheel/models/data_view_save_data_view_input.py +25 -0
- flywheel/models/data_view_zip_filter_spec.py +223 -0
- flywheel/models/default_flywheel_role.py +30 -0
- flywheel/models/deid_log_skip_reason.py +29 -0
- flywheel/models/delete_by_search_query.py +253 -0
- flywheel/models/deleted_file.py +514 -0
- flywheel/models/deleted_result.py +194 -0
- flywheel/models/deprecated_action.py +29 -0
- flywheel/models/destination_container_type.py +30 -0
- flywheel/models/device.py +437 -0
- flywheel/models/device_admin_update.py +194 -0
- flywheel/models/device_create.py +219 -0
- flywheel/models/device_self_update.py +272 -0
- flywheel/models/device_status.py +36 -0
- flywheel/models/device_status_entry.py +221 -0
- flywheel/models/device_storage_strategy_update.py +193 -0
- flywheel/models/dimse_project_input.py +36 -0
- flywheel/models/dimse_project_output.py +36 -0
- flywheel/models/dimse_service_input.py +36 -0
- flywheel/models/dimse_service_output.py +36 -0
- flywheel/models/download.py +249 -0
- flywheel/models/download_container_filter.py +167 -0
- flywheel/models/download_container_filter_definition.py +222 -0
- flywheel/models/download_filter.py +221 -0
- flywheel/models/download_filter_definition.py +195 -0
- flywheel/models/download_format.py +29 -0
- flywheel/models/download_input.py +25 -0
- flywheel/models/download_node.py +189 -0
- flywheel/models/download_strategy.py +31 -0
- flywheel/models/download_ticket.py +36 -0
- flywheel/models/download_ticket_stub.py +249 -0
- flywheel/models/download_ticket_with_summary.py +36 -0
- flywheel/models/e_signature.py +242 -0
- flywheel/models/edition.py +169 -0
- flywheel/models/egress_device.py +597 -0
- flywheel/models/egress_device_page.py +219 -0
- flywheel/models/egress_provider.py +408 -0
- flywheel/models/egress_provider_id.py +164 -0
- flywheel/models/exchange_storage.py +243 -0
- flywheel/models/executor_info.py +353 -0
- flywheel/models/export_templates.py +195 -0
- flywheel/models/features.py +1838 -0
- flywheel/models/field_change.py +271 -0
- flywheel/models/field_change_log_document.py +245 -0
- flywheel/models/field_type.py +37 -0
- flywheel/models/file.py +1139 -0
- flywheel/models/file_classification_delta.py +245 -0
- flywheel/models/file_container_type.py +34 -0
- flywheel/models/file_entry.py +740 -0
- flywheel/models/file_export_templates.py +272 -0
- flywheel/models/file_format.py +33 -0
- flywheel/models/file_gear_info.py +215 -0
- flywheel/models/file_group.py +29 -0
- flywheel/models/file_list_output.py +1115 -0
- flywheel/models/file_modify_input.py +191 -0
- flywheel/models/file_move_input.py +221 -0
- flywheel/models/file_node.py +1138 -0
- flywheel/models/file_node_min.py +321 -0
- flywheel/models/file_origin.py +283 -0
- flywheel/models/file_output.py +1135 -0
- flywheel/models/file_parents.py +297 -0
- flywheel/models/file_reference.py +221 -0
- flywheel/models/file_suggestion.py +241 -0
- flywheel/models/file_template_options.py +299 -0
- flywheel/models/file_upsert_input.py +612 -0
- flywheel/models/file_upsert_origin.py +36 -0
- flywheel/models/file_upsert_output.py +1154 -0
- flywheel/models/file_version.py +190 -0
- flywheel/models/file_version_copy_of.py +273 -0
- flywheel/models/file_version_output.py +325 -0
- flywheel/models/file_via.py +245 -0
- flywheel/models/file_zip_entry.py +25 -0
- flywheel/models/file_zip_info.py +25 -0
- flywheel/models/filter.py +350 -0
- flywheel/models/filter_input.py +218 -0
- flywheel/models/filter_values.py +195 -0
- flywheel/models/filter_view.py +28 -0
- flywheel/models/fixed_file_version_input.py +216 -0
- flywheel/models/fixed_input.py +299 -0
- flywheel/models/form_definition.py +163 -0
- flywheel/models/form_response_base.py +311 -0
- flywheel/models/form_response_create.py +193 -0
- flywheel/models/gcp_creds.py +397 -0
- flywheel/models/gcp_storage.py +298 -0
- flywheel/models/gear.py +619 -0
- flywheel/models/gear_category.py +32 -0
- flywheel/models/gear_config.py +138 -0
- flywheel/models/gear_context_input.py +164 -0
- flywheel/models/gear_context_lookup.py +25 -0
- flywheel/models/gear_context_lookup_item.py +36 -0
- flywheel/models/gear_context_value_output.py +272 -0
- flywheel/models/gear_context_value_output_unfound.py +164 -0
- flywheel/models/gear_custom.py +135 -0
- flywheel/models/gear_directive.py +135 -0
- flywheel/models/gear_doc.py +25 -0
- flywheel/models/gear_document.py +332 -0
- flywheel/models/gear_document_input.py +303 -0
- flywheel/models/gear_document_legacy_input.py +302 -0
- flywheel/models/gear_environment.py +135 -0
- flywheel/models/gear_exchange.py +221 -0
- flywheel/models/gear_file_input.py +192 -0
- flywheel/models/gear_id_output.py +170 -0
- flywheel/models/gear_info.py +251 -0
- flywheel/models/gear_input_item.py +231 -0
- flywheel/models/gear_inputs.py +140 -0
- flywheel/models/gear_invocation.py +138 -0
- flywheel/models/gear_key_input.py +191 -0
- flywheel/models/gear_manifest.py +624 -0
- flywheel/models/gear_mixin.py +218 -0
- flywheel/models/gear_node.py +355 -0
- flywheel/models/gear_output_configuration.py +164 -0
- flywheel/models/gear_permissions.py +191 -0
- flywheel/models/gear_permissions_input.py +163 -0
- flywheel/models/gear_permissions_type.py +29 -0
- flywheel/models/gear_return_ticket.py +25 -0
- flywheel/models/gear_rule.py +653 -0
- flywheel/models/gear_rule_condition.py +219 -0
- flywheel/models/gear_rule_condition_type.py +37 -0
- flywheel/models/gear_rule_input.py +517 -0
- flywheel/models/gear_rule_modify_input.py +492 -0
- flywheel/models/gear_rule_output.py +652 -0
- flywheel/models/gear_save_submission.py +221 -0
- flywheel/models/gear_series.py +298 -0
- flywheel/models/gear_series_update.py +163 -0
- flywheel/models/gear_suggestion_output.py +301 -0
- flywheel/models/gear_ticket.py +245 -0
- flywheel/models/gear_ticket_output.py +163 -0
- flywheel/models/google_auth_out.py +299 -0
- flywheel/models/graph_filter.py +329 -0
- flywheel/models/group.py +25 -0
- flywheel/models/group_by.py +163 -0
- flywheel/models/group_by_column.py +36 -0
- flywheel/models/group_container_output.py +33 -0
- flywheel/models/group_input.py +248 -0
- flywheel/models/group_metadata_input.py +36 -0
- flywheel/models/group_node.py +34 -0
- flywheel/models/group_output.py +471 -0
- flywheel/models/group_report.py +218 -0
- flywheel/models/group_role.py +163 -0
- flywheel/models/group_settings_output.py +249 -0
- flywheel/models/group_update.py +249 -0
- flywheel/models/header_feature.py +37 -0
- flywheel/models/hierarchy_export_templates.py +272 -0
- flywheel/models/http_validation_error.py +167 -0
- flywheel/models/info.py +218 -0
- flywheel/models/info_add_remove.py +36 -0
- flywheel/models/info_container_type.py +35 -0
- flywheel/models/info_replace.py +36 -0
- flywheel/models/info_update_input.py +36 -0
- flywheel/models/ingress_provider.py +299 -0
- flywheel/models/ingress_providers.py +272 -0
- flywheel/models/ingress_site_settings.py +305 -0
- flywheel/models/ingress_update_provider.py +218 -0
- flywheel/models/inline_response200.py +163 -0
- flywheel/models/inline_response2001.py +171 -0
- flywheel/models/inline_response2002.py +163 -0
- flywheel/models/inline_response2003.py +36 -0
- flywheel/models/inline_response2005.py +25 -0
- flywheel/models/input_filter.py +221 -0
- flywheel/models/input_job.py +521 -0
- flywheel/models/input_job_profile.py +275 -0
- flywheel/models/inserted_id.py +163 -0
- flywheel/models/job.py +841 -0
- flywheel/models/job_analysis_input.py +273 -0
- flywheel/models/job_ask.py +301 -0
- flywheel/models/job_ask_response.py +195 -0
- flywheel/models/job_ask_response_job.py +978 -0
- flywheel/models/job_ask_return.py +25 -0
- flywheel/models/job_ask_return_criteria.py +245 -0
- flywheel/models/job_ask_state.py +25 -0
- flywheel/models/job_ask_state_response.py +163 -0
- flywheel/models/job_complete.py +220 -0
- flywheel/models/job_completion_input.py +25 -0
- flywheel/models/job_completion_ticket.py +25 -0
- flywheel/models/job_config.py +135 -0
- flywheel/models/job_config_input.py +272 -0
- flywheel/models/job_config_inputs.py +25 -0
- flywheel/models/job_config_output.py +25 -0
- flywheel/models/job_container_detail.py +25 -0
- flywheel/models/job_destination.py +189 -0
- flywheel/models/job_detail.py +925 -0
- flywheel/models/job_detail_container.py +190 -0
- flywheel/models/job_detail_file_entry.py +194 -0
- flywheel/models/job_detail_group.py +190 -0
- flywheel/models/job_detail_parent_info.py +303 -0
- flywheel/models/job_executor_info.py +369 -0
- flywheel/models/job_file_input.py +247 -0
- flywheel/models/job_file_input_list_output.py +247 -0
- flywheel/models/job_file_object.py +435 -0
- flywheel/models/job_file_object_list_output.py +407 -0
- flywheel/models/job_gear_match.py +25 -0
- flywheel/models/job_inputs_array_item.py +305 -0
- flywheel/models/job_inputs_item.py +242 -0
- flywheel/models/job_inputs_object.py +138 -0
- flywheel/models/job_list_entry.py +25 -0
- flywheel/models/job_list_output.py +979 -0
- flywheel/models/job_list_output_config.py +220 -0
- flywheel/models/job_log.py +189 -0
- flywheel/models/job_log_column.py +40 -0
- flywheel/models/job_log_record.py +192 -0
- flywheel/models/job_modify.py +193 -0
- flywheel/models/job_origin.py +190 -0
- flywheel/models/job_output.py +1005 -0
- flywheel/models/job_output_config.py +247 -0
- flywheel/models/job_parents.py +297 -0
- flywheel/models/job_priority.py +31 -0
- flywheel/models/job_priority_update.py +192 -0
- flywheel/models/job_profile.py +427 -0
- flywheel/models/job_profile_input.py +25 -0
- flywheel/models/job_request.py +221 -0
- flywheel/models/job_request_item.py +246 -0
- flywheel/models/job_request_item_type.py +31 -0
- flywheel/models/job_request_target.py +270 -0
- flywheel/models/job_state.py +32 -0
- flywheel/models/job_state_counts.py +25 -0
- flywheel/models/job_stats_by_state.py +25 -0
- flywheel/models/job_ticket_output.py +165 -0
- flywheel/models/job_transition_times.py +253 -0
- flywheel/models/job_version_info.py +135 -0
- flywheel/models/jobs_by_state.py +272 -0
- flywheel/models/jobs_list.py +166 -0
- flywheel/models/join_origin_device.py +164 -0
- flywheel/models/join_origin_job.py +219 -0
- flywheel/models/join_origin_user.py +189 -0
- flywheel/models/join_origins.py +223 -0
- flywheel/models/join_type.py +28 -0
- flywheel/models/jupyterhub_workspace.py +163 -0
- flywheel/models/jupyterlab_server_modify.py +275 -0
- flywheel/models/jupyterlab_server_origin.py +25 -0
- flywheel/models/jupyterlab_server_output.py +25 -0
- flywheel/models/jupyterlab_server_response.py +415 -0
- flywheel/models/jupyterlab_server_update.py +25 -0
- flywheel/models/ldap_sync.py +36 -0
- flywheel/models/ldap_sync_config.py +163 -0
- flywheel/models/ldap_sync_input.py +36 -0
- flywheel/models/ldap_sync_status.py +250 -0
- flywheel/models/legacy_api_key_output.py +271 -0
- flywheel/models/legacy_input.py +244 -0
- flywheel/models/legacy_usage_report.py +309 -0
- flywheel/models/legacys_usage_project_entry.py +194 -0
- flywheel/models/libs_workflows_models_parent_type.py +33 -0
- flywheel/models/libs_workflows_models_task_status.py +32 -0
- flywheel/models/local_storage.py +217 -0
- flywheel/models/location.py +189 -0
- flywheel/models/locked.py +219 -0
- flywheel/models/master_subject_code_dob_input.py +279 -0
- flywheel/models/master_subject_code_input.py +281 -0
- flywheel/models/master_subject_code_output.py +166 -0
- flywheel/models/matched_acquisition_output.py +518 -0
- flywheel/models/mfa_channel.py +30 -0
- flywheel/models/mfa_settings.py +167 -0
- flywheel/models/mixins.py +794 -0
- flywheel/models/ml_set_filter.py +194 -0
- flywheel/models/ml_type.py +30 -0
- flywheel/models/modality.py +250 -0
- flywheel/models/modality_input.py +244 -0
- flywheel/models/modality_modify.py +218 -0
- flywheel/models/modality_output.py +271 -0
- flywheel/models/modified_result.py +190 -0
- flywheel/models/modify_user_input.py +466 -0
- flywheel/models/move_conflict.py +300 -0
- flywheel/models/note.py +391 -0
- flywheel/models/note_input.py +165 -0
- flywheel/models/optional_input_policy.py +30 -0
- flywheel/models/order.py +29 -0
- flywheel/models/organ_system.py +64 -0
- flywheel/models/origin.py +193 -0
- flywheel/models/origin_type.py +35 -0
- flywheel/models/orphaned_count.py +163 -0
- flywheel/models/output_user_page.py +219 -0
- flywheel/models/packfile_cleanup_output.py +166 -0
- flywheel/models/packfile_removed_output.py +189 -0
- flywheel/models/page.py +216 -0
- flywheel/models/page_generic_file_output.py +219 -0
- flywheel/models/page_generic_filter.py +219 -0
- flywheel/models/page_generic_form_response_output.py +219 -0
- flywheel/models/page_generic_protocol.py +244 -0
- flywheel/models/page_generic_reader_task_output.py +244 -0
- flywheel/models/page_generic_staffing_pool.py +244 -0
- flywheel/models/parsed_query_response.py +194 -0
- flywheel/models/permission_access_permission.py +25 -0
- flywheel/models/premade_jobs_batch_job_output.py +298 -0
- flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +299 -0
- flywheel/models/premade_jobs_batch_proposal.py +334 -0
- flywheel/models/premade_jobs_batch_proposal_detail.py +166 -0
- flywheel/models/premade_jobs_batch_proposal_input.py +166 -0
- flywheel/models/project.py +25 -0
- flywheel/models/project_acquisition_upsert_input.py +25 -0
- flywheel/models/project_acquisition_upsert_output.py +25 -0
- flywheel/models/project_aet.py +331 -0
- flywheel/models/project_aet_input.py +248 -0
- flywheel/models/project_catalog_list_output.py +25 -0
- flywheel/models/project_contact.py +194 -0
- flywheel/models/project_container_output.py +41 -0
- flywheel/models/project_copy_input.py +245 -0
- flywheel/models/project_copy_output.py +215 -0
- flywheel/models/project_counters.py +346 -0
- flywheel/models/project_hierarchy_input.py +278 -0
- flywheel/models/project_hierarchy_output.py +222 -0
- flywheel/models/project_hierarchy_upsert_input.py +25 -0
- flywheel/models/project_hierarchy_upsert_output.py +25 -0
- flywheel/models/project_input.py +384 -0
- flywheel/models/project_institution.py +194 -0
- flywheel/models/project_list_output.py +897 -0
- flywheel/models/project_locking_reason.py +32 -0
- flywheel/models/project_modify.py +413 -0
- flywheel/models/project_node.py +42 -0
- flywheel/models/project_output.py +899 -0
- flywheel/models/project_parents.py +168 -0
- flywheel/models/project_report.py +463 -0
- flywheel/models/project_report_list.py +167 -0
- flywheel/models/project_session_upsert_input.py +25 -0
- flywheel/models/project_session_upsert_output.py +25 -0
- flywheel/models/project_settings_input.py +333 -0
- flywheel/models/project_settings_output.py +333 -0
- flywheel/models/project_settings_sharing.py +327 -0
- flywheel/models/project_settings_sharing_input.py +334 -0
- flywheel/models/project_settings_workspaces.py +167 -0
- flywheel/models/project_settings_workspaces_input.py +167 -0
- flywheel/models/project_share_level.py +29 -0
- flywheel/models/project_sharing_settings_project_contact.py +25 -0
- flywheel/models/project_sharing_settings_project_counters.py +36 -0
- flywheel/models/project_sharing_settings_project_institution.py +25 -0
- flywheel/models/project_sharing_settings_project_settings_input.py +25 -0
- flywheel/models/project_sharing_settings_project_settings_output.py +25 -0
- flywheel/models/project_sharing_settings_project_settings_sharing.py +25 -0
- flywheel/models/project_sharing_settings_project_settings_sharing_input.py +25 -0
- flywheel/models/project_sharing_settings_project_stats.py +36 -0
- flywheel/models/project_stats.py +270 -0
- flywheel/models/project_subject_upsert_input.py +25 -0
- flywheel/models/project_subject_upsert_output.py +25 -0
- flywheel/models/project_template.py +195 -0
- flywheel/models/project_template_input.py +195 -0
- flywheel/models/project_template_list_input.py +166 -0
- flywheel/models/project_template_requirement.py +36 -0
- flywheel/models/project_template_session_template.py +36 -0
- flywheel/models/project_upsert_origin.py +36 -0
- flywheel/models/protocol.py +515 -0
- flywheel/models/protocol_e_signature_config.py +191 -0
- flywheel/models/protocol_input.py +354 -0
- flywheel/models/protocol_modify.py +277 -0
- flywheel/models/protocol_status.py +30 -0
- flywheel/models/provider.py +461 -0
- flywheel/models/provider_access_type.py +29 -0
- flywheel/models/provider_class.py +29 -0
- flywheel/models/provider_deletion_status.py +189 -0
- flywheel/models/provider_input.py +25 -0
- flywheel/models/provider_links.py +282 -0
- flywheel/models/provider_type.py +34 -0
- flywheel/models/providers.py +277 -0
- flywheel/models/reader_batch_create.py +463 -0
- flywheel/models/reader_task.py +725 -0
- flywheel/models/reader_task_config.py +189 -0
- flywheel/models/reader_task_create.py +543 -0
- flywheel/models/reader_task_modify.py +303 -0
- flywheel/models/reader_task_output.py +752 -0
- flywheel/models/reader_task_parent_details.py +322 -0
- flywheel/models/report_access_log_context.py +301 -0
- flywheel/models/report_access_log_context_entry.py +194 -0
- flywheel/models/report_access_log_context_file_entry.py +165 -0
- flywheel/models/report_access_log_entry.py +624 -0
- flywheel/models/report_access_log_origin.py +194 -0
- flywheel/models/report_availability_list.py +167 -0
- flywheel/models/report_daily_usage_entry.py +501 -0
- flywheel/models/report_demographics_grid.py +36 -0
- flywheel/models/report_ethnicity_grid.py +252 -0
- flywheel/models/report_gender_count.py +222 -0
- flywheel/models/report_group_report.py +217 -0
- flywheel/models/report_legacy_usage_entry.py +36 -0
- flywheel/models/report_legacy_usage_project_entry.py +36 -0
- flywheel/models/report_project.py +25 -0
- flywheel/models/report_site.py +192 -0
- flywheel/models/report_time_period.py +193 -0
- flywheel/models/report_usage.py +630 -0
- flywheel/models/report_usage_entry.py +25 -0
- flywheel/models/resolve_input.py +163 -0
- flywheel/models/resolve_output.py +194 -0
- flywheel/models/resolver_acquisition_node.py +36 -0
- flywheel/models/resolver_analysis_node.py +36 -0
- flywheel/models/resolver_file_node.py +36 -0
- flywheel/models/resolver_gear_node.py +36 -0
- flywheel/models/resolver_group_node.py +36 -0
- flywheel/models/resolver_input.py +25 -0
- flywheel/models/resolver_node.py +182 -0
- flywheel/models/resolver_output.py +25 -0
- flywheel/models/resolver_project_node.py +36 -0
- flywheel/models/resolver_session_node.py +36 -0
- flywheel/models/resolver_subject_node.py +36 -0
- flywheel/models/role_input.py +192 -0
- flywheel/models/role_output.py +273 -0
- flywheel/models/role_permission.py +194 -0
- flywheel/models/role_permission_output.py +189 -0
- flywheel/models/role_permission_update.py +163 -0
- flywheel/models/role_type.py +32 -0
- flywheel/models/role_update.py +194 -0
- flywheel/models/roles_backwards_compatible_role_assignment.py +36 -0
- flywheel/models/roles_group_role_pool_input.py +36 -0
- flywheel/models/roles_role.py +36 -0
- flywheel/models/roles_role_assignment.py +195 -0
- flywheel/models/roles_role_input.py +36 -0
- flywheel/models/rule.py +467 -0
- flywheel/models/rule_any.py +216 -0
- flywheel/models/s3_addressing_style.py +29 -0
- flywheel/models/s3_compat_storage.py +381 -0
- flywheel/models/save_search.py +298 -0
- flywheel/models/save_search_input.py +219 -0
- flywheel/models/save_search_output.py +301 -0
- flywheel/models/save_search_page.py +219 -0
- flywheel/models/save_search_parent.py +192 -0
- flywheel/models/save_search_update.py +194 -0
- flywheel/models/search_acquisition_response.py +252 -0
- flywheel/models/search_analysis_response.py +254 -0
- flywheel/models/search_collection_response.py +254 -0
- flywheel/models/search_file_response.py +312 -0
- flywheel/models/search_group_response.py +196 -0
- flywheel/models/search_parent_acquisition.py +47 -0
- flywheel/models/search_parent_analysis.py +47 -0
- flywheel/models/search_parent_collection.py +46 -0
- flywheel/models/search_parent_project.py +54 -0
- flywheel/models/search_parent_response.py +213 -0
- flywheel/models/search_parent_session.py +48 -0
- flywheel/models/search_parent_subject.py +48 -0
- flywheel/models/search_parse_error.py +252 -0
- flywheel/models/search_parse_search_query_result.py +36 -0
- flywheel/models/search_project_response.py +196 -0
- flywheel/models/search_query.py +337 -0
- flywheel/models/search_query_suggestions.py +36 -0
- flywheel/models/search_response.py +448 -0
- flywheel/models/search_return_type.py +33 -0
- flywheel/models/search_save_search.py +36 -0
- flywheel/models/search_save_search_input.py +36 -0
- flywheel/models/search_save_search_parent.py +36 -0
- flywheel/models/search_save_search_update.py +36 -0
- flywheel/models/search_session_response.py +252 -0
- flywheel/models/search_status.py +166 -0
- flywheel/models/search_structured_search_query.py +25 -0
- flywheel/models/search_subject_response.py +225 -0
- flywheel/models/search_suggestion.py +36 -0
- flywheel/models/select_item.py +190 -0
- flywheel/models/server_state.py +303 -0
- flywheel/models/service_aet.py +301 -0
- flywheel/models/service_aet_input.py +276 -0
- flywheel/models/session.py +25 -0
- flywheel/models/session_container_output.py +35 -0
- flywheel/models/session_copy_input.py +253 -0
- flywheel/models/session_embedded_subject.py +299 -0
- flywheel/models/session_input.py +431 -0
- flywheel/models/session_list_output.py +897 -0
- flywheel/models/session_metadata_input.py +36 -0
- flywheel/models/session_modify.py +464 -0
- flywheel/models/session_node.py +36 -0
- flywheel/models/session_output.py +897 -0
- flywheel/models/session_parents.py +220 -0
- flywheel/models/session_template_options.py +221 -0
- flywheel/models/session_template_recalc_output.py +165 -0
- flywheel/models/session_upsert_input.py +464 -0
- flywheel/models/session_upsert_output.py +243 -0
- flywheel/models/sharing_filter_options.py +345 -0
- flywheel/models/signed_fs_upload_output.py +189 -0
- flywheel/models/signed_url_cleanup_input.py +189 -0
- flywheel/models/signed_url_upload_input.py +190 -0
- flywheel/models/signed_url_upload_output.py +349 -0
- flywheel/models/site.py +623 -0
- flywheel/models/site_report.py +194 -0
- flywheel/models/site_settings.py +385 -0
- flywheel/models/sort.py +192 -0
- flywheel/models/stable_api_key_input.py +25 -0
- flywheel/models/staffing_pool.py +324 -0
- flywheel/models/staffing_pool_create.py +216 -0
- flywheel/models/staffing_pool_list.py +164 -0
- flywheel/models/staffing_pool_modify.py +218 -0
- flywheel/models/state.py +32 -0
- flywheel/models/static_compute.py +218 -0
- flywheel/models/status_transitions.py +245 -0
- flywheel/models/status_type.py +31 -0
- flywheel/models/status_value.py +31 -0
- flywheel/models/storage_strategy.py +30 -0
- flywheel/models/storage_strategy_config.py +194 -0
- flywheel/models/structured_query.py +165 -0
- flywheel/models/structured_query_suggestions.py +196 -0
- flywheel/models/structured_query_value_suggestion.py +247 -0
- flywheel/models/subject.py +34 -0
- flywheel/models/subject_container_output.py +36 -0
- flywheel/models/subject_copy_input.py +223 -0
- flywheel/models/subject_input.py +627 -0
- flywheel/models/subject_modify.py +684 -0
- flywheel/models/subject_node.py +37 -0
- flywheel/models/subject_output.py +1008 -0
- flywheel/models/subject_output_for_list.py +1005 -0
- flywheel/models/subject_parents.py +194 -0
- flywheel/models/subject_role_permission.py +194 -0
- flywheel/models/subject_state.py +30 -0
- flywheel/models/subject_template_options.py +191 -0
- flywheel/models/subject_upsert_input.py +573 -0
- flywheel/models/subject_upsert_output.py +216 -0
- flywheel/models/sync_user_input.py +322 -0
- flywheel/models/tag.py +165 -0
- flywheel/models/task_assign.py +194 -0
- flywheel/models/task_facet.py +29 -0
- flywheel/models/task_parent_ref.py +245 -0
- flywheel/models/task_parent_ref_input.py +219 -0
- flywheel/models/task_priority.py +31 -0
- flywheel/models/task_submission.py +189 -0
- flywheel/models/therapeutic_area.py +60 -0
- flywheel/models/transitions.py +272 -0
- flywheel/models/tree_container_request_spec.py +281 -0
- flywheel/models/tree_graph.py +142 -0
- flywheel/models/tree_graph_connection.py +244 -0
- flywheel/models/tree_graph_connections.py +142 -0
- flywheel/models/tree_graph_node.py +166 -0
- flywheel/models/tree_request.py +25 -0
- flywheel/models/tree_response_item.py +142 -0
- flywheel/models/type_str.py +31 -0
- flywheel/models/uid_check_input_acquisitions.py +244 -0
- flywheel/models/uid_check_input_sessions.py +244 -0
- flywheel/models/uid_check_output.py +191 -0
- flywheel/models/upload_complete_s3_multipart_input.py +25 -0
- flywheel/models/upload_complete_s3_multipart_output.py +25 -0
- flywheel/models/upload_signed_fs_file_upload_output.py +36 -0
- flywheel/models/upload_signed_upload_url_input.py +36 -0
- flywheel/models/upload_signed_upload_url_output.py +36 -0
- flywheel/models/upload_ticket_output.py +215 -0
- flywheel/models/upload_token_output.py +163 -0
- flywheel/models/upsert_result.py +31 -0
- flywheel/models/user.py +760 -0
- flywheel/models/user_api_key.py +220 -0
- flywheel/models/user_input.py +461 -0
- flywheel/models/user_jobs.py +219 -0
- flywheel/models/user_jobs_output.py +25 -0
- flywheel/models/user_output.py +36 -0
- flywheel/models/user_output_id.py +163 -0
- flywheel/models/user_preferences.py +135 -0
- flywheel/models/user_wechat.py +135 -0
- flywheel/models/validation_error.py +215 -0
- flywheel/models/validation_rule.py +190 -0
- flywheel/models/version.py +363 -0
- flywheel/models/version_output.py +25 -0
- flywheel/models/view_id_output.py +164 -0
- flywheel/models/view_output.py +440 -0
- flywheel/models/viewer_app.py +381 -0
- flywheel/models/viewer_app_input.py +382 -0
- flywheel/models/viewer_app_type.py +29 -0
- flywheel/models/virus_scan.py +166 -0
- flywheel/models/virus_scan_state.py +30 -0
- flywheel/models/work_in_progress_features.py +135 -0
- flywheel/models/zipfile_info.py +192 -0
- flywheel/models/zipfile_member_info.py +241 -0
- flywheel/partial_reader.py +50 -0
- flywheel/rest.py +352 -0
- flywheel/util.py +95 -0
- flywheel/view_builder.py +449 -0
- flywheel_sdk-21.2.0.dist-info/METADATA +42 -0
- flywheel_sdk-21.2.0.dist-info/RECORD +772 -0
- flywheel_sdk-21.2.0.dist-info/WHEEL +4 -0
- flywheel_sdk-21.2.0.dist-info/licenses/LICENSE.txt +18 -0
|
@@ -0,0 +1,1868 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Flywheel
|
|
5
|
+
|
|
6
|
+
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
|
|
7
|
+
|
|
8
|
+
OpenAPI spec version: 0.0.1
|
|
9
|
+
|
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
from __future__ import absolute_import
|
|
15
|
+
|
|
16
|
+
import re # noqa: F401
|
|
17
|
+
|
|
18
|
+
# python 2 and python 3 compatibility library
|
|
19
|
+
import six
|
|
20
|
+
|
|
21
|
+
from flywheel.api_client import ApiClient
|
|
22
|
+
import flywheel.models
|
|
23
|
+
from flywheel.util import check_filename_params
|
|
24
|
+
|
|
25
|
+
# NOTE: This file is auto generated by the swagger code generator program.
|
|
26
|
+
# Do not edit the class manually.
|
|
27
|
+
|
|
28
|
+
class FilesApi(object):
|
|
29
|
+
def __init__(self, api_client=None):
|
|
30
|
+
if api_client is None:
|
|
31
|
+
api_client = ApiClient()
|
|
32
|
+
self.api_client = api_client
|
|
33
|
+
|
|
34
|
+
def add_file_tags(self, file_id, body, **kwargs): # noqa: E501
|
|
35
|
+
"""Add list of tags on a file.
|
|
36
|
+
|
|
37
|
+
Add the tags on a file to the list of tags
|
|
38
|
+
This method makes a synchronous HTTP request by default.
|
|
39
|
+
|
|
40
|
+
:param str file_id: (required)
|
|
41
|
+
:param list[str] body: (required)
|
|
42
|
+
:param bool async_: Perform the request asynchronously
|
|
43
|
+
:return: list[str]
|
|
44
|
+
"""
|
|
45
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
46
|
+
kwargs['_return_http_data_only'] = True
|
|
47
|
+
|
|
48
|
+
if kwargs.get('async_'):
|
|
49
|
+
return self.add_file_tags_with_http_info(file_id, body, **kwargs) # noqa: E501
|
|
50
|
+
else:
|
|
51
|
+
(data) = self.add_file_tags_with_http_info(file_id, body, **kwargs) # noqa: E501
|
|
52
|
+
if (
|
|
53
|
+
data
|
|
54
|
+
and hasattr(data, 'return_value')
|
|
55
|
+
and not ignore_simplified_return_value
|
|
56
|
+
):
|
|
57
|
+
return data.return_value()
|
|
58
|
+
return data
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
def add_file_tags_with_http_info(self, file_id, body, **kwargs): # noqa: E501
|
|
62
|
+
"""Add list of tags on a file.
|
|
63
|
+
|
|
64
|
+
Add the tags on a file to the list of tags
|
|
65
|
+
This method makes a synchronous HTTP request by default.
|
|
66
|
+
|
|
67
|
+
:param str file_id: (required)
|
|
68
|
+
:param list[str] body: (required)
|
|
69
|
+
:param bool async_: Perform the request asynchronously
|
|
70
|
+
:return: list[str]
|
|
71
|
+
"""
|
|
72
|
+
|
|
73
|
+
all_params = ['file_id','body',] # noqa: E501
|
|
74
|
+
all_params.append('async_')
|
|
75
|
+
all_params.append('_return_http_data_only')
|
|
76
|
+
all_params.append('_preload_content')
|
|
77
|
+
all_params.append('_request_timeout')
|
|
78
|
+
all_params.append('_request_out')
|
|
79
|
+
|
|
80
|
+
params = locals()
|
|
81
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
82
|
+
if key not in all_params:
|
|
83
|
+
raise TypeError(
|
|
84
|
+
"Got an unexpected keyword argument '%s'"
|
|
85
|
+
" to method add_file_tags" % key
|
|
86
|
+
)
|
|
87
|
+
params[key] = val
|
|
88
|
+
del params['kwargs']
|
|
89
|
+
# verify the required parameter 'file_id' is set
|
|
90
|
+
if ('file_id' not in params or
|
|
91
|
+
params['file_id'] is None):
|
|
92
|
+
raise ValueError("Missing the required parameter `file_id` when calling `add_file_tags`") # noqa: E501
|
|
93
|
+
# verify the required parameter 'body' is set
|
|
94
|
+
if ('body' not in params or
|
|
95
|
+
params['body'] is None):
|
|
96
|
+
raise ValueError("Missing the required parameter `body` when calling `add_file_tags`") # noqa: E501
|
|
97
|
+
check_filename_params(params)
|
|
98
|
+
|
|
99
|
+
collection_formats = {}
|
|
100
|
+
|
|
101
|
+
path_params = {}
|
|
102
|
+
if 'file_id' in params:
|
|
103
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
104
|
+
|
|
105
|
+
query_params = []
|
|
106
|
+
|
|
107
|
+
header_params = {}
|
|
108
|
+
|
|
109
|
+
form_params = []
|
|
110
|
+
local_var_files = {}
|
|
111
|
+
|
|
112
|
+
body_params = None
|
|
113
|
+
if 'body' in params:
|
|
114
|
+
body_params = params['body']
|
|
115
|
+
# HTTP header `Accept`
|
|
116
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
117
|
+
['application/json']) # noqa: E501
|
|
118
|
+
|
|
119
|
+
# HTTP header `Content-Type`
|
|
120
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
121
|
+
['application/json']) # noqa: E501
|
|
122
|
+
|
|
123
|
+
# Authentication setting
|
|
124
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
125
|
+
|
|
126
|
+
return self.api_client.call_api(
|
|
127
|
+
'/files/{file_id}/tags', 'PATCH',
|
|
128
|
+
path_params,
|
|
129
|
+
query_params,
|
|
130
|
+
header_params,
|
|
131
|
+
body=body_params,
|
|
132
|
+
post_params=form_params,
|
|
133
|
+
files=local_var_files,
|
|
134
|
+
response_type='list[str]', # noqa: E501
|
|
135
|
+
auth_settings=auth_settings,
|
|
136
|
+
async_=params.get('async_'),
|
|
137
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
138
|
+
_preload_content=params.get('_preload_content', True),
|
|
139
|
+
_request_timeout=params.get('_request_timeout'),
|
|
140
|
+
_request_out=params.get('_request_out'),
|
|
141
|
+
collection_formats=collection_formats)
|
|
142
|
+
|
|
143
|
+
def delete_file(self, file_id, **kwargs): # noqa: E501
|
|
144
|
+
"""Delete a File
|
|
145
|
+
|
|
146
|
+
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
147
|
+
This method makes a synchronous HTTP request by default.
|
|
148
|
+
|
|
149
|
+
:param str file_id: (required)
|
|
150
|
+
:param int version: Version of the file to delete (defaults to current version)
|
|
151
|
+
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
152
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
153
|
+
:param bool async_: Perform the request asynchronously
|
|
154
|
+
:return: DeletedResult
|
|
155
|
+
"""
|
|
156
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
157
|
+
kwargs['_return_http_data_only'] = True
|
|
158
|
+
|
|
159
|
+
if kwargs.get('async_'):
|
|
160
|
+
return self.delete_file_with_http_info(file_id, **kwargs) # noqa: E501
|
|
161
|
+
else:
|
|
162
|
+
(data) = self.delete_file_with_http_info(file_id, **kwargs) # noqa: E501
|
|
163
|
+
if (
|
|
164
|
+
data
|
|
165
|
+
and hasattr(data, 'return_value')
|
|
166
|
+
and not ignore_simplified_return_value
|
|
167
|
+
):
|
|
168
|
+
return data.return_value()
|
|
169
|
+
return data
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
def delete_file_with_http_info(self, file_id, **kwargs): # noqa: E501
|
|
173
|
+
"""Delete a File
|
|
174
|
+
|
|
175
|
+
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
176
|
+
This method makes a synchronous HTTP request by default.
|
|
177
|
+
|
|
178
|
+
:param str file_id: (required)
|
|
179
|
+
:param int version: Version of the file to delete (defaults to current version)
|
|
180
|
+
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
181
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
182
|
+
:param bool async_: Perform the request asynchronously
|
|
183
|
+
:return: DeletedResult
|
|
184
|
+
"""
|
|
185
|
+
|
|
186
|
+
all_params = ['file_id','version','delete_reason','force',] # noqa: E501
|
|
187
|
+
all_params.append('async_')
|
|
188
|
+
all_params.append('_return_http_data_only')
|
|
189
|
+
all_params.append('_preload_content')
|
|
190
|
+
all_params.append('_request_timeout')
|
|
191
|
+
all_params.append('_request_out')
|
|
192
|
+
|
|
193
|
+
params = locals()
|
|
194
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
195
|
+
if key not in all_params:
|
|
196
|
+
raise TypeError(
|
|
197
|
+
"Got an unexpected keyword argument '%s'"
|
|
198
|
+
" to method delete_file" % key
|
|
199
|
+
)
|
|
200
|
+
params[key] = val
|
|
201
|
+
del params['kwargs']
|
|
202
|
+
# verify the required parameter 'file_id' is set
|
|
203
|
+
if ('file_id' not in params or
|
|
204
|
+
params['file_id'] is None):
|
|
205
|
+
raise ValueError("Missing the required parameter `file_id` when calling `delete_file`") # noqa: E501
|
|
206
|
+
check_filename_params(params)
|
|
207
|
+
|
|
208
|
+
collection_formats = {}
|
|
209
|
+
|
|
210
|
+
path_params = {}
|
|
211
|
+
if 'file_id' in params:
|
|
212
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
213
|
+
|
|
214
|
+
query_params = []
|
|
215
|
+
if 'version' in params:
|
|
216
|
+
query_params.append(('version', params['version'])) # noqa: E501
|
|
217
|
+
if 'delete_reason' in params:
|
|
218
|
+
query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
|
|
219
|
+
if 'force' in params:
|
|
220
|
+
query_params.append(('force', params['force'])) # noqa: E501
|
|
221
|
+
|
|
222
|
+
header_params = {}
|
|
223
|
+
|
|
224
|
+
form_params = []
|
|
225
|
+
local_var_files = {}
|
|
226
|
+
|
|
227
|
+
body_params = None
|
|
228
|
+
# HTTP header `Accept`
|
|
229
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
230
|
+
['application/json']) # noqa: E501
|
|
231
|
+
|
|
232
|
+
# Authentication setting
|
|
233
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
234
|
+
|
|
235
|
+
return self.api_client.call_api(
|
|
236
|
+
'/files/{file_id}', 'DELETE',
|
|
237
|
+
path_params,
|
|
238
|
+
query_params,
|
|
239
|
+
header_params,
|
|
240
|
+
body=body_params,
|
|
241
|
+
post_params=form_params,
|
|
242
|
+
files=local_var_files,
|
|
243
|
+
response_type='DeletedResult', # noqa: E501
|
|
244
|
+
auth_settings=auth_settings,
|
|
245
|
+
async_=params.get('async_'),
|
|
246
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
247
|
+
_preload_content=params.get('_preload_content', True),
|
|
248
|
+
_request_timeout=params.get('_request_timeout'),
|
|
249
|
+
_request_out=params.get('_request_out'),
|
|
250
|
+
collection_formats=collection_formats)
|
|
251
|
+
|
|
252
|
+
def delete_file_tags(self, file_id, **kwargs): # noqa: E501
|
|
253
|
+
"""Remove the specified tags from most recent file version
|
|
254
|
+
|
|
255
|
+
Remove the specified tags from most recent file version
|
|
256
|
+
This method makes a synchronous HTTP request by default.
|
|
257
|
+
|
|
258
|
+
:param str file_id: (required)
|
|
259
|
+
:param list[str] body: List of application-specific tags
|
|
260
|
+
:param bool async_: Perform the request asynchronously
|
|
261
|
+
:return: None
|
|
262
|
+
"""
|
|
263
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
264
|
+
kwargs['_return_http_data_only'] = True
|
|
265
|
+
|
|
266
|
+
if kwargs.get('async_'):
|
|
267
|
+
return self.delete_file_tags_with_http_info(file_id, **kwargs) # noqa: E501
|
|
268
|
+
else:
|
|
269
|
+
(data) = self.delete_file_tags_with_http_info(file_id, **kwargs) # noqa: E501
|
|
270
|
+
if (
|
|
271
|
+
data
|
|
272
|
+
and hasattr(data, 'return_value')
|
|
273
|
+
and not ignore_simplified_return_value
|
|
274
|
+
):
|
|
275
|
+
return data.return_value()
|
|
276
|
+
return data
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
def delete_file_tags_with_http_info(self, file_id, **kwargs): # noqa: E501
|
|
280
|
+
"""Remove the specified tags from most recent file version
|
|
281
|
+
|
|
282
|
+
Remove the specified tags from most recent file version
|
|
283
|
+
This method makes a synchronous HTTP request by default.
|
|
284
|
+
|
|
285
|
+
:param str file_id: (required)
|
|
286
|
+
:param list[str] body: List of application-specific tags
|
|
287
|
+
:param bool async_: Perform the request asynchronously
|
|
288
|
+
:return: None
|
|
289
|
+
"""
|
|
290
|
+
|
|
291
|
+
all_params = ['file_id','body',] # noqa: E501
|
|
292
|
+
all_params.append('async_')
|
|
293
|
+
all_params.append('_return_http_data_only')
|
|
294
|
+
all_params.append('_preload_content')
|
|
295
|
+
all_params.append('_request_timeout')
|
|
296
|
+
all_params.append('_request_out')
|
|
297
|
+
|
|
298
|
+
params = locals()
|
|
299
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
300
|
+
if key not in all_params:
|
|
301
|
+
raise TypeError(
|
|
302
|
+
"Got an unexpected keyword argument '%s'"
|
|
303
|
+
" to method delete_file_tags" % key
|
|
304
|
+
)
|
|
305
|
+
params[key] = val
|
|
306
|
+
del params['kwargs']
|
|
307
|
+
# verify the required parameter 'file_id' is set
|
|
308
|
+
if ('file_id' not in params or
|
|
309
|
+
params['file_id'] is None):
|
|
310
|
+
raise ValueError("Missing the required parameter `file_id` when calling `delete_file_tags`") # noqa: E501
|
|
311
|
+
check_filename_params(params)
|
|
312
|
+
|
|
313
|
+
collection_formats = {}
|
|
314
|
+
|
|
315
|
+
path_params = {}
|
|
316
|
+
if 'file_id' in params:
|
|
317
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
318
|
+
|
|
319
|
+
query_params = []
|
|
320
|
+
|
|
321
|
+
header_params = {}
|
|
322
|
+
|
|
323
|
+
form_params = []
|
|
324
|
+
local_var_files = {}
|
|
325
|
+
|
|
326
|
+
body_params = None
|
|
327
|
+
if 'body' in params:
|
|
328
|
+
body_params = params['body']
|
|
329
|
+
# HTTP header `Accept`
|
|
330
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
331
|
+
['application/json']) # noqa: E501
|
|
332
|
+
|
|
333
|
+
# HTTP header `Content-Type`
|
|
334
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
335
|
+
['application/json']) # noqa: E501
|
|
336
|
+
|
|
337
|
+
# Authentication setting
|
|
338
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
339
|
+
|
|
340
|
+
return self.api_client.call_api(
|
|
341
|
+
'/files/{file_id}/tags', 'DELETE',
|
|
342
|
+
path_params,
|
|
343
|
+
query_params,
|
|
344
|
+
header_params,
|
|
345
|
+
body=body_params,
|
|
346
|
+
post_params=form_params,
|
|
347
|
+
files=local_var_files,
|
|
348
|
+
response_type=None, # noqa: E501
|
|
349
|
+
auth_settings=auth_settings,
|
|
350
|
+
async_=params.get('async_'),
|
|
351
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
352
|
+
_preload_content=params.get('_preload_content', True),
|
|
353
|
+
_request_timeout=params.get('_request_timeout'),
|
|
354
|
+
_request_out=params.get('_request_out'),
|
|
355
|
+
collection_formats=collection_formats)
|
|
356
|
+
|
|
357
|
+
def delete_files_by_ids(self, body, **kwargs): # noqa: E501
|
|
358
|
+
"""Delete multiple files by ID list
|
|
359
|
+
|
|
360
|
+
Delete multiple files by ID list
|
|
361
|
+
This method makes a synchronous HTTP request by default.
|
|
362
|
+
|
|
363
|
+
:param list[str] body: List of IDs to delete (required)
|
|
364
|
+
:param ContainerDeleteReason delete_reason:
|
|
365
|
+
:param bool async_: Perform the request asynchronously
|
|
366
|
+
:return: DeletedResult
|
|
367
|
+
"""
|
|
368
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
369
|
+
kwargs['_return_http_data_only'] = True
|
|
370
|
+
|
|
371
|
+
if kwargs.get('async_'):
|
|
372
|
+
return self.delete_files_by_ids_with_http_info(body, **kwargs) # noqa: E501
|
|
373
|
+
else:
|
|
374
|
+
(data) = self.delete_files_by_ids_with_http_info(body, **kwargs) # noqa: E501
|
|
375
|
+
if (
|
|
376
|
+
data
|
|
377
|
+
and hasattr(data, 'return_value')
|
|
378
|
+
and not ignore_simplified_return_value
|
|
379
|
+
):
|
|
380
|
+
return data.return_value()
|
|
381
|
+
return data
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
def delete_files_by_ids_with_http_info(self, body, **kwargs): # noqa: E501
|
|
385
|
+
"""Delete multiple files by ID list
|
|
386
|
+
|
|
387
|
+
Delete multiple files by ID list
|
|
388
|
+
This method makes a synchronous HTTP request by default.
|
|
389
|
+
|
|
390
|
+
:param list[str] body: List of IDs to delete (required)
|
|
391
|
+
:param ContainerDeleteReason delete_reason:
|
|
392
|
+
:param bool async_: Perform the request asynchronously
|
|
393
|
+
:return: DeletedResult
|
|
394
|
+
"""
|
|
395
|
+
|
|
396
|
+
all_params = ['body','delete_reason',] # noqa: E501
|
|
397
|
+
all_params.append('async_')
|
|
398
|
+
all_params.append('_return_http_data_only')
|
|
399
|
+
all_params.append('_preload_content')
|
|
400
|
+
all_params.append('_request_timeout')
|
|
401
|
+
all_params.append('_request_out')
|
|
402
|
+
|
|
403
|
+
params = locals()
|
|
404
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
405
|
+
if key not in all_params:
|
|
406
|
+
raise TypeError(
|
|
407
|
+
"Got an unexpected keyword argument '%s'"
|
|
408
|
+
" to method delete_files_by_ids" % key
|
|
409
|
+
)
|
|
410
|
+
params[key] = val
|
|
411
|
+
del params['kwargs']
|
|
412
|
+
# verify the required parameter 'body' is set
|
|
413
|
+
if ('body' not in params or
|
|
414
|
+
params['body'] is None):
|
|
415
|
+
raise ValueError("Missing the required parameter `body` when calling `delete_files_by_ids`") # noqa: E501
|
|
416
|
+
check_filename_params(params)
|
|
417
|
+
|
|
418
|
+
collection_formats = {}
|
|
419
|
+
|
|
420
|
+
path_params = {}
|
|
421
|
+
|
|
422
|
+
query_params = []
|
|
423
|
+
if 'delete_reason' in params:
|
|
424
|
+
query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
|
|
425
|
+
|
|
426
|
+
header_params = {}
|
|
427
|
+
|
|
428
|
+
form_params = []
|
|
429
|
+
local_var_files = {}
|
|
430
|
+
|
|
431
|
+
body_params = None
|
|
432
|
+
if 'body' in params:
|
|
433
|
+
body_params = params['body']
|
|
434
|
+
# HTTP header `Accept`
|
|
435
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
436
|
+
['application/json']) # noqa: E501
|
|
437
|
+
|
|
438
|
+
# HTTP header `Content-Type`
|
|
439
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
440
|
+
['application/json']) # noqa: E501
|
|
441
|
+
|
|
442
|
+
# Authentication setting
|
|
443
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
444
|
+
|
|
445
|
+
return self.api_client.call_api(
|
|
446
|
+
'/files', 'DELETE',
|
|
447
|
+
path_params,
|
|
448
|
+
query_params,
|
|
449
|
+
header_params,
|
|
450
|
+
body=body_params,
|
|
451
|
+
post_params=form_params,
|
|
452
|
+
files=local_var_files,
|
|
453
|
+
response_type='DeletedResult', # noqa: E501
|
|
454
|
+
auth_settings=auth_settings,
|
|
455
|
+
async_=params.get('async_'),
|
|
456
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
457
|
+
_preload_content=params.get('_preload_content', True),
|
|
458
|
+
_request_timeout=params.get('_request_timeout'),
|
|
459
|
+
_request_out=params.get('_request_out'),
|
|
460
|
+
collection_formats=collection_formats)
|
|
461
|
+
|
|
462
|
+
def get_all_files(self, **kwargs): # noqa: E501
|
|
463
|
+
"""Return all files
|
|
464
|
+
|
|
465
|
+
Get metadata of all current user files
|
|
466
|
+
This method makes a synchronous HTTP request by default.
|
|
467
|
+
|
|
468
|
+
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
469
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
470
|
+
:param int limit: The maximum number of entries to return.
|
|
471
|
+
:param int skip: The number of entries to skip.
|
|
472
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
473
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
474
|
+
:param bool async_: Perform the request asynchronously
|
|
475
|
+
:return: PageGenericFileOutput
|
|
476
|
+
"""
|
|
477
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
478
|
+
kwargs['_return_http_data_only'] = True
|
|
479
|
+
|
|
480
|
+
if kwargs.get('async_'):
|
|
481
|
+
return self.get_all_files_with_http_info(**kwargs) # noqa: E501
|
|
482
|
+
else:
|
|
483
|
+
(data) = self.get_all_files_with_http_info(**kwargs) # noqa: E501
|
|
484
|
+
if (
|
|
485
|
+
data
|
|
486
|
+
and hasattr(data, 'return_value')
|
|
487
|
+
and not ignore_simplified_return_value
|
|
488
|
+
):
|
|
489
|
+
return data.return_value()
|
|
490
|
+
return data
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
def get_all_files_with_http_info(self, **kwargs): # noqa: E501
|
|
494
|
+
"""Return all files
|
|
495
|
+
|
|
496
|
+
Get metadata of all current user files
|
|
497
|
+
This method makes a synchronous HTTP request by default.
|
|
498
|
+
|
|
499
|
+
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
500
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
501
|
+
:param int limit: The maximum number of entries to return.
|
|
502
|
+
:param int skip: The number of entries to skip.
|
|
503
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
504
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
505
|
+
:param bool async_: Perform the request asynchronously
|
|
506
|
+
:return: PageGenericFileOutput
|
|
507
|
+
"""
|
|
508
|
+
|
|
509
|
+
all_params = ['filter','sort','limit','skip','page','after_id',] # noqa: E501
|
|
510
|
+
all_params.append('async_')
|
|
511
|
+
all_params.append('_return_http_data_only')
|
|
512
|
+
all_params.append('_preload_content')
|
|
513
|
+
all_params.append('_request_timeout')
|
|
514
|
+
all_params.append('_request_out')
|
|
515
|
+
|
|
516
|
+
params = locals()
|
|
517
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
518
|
+
if key not in all_params:
|
|
519
|
+
raise TypeError(
|
|
520
|
+
"Got an unexpected keyword argument '%s'"
|
|
521
|
+
" to method get_all_files" % key
|
|
522
|
+
)
|
|
523
|
+
params[key] = val
|
|
524
|
+
del params['kwargs']
|
|
525
|
+
check_filename_params(params)
|
|
526
|
+
|
|
527
|
+
collection_formats = {}
|
|
528
|
+
|
|
529
|
+
path_params = {}
|
|
530
|
+
|
|
531
|
+
query_params = []
|
|
532
|
+
if 'filter' in params:
|
|
533
|
+
query_params.append(('filter', params['filter'])) # noqa: E501
|
|
534
|
+
if 'sort' in params:
|
|
535
|
+
query_params.append(('sort', params['sort'])) # noqa: E501
|
|
536
|
+
if 'limit' in params:
|
|
537
|
+
query_params.append(('limit', params['limit'])) # noqa: E501
|
|
538
|
+
if 'skip' in params:
|
|
539
|
+
query_params.append(('skip', params['skip'])) # noqa: E501
|
|
540
|
+
if 'page' in params:
|
|
541
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
542
|
+
if 'after_id' in params:
|
|
543
|
+
query_params.append(('after_id', params['after_id'])) # noqa: E501
|
|
544
|
+
|
|
545
|
+
header_params = {}
|
|
546
|
+
|
|
547
|
+
form_params = []
|
|
548
|
+
local_var_files = {}
|
|
549
|
+
|
|
550
|
+
body_params = None
|
|
551
|
+
# HTTP header `Accept`
|
|
552
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
553
|
+
['application/json']) # noqa: E501
|
|
554
|
+
|
|
555
|
+
# Authentication setting
|
|
556
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
557
|
+
|
|
558
|
+
return self.api_client.call_api(
|
|
559
|
+
'/files', 'GET',
|
|
560
|
+
path_params,
|
|
561
|
+
query_params,
|
|
562
|
+
header_params,
|
|
563
|
+
body=body_params,
|
|
564
|
+
post_params=form_params,
|
|
565
|
+
files=local_var_files,
|
|
566
|
+
response_type='PageGenericFileOutput', # noqa: E501
|
|
567
|
+
auth_settings=auth_settings,
|
|
568
|
+
async_=params.get('async_'),
|
|
569
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
570
|
+
_preload_content=params.get('_preload_content', True),
|
|
571
|
+
_request_timeout=params.get('_request_timeout'),
|
|
572
|
+
_request_out=params.get('_request_out'),
|
|
573
|
+
collection_formats=collection_formats)
|
|
574
|
+
|
|
575
|
+
def get_file(self, file_id, **kwargs): # noqa: E501
|
|
576
|
+
"""Get File
|
|
577
|
+
|
|
578
|
+
Get file details
|
|
579
|
+
This method makes a synchronous HTTP request by default.
|
|
580
|
+
|
|
581
|
+
:param str file_id: (required)
|
|
582
|
+
:param int version:
|
|
583
|
+
:param bool async_: Perform the request asynchronously
|
|
584
|
+
:return: FileOutput
|
|
585
|
+
"""
|
|
586
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
587
|
+
kwargs['_return_http_data_only'] = True
|
|
588
|
+
|
|
589
|
+
if kwargs.get('async_'):
|
|
590
|
+
return self.get_file_with_http_info(file_id, **kwargs) # noqa: E501
|
|
591
|
+
else:
|
|
592
|
+
(data) = self.get_file_with_http_info(file_id, **kwargs) # noqa: E501
|
|
593
|
+
if (
|
|
594
|
+
data
|
|
595
|
+
and hasattr(data, 'return_value')
|
|
596
|
+
and not ignore_simplified_return_value
|
|
597
|
+
):
|
|
598
|
+
return data.return_value()
|
|
599
|
+
return data
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
def get_file_with_http_info(self, file_id, **kwargs): # noqa: E501
|
|
603
|
+
"""Get File
|
|
604
|
+
|
|
605
|
+
Get file details
|
|
606
|
+
This method makes a synchronous HTTP request by default.
|
|
607
|
+
|
|
608
|
+
:param str file_id: (required)
|
|
609
|
+
:param int version:
|
|
610
|
+
:param bool async_: Perform the request asynchronously
|
|
611
|
+
:return: FileOutput
|
|
612
|
+
"""
|
|
613
|
+
|
|
614
|
+
all_params = ['file_id','version',] # noqa: E501
|
|
615
|
+
all_params.append('async_')
|
|
616
|
+
all_params.append('_return_http_data_only')
|
|
617
|
+
all_params.append('_preload_content')
|
|
618
|
+
all_params.append('_request_timeout')
|
|
619
|
+
all_params.append('_request_out')
|
|
620
|
+
|
|
621
|
+
params = locals()
|
|
622
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
623
|
+
if key not in all_params:
|
|
624
|
+
raise TypeError(
|
|
625
|
+
"Got an unexpected keyword argument '%s'"
|
|
626
|
+
" to method get_file" % key
|
|
627
|
+
)
|
|
628
|
+
params[key] = val
|
|
629
|
+
del params['kwargs']
|
|
630
|
+
# verify the required parameter 'file_id' is set
|
|
631
|
+
if ('file_id' not in params or
|
|
632
|
+
params['file_id'] is None):
|
|
633
|
+
raise ValueError("Missing the required parameter `file_id` when calling `get_file`") # noqa: E501
|
|
634
|
+
check_filename_params(params)
|
|
635
|
+
|
|
636
|
+
collection_formats = {}
|
|
637
|
+
|
|
638
|
+
path_params = {}
|
|
639
|
+
if 'file_id' in params:
|
|
640
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
641
|
+
|
|
642
|
+
query_params = []
|
|
643
|
+
if 'version' in params:
|
|
644
|
+
query_params.append(('version', params['version'])) # noqa: E501
|
|
645
|
+
|
|
646
|
+
header_params = {}
|
|
647
|
+
|
|
648
|
+
form_params = []
|
|
649
|
+
local_var_files = {}
|
|
650
|
+
|
|
651
|
+
body_params = None
|
|
652
|
+
# HTTP header `Accept`
|
|
653
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
654
|
+
['application/json']) # noqa: E501
|
|
655
|
+
|
|
656
|
+
# Authentication setting
|
|
657
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
658
|
+
|
|
659
|
+
return self.api_client.call_api(
|
|
660
|
+
'/files/{file_id}', 'GET',
|
|
661
|
+
path_params,
|
|
662
|
+
query_params,
|
|
663
|
+
header_params,
|
|
664
|
+
body=body_params,
|
|
665
|
+
post_params=form_params,
|
|
666
|
+
files=local_var_files,
|
|
667
|
+
response_type='FileOutput', # noqa: E501
|
|
668
|
+
auth_settings=auth_settings,
|
|
669
|
+
async_=params.get('async_'),
|
|
670
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
671
|
+
_preload_content=params.get('_preload_content', True),
|
|
672
|
+
_request_timeout=params.get('_request_timeout'),
|
|
673
|
+
_request_out=params.get('_request_out'),
|
|
674
|
+
collection_formats=collection_formats)
|
|
675
|
+
|
|
676
|
+
def get_file_info(self, file_id, **kwargs): # noqa: E501
|
|
677
|
+
"""Get Info
|
|
678
|
+
|
|
679
|
+
Get info dict for any file version. Returns: dict of key/value pairs
|
|
680
|
+
This method makes a synchronous HTTP request by default.
|
|
681
|
+
|
|
682
|
+
:param str file_id: (required)
|
|
683
|
+
:param int version:
|
|
684
|
+
:param bool async_: Perform the request asynchronously
|
|
685
|
+
:return: object
|
|
686
|
+
"""
|
|
687
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
688
|
+
kwargs['_return_http_data_only'] = True
|
|
689
|
+
|
|
690
|
+
if kwargs.get('async_'):
|
|
691
|
+
return self.get_file_info_with_http_info(file_id, **kwargs) # noqa: E501
|
|
692
|
+
else:
|
|
693
|
+
(data) = self.get_file_info_with_http_info(file_id, **kwargs) # noqa: E501
|
|
694
|
+
if (
|
|
695
|
+
data
|
|
696
|
+
and hasattr(data, 'return_value')
|
|
697
|
+
and not ignore_simplified_return_value
|
|
698
|
+
):
|
|
699
|
+
return data.return_value()
|
|
700
|
+
return data
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
def get_file_info_with_http_info(self, file_id, **kwargs): # noqa: E501
|
|
704
|
+
"""Get Info
|
|
705
|
+
|
|
706
|
+
Get info dict for any file version. Returns: dict of key/value pairs
|
|
707
|
+
This method makes a synchronous HTTP request by default.
|
|
708
|
+
|
|
709
|
+
:param str file_id: (required)
|
|
710
|
+
:param int version:
|
|
711
|
+
:param bool async_: Perform the request asynchronously
|
|
712
|
+
:return: object
|
|
713
|
+
"""
|
|
714
|
+
|
|
715
|
+
all_params = ['file_id','version',] # noqa: E501
|
|
716
|
+
all_params.append('async_')
|
|
717
|
+
all_params.append('_return_http_data_only')
|
|
718
|
+
all_params.append('_preload_content')
|
|
719
|
+
all_params.append('_request_timeout')
|
|
720
|
+
all_params.append('_request_out')
|
|
721
|
+
|
|
722
|
+
params = locals()
|
|
723
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
724
|
+
if key not in all_params:
|
|
725
|
+
raise TypeError(
|
|
726
|
+
"Got an unexpected keyword argument '%s'"
|
|
727
|
+
" to method get_file_info" % key
|
|
728
|
+
)
|
|
729
|
+
params[key] = val
|
|
730
|
+
del params['kwargs']
|
|
731
|
+
# verify the required parameter 'file_id' is set
|
|
732
|
+
if ('file_id' not in params or
|
|
733
|
+
params['file_id'] is None):
|
|
734
|
+
raise ValueError("Missing the required parameter `file_id` when calling `get_file_info`") # noqa: E501
|
|
735
|
+
check_filename_params(params)
|
|
736
|
+
|
|
737
|
+
collection_formats = {}
|
|
738
|
+
|
|
739
|
+
path_params = {}
|
|
740
|
+
if 'file_id' in params:
|
|
741
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
742
|
+
|
|
743
|
+
query_params = []
|
|
744
|
+
if 'version' in params:
|
|
745
|
+
query_params.append(('version', params['version'])) # noqa: E501
|
|
746
|
+
|
|
747
|
+
header_params = {}
|
|
748
|
+
|
|
749
|
+
form_params = []
|
|
750
|
+
local_var_files = {}
|
|
751
|
+
|
|
752
|
+
body_params = None
|
|
753
|
+
# HTTP header `Accept`
|
|
754
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
755
|
+
['application/json']) # noqa: E501
|
|
756
|
+
|
|
757
|
+
# Authentication setting
|
|
758
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
759
|
+
|
|
760
|
+
return self.api_client.call_api(
|
|
761
|
+
'/files/{file_id}/info', 'GET',
|
|
762
|
+
path_params,
|
|
763
|
+
query_params,
|
|
764
|
+
header_params,
|
|
765
|
+
body=body_params,
|
|
766
|
+
post_params=form_params,
|
|
767
|
+
files=local_var_files,
|
|
768
|
+
response_type='object', # noqa: E501
|
|
769
|
+
auth_settings=auth_settings,
|
|
770
|
+
async_=params.get('async_'),
|
|
771
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
772
|
+
_preload_content=params.get('_preload_content', True),
|
|
773
|
+
_request_timeout=params.get('_request_timeout'),
|
|
774
|
+
_request_out=params.get('_request_out'),
|
|
775
|
+
collection_formats=collection_formats)
|
|
776
|
+
|
|
777
|
+
def get_file_tags(self, file_id, **kwargs): # noqa: E501
|
|
778
|
+
"""Return a file tags, from any version
|
|
779
|
+
|
|
780
|
+
Return a file tags, from any version
|
|
781
|
+
This method makes a synchronous HTTP request by default.
|
|
782
|
+
|
|
783
|
+
:param str file_id: (required)
|
|
784
|
+
:param int version:
|
|
785
|
+
:param bool async_: Perform the request asynchronously
|
|
786
|
+
:return: list[str]
|
|
787
|
+
"""
|
|
788
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
789
|
+
kwargs['_return_http_data_only'] = True
|
|
790
|
+
|
|
791
|
+
if kwargs.get('async_'):
|
|
792
|
+
return self.get_file_tags_with_http_info(file_id, **kwargs) # noqa: E501
|
|
793
|
+
else:
|
|
794
|
+
(data) = self.get_file_tags_with_http_info(file_id, **kwargs) # noqa: E501
|
|
795
|
+
if (
|
|
796
|
+
data
|
|
797
|
+
and hasattr(data, 'return_value')
|
|
798
|
+
and not ignore_simplified_return_value
|
|
799
|
+
):
|
|
800
|
+
return data.return_value()
|
|
801
|
+
return data
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
def get_file_tags_with_http_info(self, file_id, **kwargs): # noqa: E501
|
|
805
|
+
"""Return a file tags, from any version
|
|
806
|
+
|
|
807
|
+
Return a file tags, from any version
|
|
808
|
+
This method makes a synchronous HTTP request by default.
|
|
809
|
+
|
|
810
|
+
:param str file_id: (required)
|
|
811
|
+
:param int version:
|
|
812
|
+
:param bool async_: Perform the request asynchronously
|
|
813
|
+
:return: list[str]
|
|
814
|
+
"""
|
|
815
|
+
|
|
816
|
+
all_params = ['file_id','version',] # noqa: E501
|
|
817
|
+
all_params.append('async_')
|
|
818
|
+
all_params.append('_return_http_data_only')
|
|
819
|
+
all_params.append('_preload_content')
|
|
820
|
+
all_params.append('_request_timeout')
|
|
821
|
+
all_params.append('_request_out')
|
|
822
|
+
|
|
823
|
+
params = locals()
|
|
824
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
825
|
+
if key not in all_params:
|
|
826
|
+
raise TypeError(
|
|
827
|
+
"Got an unexpected keyword argument '%s'"
|
|
828
|
+
" to method get_file_tags" % key
|
|
829
|
+
)
|
|
830
|
+
params[key] = val
|
|
831
|
+
del params['kwargs']
|
|
832
|
+
# verify the required parameter 'file_id' is set
|
|
833
|
+
if ('file_id' not in params or
|
|
834
|
+
params['file_id'] is None):
|
|
835
|
+
raise ValueError("Missing the required parameter `file_id` when calling `get_file_tags`") # noqa: E501
|
|
836
|
+
check_filename_params(params)
|
|
837
|
+
|
|
838
|
+
collection_formats = {}
|
|
839
|
+
|
|
840
|
+
path_params = {}
|
|
841
|
+
if 'file_id' in params:
|
|
842
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
843
|
+
|
|
844
|
+
query_params = []
|
|
845
|
+
if 'version' in params:
|
|
846
|
+
query_params.append(('version', params['version'])) # noqa: E501
|
|
847
|
+
|
|
848
|
+
header_params = {}
|
|
849
|
+
|
|
850
|
+
form_params = []
|
|
851
|
+
local_var_files = {}
|
|
852
|
+
|
|
853
|
+
body_params = None
|
|
854
|
+
# HTTP header `Accept`
|
|
855
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
856
|
+
['application/json']) # noqa: E501
|
|
857
|
+
|
|
858
|
+
# Authentication setting
|
|
859
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
860
|
+
|
|
861
|
+
return self.api_client.call_api(
|
|
862
|
+
'/files/{file_id}/tags', 'GET',
|
|
863
|
+
path_params,
|
|
864
|
+
query_params,
|
|
865
|
+
header_params,
|
|
866
|
+
body=body_params,
|
|
867
|
+
post_params=form_params,
|
|
868
|
+
files=local_var_files,
|
|
869
|
+
response_type='list[str]', # noqa: E501
|
|
870
|
+
auth_settings=auth_settings,
|
|
871
|
+
async_=params.get('async_'),
|
|
872
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
873
|
+
_preload_content=params.get('_preload_content', True),
|
|
874
|
+
_request_timeout=params.get('_request_timeout'),
|
|
875
|
+
_request_out=params.get('_request_out'),
|
|
876
|
+
collection_formats=collection_formats)
|
|
877
|
+
|
|
878
|
+
def get_file_versions(self, file_id, **kwargs): # noqa: E501
|
|
879
|
+
"""Get Versions
|
|
880
|
+
|
|
881
|
+
Get file version details
|
|
882
|
+
This method makes a synchronous HTTP request by default.
|
|
883
|
+
|
|
884
|
+
:param str file_id: (required)
|
|
885
|
+
:param bool async_: Perform the request asynchronously
|
|
886
|
+
:return: list[FileVersionOutput]
|
|
887
|
+
"""
|
|
888
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
889
|
+
kwargs['_return_http_data_only'] = True
|
|
890
|
+
|
|
891
|
+
if kwargs.get('async_'):
|
|
892
|
+
return self.get_file_versions_with_http_info(file_id, **kwargs) # noqa: E501
|
|
893
|
+
else:
|
|
894
|
+
(data) = self.get_file_versions_with_http_info(file_id, **kwargs) # noqa: E501
|
|
895
|
+
if (
|
|
896
|
+
data
|
|
897
|
+
and hasattr(data, 'return_value')
|
|
898
|
+
and not ignore_simplified_return_value
|
|
899
|
+
):
|
|
900
|
+
return data.return_value()
|
|
901
|
+
return data
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
def get_file_versions_with_http_info(self, file_id, **kwargs): # noqa: E501
|
|
905
|
+
"""Get Versions
|
|
906
|
+
|
|
907
|
+
Get file version details
|
|
908
|
+
This method makes a synchronous HTTP request by default.
|
|
909
|
+
|
|
910
|
+
:param str file_id: (required)
|
|
911
|
+
:param bool async_: Perform the request asynchronously
|
|
912
|
+
:return: list[FileVersionOutput]
|
|
913
|
+
"""
|
|
914
|
+
|
|
915
|
+
all_params = ['file_id',] # noqa: E501
|
|
916
|
+
all_params.append('async_')
|
|
917
|
+
all_params.append('_return_http_data_only')
|
|
918
|
+
all_params.append('_preload_content')
|
|
919
|
+
all_params.append('_request_timeout')
|
|
920
|
+
all_params.append('_request_out')
|
|
921
|
+
|
|
922
|
+
params = locals()
|
|
923
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
924
|
+
if key not in all_params:
|
|
925
|
+
raise TypeError(
|
|
926
|
+
"Got an unexpected keyword argument '%s'"
|
|
927
|
+
" to method get_file_versions" % key
|
|
928
|
+
)
|
|
929
|
+
params[key] = val
|
|
930
|
+
del params['kwargs']
|
|
931
|
+
# verify the required parameter 'file_id' is set
|
|
932
|
+
if ('file_id' not in params or
|
|
933
|
+
params['file_id'] is None):
|
|
934
|
+
raise ValueError("Missing the required parameter `file_id` when calling `get_file_versions`") # noqa: E501
|
|
935
|
+
check_filename_params(params)
|
|
936
|
+
|
|
937
|
+
collection_formats = {}
|
|
938
|
+
|
|
939
|
+
path_params = {}
|
|
940
|
+
if 'file_id' in params:
|
|
941
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
942
|
+
|
|
943
|
+
query_params = []
|
|
944
|
+
|
|
945
|
+
header_params = {}
|
|
946
|
+
|
|
947
|
+
form_params = []
|
|
948
|
+
local_var_files = {}
|
|
949
|
+
|
|
950
|
+
body_params = None
|
|
951
|
+
# HTTP header `Accept`
|
|
952
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
953
|
+
['application/json']) # noqa: E501
|
|
954
|
+
|
|
955
|
+
# Authentication setting
|
|
956
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
957
|
+
|
|
958
|
+
return self.api_client.call_api(
|
|
959
|
+
'/files/{file_id}/versions', 'GET',
|
|
960
|
+
path_params,
|
|
961
|
+
query_params,
|
|
962
|
+
header_params,
|
|
963
|
+
body=body_params,
|
|
964
|
+
post_params=form_params,
|
|
965
|
+
files=local_var_files,
|
|
966
|
+
response_type='list[FileVersionOutput]', # noqa: E501
|
|
967
|
+
auth_settings=auth_settings,
|
|
968
|
+
async_=params.get('async_'),
|
|
969
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
970
|
+
_preload_content=params.get('_preload_content', True),
|
|
971
|
+
_request_timeout=params.get('_request_timeout'),
|
|
972
|
+
_request_out=params.get('_request_out'),
|
|
973
|
+
collection_formats=collection_formats)
|
|
974
|
+
|
|
975
|
+
def get_file_zip_info(self, file_id, **kwargs): # noqa: E501
|
|
976
|
+
"""Get Zip Info
|
|
977
|
+
|
|
978
|
+
Get info on zipfile
|
|
979
|
+
This method makes a synchronous HTTP request by default.
|
|
980
|
+
|
|
981
|
+
:param str file_id: (required)
|
|
982
|
+
:param int version:
|
|
983
|
+
:param str ticket:
|
|
984
|
+
:param bool async_: Perform the request asynchronously
|
|
985
|
+
:return: ZipfileInfo
|
|
986
|
+
"""
|
|
987
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
988
|
+
kwargs['_return_http_data_only'] = True
|
|
989
|
+
|
|
990
|
+
if kwargs.get('async_'):
|
|
991
|
+
return self.get_file_zip_info_with_http_info(file_id, **kwargs) # noqa: E501
|
|
992
|
+
else:
|
|
993
|
+
(data) = self.get_file_zip_info_with_http_info(file_id, **kwargs) # noqa: E501
|
|
994
|
+
if (
|
|
995
|
+
data
|
|
996
|
+
and hasattr(data, 'return_value')
|
|
997
|
+
and not ignore_simplified_return_value
|
|
998
|
+
):
|
|
999
|
+
return data.return_value()
|
|
1000
|
+
return data
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
def get_file_zip_info_with_http_info(self, file_id, **kwargs): # noqa: E501
|
|
1004
|
+
"""Get Zip Info
|
|
1005
|
+
|
|
1006
|
+
Get info on zipfile
|
|
1007
|
+
This method makes a synchronous HTTP request by default.
|
|
1008
|
+
|
|
1009
|
+
:param str file_id: (required)
|
|
1010
|
+
:param int version:
|
|
1011
|
+
:param str ticket:
|
|
1012
|
+
:param bool async_: Perform the request asynchronously
|
|
1013
|
+
:return: ZipfileInfo
|
|
1014
|
+
"""
|
|
1015
|
+
|
|
1016
|
+
all_params = ['file_id','version','ticket',] # noqa: E501
|
|
1017
|
+
all_params.append('async_')
|
|
1018
|
+
all_params.append('_return_http_data_only')
|
|
1019
|
+
all_params.append('_preload_content')
|
|
1020
|
+
all_params.append('_request_timeout')
|
|
1021
|
+
all_params.append('_request_out')
|
|
1022
|
+
|
|
1023
|
+
params = locals()
|
|
1024
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1025
|
+
if key not in all_params:
|
|
1026
|
+
raise TypeError(
|
|
1027
|
+
"Got an unexpected keyword argument '%s'"
|
|
1028
|
+
" to method get_file_zip_info" % key
|
|
1029
|
+
)
|
|
1030
|
+
params[key] = val
|
|
1031
|
+
del params['kwargs']
|
|
1032
|
+
# verify the required parameter 'file_id' is set
|
|
1033
|
+
if ('file_id' not in params or
|
|
1034
|
+
params['file_id'] is None):
|
|
1035
|
+
raise ValueError("Missing the required parameter `file_id` when calling `get_file_zip_info`") # noqa: E501
|
|
1036
|
+
check_filename_params(params)
|
|
1037
|
+
|
|
1038
|
+
collection_formats = {}
|
|
1039
|
+
|
|
1040
|
+
path_params = {}
|
|
1041
|
+
if 'file_id' in params:
|
|
1042
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
1043
|
+
|
|
1044
|
+
query_params = []
|
|
1045
|
+
if 'version' in params:
|
|
1046
|
+
query_params.append(('version', params['version'])) # noqa: E501
|
|
1047
|
+
if 'ticket' in params:
|
|
1048
|
+
query_params.append(('ticket', params['ticket'])) # noqa: E501
|
|
1049
|
+
|
|
1050
|
+
header_params = {}
|
|
1051
|
+
|
|
1052
|
+
form_params = []
|
|
1053
|
+
local_var_files = {}
|
|
1054
|
+
|
|
1055
|
+
body_params = None
|
|
1056
|
+
# HTTP header `Accept`
|
|
1057
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1058
|
+
['application/json']) # noqa: E501
|
|
1059
|
+
|
|
1060
|
+
# Authentication setting
|
|
1061
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1062
|
+
|
|
1063
|
+
return self.api_client.call_api(
|
|
1064
|
+
'/files/{file_id}/zip_info', 'GET',
|
|
1065
|
+
path_params,
|
|
1066
|
+
query_params,
|
|
1067
|
+
header_params,
|
|
1068
|
+
body=body_params,
|
|
1069
|
+
post_params=form_params,
|
|
1070
|
+
files=local_var_files,
|
|
1071
|
+
response_type='ZipfileInfo', # noqa: E501
|
|
1072
|
+
auth_settings=auth_settings,
|
|
1073
|
+
async_=params.get('async_'),
|
|
1074
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1075
|
+
_preload_content=params.get('_preload_content', True),
|
|
1076
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1077
|
+
_request_out=params.get('_request_out'),
|
|
1078
|
+
collection_formats=collection_formats)
|
|
1079
|
+
|
|
1080
|
+
def modify_file_classification(self, file_id, body, **kwargs): # noqa: E501
|
|
1081
|
+
"""Modify Classification
|
|
1082
|
+
|
|
1083
|
+
Modify classification of most recent file version
|
|
1084
|
+
This method makes a synchronous HTTP request by default.
|
|
1085
|
+
|
|
1086
|
+
:param str file_id: (required)
|
|
1087
|
+
:param FileClassificationDelta body: (required)
|
|
1088
|
+
:param bool async_: Perform the request asynchronously
|
|
1089
|
+
:return: ModifiedResult
|
|
1090
|
+
"""
|
|
1091
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1092
|
+
kwargs['_return_http_data_only'] = True
|
|
1093
|
+
|
|
1094
|
+
if kwargs.get('async_'):
|
|
1095
|
+
return self.modify_file_classification_with_http_info(file_id, body, **kwargs) # noqa: E501
|
|
1096
|
+
else:
|
|
1097
|
+
(data) = self.modify_file_classification_with_http_info(file_id, body, **kwargs) # noqa: E501
|
|
1098
|
+
if (
|
|
1099
|
+
data
|
|
1100
|
+
and hasattr(data, 'return_value')
|
|
1101
|
+
and not ignore_simplified_return_value
|
|
1102
|
+
):
|
|
1103
|
+
return data.return_value()
|
|
1104
|
+
return data
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
def modify_file_classification_with_http_info(self, file_id, body, **kwargs): # noqa: E501
|
|
1108
|
+
"""Modify Classification
|
|
1109
|
+
|
|
1110
|
+
Modify classification of most recent file version
|
|
1111
|
+
This method makes a synchronous HTTP request by default.
|
|
1112
|
+
|
|
1113
|
+
:param str file_id: (required)
|
|
1114
|
+
:param FileClassificationDelta body: (required)
|
|
1115
|
+
:param bool async_: Perform the request asynchronously
|
|
1116
|
+
:return: ModifiedResult
|
|
1117
|
+
"""
|
|
1118
|
+
|
|
1119
|
+
all_params = ['file_id','body',] # noqa: E501
|
|
1120
|
+
all_params.append('async_')
|
|
1121
|
+
all_params.append('_return_http_data_only')
|
|
1122
|
+
all_params.append('_preload_content')
|
|
1123
|
+
all_params.append('_request_timeout')
|
|
1124
|
+
all_params.append('_request_out')
|
|
1125
|
+
|
|
1126
|
+
params = locals()
|
|
1127
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1128
|
+
if key not in all_params:
|
|
1129
|
+
raise TypeError(
|
|
1130
|
+
"Got an unexpected keyword argument '%s'"
|
|
1131
|
+
" to method modify_file_classification" % key
|
|
1132
|
+
)
|
|
1133
|
+
params[key] = val
|
|
1134
|
+
del params['kwargs']
|
|
1135
|
+
# verify the required parameter 'file_id' is set
|
|
1136
|
+
if ('file_id' not in params or
|
|
1137
|
+
params['file_id'] is None):
|
|
1138
|
+
raise ValueError("Missing the required parameter `file_id` when calling `modify_file_classification`") # noqa: E501
|
|
1139
|
+
# verify the required parameter 'body' is set
|
|
1140
|
+
if ('body' not in params or
|
|
1141
|
+
params['body'] is None):
|
|
1142
|
+
raise ValueError("Missing the required parameter `body` when calling `modify_file_classification`") # noqa: E501
|
|
1143
|
+
check_filename_params(params)
|
|
1144
|
+
|
|
1145
|
+
collection_formats = {}
|
|
1146
|
+
|
|
1147
|
+
path_params = {}
|
|
1148
|
+
if 'file_id' in params:
|
|
1149
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
1150
|
+
|
|
1151
|
+
query_params = []
|
|
1152
|
+
|
|
1153
|
+
header_params = {}
|
|
1154
|
+
|
|
1155
|
+
form_params = []
|
|
1156
|
+
local_var_files = {}
|
|
1157
|
+
|
|
1158
|
+
body_params = None
|
|
1159
|
+
if 'body' in params:
|
|
1160
|
+
if 'FileClassificationDelta'.startswith('union'):
|
|
1161
|
+
body_type = type(params['body'])
|
|
1162
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
1163
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
1164
|
+
else:
|
|
1165
|
+
body_params = params['body']
|
|
1166
|
+
else:
|
|
1167
|
+
body_params = flywheel.models.FileClassificationDelta.positional_to_model(params['body'])
|
|
1168
|
+
# HTTP header `Accept`
|
|
1169
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1170
|
+
['application/json']) # noqa: E501
|
|
1171
|
+
|
|
1172
|
+
# HTTP header `Content-Type`
|
|
1173
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
1174
|
+
['application/json']) # noqa: E501
|
|
1175
|
+
|
|
1176
|
+
# Authentication setting
|
|
1177
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1178
|
+
|
|
1179
|
+
return self.api_client.call_api(
|
|
1180
|
+
'/files/{file_id}/classification', 'PUT',
|
|
1181
|
+
path_params,
|
|
1182
|
+
query_params,
|
|
1183
|
+
header_params,
|
|
1184
|
+
body=body_params,
|
|
1185
|
+
post_params=form_params,
|
|
1186
|
+
files=local_var_files,
|
|
1187
|
+
response_type='ModifiedResult', # noqa: E501
|
|
1188
|
+
auth_settings=auth_settings,
|
|
1189
|
+
async_=params.get('async_'),
|
|
1190
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1191
|
+
_preload_content=params.get('_preload_content', True),
|
|
1192
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1193
|
+
_request_out=params.get('_request_out'),
|
|
1194
|
+
collection_formats=collection_formats)
|
|
1195
|
+
|
|
1196
|
+
def modify_file_info(self, file_id, **kwargs): # noqa: E501
|
|
1197
|
+
"""Modify Info
|
|
1198
|
+
|
|
1199
|
+
Add info to most recent file version, adding items or replacing some existing ones. Parameters: info (dict) -- key/value pairs to add Returns: dict added
|
|
1200
|
+
This method makes a synchronous HTTP request by default.
|
|
1201
|
+
|
|
1202
|
+
:param str file_id: (required)
|
|
1203
|
+
:param object body:
|
|
1204
|
+
:param bool async_: Perform the request asynchronously
|
|
1205
|
+
:return: ModifiedResult
|
|
1206
|
+
"""
|
|
1207
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1208
|
+
kwargs['_return_http_data_only'] = True
|
|
1209
|
+
|
|
1210
|
+
if kwargs.get('async_'):
|
|
1211
|
+
return self.modify_file_info_with_http_info(file_id, **kwargs) # noqa: E501
|
|
1212
|
+
else:
|
|
1213
|
+
(data) = self.modify_file_info_with_http_info(file_id, **kwargs) # noqa: E501
|
|
1214
|
+
if (
|
|
1215
|
+
data
|
|
1216
|
+
and hasattr(data, 'return_value')
|
|
1217
|
+
and not ignore_simplified_return_value
|
|
1218
|
+
):
|
|
1219
|
+
return data.return_value()
|
|
1220
|
+
return data
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
def modify_file_info_with_http_info(self, file_id, **kwargs): # noqa: E501
|
|
1224
|
+
"""Modify Info
|
|
1225
|
+
|
|
1226
|
+
Add info to most recent file version, adding items or replacing some existing ones. Parameters: info (dict) -- key/value pairs to add Returns: dict added
|
|
1227
|
+
This method makes a synchronous HTTP request by default.
|
|
1228
|
+
|
|
1229
|
+
:param str file_id: (required)
|
|
1230
|
+
:param object body:
|
|
1231
|
+
:param bool async_: Perform the request asynchronously
|
|
1232
|
+
:return: ModifiedResult
|
|
1233
|
+
"""
|
|
1234
|
+
|
|
1235
|
+
all_params = ['file_id','body',] # noqa: E501
|
|
1236
|
+
all_params.append('async_')
|
|
1237
|
+
all_params.append('_return_http_data_only')
|
|
1238
|
+
all_params.append('_preload_content')
|
|
1239
|
+
all_params.append('_request_timeout')
|
|
1240
|
+
all_params.append('_request_out')
|
|
1241
|
+
|
|
1242
|
+
params = locals()
|
|
1243
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1244
|
+
if key not in all_params:
|
|
1245
|
+
raise TypeError(
|
|
1246
|
+
"Got an unexpected keyword argument '%s'"
|
|
1247
|
+
" to method modify_file_info" % key
|
|
1248
|
+
)
|
|
1249
|
+
params[key] = val
|
|
1250
|
+
del params['kwargs']
|
|
1251
|
+
# verify the required parameter 'file_id' is set
|
|
1252
|
+
if ('file_id' not in params or
|
|
1253
|
+
params['file_id'] is None):
|
|
1254
|
+
raise ValueError("Missing the required parameter `file_id` when calling `modify_file_info`") # noqa: E501
|
|
1255
|
+
check_filename_params(params)
|
|
1256
|
+
|
|
1257
|
+
collection_formats = {}
|
|
1258
|
+
|
|
1259
|
+
path_params = {}
|
|
1260
|
+
if 'file_id' in params:
|
|
1261
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
1262
|
+
|
|
1263
|
+
query_params = []
|
|
1264
|
+
|
|
1265
|
+
header_params = {}
|
|
1266
|
+
|
|
1267
|
+
form_params = []
|
|
1268
|
+
local_var_files = {}
|
|
1269
|
+
|
|
1270
|
+
body_params = None
|
|
1271
|
+
if 'body' in params:
|
|
1272
|
+
if 'object'.startswith('union'):
|
|
1273
|
+
body_type = type(params['body'])
|
|
1274
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
1275
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
1276
|
+
else:
|
|
1277
|
+
body_params = params['body']
|
|
1278
|
+
else:
|
|
1279
|
+
body_params = flywheel.models.object.positional_to_model(params['body'])
|
|
1280
|
+
# HTTP header `Accept`
|
|
1281
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1282
|
+
['application/json']) # noqa: E501
|
|
1283
|
+
|
|
1284
|
+
# HTTP header `Content-Type`
|
|
1285
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
1286
|
+
['application/json']) # noqa: E501
|
|
1287
|
+
|
|
1288
|
+
# Authentication setting
|
|
1289
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1290
|
+
|
|
1291
|
+
return self.api_client.call_api(
|
|
1292
|
+
'/files/{file_id}/info', 'PATCH',
|
|
1293
|
+
path_params,
|
|
1294
|
+
query_params,
|
|
1295
|
+
header_params,
|
|
1296
|
+
body=body_params,
|
|
1297
|
+
post_params=form_params,
|
|
1298
|
+
files=local_var_files,
|
|
1299
|
+
response_type='ModifiedResult', # noqa: E501
|
|
1300
|
+
auth_settings=auth_settings,
|
|
1301
|
+
async_=params.get('async_'),
|
|
1302
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1303
|
+
_preload_content=params.get('_preload_content', True),
|
|
1304
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1305
|
+
_request_out=params.get('_request_out'),
|
|
1306
|
+
collection_formats=collection_formats)
|
|
1307
|
+
|
|
1308
|
+
def move_file(self, file_id, body, **kwargs): # noqa: E501
|
|
1309
|
+
"""Move and/or rename a file
|
|
1310
|
+
|
|
1311
|
+
Move a file to a new container and/or give it a new name
|
|
1312
|
+
This method makes a synchronous HTTP request by default.
|
|
1313
|
+
|
|
1314
|
+
:param str file_id: (required)
|
|
1315
|
+
:param FileMoveInput body: (required)
|
|
1316
|
+
:param bool async_: Perform the request asynchronously
|
|
1317
|
+
:return: ModifiedResult
|
|
1318
|
+
"""
|
|
1319
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1320
|
+
kwargs['_return_http_data_only'] = True
|
|
1321
|
+
|
|
1322
|
+
if kwargs.get('async_'):
|
|
1323
|
+
return self.move_file_with_http_info(file_id, body, **kwargs) # noqa: E501
|
|
1324
|
+
else:
|
|
1325
|
+
(data) = self.move_file_with_http_info(file_id, body, **kwargs) # noqa: E501
|
|
1326
|
+
if (
|
|
1327
|
+
data
|
|
1328
|
+
and hasattr(data, 'return_value')
|
|
1329
|
+
and not ignore_simplified_return_value
|
|
1330
|
+
):
|
|
1331
|
+
return data.return_value()
|
|
1332
|
+
return data
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
def move_file_with_http_info(self, file_id, body, **kwargs): # noqa: E501
|
|
1336
|
+
"""Move and/or rename a file
|
|
1337
|
+
|
|
1338
|
+
Move a file to a new container and/or give it a new name
|
|
1339
|
+
This method makes a synchronous HTTP request by default.
|
|
1340
|
+
|
|
1341
|
+
:param str file_id: (required)
|
|
1342
|
+
:param FileMoveInput body: (required)
|
|
1343
|
+
:param bool async_: Perform the request asynchronously
|
|
1344
|
+
:return: ModifiedResult
|
|
1345
|
+
"""
|
|
1346
|
+
|
|
1347
|
+
all_params = ['file_id','body',] # noqa: E501
|
|
1348
|
+
all_params.append('async_')
|
|
1349
|
+
all_params.append('_return_http_data_only')
|
|
1350
|
+
all_params.append('_preload_content')
|
|
1351
|
+
all_params.append('_request_timeout')
|
|
1352
|
+
all_params.append('_request_out')
|
|
1353
|
+
|
|
1354
|
+
params = locals()
|
|
1355
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1356
|
+
if key not in all_params:
|
|
1357
|
+
raise TypeError(
|
|
1358
|
+
"Got an unexpected keyword argument '%s'"
|
|
1359
|
+
" to method move_file" % key
|
|
1360
|
+
)
|
|
1361
|
+
params[key] = val
|
|
1362
|
+
del params['kwargs']
|
|
1363
|
+
# verify the required parameter 'file_id' is set
|
|
1364
|
+
if ('file_id' not in params or
|
|
1365
|
+
params['file_id'] is None):
|
|
1366
|
+
raise ValueError("Missing the required parameter `file_id` when calling `move_file`") # noqa: E501
|
|
1367
|
+
# verify the required parameter 'body' is set
|
|
1368
|
+
if ('body' not in params or
|
|
1369
|
+
params['body'] is None):
|
|
1370
|
+
raise ValueError("Missing the required parameter `body` when calling `move_file`") # noqa: E501
|
|
1371
|
+
check_filename_params(params)
|
|
1372
|
+
|
|
1373
|
+
collection_formats = {}
|
|
1374
|
+
|
|
1375
|
+
path_params = {}
|
|
1376
|
+
if 'file_id' in params:
|
|
1377
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
1378
|
+
|
|
1379
|
+
query_params = []
|
|
1380
|
+
|
|
1381
|
+
header_params = {}
|
|
1382
|
+
|
|
1383
|
+
form_params = []
|
|
1384
|
+
local_var_files = {}
|
|
1385
|
+
|
|
1386
|
+
body_params = None
|
|
1387
|
+
if 'body' in params:
|
|
1388
|
+
if 'FileMoveInput'.startswith('union'):
|
|
1389
|
+
body_type = type(params['body'])
|
|
1390
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
1391
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
1392
|
+
else:
|
|
1393
|
+
body_params = params['body']
|
|
1394
|
+
else:
|
|
1395
|
+
body_params = flywheel.models.FileMoveInput.positional_to_model(params['body'])
|
|
1396
|
+
# HTTP header `Accept`
|
|
1397
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1398
|
+
['application/json']) # noqa: E501
|
|
1399
|
+
|
|
1400
|
+
# HTTP header `Content-Type`
|
|
1401
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
1402
|
+
['application/json']) # noqa: E501
|
|
1403
|
+
|
|
1404
|
+
# Authentication setting
|
|
1405
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1406
|
+
|
|
1407
|
+
return self.api_client.call_api(
|
|
1408
|
+
'/files/{file_id}/move', 'POST',
|
|
1409
|
+
path_params,
|
|
1410
|
+
query_params,
|
|
1411
|
+
header_params,
|
|
1412
|
+
body=body_params,
|
|
1413
|
+
post_params=form_params,
|
|
1414
|
+
files=local_var_files,
|
|
1415
|
+
response_type='ModifiedResult', # noqa: E501
|
|
1416
|
+
auth_settings=auth_settings,
|
|
1417
|
+
async_=params.get('async_'),
|
|
1418
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1419
|
+
_preload_content=params.get('_preload_content', True),
|
|
1420
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1421
|
+
_request_out=params.get('_request_out'),
|
|
1422
|
+
collection_formats=collection_formats)
|
|
1423
|
+
|
|
1424
|
+
def replace_file_info(self, file_id, **kwargs): # noqa: E501
|
|
1425
|
+
"""Replace Info
|
|
1426
|
+
|
|
1427
|
+
Add info to most recent file version, replacing all existing values. Parameters: info (dict) -- all key/value pairs to populate info Returns: dict added
|
|
1428
|
+
This method makes a synchronous HTTP request by default.
|
|
1429
|
+
|
|
1430
|
+
:param str file_id: (required)
|
|
1431
|
+
:param object body:
|
|
1432
|
+
:param bool async_: Perform the request asynchronously
|
|
1433
|
+
:return: object
|
|
1434
|
+
"""
|
|
1435
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1436
|
+
kwargs['_return_http_data_only'] = True
|
|
1437
|
+
|
|
1438
|
+
if kwargs.get('async_'):
|
|
1439
|
+
return self.replace_file_info_with_http_info(file_id, **kwargs) # noqa: E501
|
|
1440
|
+
else:
|
|
1441
|
+
(data) = self.replace_file_info_with_http_info(file_id, **kwargs) # noqa: E501
|
|
1442
|
+
if (
|
|
1443
|
+
data
|
|
1444
|
+
and hasattr(data, 'return_value')
|
|
1445
|
+
and not ignore_simplified_return_value
|
|
1446
|
+
):
|
|
1447
|
+
return data.return_value()
|
|
1448
|
+
return data
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
def replace_file_info_with_http_info(self, file_id, **kwargs): # noqa: E501
|
|
1452
|
+
"""Replace Info
|
|
1453
|
+
|
|
1454
|
+
Add info to most recent file version, replacing all existing values. Parameters: info (dict) -- all key/value pairs to populate info Returns: dict added
|
|
1455
|
+
This method makes a synchronous HTTP request by default.
|
|
1456
|
+
|
|
1457
|
+
:param str file_id: (required)
|
|
1458
|
+
:param object body:
|
|
1459
|
+
:param bool async_: Perform the request asynchronously
|
|
1460
|
+
:return: object
|
|
1461
|
+
"""
|
|
1462
|
+
|
|
1463
|
+
all_params = ['file_id','body',] # noqa: E501
|
|
1464
|
+
all_params.append('async_')
|
|
1465
|
+
all_params.append('_return_http_data_only')
|
|
1466
|
+
all_params.append('_preload_content')
|
|
1467
|
+
all_params.append('_request_timeout')
|
|
1468
|
+
all_params.append('_request_out')
|
|
1469
|
+
|
|
1470
|
+
params = locals()
|
|
1471
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1472
|
+
if key not in all_params:
|
|
1473
|
+
raise TypeError(
|
|
1474
|
+
"Got an unexpected keyword argument '%s'"
|
|
1475
|
+
" to method replace_file_info" % key
|
|
1476
|
+
)
|
|
1477
|
+
params[key] = val
|
|
1478
|
+
del params['kwargs']
|
|
1479
|
+
# verify the required parameter 'file_id' is set
|
|
1480
|
+
if ('file_id' not in params or
|
|
1481
|
+
params['file_id'] is None):
|
|
1482
|
+
raise ValueError("Missing the required parameter `file_id` when calling `replace_file_info`") # noqa: E501
|
|
1483
|
+
check_filename_params(params)
|
|
1484
|
+
|
|
1485
|
+
collection_formats = {}
|
|
1486
|
+
|
|
1487
|
+
path_params = {}
|
|
1488
|
+
if 'file_id' in params:
|
|
1489
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
1490
|
+
|
|
1491
|
+
query_params = []
|
|
1492
|
+
|
|
1493
|
+
header_params = {}
|
|
1494
|
+
|
|
1495
|
+
form_params = []
|
|
1496
|
+
local_var_files = {}
|
|
1497
|
+
|
|
1498
|
+
body_params = None
|
|
1499
|
+
if 'body' in params:
|
|
1500
|
+
if 'object'.startswith('union'):
|
|
1501
|
+
body_type = type(params['body'])
|
|
1502
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
1503
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
1504
|
+
else:
|
|
1505
|
+
body_params = params['body']
|
|
1506
|
+
else:
|
|
1507
|
+
body_params = flywheel.models.object.positional_to_model(params['body'])
|
|
1508
|
+
# HTTP header `Accept`
|
|
1509
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1510
|
+
['application/json']) # noqa: E501
|
|
1511
|
+
|
|
1512
|
+
# HTTP header `Content-Type`
|
|
1513
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
1514
|
+
['application/json']) # noqa: E501
|
|
1515
|
+
|
|
1516
|
+
# Authentication setting
|
|
1517
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1518
|
+
|
|
1519
|
+
return self.api_client.call_api(
|
|
1520
|
+
'/files/{file_id}/info', 'PUT',
|
|
1521
|
+
path_params,
|
|
1522
|
+
query_params,
|
|
1523
|
+
header_params,
|
|
1524
|
+
body=body_params,
|
|
1525
|
+
post_params=form_params,
|
|
1526
|
+
files=local_var_files,
|
|
1527
|
+
response_type='object', # noqa: E501
|
|
1528
|
+
auth_settings=auth_settings,
|
|
1529
|
+
async_=params.get('async_'),
|
|
1530
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1531
|
+
_preload_content=params.get('_preload_content', True),
|
|
1532
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1533
|
+
_request_out=params.get('_request_out'),
|
|
1534
|
+
collection_formats=collection_formats)
|
|
1535
|
+
|
|
1536
|
+
def restore_file(self, file_id, version, evaluate_gear_rules, **kwargs): # noqa: E501
|
|
1537
|
+
"""Restore a File
|
|
1538
|
+
|
|
1539
|
+
Restore a specific version of a file as the active version. This will create a new version which will be identical to the restored version.
|
|
1540
|
+
This method makes a synchronous HTTP request by default.
|
|
1541
|
+
|
|
1542
|
+
:param str file_id: (required)
|
|
1543
|
+
:param int version: (required)
|
|
1544
|
+
:param bool evaluate_gear_rules: Specify if gear rules should be reevaluated on the newly created file version (required)
|
|
1545
|
+
:param bool async_: Perform the request asynchronously
|
|
1546
|
+
:return: FileOutput
|
|
1547
|
+
"""
|
|
1548
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1549
|
+
kwargs['_return_http_data_only'] = True
|
|
1550
|
+
|
|
1551
|
+
if kwargs.get('async_'):
|
|
1552
|
+
return self.restore_file_with_http_info(file_id, version, evaluate_gear_rules, **kwargs) # noqa: E501
|
|
1553
|
+
else:
|
|
1554
|
+
(data) = self.restore_file_with_http_info(file_id, version, evaluate_gear_rules, **kwargs) # noqa: E501
|
|
1555
|
+
if (
|
|
1556
|
+
data
|
|
1557
|
+
and hasattr(data, 'return_value')
|
|
1558
|
+
and not ignore_simplified_return_value
|
|
1559
|
+
):
|
|
1560
|
+
return data.return_value()
|
|
1561
|
+
return data
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
def restore_file_with_http_info(self, file_id, version, evaluate_gear_rules, **kwargs): # noqa: E501
|
|
1565
|
+
"""Restore a File
|
|
1566
|
+
|
|
1567
|
+
Restore a specific version of a file as the active version. This will create a new version which will be identical to the restored version.
|
|
1568
|
+
This method makes a synchronous HTTP request by default.
|
|
1569
|
+
|
|
1570
|
+
:param str file_id: (required)
|
|
1571
|
+
:param int version: (required)
|
|
1572
|
+
:param bool evaluate_gear_rules: Specify if gear rules should be reevaluated on the newly created file version (required)
|
|
1573
|
+
:param bool async_: Perform the request asynchronously
|
|
1574
|
+
:return: FileOutput
|
|
1575
|
+
"""
|
|
1576
|
+
|
|
1577
|
+
all_params = ['file_id','version','evaluate_gear_rules',] # noqa: E501
|
|
1578
|
+
all_params.append('async_')
|
|
1579
|
+
all_params.append('_return_http_data_only')
|
|
1580
|
+
all_params.append('_preload_content')
|
|
1581
|
+
all_params.append('_request_timeout')
|
|
1582
|
+
all_params.append('_request_out')
|
|
1583
|
+
|
|
1584
|
+
params = locals()
|
|
1585
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1586
|
+
if key not in all_params:
|
|
1587
|
+
raise TypeError(
|
|
1588
|
+
"Got an unexpected keyword argument '%s'"
|
|
1589
|
+
" to method restore_file" % key
|
|
1590
|
+
)
|
|
1591
|
+
params[key] = val
|
|
1592
|
+
del params['kwargs']
|
|
1593
|
+
# verify the required parameter 'file_id' is set
|
|
1594
|
+
if ('file_id' not in params or
|
|
1595
|
+
params['file_id'] is None):
|
|
1596
|
+
raise ValueError("Missing the required parameter `file_id` when calling `restore_file`") # noqa: E501
|
|
1597
|
+
# verify the required parameter 'version' is set
|
|
1598
|
+
if ('version' not in params or
|
|
1599
|
+
params['version'] is None):
|
|
1600
|
+
raise ValueError("Missing the required parameter `version` when calling `restore_file`") # noqa: E501
|
|
1601
|
+
# verify the required parameter 'evaluate_gear_rules' is set
|
|
1602
|
+
if ('evaluate_gear_rules' not in params or
|
|
1603
|
+
params['evaluate_gear_rules'] is None):
|
|
1604
|
+
raise ValueError("Missing the required parameter `evaluate_gear_rules` when calling `restore_file`") # noqa: E501
|
|
1605
|
+
check_filename_params(params)
|
|
1606
|
+
|
|
1607
|
+
collection_formats = {}
|
|
1608
|
+
|
|
1609
|
+
path_params = {}
|
|
1610
|
+
if 'file_id' in params:
|
|
1611
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
1612
|
+
|
|
1613
|
+
query_params = []
|
|
1614
|
+
if 'version' in params:
|
|
1615
|
+
query_params.append(('version', params['version'])) # noqa: E501
|
|
1616
|
+
if 'evaluate_gear_rules' in params:
|
|
1617
|
+
query_params.append(('evaluate_gear_rules', params['evaluate_gear_rules'])) # noqa: E501
|
|
1618
|
+
|
|
1619
|
+
header_params = {}
|
|
1620
|
+
|
|
1621
|
+
form_params = []
|
|
1622
|
+
local_var_files = {}
|
|
1623
|
+
|
|
1624
|
+
body_params = None
|
|
1625
|
+
# HTTP header `Accept`
|
|
1626
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1627
|
+
['application/json']) # noqa: E501
|
|
1628
|
+
|
|
1629
|
+
# Authentication setting
|
|
1630
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1631
|
+
|
|
1632
|
+
return self.api_client.call_api(
|
|
1633
|
+
'/files/{file_id}/restore', 'POST',
|
|
1634
|
+
path_params,
|
|
1635
|
+
query_params,
|
|
1636
|
+
header_params,
|
|
1637
|
+
body=body_params,
|
|
1638
|
+
post_params=form_params,
|
|
1639
|
+
files=local_var_files,
|
|
1640
|
+
response_type='FileOutput', # noqa: E501
|
|
1641
|
+
auth_settings=auth_settings,
|
|
1642
|
+
async_=params.get('async_'),
|
|
1643
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1644
|
+
_preload_content=params.get('_preload_content', True),
|
|
1645
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1646
|
+
_request_out=params.get('_request_out'),
|
|
1647
|
+
collection_formats=collection_formats)
|
|
1648
|
+
|
|
1649
|
+
def set_file_tags(self, file_id, body, **kwargs): # noqa: E501
|
|
1650
|
+
"""Set list of tags on a file.
|
|
1651
|
+
|
|
1652
|
+
Set the tags on a file to the list of tags provided
|
|
1653
|
+
This method makes a synchronous HTTP request by default.
|
|
1654
|
+
|
|
1655
|
+
:param str file_id: (required)
|
|
1656
|
+
:param list[str] body: List of application-specific tags (required)
|
|
1657
|
+
:param bool async_: Perform the request asynchronously
|
|
1658
|
+
:return: ModifiedResult
|
|
1659
|
+
"""
|
|
1660
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1661
|
+
kwargs['_return_http_data_only'] = True
|
|
1662
|
+
|
|
1663
|
+
if kwargs.get('async_'):
|
|
1664
|
+
return self.set_file_tags_with_http_info(file_id, body, **kwargs) # noqa: E501
|
|
1665
|
+
else:
|
|
1666
|
+
(data) = self.set_file_tags_with_http_info(file_id, body, **kwargs) # noqa: E501
|
|
1667
|
+
if (
|
|
1668
|
+
data
|
|
1669
|
+
and hasattr(data, 'return_value')
|
|
1670
|
+
and not ignore_simplified_return_value
|
|
1671
|
+
):
|
|
1672
|
+
return data.return_value()
|
|
1673
|
+
return data
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
def set_file_tags_with_http_info(self, file_id, body, **kwargs): # noqa: E501
|
|
1677
|
+
"""Set list of tags on a file.
|
|
1678
|
+
|
|
1679
|
+
Set the tags on a file to the list of tags provided
|
|
1680
|
+
This method makes a synchronous HTTP request by default.
|
|
1681
|
+
|
|
1682
|
+
:param str file_id: (required)
|
|
1683
|
+
:param list[str] body: List of application-specific tags (required)
|
|
1684
|
+
:param bool async_: Perform the request asynchronously
|
|
1685
|
+
:return: ModifiedResult
|
|
1686
|
+
"""
|
|
1687
|
+
|
|
1688
|
+
all_params = ['file_id','body',] # noqa: E501
|
|
1689
|
+
all_params.append('async_')
|
|
1690
|
+
all_params.append('_return_http_data_only')
|
|
1691
|
+
all_params.append('_preload_content')
|
|
1692
|
+
all_params.append('_request_timeout')
|
|
1693
|
+
all_params.append('_request_out')
|
|
1694
|
+
|
|
1695
|
+
params = locals()
|
|
1696
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1697
|
+
if key not in all_params:
|
|
1698
|
+
raise TypeError(
|
|
1699
|
+
"Got an unexpected keyword argument '%s'"
|
|
1700
|
+
" to method set_file_tags" % key
|
|
1701
|
+
)
|
|
1702
|
+
params[key] = val
|
|
1703
|
+
del params['kwargs']
|
|
1704
|
+
# verify the required parameter 'file_id' is set
|
|
1705
|
+
if ('file_id' not in params or
|
|
1706
|
+
params['file_id'] is None):
|
|
1707
|
+
raise ValueError("Missing the required parameter `file_id` when calling `set_file_tags`") # noqa: E501
|
|
1708
|
+
# verify the required parameter 'body' is set
|
|
1709
|
+
if ('body' not in params or
|
|
1710
|
+
params['body'] is None):
|
|
1711
|
+
raise ValueError("Missing the required parameter `body` when calling `set_file_tags`") # noqa: E501
|
|
1712
|
+
check_filename_params(params)
|
|
1713
|
+
|
|
1714
|
+
collection_formats = {}
|
|
1715
|
+
|
|
1716
|
+
path_params = {}
|
|
1717
|
+
if 'file_id' in params:
|
|
1718
|
+
path_params['file_id'] = params['file_id'] # noqa: E501
|
|
1719
|
+
|
|
1720
|
+
query_params = []
|
|
1721
|
+
|
|
1722
|
+
header_params = {}
|
|
1723
|
+
|
|
1724
|
+
form_params = []
|
|
1725
|
+
local_var_files = {}
|
|
1726
|
+
|
|
1727
|
+
body_params = None
|
|
1728
|
+
if 'body' in params:
|
|
1729
|
+
body_params = params['body']
|
|
1730
|
+
# HTTP header `Accept`
|
|
1731
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1732
|
+
['application/json']) # noqa: E501
|
|
1733
|
+
|
|
1734
|
+
# HTTP header `Content-Type`
|
|
1735
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
1736
|
+
['application/json']) # noqa: E501
|
|
1737
|
+
|
|
1738
|
+
# Authentication setting
|
|
1739
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1740
|
+
|
|
1741
|
+
return self.api_client.call_api(
|
|
1742
|
+
'/files/{file_id}/tags', 'PUT',
|
|
1743
|
+
path_params,
|
|
1744
|
+
query_params,
|
|
1745
|
+
header_params,
|
|
1746
|
+
body=body_params,
|
|
1747
|
+
post_params=form_params,
|
|
1748
|
+
files=local_var_files,
|
|
1749
|
+
response_type='ModifiedResult', # noqa: E501
|
|
1750
|
+
auth_settings=auth_settings,
|
|
1751
|
+
async_=params.get('async_'),
|
|
1752
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1753
|
+
_preload_content=params.get('_preload_content', True),
|
|
1754
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1755
|
+
_request_out=params.get('_request_out'),
|
|
1756
|
+
collection_formats=collection_formats)
|
|
1757
|
+
|
|
1758
|
+
def upsert_file(self, body, **kwargs): # noqa: E501
|
|
1759
|
+
"""Upsert a File
|
|
1760
|
+
|
|
1761
|
+
Create or update a file
|
|
1762
|
+
This method makes a synchronous HTTP request by default.
|
|
1763
|
+
|
|
1764
|
+
:param FileUpsertInput body: (required)
|
|
1765
|
+
:param bool force_update:
|
|
1766
|
+
:param bool async_: Perform the request asynchronously
|
|
1767
|
+
:return: FileUpsertOutput
|
|
1768
|
+
"""
|
|
1769
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1770
|
+
kwargs['_return_http_data_only'] = True
|
|
1771
|
+
|
|
1772
|
+
if kwargs.get('async_'):
|
|
1773
|
+
return self.upsert_file_with_http_info(body, **kwargs) # noqa: E501
|
|
1774
|
+
else:
|
|
1775
|
+
(data) = self.upsert_file_with_http_info(body, **kwargs) # noqa: E501
|
|
1776
|
+
if (
|
|
1777
|
+
data
|
|
1778
|
+
and hasattr(data, 'return_value')
|
|
1779
|
+
and not ignore_simplified_return_value
|
|
1780
|
+
):
|
|
1781
|
+
return data.return_value()
|
|
1782
|
+
return data
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
def upsert_file_with_http_info(self, body, **kwargs): # noqa: E501
|
|
1786
|
+
"""Upsert a File
|
|
1787
|
+
|
|
1788
|
+
Create or update a file
|
|
1789
|
+
This method makes a synchronous HTTP request by default.
|
|
1790
|
+
|
|
1791
|
+
:param FileUpsertInput body: (required)
|
|
1792
|
+
:param bool force_update:
|
|
1793
|
+
:param bool async_: Perform the request asynchronously
|
|
1794
|
+
:return: FileUpsertOutput
|
|
1795
|
+
"""
|
|
1796
|
+
|
|
1797
|
+
all_params = ['body','force_update',] # noqa: E501
|
|
1798
|
+
all_params.append('async_')
|
|
1799
|
+
all_params.append('_return_http_data_only')
|
|
1800
|
+
all_params.append('_preload_content')
|
|
1801
|
+
all_params.append('_request_timeout')
|
|
1802
|
+
all_params.append('_request_out')
|
|
1803
|
+
|
|
1804
|
+
params = locals()
|
|
1805
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1806
|
+
if key not in all_params:
|
|
1807
|
+
raise TypeError(
|
|
1808
|
+
"Got an unexpected keyword argument '%s'"
|
|
1809
|
+
" to method upsert_file" % key
|
|
1810
|
+
)
|
|
1811
|
+
params[key] = val
|
|
1812
|
+
del params['kwargs']
|
|
1813
|
+
# verify the required parameter 'body' is set
|
|
1814
|
+
if ('body' not in params or
|
|
1815
|
+
params['body'] is None):
|
|
1816
|
+
raise ValueError("Missing the required parameter `body` when calling `upsert_file`") # noqa: E501
|
|
1817
|
+
check_filename_params(params)
|
|
1818
|
+
|
|
1819
|
+
collection_formats = {}
|
|
1820
|
+
|
|
1821
|
+
path_params = {}
|
|
1822
|
+
|
|
1823
|
+
query_params = []
|
|
1824
|
+
if 'force_update' in params:
|
|
1825
|
+
query_params.append(('force_update', params['force_update'])) # noqa: E501
|
|
1826
|
+
|
|
1827
|
+
header_params = {}
|
|
1828
|
+
|
|
1829
|
+
form_params = []
|
|
1830
|
+
local_var_files = {}
|
|
1831
|
+
|
|
1832
|
+
body_params = None
|
|
1833
|
+
if 'body' in params:
|
|
1834
|
+
if 'FileUpsertInput'.startswith('union'):
|
|
1835
|
+
body_type = type(params['body'])
|
|
1836
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
1837
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
1838
|
+
else:
|
|
1839
|
+
body_params = params['body']
|
|
1840
|
+
else:
|
|
1841
|
+
body_params = flywheel.models.FileUpsertInput.positional_to_model(params['body'])
|
|
1842
|
+
# HTTP header `Accept`
|
|
1843
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1844
|
+
['application/json']) # noqa: E501
|
|
1845
|
+
|
|
1846
|
+
# HTTP header `Content-Type`
|
|
1847
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
1848
|
+
['application/json']) # noqa: E501
|
|
1849
|
+
|
|
1850
|
+
# Authentication setting
|
|
1851
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1852
|
+
|
|
1853
|
+
return self.api_client.call_api(
|
|
1854
|
+
'/files', 'POST',
|
|
1855
|
+
path_params,
|
|
1856
|
+
query_params,
|
|
1857
|
+
header_params,
|
|
1858
|
+
body=body_params,
|
|
1859
|
+
post_params=form_params,
|
|
1860
|
+
files=local_var_files,
|
|
1861
|
+
response_type='FileUpsertOutput', # noqa: E501
|
|
1862
|
+
auth_settings=auth_settings,
|
|
1863
|
+
async_=params.get('async_'),
|
|
1864
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1865
|
+
_preload_content=params.get('_preload_content', True),
|
|
1866
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1867
|
+
_request_out=params.get('_request_out'),
|
|
1868
|
+
collection_formats=collection_formats)
|