From f98942a7d44665b1ca655a9628b5c8c50c10d39d Mon Sep 17 00:00:00 2001 From: kcutler Date: Tue, 5 Sep 2023 15:40:12 -0700 Subject: [PATCH 1/5] v2.18 updates --- .openapi-generator/FILES | 91 ++- README.md | 39 + docs/apis/tags/BundleApi.md | 232 ++++++ docs/apis/tags/ConnectorApi.md | 4 +- docs/apis/tags/PipelineApi.md | 264 +++++++ docs/apis/tags/ProjectAnalysisApi.md | 4 +- docs/apis/tags/ProjectApi.md | 6 +- docs/apis/tags/ProjectDataApi.md | 20 +- docs/apis/tags/ProjectDataUpdateBatchApi.md | 636 +++++++++++++++ docs/apis/tags/ProjectPermissionApi.md | 109 ++- docs/apis/tags/ProjectPipelineApi.md | 729 ++++++++++++++++++ docs/apis/tags/ProjectSampleApi.md | 247 ++++++ docs/apis/tags/SequencingRunApi.md | 143 ++++ docs/apis/tags/SystemApi.md | 102 +++ docs/models/Analysis.md | 2 +- docs/models/AnalysisData.md | 1 + docs/models/AnalysisStorage.md | 2 +- docs/models/CreateCwlAnalysis.md | 2 +- docs/models/CreateNextflowAnalysis.md | 2 +- docs/models/CreateProject.md | 2 +- docs/models/CreateProjectDataUpdateBatch.md | 27 + docs/models/CreateProjectPermissionV4.md | 24 + docs/models/DataUpdateGroup.md | 31 + docs/models/InputPart.md | 46 +- docs/models/IntegerSettings.md | 27 + docs/models/LoadDataInBaseRequest.md | 2 +- docs/models/MultipartFormDataInput.md | 26 +- docs/models/OptionSettings.md | 40 + docs/models/PipelineConfigurationParameter.md | 2 + docs/models/PipelineFile.md | 16 + docs/models/PipelineFileContentSpec.md | 15 + docs/models/PipelineFileList.md | 27 + docs/models/Project.md | 2 +- docs/models/ProjectDataUpdateBatch.md | 16 + docs/models/ProjectDataUpdateBatchItem.md | 17 + .../ProjectDataUpdateBatchItemPagedList.md | 30 + .../ProjectDataUpdateBatchItemProcessing.md | 16 + .../ProjectDataUpdateBatchItemRequest.md | 17 + docs/models/ProjectPermissionListV4.md | 27 + docs/models/ProjectPermissionV4.md | 32 + docs/models/SampleCreationBatch.md | 1 + docs/models/Settings.md | 19 + docs/models/StringSettings.md | 27 + docs/models/SystemInfo.md | 16 + docs/models/TagUpdate.md | 40 + docs/models/TermsOfUseAcceptance.md | 19 + icasdk/apis/path_to_api.py | 42 + ...rms_of_use_user_acceptance_current_user.py | 7 + ...pi_bundles_bundle_id_terms_of_useaccept.py | 7 + .../paths/api_pipelines_pipeline_id_files.py | 7 + ...lines_pipeline_id_files_file_id_content.py | 7 + ...i_projects_project_id_data_update_batch.py | 7 + ...s_project_id_data_update_batch_batch_id.py | 7 + ...ect_id_data_update_batch_batch_id_items.py | 7 + ...ata_update_batch_batch_id_items_item_id.py | 7 + ..._project_id_pipelines_pipeline_id_files.py | 9 + ..._id_pipelines_pipeline_id_files_file_id.py | 7 + ...lines_pipeline_id_files_file_id_content.py | 9 + ...s_project_id_samples_sample_id_analyses.py | 7 + .../api_sequencing_runs_sequencing_run_id.py | 7 + icasdk/apis/paths/api_system_info.py | 7 + icasdk/apis/tag_to_api.py | 9 + icasdk/apis/tags/__init__.py | 3 + icasdk/apis/tags/bundle_api.py | 4 + icasdk/apis/tags/pipeline_api.py | 4 + .../tags/project_data_update_batch_api.py | 29 + icasdk/apis/tags/project_pipeline_api.py | 10 + icasdk/apis/tags/project_sample_api.py | 2 + icasdk/apis/tags/sequencing_run_api.py | 23 + icasdk/apis/tags/system_api.py | 23 + icasdk/model/analysis.py | 12 +- icasdk/model/analysis.pyi | 12 +- icasdk/model/analysis_data.py | 14 +- icasdk/model/analysis_data.pyi | 14 +- icasdk/model/analysis_storage.py | 20 +- icasdk/model/analysis_storage.pyi | 20 +- icasdk/model/create_cwl_analysis.py | 22 +- icasdk/model/create_cwl_analysis.pyi | 22 +- icasdk/model/create_nextflow_analysis.py | 22 +- icasdk/model/create_nextflow_analysis.pyi | 22 +- icasdk/model/create_project.py | 12 +- icasdk/model/create_project.pyi | 12 +- .../model/create_project_data_update_batch.py | 110 +++ .../create_project_data_update_batch.pyi | 110 +++ icasdk/model/create_project_permission_v4.py | 317 ++++++++ icasdk/model/create_project_permission_v4.pyi | 289 +++++++ icasdk/model/data_update_group.py | 135 ++++ icasdk/model/data_update_group.pyi | 135 ++++ icasdk/model/input_part.py | 132 ++-- icasdk/model/input_part.pyi | 132 ++-- icasdk/model/integer_settings.py | 100 +++ icasdk/model/integer_settings.pyi | 100 +++ icasdk/model/multipart_form_data_input.py | 82 +- icasdk/model/multipart_form_data_input.pyi | 82 +- icasdk/model/option_settings.py | 132 ++++ icasdk/model/option_settings.pyi | 132 ++++ .../model/pipeline_configuration_parameter.py | 31 +- .../pipeline_configuration_parameter.pyi | 31 +- icasdk/model/pipeline_file.py | 95 +++ icasdk/model/pipeline_file.pyi | 95 +++ icasdk/model/pipeline_file_content_spec.py | 83 ++ icasdk/model/pipeline_file_content_spec.pyi | 83 ++ icasdk/model/pipeline_file_list.py | 110 +++ icasdk/model/pipeline_file_list.pyi | 110 +++ icasdk/model/project.py | 12 +- icasdk/model/project.pyi | 12 +- icasdk/model/project_data_update_batch.py | 100 +++ icasdk/model/project_data_update_batch.pyi | 100 +++ .../model/project_data_update_batch_item.py | 116 +++ .../model/project_data_update_batch_item.pyi | 116 +++ ...oject_data_update_batch_item_paged_list.py | 214 +++++ ...ject_data_update_batch_item_paged_list.pyi | 210 +++++ ...oject_data_update_batch_item_processing.py | 152 ++++ ...ject_data_update_batch_item_processing.pyi | 141 ++++ .../project_data_update_batch_item_request.py | 111 +++ ...project_data_update_batch_item_request.pyi | 111 +++ icasdk/model/project_permission_list_v4.py | 110 +++ icasdk/model/project_permission_list_v4.pyi | 110 +++ icasdk/model/project_permission_v4.py | 385 +++++++++ icasdk/model/project_permission_v4.pyi | 377 +++++++++ icasdk/model/sample_creation_batch.py | 38 +- icasdk/model/sample_creation_batch.pyi | 38 +- icasdk/model/settings.py | 73 ++ icasdk/model/settings.pyi | 73 ++ icasdk/model/string_settings.py | 100 +++ icasdk/model/string_settings.pyi | 100 +++ icasdk/model/system_info.py | 95 +++ icasdk/model/system_info.pyi | 95 +++ icasdk/model/tag_update.py | 136 ++++ icasdk/model/tag_update.pyi | 136 ++++ icasdk/model/terms_of_use_acceptance.py | 127 +++ icasdk/model/terms_of_use_acceptance.pyi | 127 +++ icasdk/models/__init__.py | 20 + icasdk/paths/__init__.py | 14 + .../__init__.py | 7 + .../get.py | 326 ++++++++ .../get.pyi | 316 ++++++++ .../__init__.py | 7 + .../post.py | 323 ++++++++ .../post.pyi | 313 ++++++++ .../__init__.py | 7 + .../api_pipelines_pipeline_id_files/get.py | 326 ++++++++ .../api_pipelines_pipeline_id_files/get.pyi | 316 ++++++++ .../__init__.py | 7 + .../get.py | 349 +++++++++ .../get.pyi | 334 ++++++++ .../post.py | 41 +- .../post.pyi | 41 +- .../__init__.py | 7 + .../post.py | 385 +++++++++ .../post.pyi | 375 +++++++++ .../__init__.py | 7 + .../get.py | 335 ++++++++ .../get.pyi | 325 ++++++++ .../__init__.py | 7 + .../get.py | 487 ++++++++++++ .../get.pyi | 466 +++++++++++ .../__init__.py | 7 + .../get.py | 344 +++++++++ .../get.pyi | 334 ++++++++ .../get.py | 6 + .../get.pyi | 6 + .../post.py | 44 +- .../post.pyi | 44 +- .../get.py | 6 + .../get.pyi | 6 + .../put.py | 43 +- .../put.pyi | 43 +- .../__init__.py | 7 + .../get.py | 335 ++++++++ .../get.pyi | 325 ++++++++ .../post.py | 388 ++++++++++ .../post.pyi | 378 +++++++++ .../__init__.py | 7 + .../delete.py | 341 ++++++++ .../delete.pyi | 331 ++++++++ .../__init__.py | 7 + .../get.py | 358 +++++++++ .../get.pyi | 343 ++++++++ .../put.py | 394 ++++++++++ .../put.pyi | 384 +++++++++ .../__init__.py | 7 + .../get.py | 470 +++++++++++ .../get.pyi | 460 +++++++++++ .../__init__.py | 7 + .../get.py | 341 ++++++++ .../get.pyi | 326 ++++++++ icasdk/paths/api_system_info/__init__.py | 7 + icasdk/paths/api_system_info/get.py | 272 +++++++ icasdk/paths/api_system_info/get.pyi | 262 +++++++ sample/sample.py | 92 ++- test-requirements.txt | 1 - test/test_integration/test_projects.py | 41 + .../test_create_project_data_update_batch.py | 25 + .../test_create_project_permission_v4.py | 25 + test/test_models/test_data_update_group.py | 25 + test/test_models/test_integer_settings.py | 25 + test/test_models/test_option_settings.py | 25 + test/test_models/test_pipeline_file.py | 25 + .../test_pipeline_file_content_spec.py | 25 + test/test_models/test_pipeline_file_list.py | 25 + .../test_project_data_update_batch.py | 25 + .../test_project_data_update_batch_item.py | 25 + ...oject_data_update_batch_item_paged_list.py | 25 + ...oject_data_update_batch_item_processing.py | 25 + ..._project_data_update_batch_item_request.py | 25 + .../test_project_permission_list_v4.py | 25 + .../test_models/test_project_permission_v4.py | 25 + test/test_models/test_settings.py | 25 + test/test_models/test_string_settings.py | 25 + test/test_models/test_system_info.py | 25 + test/test_models/test_tag_update.py | 25 + .../test_terms_of_use_acceptance.py | 25 + .../__init__.py | 0 .../test_get.py | 41 + .../__init__.py | 0 .../test_post.py | 41 + .../__init__.py | 0 .../test_get.py | 41 + .../__init__.py | 0 .../test_get.py | 41 + .../test_post.py | 4 - .../__init__.py | 0 .../test_post.py | 45 ++ .../__init__.py | 0 .../test_get.py | 41 + .../__init__.py | 0 .../test_get.py | 41 + .../__init__.py | 0 .../test_get.py | 41 + .../test_get.py | 2 + .../test_post.py | 4 + .../test_get.py | 2 + .../test_put.py | 4 + .../__init__.py | 0 .../test_get.py | 41 + .../test_post.py | 41 + .../__init__.py | 0 .../test_delete.py | 41 + .../__init__.py | 0 .../test_get.py | 41 + .../test_put.py | 41 + .../__init__.py | 0 .../test_get.py | 41 + .../__init__.py | 0 .../test_get.py | 41 + .../test_api_system_info/__init__.py | 0 .../test_api_system_info/test_get.py | 41 + 248 files changed, 22304 insertions(+), 575 deletions(-) create mode 100644 docs/apis/tags/ProjectDataUpdateBatchApi.md create mode 100644 docs/apis/tags/SequencingRunApi.md create mode 100644 docs/apis/tags/SystemApi.md create mode 100644 docs/models/CreateProjectDataUpdateBatch.md create mode 100644 docs/models/CreateProjectPermissionV4.md create mode 100644 docs/models/DataUpdateGroup.md create mode 100644 docs/models/IntegerSettings.md create mode 100644 docs/models/OptionSettings.md create mode 100644 docs/models/PipelineFile.md create mode 100644 docs/models/PipelineFileContentSpec.md create mode 100644 docs/models/PipelineFileList.md create mode 100644 docs/models/ProjectDataUpdateBatch.md create mode 100644 docs/models/ProjectDataUpdateBatchItem.md create mode 100644 docs/models/ProjectDataUpdateBatchItemPagedList.md create mode 100644 docs/models/ProjectDataUpdateBatchItemProcessing.md create mode 100644 docs/models/ProjectDataUpdateBatchItemRequest.md create mode 100644 docs/models/ProjectPermissionListV4.md create mode 100644 docs/models/ProjectPermissionV4.md create mode 100644 docs/models/Settings.md create mode 100644 docs/models/StringSettings.md create mode 100644 docs/models/SystemInfo.md create mode 100644 docs/models/TagUpdate.md create mode 100644 docs/models/TermsOfUseAcceptance.md create mode 100644 icasdk/apis/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user.py create mode 100644 icasdk/apis/paths/api_bundles_bundle_id_terms_of_useaccept.py create mode 100644 icasdk/apis/paths/api_pipelines_pipeline_id_files.py create mode 100644 icasdk/apis/paths/api_pipelines_pipeline_id_files_file_id_content.py create mode 100644 icasdk/apis/paths/api_projects_project_id_data_update_batch.py create mode 100644 icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id.py create mode 100644 icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id_items.py create mode 100644 icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id.py create mode 100644 icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files.py create mode 100644 icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id.py create mode 100644 icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content.py create mode 100644 icasdk/apis/paths/api_projects_project_id_samples_sample_id_analyses.py create mode 100644 icasdk/apis/paths/api_sequencing_runs_sequencing_run_id.py create mode 100644 icasdk/apis/paths/api_system_info.py create mode 100644 icasdk/apis/tags/project_data_update_batch_api.py create mode 100644 icasdk/apis/tags/sequencing_run_api.py create mode 100644 icasdk/apis/tags/system_api.py create mode 100644 icasdk/model/create_project_data_update_batch.py create mode 100644 icasdk/model/create_project_data_update_batch.pyi create mode 100644 icasdk/model/create_project_permission_v4.py create mode 100644 icasdk/model/create_project_permission_v4.pyi create mode 100644 icasdk/model/data_update_group.py create mode 100644 icasdk/model/data_update_group.pyi create mode 100644 icasdk/model/integer_settings.py create mode 100644 icasdk/model/integer_settings.pyi create mode 100644 icasdk/model/option_settings.py create mode 100644 icasdk/model/option_settings.pyi create mode 100644 icasdk/model/pipeline_file.py create mode 100644 icasdk/model/pipeline_file.pyi create mode 100644 icasdk/model/pipeline_file_content_spec.py create mode 100644 icasdk/model/pipeline_file_content_spec.pyi create mode 100644 icasdk/model/pipeline_file_list.py create mode 100644 icasdk/model/pipeline_file_list.pyi create mode 100644 icasdk/model/project_data_update_batch.py create mode 100644 icasdk/model/project_data_update_batch.pyi create mode 100644 icasdk/model/project_data_update_batch_item.py create mode 100644 icasdk/model/project_data_update_batch_item.pyi create mode 100644 icasdk/model/project_data_update_batch_item_paged_list.py create mode 100644 icasdk/model/project_data_update_batch_item_paged_list.pyi create mode 100644 icasdk/model/project_data_update_batch_item_processing.py create mode 100644 icasdk/model/project_data_update_batch_item_processing.pyi create mode 100644 icasdk/model/project_data_update_batch_item_request.py create mode 100644 icasdk/model/project_data_update_batch_item_request.pyi create mode 100644 icasdk/model/project_permission_list_v4.py create mode 100644 icasdk/model/project_permission_list_v4.pyi create mode 100644 icasdk/model/project_permission_v4.py create mode 100644 icasdk/model/project_permission_v4.pyi create mode 100644 icasdk/model/settings.py create mode 100644 icasdk/model/settings.pyi create mode 100644 icasdk/model/string_settings.py create mode 100644 icasdk/model/string_settings.pyi create mode 100644 icasdk/model/system_info.py create mode 100644 icasdk/model/system_info.pyi create mode 100644 icasdk/model/tag_update.py create mode 100644 icasdk/model/tag_update.pyi create mode 100644 icasdk/model/terms_of_use_acceptance.py create mode 100644 icasdk/model/terms_of_use_acceptance.pyi create mode 100644 icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/__init__.py create mode 100644 icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/get.py create mode 100644 icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/get.pyi create mode 100644 icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/__init__.py create mode 100644 icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/post.py create mode 100644 icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/post.pyi create mode 100644 icasdk/paths/api_pipelines_pipeline_id_files/__init__.py create mode 100644 icasdk/paths/api_pipelines_pipeline_id_files/get.py create mode 100644 icasdk/paths/api_pipelines_pipeline_id_files/get.pyi create mode 100644 icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/__init__.py create mode 100644 icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/get.py create mode 100644 icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/get.pyi create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch/__init__.py create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch/post.py create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch/post.pyi create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch_batch_id/__init__.py create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch_batch_id/get.py create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch_batch_id/get.pyi create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/__init__.py create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/get.py create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/get.pyi create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/__init__.py create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/get.py create mode 100644 icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/get.pyi create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/__init__.py create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/get.py create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/get.pyi create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/post.py create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/post.pyi create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/__init__.py create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/delete.py create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/delete.pyi create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/__init__.py create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/get.py create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/get.pyi create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/put.py create mode 100644 icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/put.pyi create mode 100644 icasdk/paths/api_projects_project_id_samples_sample_id_analyses/__init__.py create mode 100644 icasdk/paths/api_projects_project_id_samples_sample_id_analyses/get.py create mode 100644 icasdk/paths/api_projects_project_id_samples_sample_id_analyses/get.pyi create mode 100644 icasdk/paths/api_sequencing_runs_sequencing_run_id/__init__.py create mode 100644 icasdk/paths/api_sequencing_runs_sequencing_run_id/get.py create mode 100644 icasdk/paths/api_sequencing_runs_sequencing_run_id/get.pyi create mode 100644 icasdk/paths/api_system_info/__init__.py create mode 100644 icasdk/paths/api_system_info/get.py create mode 100644 icasdk/paths/api_system_info/get.pyi create mode 100755 test/test_integration/test_projects.py create mode 100644 test/test_models/test_create_project_data_update_batch.py create mode 100644 test/test_models/test_create_project_permission_v4.py create mode 100644 test/test_models/test_data_update_group.py create mode 100644 test/test_models/test_integer_settings.py create mode 100644 test/test_models/test_option_settings.py create mode 100644 test/test_models/test_pipeline_file.py create mode 100644 test/test_models/test_pipeline_file_content_spec.py create mode 100644 test/test_models/test_pipeline_file_list.py create mode 100644 test/test_models/test_project_data_update_batch.py create mode 100644 test/test_models/test_project_data_update_batch_item.py create mode 100644 test/test_models/test_project_data_update_batch_item_paged_list.py create mode 100644 test/test_models/test_project_data_update_batch_item_processing.py create mode 100644 test/test_models/test_project_data_update_batch_item_request.py create mode 100644 test/test_models/test_project_permission_list_v4.py create mode 100644 test/test_models/test_project_permission_v4.py create mode 100644 test/test_models/test_settings.py create mode 100644 test/test_models/test_string_settings.py create mode 100644 test/test_models/test_system_info.py create mode 100644 test/test_models/test_tag_update.py create mode 100644 test/test_models/test_terms_of_use_acceptance.py create mode 100644 test/test_paths/test_api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/__init__.py create mode 100644 test/test_paths/test_api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/test_get.py create mode 100644 test/test_paths/test_api_bundles_bundle_id_terms_of_useaccept/__init__.py create mode 100644 test/test_paths/test_api_bundles_bundle_id_terms_of_useaccept/test_post.py create mode 100644 test/test_paths/test_api_pipelines_pipeline_id_files/__init__.py create mode 100644 test/test_paths/test_api_pipelines_pipeline_id_files/test_get.py create mode 100644 test/test_paths/test_api_pipelines_pipeline_id_files_file_id_content/__init__.py create mode 100644 test/test_paths/test_api_pipelines_pipeline_id_files_file_id_content/test_get.py create mode 100644 test/test_paths/test_api_projects_project_id_data_update_batch/__init__.py create mode 100644 test/test_paths/test_api_projects_project_id_data_update_batch/test_post.py create mode 100644 test/test_paths/test_api_projects_project_id_data_update_batch_batch_id/__init__.py create mode 100644 test/test_paths/test_api_projects_project_id_data_update_batch_batch_id/test_get.py create mode 100644 test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items/__init__.py create mode 100644 test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items/test_get.py create mode 100644 test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items_item_id/__init__.py create mode 100644 test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items_item_id/test_get.py create mode 100644 test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/__init__.py create mode 100644 test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/test_get.py create mode 100644 test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/test_post.py create mode 100644 test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id/__init__.py create mode 100644 test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id/test_delete.py create mode 100644 test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/__init__.py create mode 100644 test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/test_get.py create mode 100644 test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/test_put.py create mode 100644 test/test_paths/test_api_projects_project_id_samples_sample_id_analyses/__init__.py create mode 100644 test/test_paths/test_api_projects_project_id_samples_sample_id_analyses/test_get.py create mode 100644 test/test_paths/test_api_sequencing_runs_sequencing_run_id/__init__.py create mode 100644 test/test_paths/test_api_sequencing_runs_sequencing_run_id/test_get.py create mode 100644 test/test_paths/test_api_system_info/__init__.py create mode 100644 test/test_paths/test_api_system_info/test_get.py diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index c3aac5c..03ffe27 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -28,6 +28,7 @@ docs/apis/tags/ProjectCustomNotificationSubscriptionsApi.md docs/apis/tags/ProjectDataApi.md docs/apis/tags/ProjectDataLinkingBatchApi.md docs/apis/tags/ProjectDataTransferApi.md +docs/apis/tags/ProjectDataUpdateBatchApi.md docs/apis/tags/ProjectNotificationSubscriptionsApi.md docs/apis/tags/ProjectPermissionApi.md docs/apis/tags/ProjectPipelineApi.md @@ -36,9 +37,11 @@ docs/apis/tags/ProjectSampleBatchApi.md docs/apis/tags/ReferenceSetApi.md docs/apis/tags/RegionApi.md docs/apis/tags/SampleApi.md +docs/apis/tags/SequencingRunApi.md docs/apis/tags/StorageBundleApi.md docs/apis/tags/StorageConfigurationApi.md docs/apis/tags/StorageCredentialsApi.md +docs/apis/tags/SystemApi.md docs/apis/tags/TokenApi.md docs/apis/tags/UserApi.md docs/apis/tags/WorkgroupApi.md @@ -111,7 +114,9 @@ docs/models/CreateNotificationSubscription.md docs/models/CreateProject.md docs/models/CreateProjectDataLinkingBatch.md docs/models/CreateProjectDataLinkingBatchItem.md +docs/models/CreateProjectDataUpdateBatch.md docs/models/CreateProjectPermission.md +docs/models/CreateProjectPermissionV4.md docs/models/CreateSample.md docs/models/CreateSampleCreationBatch.md docs/models/CreateSampleCreationBatchDataItem.md @@ -139,6 +144,7 @@ docs/models/DataPagedList.md docs/models/DataTag.md docs/models/DataTransfer.md docs/models/DataTransferPagedList.md +docs/models/DataUpdateGroup.md docs/models/DataUrlWithPath.md docs/models/DataUrlWithPathList.md docs/models/Download.md @@ -163,6 +169,7 @@ docs/models/InlineView.md docs/models/InputParameter.md docs/models/InputParameterList.md docs/models/InputPart.md +docs/models/IntegerSettings.md docs/models/Job.md docs/models/JobPagedList.md docs/models/Link.md @@ -178,11 +185,15 @@ docs/models/NotificationChannel.md docs/models/NotificationChannelList.md docs/models/NotificationSubscription.md docs/models/NotificationSubscriptionList.md +docs/models/OptionSettings.md docs/models/OptionalSampleTags.md docs/models/Pipeline.md docs/models/PipelineBundle.md docs/models/PipelineConfigurationParameter.md docs/models/PipelineConfigurationParameterList.md +docs/models/PipelineFile.md +docs/models/PipelineFileContentSpec.md +docs/models/PipelineFileList.md docs/models/PipelineHtmlDocumentation.md docs/models/PipelineLanguageVersion.md docs/models/PipelineLanguageVersionList.md @@ -201,10 +212,17 @@ docs/models/ProjectDataLinkingBatchItemPagedList.md docs/models/ProjectDataLinkingBatchItemProcessing.md docs/models/ProjectDataLinkingBatchItemRequest.md docs/models/ProjectDataPagedList.md +docs/models/ProjectDataUpdateBatch.md +docs/models/ProjectDataUpdateBatchItem.md +docs/models/ProjectDataUpdateBatchItemPagedList.md +docs/models/ProjectDataUpdateBatchItemProcessing.md +docs/models/ProjectDataUpdateBatchItemRequest.md docs/models/ProjectList.md docs/models/ProjectPagedList.md docs/models/ProjectPermission.md docs/models/ProjectPermissionList.md +docs/models/ProjectPermissionListV4.md +docs/models/ProjectPermissionV4.md docs/models/ProjectPipeline.md docs/models/ProjectPipelineList.md docs/models/ProjectSample.md @@ -231,6 +249,7 @@ docs/models/ScheduleDownload.md docs/models/SearchMatchingActivationCodesForCwlAnalysis.md docs/models/SearchMatchingActivationCodesForNextflowAnalysis.md docs/models/SequencingRun.md +docs/models/Settings.md docs/models/Species.md docs/models/SpeciesList.md docs/models/StorageBundle.md @@ -241,8 +260,12 @@ docs/models/StorageConfigurationWithDetails.md docs/models/StorageConfigurationWithDetailsList.md docs/models/StorageCredential.md docs/models/StorageCredentialList.md +docs/models/StringSettings.md +docs/models/SystemInfo.md +docs/models/TagUpdate.md docs/models/TempCredentials.md docs/models/TermsOfUse.md +docs/models/TermsOfUseAcceptance.md docs/models/Token.md docs/models/Type.md docs/models/TypeList.md @@ -290,6 +313,7 @@ icasdk/apis/tags/project_custom_notification_subscriptions_api.py icasdk/apis/tags/project_data_api.py icasdk/apis/tags/project_data_linking_batch_api.py icasdk/apis/tags/project_data_transfer_api.py +icasdk/apis/tags/project_data_update_batch_api.py icasdk/apis/tags/project_notification_subscriptions_api.py icasdk/apis/tags/project_permission_api.py icasdk/apis/tags/project_pipeline_api.py @@ -298,9 +322,11 @@ icasdk/apis/tags/project_sample_batch_api.py icasdk/apis/tags/reference_set_api.py icasdk/apis/tags/region_api.py icasdk/apis/tags/sample_api.py +icasdk/apis/tags/sequencing_run_api.py icasdk/apis/tags/storage_bundle_api.py icasdk/apis/tags/storage_configuration_api.py icasdk/apis/tags/storage_credentials_api.py +icasdk/apis/tags/system_api.py icasdk/apis/tags/token_api.py icasdk/apis/tags/user_api.py icasdk/apis/tags/workgroup_api.py @@ -443,8 +469,12 @@ icasdk/model/create_project_data_linking_batch.py icasdk/model/create_project_data_linking_batch.pyi icasdk/model/create_project_data_linking_batch_item.py icasdk/model/create_project_data_linking_batch_item.pyi +icasdk/model/create_project_data_update_batch.py +icasdk/model/create_project_data_update_batch.pyi icasdk/model/create_project_permission.py icasdk/model/create_project_permission.pyi +icasdk/model/create_project_permission_v4.py +icasdk/model/create_project_permission_v4.pyi icasdk/model/create_sample.py icasdk/model/create_sample.pyi icasdk/model/create_sample_creation_batch.py @@ -501,6 +531,8 @@ icasdk/model/data_transfer.py icasdk/model/data_transfer.pyi icasdk/model/data_transfer_paged_list.py icasdk/model/data_transfer_paged_list.pyi +icasdk/model/data_update_group.py +icasdk/model/data_update_group.pyi icasdk/model/data_url_with_path.py icasdk/model/data_url_with_path.pyi icasdk/model/data_url_with_path_list.py @@ -549,6 +581,8 @@ icasdk/model/input_parameter_list.py icasdk/model/input_parameter_list.pyi icasdk/model/input_part.py icasdk/model/input_part.pyi +icasdk/model/integer_settings.py +icasdk/model/integer_settings.pyi icasdk/model/job.py icasdk/model/job.pyi icasdk/model/job_paged_list.py @@ -579,6 +613,8 @@ icasdk/model/notification_subscription.py icasdk/model/notification_subscription.pyi icasdk/model/notification_subscription_list.py icasdk/model/notification_subscription_list.pyi +icasdk/model/option_settings.py +icasdk/model/option_settings.pyi icasdk/model/optional_sample_tags.py icasdk/model/optional_sample_tags.pyi icasdk/model/pipeline.py @@ -589,6 +625,12 @@ icasdk/model/pipeline_configuration_parameter.py icasdk/model/pipeline_configuration_parameter.pyi icasdk/model/pipeline_configuration_parameter_list.py icasdk/model/pipeline_configuration_parameter_list.pyi +icasdk/model/pipeline_file.py +icasdk/model/pipeline_file.pyi +icasdk/model/pipeline_file_content_spec.py +icasdk/model/pipeline_file_content_spec.pyi +icasdk/model/pipeline_file_list.py +icasdk/model/pipeline_file_list.pyi icasdk/model/pipeline_html_documentation.py icasdk/model/pipeline_html_documentation.pyi icasdk/model/pipeline_language_version.py @@ -625,6 +667,16 @@ icasdk/model/project_data_linking_batch_item_request.py icasdk/model/project_data_linking_batch_item_request.pyi icasdk/model/project_data_paged_list.py icasdk/model/project_data_paged_list.pyi +icasdk/model/project_data_update_batch.py +icasdk/model/project_data_update_batch.pyi +icasdk/model/project_data_update_batch_item.py +icasdk/model/project_data_update_batch_item.pyi +icasdk/model/project_data_update_batch_item_paged_list.py +icasdk/model/project_data_update_batch_item_paged_list.pyi +icasdk/model/project_data_update_batch_item_processing.py +icasdk/model/project_data_update_batch_item_processing.pyi +icasdk/model/project_data_update_batch_item_request.py +icasdk/model/project_data_update_batch_item_request.pyi icasdk/model/project_list.py icasdk/model/project_list.pyi icasdk/model/project_paged_list.py @@ -633,6 +685,10 @@ icasdk/model/project_permission.py icasdk/model/project_permission.pyi icasdk/model/project_permission_list.py icasdk/model/project_permission_list.pyi +icasdk/model/project_permission_list_v4.py +icasdk/model/project_permission_list_v4.pyi +icasdk/model/project_permission_v4.py +icasdk/model/project_permission_v4.pyi icasdk/model/project_pipeline.py icasdk/model/project_pipeline.pyi icasdk/model/project_pipeline_list.py @@ -685,6 +741,8 @@ icasdk/model/search_matching_activation_codes_for_nextflow_analysis.py icasdk/model/search_matching_activation_codes_for_nextflow_analysis.pyi icasdk/model/sequencing_run.py icasdk/model/sequencing_run.pyi +icasdk/model/settings.py +icasdk/model/settings.pyi icasdk/model/species.py icasdk/model/species.pyi icasdk/model/species_list.py @@ -705,10 +763,18 @@ icasdk/model/storage_credential.py icasdk/model/storage_credential.pyi icasdk/model/storage_credential_list.py icasdk/model/storage_credential_list.pyi +icasdk/model/string_settings.py +icasdk/model/string_settings.pyi +icasdk/model/system_info.py +icasdk/model/system_info.pyi +icasdk/model/tag_update.py +icasdk/model/tag_update.pyi icasdk/model/temp_credentials.py icasdk/model/temp_credentials.pyi icasdk/model/terms_of_use.py icasdk/model/terms_of_use.pyi +icasdk/model/terms_of_use_acceptance.py +icasdk/model/terms_of_use_acceptance.pyi icasdk/model/token.py icasdk/model/token.pyi icasdk/model/type.py @@ -751,8 +817,23 @@ setup.py test-requirements.txt test/__init__.py test/test_models/__init__.py -test/test_models/test_analysis_external_data.py -test/test_models/test_analysis_input_external_data.py -test/test_models/test_analysis_s3_data_details.py -test/test_models/test_pipeline_configuration_parameter.py -test/test_models/test_pipeline_configuration_parameter_list.py +test/test_models/test_create_project_data_update_batch.py +test/test_models/test_create_project_permission_v4.py +test/test_models/test_data_update_group.py +test/test_models/test_integer_settings.py +test/test_models/test_option_settings.py +test/test_models/test_pipeline_file.py +test/test_models/test_pipeline_file_content_spec.py +test/test_models/test_pipeline_file_list.py +test/test_models/test_project_data_update_batch.py +test/test_models/test_project_data_update_batch_item.py +test/test_models/test_project_data_update_batch_item_paged_list.py +test/test_models/test_project_data_update_batch_item_processing.py +test/test_models/test_project_data_update_batch_item_request.py +test/test_models/test_project_permission_list_v4.py +test/test_models/test_project_permission_v4.py +test/test_models/test_settings.py +test/test_models/test_string_settings.py +test/test_models/test_system_info.py +test/test_models/test_tag_update.py +test/test_models/test_terms_of_use_acceptance.py diff --git a/README.md b/README.md index 6e18faa..2714e21 100644 --- a/README.md +++ b/README.md @@ -182,11 +182,13 @@ All URIs are relative to */ica/rest* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AnalysisStorageApi* | [**get_analysis_storage_options**](docs/apis/tags/AnalysisStorageApi.md#get_analysis_storage_options) | **get** /api/analysisStorages | Retrieve the list of analysis storage options. +*BundleApi* | [**accept_terms_of_use_bundle**](docs/apis/tags/BundleApi.md#accept_terms_of_use_bundle) | **post** /api/bundles/{bundleId}/termsOfUse:accept | accept terms of use for a bundle *BundleApi* | [**create_bundle**](docs/apis/tags/BundleApi.md#create_bundle) | **post** /api/bundles | Create a new bundle *BundleApi* | [**deprecate_bundle**](docs/apis/tags/BundleApi.md#deprecate_bundle) | **post** /api/bundles/{bundleId}:deprecate | deprecate a bundle *BundleApi* | [**get_bundle**](docs/apis/tags/BundleApi.md#get_bundle) | **get** /api/bundles/{bundleId} | Retrieve a bundle. *BundleApi* | [**get_bundle_terms_of_use**](docs/apis/tags/BundleApi.md#get_bundle_terms_of_use) | **get** /api/bundles/{bundleId}/termsOfUse | Retrieve the last version of terms of use for a bundle. *BundleApi* | [**get_bundles**](docs/apis/tags/BundleApi.md#get_bundles) | **get** /api/bundles | Retrieve a list of bundles. +*BundleApi* | [**get_terms_of_use_acceptance**](docs/apis/tags/BundleApi.md#get_terms_of_use_acceptance) | **get** /api/bundles/{bundleId}/termsOfUse/userAcceptance/currentUser | Retrieve the acceptance record for a bundle for the current user. *BundleApi* | [**insert_bundle_terms_of_use**](docs/apis/tags/BundleApi.md#insert_bundle_terms_of_use) | **post** /api/bundles/{bundleId}/termsOfUse:new | Insert a new version of the terms of use for a bundle *BundleApi* | [**release_bundle**](docs/apis/tags/BundleApi.md#release_bundle) | **post** /api/bundles/{bundleId}:release | release a bundle *BundleDataApi* | [**get_bundle_data**](docs/apis/tags/BundleDataApi.md#get_bundle_data) | **get** /api/bundles/{bundleId}/data | Retrieve the list of bundle data. @@ -241,8 +243,10 @@ Class | Method | HTTP request | Description *NotificationChannelApi* | [**get_notification_channel**](docs/apis/tags/NotificationChannelApi.md#get_notification_channel) | **get** /api/notificationChannels/{channelId} | Retrieve a notification channel *NotificationChannelApi* | [**get_notification_channels**](docs/apis/tags/NotificationChannelApi.md#get_notification_channels) | **get** /api/notificationChannels | Retrieve notification channels *NotificationChannelApi* | [**update_notification_channel**](docs/apis/tags/NotificationChannelApi.md#update_notification_channel) | **put** /api/notificationChannels/{channelId} | Update a notification channel +*PipelineApi* | [**download_pipeline_file_content**](docs/apis/tags/PipelineApi.md#download_pipeline_file_content) | **get** /api/pipelines/{pipelineId}/files/{fileId}/content | Download the contents of a pipeline file. *PipelineApi* | [**get_pipeline**](docs/apis/tags/PipelineApi.md#get_pipeline) | **get** /api/pipelines/{pipelineId} | Retrieve a pipeline. *PipelineApi* | [**get_pipeline_configuration_parameters**](docs/apis/tags/PipelineApi.md#get_pipeline_configuration_parameters) | **get** /api/pipelines/{pipelineId}/configurationParameters | Retrieve configuration parameters for a pipeline. +*PipelineApi* | [**get_pipeline_files**](docs/apis/tags/PipelineApi.md#get_pipeline_files) | **get** /api/pipelines/{pipelineId}/files | Retrieve files for a pipeline. *PipelineApi* | [**get_pipeline_html_documentation**](docs/apis/tags/PipelineApi.md#get_pipeline_html_documentation) | **get** /api/pipelines/{pipelineId}/documentation/HTML | Retrieve HTML documentation for a project pipeline. *PipelineApi* | [**get_pipeline_input_parameters**](docs/apis/tags/PipelineApi.md#get_pipeline_input_parameters) | **get** /api/pipelines/{pipelineId}/inputParameters | Retrieve input parameters for a pipeline. *PipelineApi* | [**get_pipeline_reference_sets**](docs/apis/tags/PipelineApi.md#get_pipeline_reference_sets) | **get** /api/pipelines/{pipelineId}/referenceSets | Retrieve the reference sets of a pipeline. @@ -317,6 +321,10 @@ Class | Method | HTTP request | Description *ProjectDataTransferApi* | [**abort_data_transfer**](docs/apis/tags/ProjectDataTransferApi.md#abort_data_transfer) | **post** /api/projects/{projectId}/dataTransfers/{dataTransferId}:abort | Abort a data transfer. *ProjectDataTransferApi* | [**get_data_transfer**](docs/apis/tags/ProjectDataTransferApi.md#get_data_transfer) | **get** /api/projects/{projectId}/dataTransfers/{dataTransferId} | Retrieve a data transfer. *ProjectDataTransferApi* | [**get_data_transfers**](docs/apis/tags/ProjectDataTransferApi.md#get_data_transfers) | **get** /api/projects/{projectId}/dataTransfers | Retrieve a list of data transfers. +*ProjectDataUpdateBatchApi* | [**create_project_data_update_batch**](docs/apis/tags/ProjectDataUpdateBatchApi.md#create_project_data_update_batch) | **post** /api/projects/{projectId}/dataUpdateBatch | Create a project data update batch. +*ProjectDataUpdateBatchApi* | [**get_project_data_update_batch**](docs/apis/tags/ProjectDataUpdateBatchApi.md#get_project_data_update_batch) | **get** /api/projects/{projectId}/dataUpdateBatch/{batchId} | Retrieve a project data update batch. +*ProjectDataUpdateBatchApi* | [**get_project_data_update_batch_item**](docs/apis/tags/ProjectDataUpdateBatchApi.md#get_project_data_update_batch_item) | **get** /api/projects/{projectId}/dataUpdateBatch/{batchId}/items/{itemId} | Retrieve a project data update batch item. +*ProjectDataUpdateBatchApi* | [**get_project_data_update_batch_items**](docs/apis/tags/ProjectDataUpdateBatchApi.md#get_project_data_update_batch_items) | **get** /api/projects/{projectId}/dataUpdateBatch/{batchId}/items | Retrieve a list of project data update batch items. *ProjectNotificationSubscriptionsApi* | [**create_notification_subscription1**](docs/apis/tags/ProjectNotificationSubscriptionsApi.md#create_notification_subscription1) | **post** /api/projects/{projectId}/notificationSubscriptions | Create a notification subscription *ProjectNotificationSubscriptionsApi* | [**delete_notification_subscription1**](docs/apis/tags/ProjectNotificationSubscriptionsApi.md#delete_notification_subscription1) | **delete** /api/projects/{projectId}/notificationSubscriptions/{subscriptionId} | Delete a notification subscription *ProjectNotificationSubscriptionsApi* | [**get_notification_subscription1**](docs/apis/tags/ProjectNotificationSubscriptionsApi.md#get_notification_subscription1) | **get** /api/projects/{projectId}/notificationSubscriptions/{subscriptionId} | Retrieve a notification subscription @@ -328,6 +336,10 @@ Class | Method | HTTP request | Description *ProjectPermissionApi* | [**update_project_permission**](docs/apis/tags/ProjectPermissionApi.md#update_project_permission) | **put** /api/projects/{projectId}/permissions/{permissionId} | Update a project permission. *ProjectPipelineApi* | [**create_cwl_pipeline**](docs/apis/tags/ProjectPipelineApi.md#create_cwl_pipeline) | **post** /api/projects/{projectId}/pipelines:createCwlPipeline | Create a CWL pipeline within a project. *ProjectPipelineApi* | [**create_nextflow_pipeline**](docs/apis/tags/ProjectPipelineApi.md#create_nextflow_pipeline) | **post** /api/projects/{projectId}/pipelines:createNextflowPipeline | Create a Nextflow pipeline within a project. +*ProjectPipelineApi* | [**create_pipeline_file**](docs/apis/tags/ProjectPipelineApi.md#create_pipeline_file) | **post** /api/projects/{projectId}/pipelines/{pipelineId}/files | Create a file for a pipeline. +*ProjectPipelineApi* | [**delete_pipeline_file**](docs/apis/tags/ProjectPipelineApi.md#delete_pipeline_file) | **delete** /api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId} | Delete a file for a pipeline. +*ProjectPipelineApi* | [**download_pipeline_file_content1**](docs/apis/tags/ProjectPipelineApi.md#download_pipeline_file_content1) | **get** /api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}/content | Download the contents of a pipeline file. +*ProjectPipelineApi* | [**get_pipeline_files1**](docs/apis/tags/ProjectPipelineApi.md#get_pipeline_files1) | **get** /api/projects/{projectId}/pipelines/{pipelineId}/files | Retrieve files for a project pipeline. *ProjectPipelineApi* | [**get_project_pipeline**](docs/apis/tags/ProjectPipelineApi.md#get_project_pipeline) | **get** /api/projects/{projectId}/pipelines/{pipelineId} | Retrieve a project pipeline. *ProjectPipelineApi* | [**get_project_pipeline_configuration_parameters**](docs/apis/tags/ProjectPipelineApi.md#get_project_pipeline_configuration_parameters) | **get** /api/projects/{projectId}/pipelines/{pipelineId}/configurationParameters | Retrieve configuration parameters for a project pipeline. *ProjectPipelineApi* | [**get_project_pipeline_html_documentation**](docs/apis/tags/ProjectPipelineApi.md#get_project_pipeline_html_documentation) | **get** /api/projects/{projectId}/pipelines/{pipelineId}/documentation/HTML | Retrieve HTML documentation for a project pipeline. @@ -337,6 +349,7 @@ Class | Method | HTTP request | Description *ProjectPipelineApi* | [**link_pipeline_to_project**](docs/apis/tags/ProjectPipelineApi.md#link_pipeline_to_project) | **post** /api/projects/{projectId}/pipelines/{pipelineId} | Link a pipeline to a project. *ProjectPipelineApi* | [**release_pipeline**](docs/apis/tags/ProjectPipelineApi.md#release_pipeline) | **post** /api/projects/{projectId}/pipelines/{pipelineId}:release | Release a pipeline. *ProjectPipelineApi* | [**unlink_pipeline_from_project**](docs/apis/tags/ProjectPipelineApi.md#unlink_pipeline_from_project) | **delete** /api/projects/{projectId}/pipelines/{pipelineId} | Unlink a pipeline from a project. +*ProjectPipelineApi* | [**update_pipeline_file**](docs/apis/tags/ProjectPipelineApi.md#update_pipeline_file) | **put** /api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}/content | Update the contents of a file for a pipeline. *ProjectSampleApi* | [**add_metadata_model_to_sample**](docs/apis/tags/ProjectSampleApi.md#add_metadata_model_to_sample) | **post** /api/projects/{projectId}/samples/{sampleId}/metadata/{metadataModelId} | Add a metadata model to a sample. *ProjectSampleApi* | [**complete_project_sample**](docs/apis/tags/ProjectSampleApi.md#complete_project_sample) | **post** /api/projects/{projectId}/samples/{sampleId}:complete | Completes the sample after data has been linked to it. *ProjectSampleApi* | [**create_sample_in_project**](docs/apis/tags/ProjectSampleApi.md#create_sample_in_project) | **post** /api/projects/{projectId}/samples | Create a new sample in this project @@ -344,6 +357,7 @@ Class | Method | HTTP request | Description *ProjectSampleApi* | [**delete_and_unlink_sample**](docs/apis/tags/ProjectSampleApi.md#delete_and_unlink_sample) | **post** /api/projects/{projectId}/samples/{sampleId}:deleteUnlink | Delete a sample and unlink its data. *ProjectSampleApi* | [**delete_sample_with_input**](docs/apis/tags/ProjectSampleApi.md#delete_sample_with_input) | **post** /api/projects/{projectId}/samples/{sampleId}:deleteWithInput | Delete a sample as well as its input data. *ProjectSampleApi* | [**get_project_sample**](docs/apis/tags/ProjectSampleApi.md#get_project_sample) | **get** /api/projects/{projectId}/samples/{sampleId} | Retrieve a project sample. +*ProjectSampleApi* | [**get_project_sample_analyses**](docs/apis/tags/ProjectSampleApi.md#get_project_sample_analyses) | **get** /api/projects/{projectId}/samples/{sampleId}/analyses | Retrieve the list of analyses. *ProjectSampleApi* | [**get_project_samples**](docs/apis/tags/ProjectSampleApi.md#get_project_samples) | **post** /api/projects/{projectId}/samples:search | Retrieve project samples. *ProjectSampleApi* | [**get_projects_for_sample**](docs/apis/tags/ProjectSampleApi.md#get_projects_for_sample) | **get** /api/projects/{projectId}/samples/{sampleId}/projects | Retrieve a list of projects for this sample. *ProjectSampleApi* | [**get_sample_data_list**](docs/apis/tags/ProjectSampleApi.md#get_sample_data_list) | **get** /api/projects/{projectId}/samples/{sampleId}/data | Retrieve the list of sample data. @@ -366,6 +380,7 @@ Class | Method | HTTP request | Description *RegionApi* | [**get_region**](docs/apis/tags/RegionApi.md#get_region) | **get** /api/regions/{regionId} | Retrieve a region. Only the regions the user has access to through his/her entitlements can be retrieved. *RegionApi* | [**get_regions**](docs/apis/tags/RegionApi.md#get_regions) | **get** /api/regions | Retrieve a list of regions. Only the regions the user has access to through his/her entitlements are returned. *SampleApi* | [**get_samples**](docs/apis/tags/SampleApi.md#get_samples) | **get** /api/samples | Retrieve a list of samples. +*SequencingRunApi* | [**get_sequencing_run**](docs/apis/tags/SequencingRunApi.md#get_sequencing_run) | **get** /api/sequencingRuns/{sequencingRunId} | Retrieve a sequencing run. *StorageBundleApi* | [**get_storage_bundles**](docs/apis/tags/StorageBundleApi.md#get_storage_bundles) | **get** /api/storageBundles | Retrieve a list of storage bundles. *StorageConfigurationApi* | [**create_storage_configuration**](docs/apis/tags/StorageConfigurationApi.md#create_storage_configuration) | **post** /api/storageConfigurations | Create a new storage configuration *StorageConfigurationApi* | [**get_storage_configuration**](docs/apis/tags/StorageConfigurationApi.md#get_storage_configuration) | **get** /api/storageConfigurations/{storageConfigurationId} | Retrieve a storage configuration. @@ -377,6 +392,7 @@ Class | Method | HTTP request | Description *StorageCredentialsApi* | [**get_storage_credentials**](docs/apis/tags/StorageCredentialsApi.md#get_storage_credentials) | **get** /api/storageCredentials | Retrieve a list of storage credentials. *StorageCredentialsApi* | [**share_storage_credential**](docs/apis/tags/StorageCredentialsApi.md#share_storage_credential) | **post** /api/storageCredentials/{storageCredentialId}:share | Share your own storage credentials with tenant. *StorageCredentialsApi* | [**update_storage_credential_secrets**](docs/apis/tags/StorageCredentialsApi.md#update_storage_credential_secrets) | **post** /api/storageCredentials/{storageCredentialId}:updateSecrets | Update a storage credential's secrets. +*SystemApi* | [**get_system_info**](docs/apis/tags/SystemApi.md#get_system_info) | **get** /api/system/info | Retrieve system information. *TokenApi* | [**create_jwt_token**](docs/apis/tags/TokenApi.md#create_jwt_token) | **post** /api/tokens | Generate a JWT using an API-key, Basic Authentication or a psToken. *TokenApi* | [**refresh_jwt_token**](docs/apis/tags/TokenApi.md#refresh_jwt_token) | **post** /api/tokens:refresh | Refresh a JWT using a not yet expired, still valid JWT. *UserApi* | [**approve_user**](docs/apis/tags/UserApi.md#approve_user) | **post** /api/users/{userId}:approve | Approve a user. @@ -459,7 +475,9 @@ Class | Method | HTTP request | Description - [CreateProject](docs/models/CreateProject.md) - [CreateProjectDataLinkingBatch](docs/models/CreateProjectDataLinkingBatch.md) - [CreateProjectDataLinkingBatchItem](docs/models/CreateProjectDataLinkingBatchItem.md) + - [CreateProjectDataUpdateBatch](docs/models/CreateProjectDataUpdateBatch.md) - [CreateProjectPermission](docs/models/CreateProjectPermission.md) + - [CreateProjectPermissionV4](docs/models/CreateProjectPermissionV4.md) - [CreateSample](docs/models/CreateSample.md) - [CreateSampleCreationBatch](docs/models/CreateSampleCreationBatch.md) - [CreateSampleCreationBatchDataItem](docs/models/CreateSampleCreationBatchDataItem.md) @@ -487,6 +505,7 @@ Class | Method | HTTP request | Description - [DataTag](docs/models/DataTag.md) - [DataTransfer](docs/models/DataTransfer.md) - [DataTransferPagedList](docs/models/DataTransferPagedList.md) + - [DataUpdateGroup](docs/models/DataUpdateGroup.md) - [DataUrlWithPath](docs/models/DataUrlWithPath.md) - [DataUrlWithPathList](docs/models/DataUrlWithPathList.md) - [Download](docs/models/Download.md) @@ -511,6 +530,7 @@ Class | Method | HTTP request | Description - [InputParameter](docs/models/InputParameter.md) - [InputParameterList](docs/models/InputParameterList.md) - [InputPart](docs/models/InputPart.md) + - [IntegerSettings](docs/models/IntegerSettings.md) - [Job](docs/models/Job.md) - [JobPagedList](docs/models/JobPagedList.md) - [Link](docs/models/Link.md) @@ -526,11 +546,15 @@ Class | Method | HTTP request | Description - [NotificationChannelList](docs/models/NotificationChannelList.md) - [NotificationSubscription](docs/models/NotificationSubscription.md) - [NotificationSubscriptionList](docs/models/NotificationSubscriptionList.md) + - [OptionSettings](docs/models/OptionSettings.md) - [OptionalSampleTags](docs/models/OptionalSampleTags.md) - [Pipeline](docs/models/Pipeline.md) - [PipelineBundle](docs/models/PipelineBundle.md) - [PipelineConfigurationParameter](docs/models/PipelineConfigurationParameter.md) - [PipelineConfigurationParameterList](docs/models/PipelineConfigurationParameterList.md) + - [PipelineFile](docs/models/PipelineFile.md) + - [PipelineFileContentSpec](docs/models/PipelineFileContentSpec.md) + - [PipelineFileList](docs/models/PipelineFileList.md) - [PipelineHtmlDocumentation](docs/models/PipelineHtmlDocumentation.md) - [PipelineLanguageVersion](docs/models/PipelineLanguageVersion.md) - [PipelineLanguageVersionList](docs/models/PipelineLanguageVersionList.md) @@ -549,10 +573,17 @@ Class | Method | HTTP request | Description - [ProjectDataLinkingBatchItemProcessing](docs/models/ProjectDataLinkingBatchItemProcessing.md) - [ProjectDataLinkingBatchItemRequest](docs/models/ProjectDataLinkingBatchItemRequest.md) - [ProjectDataPagedList](docs/models/ProjectDataPagedList.md) + - [ProjectDataUpdateBatch](docs/models/ProjectDataUpdateBatch.md) + - [ProjectDataUpdateBatchItem](docs/models/ProjectDataUpdateBatchItem.md) + - [ProjectDataUpdateBatchItemPagedList](docs/models/ProjectDataUpdateBatchItemPagedList.md) + - [ProjectDataUpdateBatchItemProcessing](docs/models/ProjectDataUpdateBatchItemProcessing.md) + - [ProjectDataUpdateBatchItemRequest](docs/models/ProjectDataUpdateBatchItemRequest.md) - [ProjectList](docs/models/ProjectList.md) - [ProjectPagedList](docs/models/ProjectPagedList.md) - [ProjectPermission](docs/models/ProjectPermission.md) - [ProjectPermissionList](docs/models/ProjectPermissionList.md) + - [ProjectPermissionListV4](docs/models/ProjectPermissionListV4.md) + - [ProjectPermissionV4](docs/models/ProjectPermissionV4.md) - [ProjectPipeline](docs/models/ProjectPipeline.md) - [ProjectPipelineList](docs/models/ProjectPipelineList.md) - [ProjectSample](docs/models/ProjectSample.md) @@ -579,6 +610,7 @@ Class | Method | HTTP request | Description - [SearchMatchingActivationCodesForCwlAnalysis](docs/models/SearchMatchingActivationCodesForCwlAnalysis.md) - [SearchMatchingActivationCodesForNextflowAnalysis](docs/models/SearchMatchingActivationCodesForNextflowAnalysis.md) - [SequencingRun](docs/models/SequencingRun.md) + - [Settings](docs/models/Settings.md) - [Species](docs/models/Species.md) - [SpeciesList](docs/models/SpeciesList.md) - [StorageBundle](docs/models/StorageBundle.md) @@ -589,8 +621,12 @@ Class | Method | HTTP request | Description - [StorageConfigurationWithDetailsList](docs/models/StorageConfigurationWithDetailsList.md) - [StorageCredential](docs/models/StorageCredential.md) - [StorageCredentialList](docs/models/StorageCredentialList.md) + - [StringSettings](docs/models/StringSettings.md) + - [SystemInfo](docs/models/SystemInfo.md) + - [TagUpdate](docs/models/TagUpdate.md) - [TempCredentials](docs/models/TempCredentials.md) - [TermsOfUse](docs/models/TermsOfUse.md) + - [TermsOfUseAcceptance](docs/models/TermsOfUseAcceptance.md) - [Token](docs/models/Token.md) - [Type](docs/models/Type.md) - [TypeList](docs/models/TypeList.md) @@ -674,6 +710,9 @@ Class | Method | HTTP request | Description + + + diff --git a/docs/apis/tags/BundleApi.md b/docs/apis/tags/BundleApi.md index ace52ab..3eb4793 100644 --- a/docs/apis/tags/BundleApi.md +++ b/docs/apis/tags/BundleApi.md @@ -5,14 +5,127 @@ All URIs are relative to */ica/rest* Method | HTTP request | Description ------------- | ------------- | ------------- +[**accept_terms_of_use_bundle**](#accept_terms_of_use_bundle) | **post** /api/bundles/{bundleId}/termsOfUse:accept | accept terms of use for a bundle [**create_bundle**](#create_bundle) | **post** /api/bundles | Create a new bundle [**deprecate_bundle**](#deprecate_bundle) | **post** /api/bundles/{bundleId}:deprecate | deprecate a bundle [**get_bundle**](#get_bundle) | **get** /api/bundles/{bundleId} | Retrieve a bundle. [**get_bundle_terms_of_use**](#get_bundle_terms_of_use) | **get** /api/bundles/{bundleId}/termsOfUse | Retrieve the last version of terms of use for a bundle. [**get_bundles**](#get_bundles) | **get** /api/bundles | Retrieve a list of bundles. +[**get_terms_of_use_acceptance**](#get_terms_of_use_acceptance) | **get** /api/bundles/{bundleId}/termsOfUse/userAcceptance/currentUser | Retrieve the acceptance record for a bundle for the current user. [**insert_bundle_terms_of_use**](#insert_bundle_terms_of_use) | **post** /api/bundles/{bundleId}/termsOfUse:new | Insert a new version of the terms of use for a bundle [**release_bundle**](#release_bundle) | **post** /api/bundles/{bundleId}:release | release a bundle +# **accept_terms_of_use_bundle** + +> accept_terms_of_use_bundle(bundle_id) + +accept terms of use for a bundle + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import bundle_api +from icasdk.model.problem import Problem +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = bundle_api.BundleApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'bundleId': "bundleId_example", + } + try: + # accept terms of use for a bundle + api_response = api_instance.accept_terms_of_use_bundle( + path_params=path_params, + ) + except icasdk.ApiException as e: + print("Exception when calling BundleApi->accept_terms_of_use_bundle: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +bundleId | BundleIdSchema | | + +# BundleIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#accept_terms_of_use_bundle.ApiResponseFor204) | The terms of use of the bundle is accepted +default | [ApiResponseForDefault](#accept_terms_of_use_bundle.ApiResponseForDefault) | A problem occurred. + +#### accept_terms_of_use_bundle.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[Unset, ] | | +headers | Unset | headers were not defined | + +#### accept_terms_of_use_bundle.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + # **create_bundle** > Bundle create_bundle(create_bundle) @@ -701,6 +814,125 @@ Type | Description | Notes [**Problem**](../../models/Problem.md) | | +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_terms_of_use_acceptance** + +> TermsOfUseAcceptance get_terms_of_use_acceptance(bundle_id) + +Retrieve the acceptance record for a bundle for the current user. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import bundle_api +from icasdk.model.problem import Problem +from icasdk.model.terms_of_use_acceptance import TermsOfUseAcceptance +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = bundle_api.BundleApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'bundleId': "bundleId_example", + } + try: + # Retrieve the acceptance record for a bundle for the current user. + api_response = api_instance.get_terms_of_use_acceptance( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling BundleApi->get_terms_of_use_acceptance: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +bundleId | BundleIdSchema | | + +# BundleIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_terms_of_use_acceptance.ApiResponseFor200) | Terms of use acceptance is successfully retrieved. +default | [ApiResponseForDefault](#get_terms_of_use_acceptance.ApiResponseForDefault) | A problem occurred. + +#### get_terms_of_use_acceptance.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**TermsOfUseAcceptance**](../../models/TermsOfUseAcceptance.md) | | + + +#### get_terms_of_use_acceptance.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + ### Authorization [JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) diff --git a/docs/apis/tags/ConnectorApi.md b/docs/apis/tags/ConnectorApi.md index 0c39397..5707a1d 100644 --- a/docs/apis/tags/ConnectorApi.md +++ b/docs/apis/tags/ConnectorApi.md @@ -2172,7 +2172,7 @@ with icasdk.ApiClient(configuration) as api_client: region=Region(), is_default=True, ), - analysis_priority="Low", + analysis_priority="LOW", metadata_model=MetadataModel( id="id_example", time_created="1970-01-01T00:00:00.00Z", @@ -2303,7 +2303,7 @@ with icasdk.ApiClient(configuration) as api_client: region=Region(), is_default=True, ), - analysis_priority="Low", + analysis_priority="LOW", metadata_model=MetadataModel( id="id_example", time_created="1970-01-01T00:00:00.00Z", diff --git a/docs/apis/tags/PipelineApi.md b/docs/apis/tags/PipelineApi.md index a0f382f..9e38c3e 100644 --- a/docs/apis/tags/PipelineApi.md +++ b/docs/apis/tags/PipelineApi.md @@ -5,13 +5,158 @@ All URIs are relative to */ica/rest* Method | HTTP request | Description ------------- | ------------- | ------------- +[**download_pipeline_file_content**](#download_pipeline_file_content) | **get** /api/pipelines/{pipelineId}/files/{fileId}/content | Download the contents of a pipeline file. [**get_pipeline**](#get_pipeline) | **get** /api/pipelines/{pipelineId} | Retrieve a pipeline. [**get_pipeline_configuration_parameters**](#get_pipeline_configuration_parameters) | **get** /api/pipelines/{pipelineId}/configurationParameters | Retrieve configuration parameters for a pipeline. +[**get_pipeline_files**](#get_pipeline_files) | **get** /api/pipelines/{pipelineId}/files | Retrieve files for a pipeline. [**get_pipeline_html_documentation**](#get_pipeline_html_documentation) | **get** /api/pipelines/{pipelineId}/documentation/HTML | Retrieve HTML documentation for a project pipeline. [**get_pipeline_input_parameters**](#get_pipeline_input_parameters) | **get** /api/pipelines/{pipelineId}/inputParameters | Retrieve input parameters for a pipeline. [**get_pipeline_reference_sets**](#get_pipeline_reference_sets) | **get** /api/pipelines/{pipelineId}/referenceSets | Retrieve the reference sets of a pipeline. [**get_pipelines**](#get_pipelines) | **get** /api/pipelines | Retrieve a list of pipelines. +# **download_pipeline_file_content** + +> file_type download_pipeline_file_content(pipeline_idfile_id) + +Download the contents of a pipeline file. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import pipeline_api +from icasdk.model.problem import Problem +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pipeline_api.PipelineApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'pipelineId': "pipelineId_example", + 'fileId': "fileId_example", + } + try: + # Download the contents of a pipeline file. + api_response = api_instance.download_pipeline_file_content( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling PipelineApi->download_pipeline_file_content: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/octet-stream', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +pipelineId | PipelineIdSchema | | +fileId | FileIdSchema | | + +# PipelineIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# FileIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, uuid.UUID, | str, | | value must be a uuid + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#download_pipeline_file_content.ApiResponseFor200) | The pipeline file is successfully downloaded. +default | [ApiResponseForDefault](#download_pipeline_file_content.ApiResponseForDefault) | A problem occurred. + +#### download_pipeline_file_content.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationOctetStream, ] | | +headers | ResponseHeadersFor200 | | + +# SchemaFor200ResponseBodyApplicationOctetStream + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | +#### ResponseHeadersFor200 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +Content-Disposition | ContentDispositionSchema | | optional + +# ContentDispositionSchema + +Contains name of the file to be downloaded. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Contains name of the file to be downloaded. | + + +#### download_pipeline_file_content.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + # **get_pipeline** > Pipeline get_pipeline(pipeline_id) @@ -259,6 +404,125 @@ Type | Description | Notes [**Problem**](../../models/Problem.md) | | +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_pipeline_files** + +> PipelineFileList get_pipeline_files(pipeline_id) + +Retrieve files for a pipeline. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import pipeline_api +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_list import PipelineFileList +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pipeline_api.PipelineApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'pipelineId': "pipelineId_example", + } + try: + # Retrieve files for a pipeline. + api_response = api_instance.get_pipeline_files( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling PipelineApi->get_pipeline_files: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +pipelineId | PipelineIdSchema | | + +# PipelineIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_pipeline_files.ApiResponseFor200) | The files are successfully retrieved. +default | [ApiResponseForDefault](#get_pipeline_files.ApiResponseForDefault) | A problem occurred. + +#### get_pipeline_files.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**PipelineFileList**](../../models/PipelineFileList.md) | | + + +#### get_pipeline_files.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + ### Authorization [JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) diff --git a/docs/apis/tags/ProjectAnalysisApi.md b/docs/apis/tags/ProjectAnalysisApi.md index 8d81b6f..996f249 100644 --- a/docs/apis/tags/ProjectAnalysisApi.md +++ b/docs/apis/tags/ProjectAnalysisApi.md @@ -2112,7 +2112,7 @@ with icasdk.ApiClient(configuration) as api_client: end_date="1970-01-01T00:00:00.00Z", summary="summary_example", analysis_storage=AnalysisStorage(), - analysis_priority="Low", + analysis_priority="LOW", tags=AnalysisTag( , user_tags=[ @@ -2217,7 +2217,7 @@ with icasdk.ApiClient(configuration) as api_client: end_date="1970-01-01T00:00:00.00Z", summary="summary_example", analysis_storage=AnalysisStorage(), - analysis_priority="Low", + analysis_priority="LOW", tags=AnalysisTag( , user_tags=[ diff --git a/docs/apis/tags/ProjectApi.md b/docs/apis/tags/ProjectApi.md index b62e30e..d63202c 100644 --- a/docs/apis/tags/ProjectApi.md +++ b/docs/apis/tags/ProjectApi.md @@ -78,7 +78,7 @@ with icasdk.ApiClient(configuration) as api_client: metadata_model_id="metadata_model_id_example", storage_configuration_id="storage_configuration_id_example", storage_configuration_subfolder="storage_configuration_subfolder_example", - analysis_priority="Medium", + analysis_priority="MEDIUM", ) try: # Create a new project. @@ -1249,7 +1249,7 @@ with icasdk.ApiClient(configuration) as api_client: region=Region(), is_default=True, ), - analysis_priority="Low", + analysis_priority="LOW", metadata_model=MetadataModel( id="id_example", time_created="1970-01-01T00:00:00.00Z", @@ -1355,7 +1355,7 @@ with icasdk.ApiClient(configuration) as api_client: region=Region(), is_default=True, ), - analysis_priority="Low", + analysis_priority="LOW", metadata_model=MetadataModel( id="id_example", time_created="1970-01-01T00:00:00.00Z", diff --git a/docs/apis/tags/ProjectDataApi.md b/docs/apis/tags/ProjectDataApi.md index e7dcfee..da831a7 100644 --- a/docs/apis/tags/ProjectDataApi.md +++ b/docs/apis/tags/ProjectDataApi.md @@ -1153,11 +1153,11 @@ Type | Description | Notes # **create_temporary_credentials_for_data** -> TempCredentials create_temporary_credentials_for_data(project_iddata_idcreate_temporary_credentials) +> TempCredentials create_temporary_credentials_for_data(project_iddata_id) Retrieve temporary credentials for this data. -Can be used to upload or download a file directly from the region where it is located, no connector is needed. +Can be used to upload or download a file directly from the region where it is located, no connector is needed. The returned credentials expire after 36 hours. ### Example @@ -1201,6 +1201,20 @@ with icasdk.ApiClient(configuration) as api_client: 'projectId': "projectId_example", 'dataId': "dataId_example", } + try: + # Retrieve temporary credentials for this data. + api_response = api_instance.create_temporary_credentials_for_data( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectDataApi->create_temporary_credentials_for_data: %s\n" % e) + + # example passing only optional values + path_params = { + 'projectId': "projectId_example", + 'dataId': "dataId_example", + } body = CreateTemporaryCredentials( credentials_format="RCLONE", ) @@ -1218,7 +1232,7 @@ with icasdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -body | typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson] | required | +body | typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, Unset] | optional, default is unset | path_params | RequestPathParams | | content_type | str | optional, default is 'application/vnd.illumina.v3+json' | Selects the schema and serialization of the request body accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client diff --git a/docs/apis/tags/ProjectDataUpdateBatchApi.md b/docs/apis/tags/ProjectDataUpdateBatchApi.md new file mode 100644 index 0000000..e042db4 --- /dev/null +++ b/docs/apis/tags/ProjectDataUpdateBatchApi.md @@ -0,0 +1,636 @@ + +# icasdk.apis.tags.project_data_update_batch_api.ProjectDataUpdateBatchApi + +All URIs are relative to */ica/rest* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_project_data_update_batch**](#create_project_data_update_batch) | **post** /api/projects/{projectId}/dataUpdateBatch | Create a project data update batch. +[**get_project_data_update_batch**](#get_project_data_update_batch) | **get** /api/projects/{projectId}/dataUpdateBatch/{batchId} | Retrieve a project data update batch. +[**get_project_data_update_batch_item**](#get_project_data_update_batch_item) | **get** /api/projects/{projectId}/dataUpdateBatch/{batchId}/items/{itemId} | Retrieve a project data update batch item. +[**get_project_data_update_batch_items**](#get_project_data_update_batch_items) | **get** /api/projects/{projectId}/dataUpdateBatch/{batchId}/items | Retrieve a list of project data update batch items. + +# **create_project_data_update_batch** + +> ProjectDataUpdateBatch create_project_data_update_batch(project_idcreate_project_data_update_batch) + +Create a project data update batch. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_data_update_batch_api +from icasdk.model.problem import Problem +from icasdk.model.project_data_update_batch import ProjectDataUpdateBatch +from icasdk.model.create_project_data_update_batch import CreateProjectDataUpdateBatch +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_data_update_batch_api.ProjectDataUpdateBatchApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + } + body = CreateProjectDataUpdateBatch( + data_update_groups=[ + DataUpdateGroup( + data_ids=[ + "data_ids_example" + ], + user_tags=TagUpdate( +, +, + ), +, + ) + ], + ) + try: + # Create a project data update batch. + api_response = api_instance.create_project_data_update_batch( + path_params=path_params, + body=body, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectDataUpdateBatchApi->create_project_data_update_batch: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/vnd.illumina.v3+json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**CreateProjectDataUpdateBatch**](../../models/CreateProjectDataUpdateBatch.md) | | + + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**CreateProjectDataUpdateBatch**](../../models/CreateProjectDataUpdateBatch.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_project_data_update_batch.ApiResponseFor201) | The project data update batch is successfully created. +default | [ApiResponseForDefault](#create_project_data_update_batch.ApiResponseForDefault) | A problem occurred. + +#### create_project_data_update_batch.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**ProjectDataUpdateBatch**](../../models/ProjectDataUpdateBatch.md) | | + + +#### create_project_data_update_batch.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_project_data_update_batch** + +> ProjectDataUpdateBatch get_project_data_update_batch(project_idbatch_id) + +Retrieve a project data update batch. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_data_update_batch_api +from icasdk.model.problem import Problem +from icasdk.model.project_data_update_batch import ProjectDataUpdateBatch +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_data_update_batch_api.ProjectDataUpdateBatchApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + 'batchId': "batchId_example", + } + try: + # Retrieve a project data update batch. + api_response = api_instance.get_project_data_update_batch( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectDataUpdateBatchApi->get_project_data_update_batch: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | +batchId | BatchIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# BatchIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, uuid.UUID, | str, | | value must be a uuid + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_project_data_update_batch.ApiResponseFor200) | The project data update batch is successfully retrieved. +default | [ApiResponseForDefault](#get_project_data_update_batch.ApiResponseForDefault) | A problem occurred. + +#### get_project_data_update_batch.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**ProjectDataUpdateBatch**](../../models/ProjectDataUpdateBatch.md) | | + + +#### get_project_data_update_batch.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_project_data_update_batch_item** + +> ProjectDataUpdateBatchItem get_project_data_update_batch_item(project_idbatch_iditem_id) + +Retrieve a project data update batch item. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_data_update_batch_api +from icasdk.model.project_data_update_batch_item import ProjectDataUpdateBatchItem +from icasdk.model.problem import Problem +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_data_update_batch_api.ProjectDataUpdateBatchApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + 'batchId': "batchId_example", + 'itemId': "itemId_example", + } + try: + # Retrieve a project data update batch item. + api_response = api_instance.get_project_data_update_batch_item( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectDataUpdateBatchApi->get_project_data_update_batch_item: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | +batchId | BatchIdSchema | | +itemId | ItemIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# BatchIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, uuid.UUID, | str, | | value must be a uuid + +# ItemIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, uuid.UUID, | str, | | value must be a uuid + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_project_data_update_batch_item.ApiResponseFor200) | The project data update batch item is successfully retrieved. +default | [ApiResponseForDefault](#get_project_data_update_batch_item.ApiResponseForDefault) | A problem occurred. + +#### get_project_data_update_batch_item.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**ProjectDataUpdateBatchItem**](../../models/ProjectDataUpdateBatchItem.md) | | + + +#### get_project_data_update_batch_item.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_project_data_update_batch_items** + +> ProjectDataUpdateBatchItemPagedList get_project_data_update_batch_items(project_idbatch_id) + +Retrieve a list of project data update batch items. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_data_update_batch_api +from icasdk.model.problem import Problem +from icasdk.model.project_data_update_batch_item_paged_list import ProjectDataUpdateBatchItemPagedList +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_data_update_batch_api.ProjectDataUpdateBatchApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + 'batchId': "batchId_example", + } + query_params = { + } + try: + # Retrieve a list of project data update batch items. + api_response = api_instance.get_project_data_update_batch_items( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectDataUpdateBatchApi->get_project_data_update_batch_items: %s\n" % e) + + # example passing only optional values + path_params = { + 'projectId': "projectId_example", + 'batchId': "batchId_example", + } + query_params = { + 'status': [ + "INITIALISED" + ], + 'pageOffset': "pageOffset_example", + 'pageToken': "pageToken_example", + 'pageSize': "pageSize_example", + 'sort': "sort_example", + } + try: + # Retrieve a list of project data update batch items. + api_response = api_instance.get_project_data_update_batch_items( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectDataUpdateBatchApi->get_project_data_update_batch_items: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +status | StatusSchema | | optional +pageOffset | PageOffsetSchema | | optional +pageToken | PageTokenSchema | | optional +pageSize | PageSizeSchema | | optional +sort | SortSchema | | optional + + +# StatusSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["INITIALISED", "WAITING_RESOURCES", "UPDATING", "UPDATED", "PARTIALLY_UPDATED", "FAILED", ] + +# PageOffsetSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageTokenSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | +batchId | BatchIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# BatchIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, uuid.UUID, | str, | | value must be a uuid + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_project_data_update_batch_items.ApiResponseFor200) | The list of project data update batch items is successfully retrieved. +default | [ApiResponseForDefault](#get_project_data_update_batch_items.ApiResponseForDefault) | A problem occurred. + +#### get_project_data_update_batch_items.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**ProjectDataUpdateBatchItemPagedList**](../../models/ProjectDataUpdateBatchItemPagedList.md) | | + + +#### get_project_data_update_batch_items.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + diff --git a/docs/apis/tags/ProjectPermissionApi.md b/docs/apis/tags/ProjectPermissionApi.md index 3ae1378..1866061 100644 --- a/docs/apis/tags/ProjectPermissionApi.md +++ b/docs/apis/tags/ProjectPermissionApi.md @@ -12,10 +12,12 @@ Method | HTTP request | Description # **create_project_permission** -> ProjectPermission create_project_permission(project_idcreate_project_permission) +> ProjectPermissionV4 create_project_permission(project_idcreate_project_permission_v4) Create a project permission. +# Changelog For this endpoint multiple versions exist. Note that the values for request headers 'Content-Type' and 'Accept' must contain a matching version. ## [V3] Initial version ## [V4] Added 'Administrator' role for Bench. The role attributes are strings instead of enums to support future additions in a backward compatible manner. + ### Example * Bearer (JWT) Authentication (JwtAuth): @@ -23,7 +25,9 @@ Create a project permission. ```python import icasdk from icasdk.apis.tags import project_permission_api +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.create_project_permission import CreateProjectPermission +from icasdk.model.create_project_permission_v4 import CreateProjectPermissionV4 from icasdk.model.problem import Problem from icasdk.model.project_permission import ProjectPermission from pprint import pprint @@ -57,11 +61,11 @@ with icasdk.ApiClient(configuration) as api_client: path_params = { 'projectId': "projectId_example", } - body = CreateProjectPermission( + body = CreateProjectPermissionV4( role_project="NONE", - role_flow="NONE", - role_base="NONE", - role_bench="NONE", + role_flow="CONTRIBUTOR", + role_base="CONTRIBUTOR", + role_bench="ADMINISTRATOR", membership_type="USER", user_id="user_id_example", email_address="email_address_example", @@ -83,16 +87,22 @@ with icasdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -body | typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson] | required | +body | typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json, SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson] | required | path_params | RequestPathParams | | -content_type | str | optional, default is 'application/vnd.illumina.v3+json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +content_type | str | optional, default is 'application/vnd.illumina.v4+json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned ### body +# SchemaForRequestBodyApplicationVndIlluminaV4json +Type | Description | Notes +------------- | ------------- | ------------- +[**CreateProjectPermissionV4**](../../models/CreateProjectPermissionV4.md) | | + + # SchemaForRequestBodyApplicationVndIlluminaV3json Type | Description | Notes ------------- | ------------- | ------------- @@ -131,9 +141,15 @@ default | [ApiResponseForDefault](#create_project_permission.ApiResponseForDefau Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- response | urllib3.HTTPResponse | Raw response | -body | typing.Union[SchemaFor201ResponseBodyApplicationVndIlluminaV3json, ] | | +body | typing.Union[SchemaFor201ResponseBodyApplicationVndIlluminaV4json, SchemaFor201ResponseBodyApplicationVndIlluminaV3json, ] | | headers | ResponseHeadersFor201 | | +# SchemaFor201ResponseBodyApplicationVndIlluminaV4json +Type | Description | Notes +------------- | ------------- | ------------- +[**ProjectPermissionV4**](../../models/ProjectPermissionV4.md) | | + + # SchemaFor201ResponseBodyApplicationVndIlluminaV3json Type | Description | Notes ------------- | ------------- | ------------- @@ -176,10 +192,12 @@ Type | Description | Notes # **get_project_permission** -> ProjectPermission get_project_permission(project_idpermission_id) +> ProjectPermissionV4 get_project_permission(project_idpermission_id) Retrieve a project permission. +# Changelog For this endpoint multiple versions exist. Note that the values for request headers 'Content-Type' and 'Accept' must contain a matching version. ## [V3] Initial version ## [V4] Added 'Administrator' role for Bench. The role attributes are strings instead of enums to support future additions in a backward compatible manner. + ### Example * Bearer (JWT) Authentication (JwtAuth): @@ -187,6 +205,7 @@ Retrieve a project permission. ```python import icasdk from icasdk.apis.tags import project_permission_api +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.problem import Problem from icasdk.model.project_permission import ProjectPermission from pprint import pprint @@ -235,7 +254,7 @@ with icasdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- path_params | RequestPathParams | | -accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned @@ -274,9 +293,15 @@ default | [ApiResponseForDefault](#get_project_permission.ApiResponseForDefault) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- response | urllib3.HTTPResponse | Raw response | -body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV4json, SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | headers | ResponseHeadersFor200 | | +# SchemaFor200ResponseBodyApplicationVndIlluminaV4json +Type | Description | Notes +------------- | ------------- | ------------- +[**ProjectPermissionV4**](../../models/ProjectPermissionV4.md) | | + + # SchemaFor200ResponseBodyApplicationVndIlluminaV3json Type | Description | Notes ------------- | ------------- | ------------- @@ -319,10 +344,12 @@ Type | Description | Notes # **get_project_permissions** -> ProjectPermissionList get_project_permissions(project_id) +> ProjectPermissionListV4 get_project_permissions(project_id) Retrieve a list of project permissions. +# Changelog For this endpoint multiple versions exist. Note that the values for request headers 'Content-Type' and 'Accept' must contain a matching version. ## [V3] Initial version ## [V4] Added 'Administrator' role for Bench. The role attributes are strings instead of enums to support future additions in a backward compatible manner. + ### Example * Bearer (JWT) Authentication (JwtAuth): @@ -330,6 +357,7 @@ Retrieve a list of project permissions. ```python import icasdk from icasdk.apis.tags import project_permission_api +from icasdk.model.project_permission_list_v4 import ProjectPermissionListV4 from icasdk.model.problem import Problem from icasdk.model.project_permission_list import ProjectPermissionList from pprint import pprint @@ -377,7 +405,7 @@ with icasdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- path_params | RequestPathParams | | -accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned @@ -408,9 +436,15 @@ default | [ApiResponseForDefault](#get_project_permissions.ApiResponseForDefault Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- response | urllib3.HTTPResponse | Raw response | -body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV4json, SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | headers | Unset | headers were not defined | +# SchemaFor200ResponseBodyApplicationVndIlluminaV4json +Type | Description | Notes +------------- | ------------- | ------------- +[**ProjectPermissionListV4**](../../models/ProjectPermissionListV4.md) | | + + # SchemaFor200ResponseBodyApplicationVndIlluminaV3json Type | Description | Notes ------------- | ------------- | ------------- @@ -438,11 +472,11 @@ Type | Description | Notes # **update_project_permission** -> ProjectPermission update_project_permission(project_idpermission_idproject_permission) +> ProjectPermissionV4 update_project_permission(project_idpermission_idproject_permission_v4) Update a project permission. -Fields which can be updated: - uploadAllowed - downloadAllowed - roleProject - roleFlow - roleBase - roleBench +# Changelog For this endpoint multiple versions exist. Note that the values for request headers 'Content-Type' and 'Accept' must contain a matching version. ## [V3] Initial version ## [V4] Added 'Administrator' role for Bench. The role attributes are strings instead of enums to support future additions in a backward compatible manner. Fields which can be updated: - uploadAllowed - downloadAllowed - roleProject - roleFlow - roleBase - roleBench ### Example @@ -451,6 +485,7 @@ Fields which can be updated: - uploadAllowed - downloadAllowed - roleProject - r ```python import icasdk from icasdk.apis.tags import project_permission_api +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.problem import Problem from icasdk.model.project_permission import ProjectPermission from pprint import pprint @@ -487,17 +522,17 @@ with icasdk.ApiClient(configuration) as api_client: } header_params = { } - body = ProjectPermission( + body = ProjectPermissionV4( id="id_example", time_created="1970-01-01T00:00:00.00Z", time_modified="1970-01-01T00:00:00.00Z", owner_id="owner_id_example", tenant_id="tenant_id_example", tenant_name="tenant_name_example", - role_project="NONE", - role_flow="NONE", - role_base="NONE", - role_bench="NONE", + role_project="role_project_example", + role_flow="role_flow_example", + role_base="role_base_example", + role_bench="role_bench_example", membership_type="USER", user=User( id="id_example", @@ -567,17 +602,17 @@ with icasdk.ApiClient(configuration) as api_client: header_params = { 'If-Match': "If-Match_example", } - body = ProjectPermission( + body = ProjectPermissionV4( id="id_example", time_created="1970-01-01T00:00:00.00Z", time_modified="1970-01-01T00:00:00.00Z", owner_id="owner_id_example", tenant_id="tenant_id_example", tenant_name="tenant_name_example", - role_project="NONE", - role_flow="NONE", - role_base="NONE", - role_bench="NONE", + role_project="role_project_example", + role_flow="role_flow_example", + role_base="role_base_example", + role_bench="role_bench_example", membership_type="USER", user=User( id="id_example", @@ -643,17 +678,23 @@ with icasdk.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -body | typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson] | required | +body | typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json, SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson] | required | header_params | RequestHeaderParams | | path_params | RequestPathParams | | -content_type | str | optional, default is 'application/vnd.illumina.v3+json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +content_type | str | optional, default is 'application/vnd.illumina.v4+json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned ### body +# SchemaForRequestBodyApplicationVndIlluminaV4json +Type | Description | Notes +------------- | ------------- | ------------- +[**ProjectPermissionV4**](../../models/ProjectPermissionV4.md) | | + + # SchemaForRequestBodyApplicationVndIlluminaV3json Type | Description | Notes ------------- | ------------- | ------------- @@ -714,9 +755,15 @@ default | [ApiResponseForDefault](#update_project_permission.ApiResponseForDefau Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- response | urllib3.HTTPResponse | Raw response | -body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV4json, SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | headers | ResponseHeadersFor200 | | +# SchemaFor200ResponseBodyApplicationVndIlluminaV4json +Type | Description | Notes +------------- | ------------- | ------------- +[**ProjectPermissionV4**](../../models/ProjectPermissionV4.md) | | + + # SchemaFor200ResponseBodyApplicationVndIlluminaV3json Type | Description | Notes ------------- | ------------- | ------------- diff --git a/docs/apis/tags/ProjectPipelineApi.md b/docs/apis/tags/ProjectPipelineApi.md index 89fc16d..1c44858 100644 --- a/docs/apis/tags/ProjectPipelineApi.md +++ b/docs/apis/tags/ProjectPipelineApi.md @@ -7,6 +7,10 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create_cwl_pipeline**](#create_cwl_pipeline) | **post** /api/projects/{projectId}/pipelines:createCwlPipeline | Create a CWL pipeline within a project. [**create_nextflow_pipeline**](#create_nextflow_pipeline) | **post** /api/projects/{projectId}/pipelines:createNextflowPipeline | Create a Nextflow pipeline within a project. +[**create_pipeline_file**](#create_pipeline_file) | **post** /api/projects/{projectId}/pipelines/{pipelineId}/files | Create a file for a pipeline. +[**delete_pipeline_file**](#delete_pipeline_file) | **delete** /api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId} | Delete a file for a pipeline. +[**download_pipeline_file_content1**](#download_pipeline_file_content1) | **get** /api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}/content | Download the contents of a pipeline file. +[**get_pipeline_files1**](#get_pipeline_files1) | **get** /api/projects/{projectId}/pipelines/{pipelineId}/files | Retrieve files for a project pipeline. [**get_project_pipeline**](#get_project_pipeline) | **get** /api/projects/{projectId}/pipelines/{pipelineId} | Retrieve a project pipeline. [**get_project_pipeline_configuration_parameters**](#get_project_pipeline_configuration_parameters) | **get** /api/projects/{projectId}/pipelines/{pipelineId}/configurationParameters | Retrieve configuration parameters for a project pipeline. [**get_project_pipeline_html_documentation**](#get_project_pipeline_html_documentation) | **get** /api/projects/{projectId}/pipelines/{pipelineId}/documentation/HTML | Retrieve HTML documentation for a project pipeline. @@ -16,6 +20,7 @@ Method | HTTP request | Description [**link_pipeline_to_project**](#link_pipeline_to_project) | **post** /api/projects/{projectId}/pipelines/{pipelineId} | Link a pipeline to a project. [**release_pipeline**](#release_pipeline) | **post** /api/projects/{projectId}/pipelines/{pipelineId}:release | Release a pipeline. [**unlink_pipeline_from_project**](#unlink_pipeline_from_project) | **delete** /api/projects/{projectId}/pipelines/{pipelineId} | Unlink a pipeline from a project. +[**update_pipeline_file**](#update_pipeline_file) | **put** /api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}/content | Update the contents of a file for a pipeline. # **create_cwl_pipeline** @@ -355,6 +360,572 @@ Type | Description | Notes [**Problem**](../../models/Problem.md) | | +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **create_pipeline_file** + +> PipelineFile create_pipeline_file(project_idpipeline_id) + +Create a file for a pipeline. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_pipeline_api +from icasdk.model.pipeline_file import PipelineFile +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_content_spec import PipelineFileContentSpec +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_pipeline_api.ProjectPipelineApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + 'pipelineId': "pipelineId_example", + } + try: + # Create a file for a pipeline. + api_response = api_instance.create_pipeline_file( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectPipelineApi->create_pipeline_file: %s\n" % e) + + # example passing only optional values + path_params = { + 'projectId': "projectId_example", + 'pipelineId': "pipelineId_example", + } + body = dict( + content=open('/path/to/file', 'rb'), + ) + try: + # Create a file for a pipeline. + api_response = api_instance.create_pipeline_file( + path_params=path_params, + body=body, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectPipelineApi->create_pipeline_file: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyMultipartFormData, Unset] | optional, default is unset | +path_params | RequestPathParams | | +content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyMultipartFormData +Type | Description | Notes +------------- | ------------- | ------------- +[**PipelineFileContentSpec**](../../models/PipelineFileContentSpec.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | +pipelineId | PipelineIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PipelineIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_pipeline_file.ApiResponseFor201) | The pipeline file is successfully created. +default | [ApiResponseForDefault](#create_pipeline_file.ApiResponseForDefault) | A problem occurred. + +#### create_pipeline_file.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**PipelineFile**](../../models/PipelineFile.md) | | + + +#### create_pipeline_file.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **delete_pipeline_file** + +> delete_pipeline_file(project_idpipeline_idfile_id) + +Delete a file for a pipeline. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_pipeline_api +from icasdk.model.problem import Problem +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_pipeline_api.ProjectPipelineApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + 'pipelineId': "pipelineId_example", + 'fileId': "fileId_example", + } + try: + # Delete a file for a pipeline. + api_response = api_instance.delete_pipeline_file( + path_params=path_params, + ) + except icasdk.ApiException as e: + print("Exception when calling ProjectPipelineApi->delete_pipeline_file: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | +pipelineId | PipelineIdSchema | | +fileId | FileIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PipelineIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# FileIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, uuid.UUID, | str, | | value must be a uuid + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_pipeline_file.ApiResponseFor204) | The pipeline file is successfully deleted. +default | [ApiResponseForDefault](#delete_pipeline_file.ApiResponseForDefault) | A problem occurred. + +#### delete_pipeline_file.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[Unset, ] | | +headers | Unset | headers were not defined | + +#### delete_pipeline_file.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **download_pipeline_file_content1** + +> file_type download_pipeline_file_content1(project_idpipeline_idfile_id) + +Download the contents of a pipeline file. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_pipeline_api +from icasdk.model.problem import Problem +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_pipeline_api.ProjectPipelineApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + 'pipelineId': "pipelineId_example", + 'fileId': "fileId_example", + } + try: + # Download the contents of a pipeline file. + api_response = api_instance.download_pipeline_file_content1( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectPipelineApi->download_pipeline_file_content1: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/octet-stream', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | +pipelineId | PipelineIdSchema | | +fileId | FileIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PipelineIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# FileIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, uuid.UUID, | str, | | value must be a uuid + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#download_pipeline_file_content1.ApiResponseFor200) | The pipeline file is successfully downloaded. +default | [ApiResponseForDefault](#download_pipeline_file_content1.ApiResponseForDefault) | A problem occurred. + +#### download_pipeline_file_content1.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationOctetStream, ] | | +headers | ResponseHeadersFor200 | | + +# SchemaFor200ResponseBodyApplicationOctetStream + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | +#### ResponseHeadersFor200 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +Content-Disposition | ContentDispositionSchema | | optional + +# ContentDispositionSchema + +Contains name of the file to be downloaded. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Contains name of the file to be downloaded. | + + +#### download_pipeline_file_content1.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_pipeline_files1** + +> PipelineFileList get_pipeline_files1(project_idpipeline_id) + +Retrieve files for a project pipeline. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_pipeline_api +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_list import PipelineFileList +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_pipeline_api.ProjectPipelineApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + 'pipelineId': "pipelineId_example", + } + try: + # Retrieve files for a project pipeline. + api_response = api_instance.get_pipeline_files1( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectPipelineApi->get_pipeline_files1: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | +pipelineId | PipelineIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PipelineIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_pipeline_files1.ApiResponseFor200) | The files are successfully retrieved. +default | [ApiResponseForDefault](#get_pipeline_files1.ApiResponseForDefault) | A problem occurred. + +#### get_pipeline_files1.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**PipelineFileList**](../../models/PipelineFileList.md) | | + + +#### get_pipeline_files1.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + ### Authorization [JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) @@ -1507,3 +2078,161 @@ Type | Description | Notes [[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) +# **update_pipeline_file** + +> update_pipeline_file(project_idpipeline_idfile_id) + +Update the contents of a file for a pipeline. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_pipeline_api +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_content_spec import PipelineFileContentSpec +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_pipeline_api.ProjectPipelineApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + 'pipelineId': "pipelineId_example", + 'fileId': "fileId_example", + } + try: + # Update the contents of a file for a pipeline. + api_response = api_instance.update_pipeline_file( + path_params=path_params, + ) + except icasdk.ApiException as e: + print("Exception when calling ProjectPipelineApi->update_pipeline_file: %s\n" % e) + + # example passing only optional values + path_params = { + 'projectId': "projectId_example", + 'pipelineId': "pipelineId_example", + 'fileId': "fileId_example", + } + body = dict( + content=open('/path/to/file', 'rb'), + ) + try: + # Update the contents of a file for a pipeline. + api_response = api_instance.update_pipeline_file( + path_params=path_params, + body=body, + ) + except icasdk.ApiException as e: + print("Exception when calling ProjectPipelineApi->update_pipeline_file: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyMultipartFormData, Unset] | optional, default is unset | +path_params | RequestPathParams | | +content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyMultipartFormData +Type | Description | Notes +------------- | ------------- | ------------- +[**PipelineFileContentSpec**](../../models/PipelineFileContentSpec.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | +pipelineId | PipelineIdSchema | | +fileId | FileIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PipelineIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# FileIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, uuid.UUID, | str, | | value must be a uuid + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_pipeline_file.ApiResponseFor200) | The pipeline file is successfully updated. +default | [ApiResponseForDefault](#update_pipeline_file.ApiResponseForDefault) | A problem occurred. + +#### update_pipeline_file.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[Unset, ] | | +headers | Unset | headers were not defined | + +#### update_pipeline_file.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + diff --git a/docs/apis/tags/ProjectSampleApi.md b/docs/apis/tags/ProjectSampleApi.md index 4ca96cb..8962390 100644 --- a/docs/apis/tags/ProjectSampleApi.md +++ b/docs/apis/tags/ProjectSampleApi.md @@ -12,6 +12,7 @@ Method | HTTP request | Description [**delete_and_unlink_sample**](#delete_and_unlink_sample) | **post** /api/projects/{projectId}/samples/{sampleId}:deleteUnlink | Delete a sample and unlink its data. [**delete_sample_with_input**](#delete_sample_with_input) | **post** /api/projects/{projectId}/samples/{sampleId}:deleteWithInput | Delete a sample as well as its input data. [**get_project_sample**](#get_project_sample) | **get** /api/projects/{projectId}/samples/{sampleId} | Retrieve a project sample. +[**get_project_sample_analyses**](#get_project_sample_analyses) | **get** /api/projects/{projectId}/samples/{sampleId}/analyses | Retrieve the list of analyses. [**get_project_samples**](#get_project_samples) | **post** /api/projects/{projectId}/samples:search | Retrieve project samples. [**get_projects_for_sample**](#get_projects_for_sample) | **get** /api/projects/{projectId}/samples/{sampleId}/projects | Retrieve a list of projects for this sample. [**get_sample_data_list**](#get_sample_data_list) | **get** /api/projects/{projectId}/samples/{sampleId}/data | Retrieve the list of sample data. @@ -944,6 +945,252 @@ Type | Description | Notes [**Problem**](../../models/Problem.md) | | +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_project_sample_analyses** + +> AnalysisPagedList get_project_sample_analyses(project_idsample_id) + +Retrieve the list of analyses. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import project_sample_api +from icasdk.model.analysis_paged_list import AnalysisPagedList +from icasdk.model.problem import Problem +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_sample_api.ProjectSampleApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'projectId': "projectId_example", + 'sampleId': "sampleId_example", + } + query_params = { + } + try: + # Retrieve the list of analyses. + api_response = api_instance.get_project_sample_analyses( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectSampleApi->get_project_sample_analyses: %s\n" % e) + + # example passing only optional values + path_params = { + 'projectId': "projectId_example", + 'sampleId': "sampleId_example", + } + query_params = { + 'reference': "reference_example", + 'userreference': "userreference_example", + 'status': "status_example", + 'usertag': "usertag_example", + 'technicaltag': "technicaltag_example", + 'referencetag': "referencetag_example", + 'pageOffset': "pageOffset_example", + 'pageToken': "pageToken_example", + 'pageSize': "pageSize_example", + 'sort': "sort_example", + } + try: + # Retrieve the list of analyses. + api_response = api_instance.get_project_sample_analyses( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectSampleApi->get_project_sample_analyses: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +reference | ReferenceSchema | | optional +userreference | UserreferenceSchema | | optional +status | StatusSchema | | optional +usertag | UsertagSchema | | optional +technicaltag | TechnicaltagSchema | | optional +referencetag | ReferencetagSchema | | optional +pageOffset | PageOffsetSchema | | optional +pageToken | PageTokenSchema | | optional +pageSize | PageSizeSchema | | optional +sort | SortSchema | | optional + + +# ReferenceSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# UserreferenceSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# StatusSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# UsertagSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# TechnicaltagSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ReferencetagSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageOffsetSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageTokenSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +projectId | ProjectIdSchema | | +sampleId | SampleIdSchema | | + +# ProjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# SampleIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_project_sample_analyses.ApiResponseFor200) | The list of project analyses is successfully retrieved. +default | [ApiResponseForDefault](#get_project_sample_analyses.ApiResponseForDefault) | A problem occurred. + +#### get_project_sample_analyses.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**AnalysisPagedList**](../../models/AnalysisPagedList.md) | | + + +#### get_project_sample_analyses.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + ### Authorization [JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) diff --git a/docs/apis/tags/SequencingRunApi.md b/docs/apis/tags/SequencingRunApi.md new file mode 100644 index 0000000..4f326a5 --- /dev/null +++ b/docs/apis/tags/SequencingRunApi.md @@ -0,0 +1,143 @@ + +# icasdk.apis.tags.sequencing_run_api.SequencingRunApi + +All URIs are relative to */ica/rest* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_sequencing_run**](#get_sequencing_run) | **get** /api/sequencingRuns/{sequencingRunId} | Retrieve a sequencing run. + +# **get_sequencing_run** + +> SequencingRun get_sequencing_run(sequencing_run_id) + +Retrieve a sequencing run. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import sequencing_run_api +from icasdk.model.sequencing_run import SequencingRun +from icasdk.model.problem import Problem +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = sequencing_run_api.SequencingRunApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'sequencingRunId': "sequencingRunId_example", + } + try: + # Retrieve a sequencing run. + api_response = api_instance.get_sequencing_run( + path_params=path_params, + ) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling SequencingRunApi->get_sequencing_run: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/problem+json', 'application/vnd.illumina.v3+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +sequencingRunId | SequencingRunIdSchema | | + +# SequencingRunIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_sequencing_run.ApiResponseFor200) | The sequencing run is successfully retrieved. +default | [ApiResponseForDefault](#get_sequencing_run.ApiResponseForDefault) | A problem occurred. + +#### get_sequencing_run.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | ResponseHeadersFor200 | | + +# SchemaFor200ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**SequencingRun**](../../models/SequencingRun.md) | | + +#### ResponseHeadersFor200 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +ETag | ETagSchema | | optional + +# ETagSchema + +The current version of the resource. Can be passed to the corresponding PUT endpoint to enable conflict exposure (409 response). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | The current version of the resource. Can be passed to the corresponding PUT endpoint to enable conflict exposure (409 response). | + + +#### get_sequencing_run.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + diff --git a/docs/apis/tags/SystemApi.md b/docs/apis/tags/SystemApi.md new file mode 100644 index 0000000..5df977f --- /dev/null +++ b/docs/apis/tags/SystemApi.md @@ -0,0 +1,102 @@ + +# icasdk.apis.tags.system_api.SystemApi + +All URIs are relative to */ica/rest* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_system_info**](#get_system_info) | **get** /api/system/info | Retrieve system information. + +# **get_system_info** + +> SystemInfo get_system_info() + +Retrieve system information. + +### Example + +* Bearer (JWT) Authentication (JwtAuth): +* Api Key Authentication (ApiKeyAuth): +```python +import icasdk +from icasdk.apis.tags import system_api +from icasdk.model.system_info import SystemInfo +from icasdk.model.problem import Problem +from pprint import pprint +# Defining the host is optional and defaults to /ica/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = icasdk.Configuration( + host = "/ica/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): JwtAuth +configuration = icasdk.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' +# Enter a context with an instance of the API client +with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = system_api.SystemApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Retrieve system information. + api_response = api_instance.get_system_info() + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling SystemApi->get_system_info: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_system_info.ApiResponseFor200) | The system information is successfully retrieved. +default | [ApiResponseForDefault](#get_system_info.ApiResponseForDefault) | A problem occurred. + +#### get_system_info.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationVndIlluminaV3json +Type | Description | Notes +------------- | ------------- | ------------- +[**SystemInfo**](../../models/SystemInfo.md) | | + + +#### get_system_info.ApiResponseForDefault +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor0ResponseBodyApplicationProblemjson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor0ResponseBodyApplicationProblemjson +Type | Description | Notes +------------- | ------------- | ------------- +[**Problem**](../../models/Problem.md) | | + + +### Authorization + +[JwtAuth](../../../README.md#JwtAuth), [ApiKeyAuth](../../../README.md#ApiKeyAuth) + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + diff --git a/docs/models/Analysis.md b/docs/models/Analysis.md index 4e21e63..ab9387e 100644 --- a/docs/models/Analysis.md +++ b/docs/models/Analysis.md @@ -24,7 +24,7 @@ Key | Input Type | Accessed Type | Description | Notes **endDate** | None, str, datetime, | NoneClass, str, | When the analysis was finished | [optional] value must conform to RFC-3339 date-time **summary** | None, str, | NoneClass, str, | The summary of the analysis | [optional] **analysisStorage** | [**AnalysisStorage**](AnalysisStorage.md) | [**AnalysisStorage**](AnalysisStorage.md) | | [optional] -**analysisPriority** | None, str, | NoneClass, str, | The priority of the analysis | [optional] must be one of ["Low", "Medium", "High", ] +**analysisPriority** | None, str, | NoneClass, str, | The priority of the analysis | [optional] must be one of ["LOW", "MEDIUM", "HIGH", ] **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/models/AnalysisData.md b/docs/models/AnalysisData.md index 984477e..108710d 100644 --- a/docs/models/AnalysisData.md +++ b/docs/models/AnalysisData.md @@ -13,6 +13,7 @@ Key | Input Type | Accessed Type | Description | Notes **format** | [**DataFormat**](DataFormat.md) | [**DataFormat**](DataFormat.md) | | **name** | str, | str, | The name of the file/folder as it was processed by the analysis. | **[children](#children)** | list, tuple, | tuple, | | [optional] +**mountPath** | str, | str, | The requested location where the input file was located on the machine that was running the pipeline. | [optional] **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] # children diff --git a/docs/models/AnalysisStorage.md b/docs/models/AnalysisStorage.md index 2496516..ebcc429 100644 --- a/docs/models/AnalysisStorage.md +++ b/docs/models/AnalysisStorage.md @@ -3,7 +3,7 @@ ## Model Type Info Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | | ### Dictionary Keys Key | Input Type | Accessed Type | Description | Notes diff --git a/docs/models/CreateCwlAnalysis.md b/docs/models/CreateCwlAnalysis.md index 34ed95a..30c37d0 100644 --- a/docs/models/CreateCwlAnalysis.md +++ b/docs/models/CreateCwlAnalysis.md @@ -8,11 +8,11 @@ dict, frozendict.frozendict, | frozendict.frozendict, | | ### Dictionary Keys Key | Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- | ------------- -**activationCodeDetailId** | str, uuid.UUID, | str, | Indicates under which activation code the pipeline is executed. | value must be a uuid **userReference** | str, | str, | The user-reference of the analysis. This should be something meaningful for the user. | **analysisInput** | [**CwlAnalysisInput**](CwlAnalysisInput.md) | [**CwlAnalysisInput**](CwlAnalysisInput.md) | | **pipelineId** | str, | str, | The pipeline for which an analysis will be created. | **tags** | [**AnalysisTag**](AnalysisTag.md) | [**AnalysisTag**](AnalysisTag.md) | | +**activationCodeDetailId** | str, uuid.UUID, | str, | Indicates under which activation code the pipeline is executed. | [optional] value must be a uuid **analysisStorageId** | None, str, uuid.UUID, | NoneClass, str, | The id of the storage to use for the analysis. | [optional] value must be a uuid **outputParentFolderId** | None, str, | NoneClass, str, | The id or the urn of the folder in which the output folder should be created. | [optional] **[analysisOutput](#analysisOutput)** | list, tuple, None, | tuple, NoneClass, | | [optional] diff --git a/docs/models/CreateNextflowAnalysis.md b/docs/models/CreateNextflowAnalysis.md index ed8c5d6..60b113b 100644 --- a/docs/models/CreateNextflowAnalysis.md +++ b/docs/models/CreateNextflowAnalysis.md @@ -8,11 +8,11 @@ dict, frozendict.frozendict, | frozendict.frozendict, | | ### Dictionary Keys Key | Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- | ------------- -**activationCodeDetailId** | str, uuid.UUID, | str, | Indicates under which activation code the pipeline is executed. | value must be a uuid **userReference** | str, | str, | The user-reference of the analysis. This should be something meaningful for the user. | **analysisInput** | [**NextflowAnalysisInput**](NextflowAnalysisInput.md) | [**NextflowAnalysisInput**](NextflowAnalysisInput.md) | | **pipelineId** | str, | str, | The pipeline for which an analysis will be created. | **tags** | [**AnalysisTag**](AnalysisTag.md) | [**AnalysisTag**](AnalysisTag.md) | | +**activationCodeDetailId** | str, uuid.UUID, | str, | Indicates under which activation code the pipeline is executed. | [optional] value must be a uuid **analysisStorageId** | None, str, uuid.UUID, | NoneClass, str, | The id of the storage to use for the analysis. | [optional] value must be a uuid **outputParentFolderId** | None, str, | NoneClass, str, | The id or the urn of the folder in which the output folder should be created. | [optional] **[analysisOutput](#analysisOutput)** | list, tuple, None, | tuple, NoneClass, | | [optional] diff --git a/docs/models/CreateProject.md b/docs/models/CreateProject.md index cbfa245..6aee842 100644 --- a/docs/models/CreateProject.md +++ b/docs/models/CreateProject.md @@ -20,7 +20,7 @@ Key | Input Type | Accessed Type | Description | Notes **metadataModelId** | None, str, uuid.UUID, | NoneClass, str, | | [optional] value must be a uuid **storageConfigurationId** | None, str, uuid.UUID, | NoneClass, str, | An optional storage configuration id to have self managed storage. | [optional] value must be a uuid **storageConfigurationSubfolder** | None, str, | NoneClass, str, | An optional subfolder that determines the object prefix of your self managed storage. If not used, you will not be able to use this storage configuration for any future projects. | [optional] -**analysisPriority** | None, str, | NoneClass, str, | Indicates the priority given to a project and its analyses within a single tenant, where Medium is the default value. | [optional] must be one of ["Low", "Medium", "High", ] if omitted the server will use the default value of "Medium" +**analysisPriority** | None, str, | NoneClass, str, | Indicates the priority given to a project and its analyses within a single tenant, where MEDIUM is the default value. | [optional] must be one of ["LOW", "MEDIUM", "HIGH", ] if omitted the server will use the default value of "MEDIUM" **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/models/CreateProjectDataUpdateBatch.md b/docs/models/CreateProjectDataUpdateBatch.md new file mode 100644 index 0000000..166afac --- /dev/null +++ b/docs/models/CreateProjectDataUpdateBatch.md @@ -0,0 +1,27 @@ +# icasdk.model.create_project_data_update_batch.CreateProjectDataUpdateBatch + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[dataUpdateGroups](#dataUpdateGroups)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dataUpdateGroups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DataUpdateGroup**](DataUpdateGroup.md) | [**DataUpdateGroup**](DataUpdateGroup.md) | [**DataUpdateGroup**](DataUpdateGroup.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateProjectPermissionV4.md b/docs/models/CreateProjectPermissionV4.md new file mode 100644 index 0000000..4237ac1 --- /dev/null +++ b/docs/models/CreateProjectPermissionV4.md @@ -0,0 +1,24 @@ +# icasdk.model.create_project_permission_v4.CreateProjectPermissionV4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**uploadAllowed** | bool, | BoolClass, | Indicates if uploading data is allowed or not. | +**membershipType** | str, | str, | How users are invited to the project | must be one of ["USER", "EMAIL", "WORKGROUP", ] +**roleFlow** | str, | str, | | +**roleBase** | str, | str, | | +**downloadAllowed** | bool, | BoolClass, | Indicates if downloading data is allowed or not. | +**roleBench** | str, | str, | | +**roleProject** | str, | str, | | +**userId** | None, str, uuid.UUID, | NoneClass, str, | the id of the user that should be given access, required when membershipType is USER | [optional] value must be a uuid +**emailAddress** | None, str, | NoneClass, str, | The email to invite a user on, required when membershipType is EMAIL | [optional] +**workgroupId** | None, str, uuid.UUID, | NoneClass, str, | the id of the workgroup to give access, required when membershipType is WORKGROUP | [optional] value must be a uuid +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DataUpdateGroup.md b/docs/models/DataUpdateGroup.md new file mode 100644 index 0000000..f02a135 --- /dev/null +++ b/docs/models/DataUpdateGroup.md @@ -0,0 +1,31 @@ +# icasdk.model.data_update_group.DataUpdateGroup + +Updates to apply. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Updates to apply. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[dataIds](#dataIds)** | list, tuple, | tuple, | | +**userTags** | [**TagUpdate**](TagUpdate.md) | [**TagUpdate**](TagUpdate.md) | | [optional] +**technicalTags** | [**TagUpdate**](TagUpdate.md) | [**TagUpdate**](TagUpdate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dataIds + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/InputPart.md b/docs/models/InputPart.md index 853525f..f4b7bc4 100644 --- a/docs/models/InputPart.md +++ b/docs/models/InputPart.md @@ -8,13 +8,13 @@ dict, frozendict.frozendict, | frozendict.frozendict, | | ### Dictionary Keys Key | Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- | ------------- -**[headers](#headers)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] **[mediaType](#mediaType)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**bodyAsString** | str, | str, | | [optional] **contentTypeFromMessage** | bool, | BoolClass, | | [optional] +**bodyAsString** | str, | str, | | [optional] +**[headers](#headers)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] -# headers +# mediaType ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -24,21 +24,26 @@ dict, frozendict.frozendict, | frozendict.frozendict, | | ### Dictionary Keys Key | Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- | ------------- -**[any_string_name](#any_string_name)** | list, tuple, | tuple, | any string name can be used but the value must be the correct type | [optional] +**type** | str, | str, | | [optional] +**subtype** | str, | str, | | [optional] +**[parameters](#parameters)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**wildcardType** | bool, | BoolClass, | | [optional] +**wildcardSubtype** | bool, | BoolClass, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] -# any_string_name +# parameters ## Model Type Info Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- -list, tuple, | tuple, | | +dict, frozendict.frozendict, | frozendict.frozendict, | | -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] -# mediaType +# headers ## Model Type Info Input Type | Accessed Type | Description | Notes @@ -48,24 +53,19 @@ dict, frozendict.frozendict, | frozendict.frozendict, | | ### Dictionary Keys Key | Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- | ------------- -**type** | str, | str, | | [optional] -**subtype** | str, | str, | | [optional] -**[parameters](#parameters)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**wildcardType** | bool, | BoolClass, | | [optional] -**wildcardSubtype** | bool, | BoolClass, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] +**[any_string_name](#any_string_name)** | list, tuple, | tuple, | any string name can be used but the value must be the correct type | [optional] -# parameters +# any_string_name ## Model Type Info Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | +list, tuple, | tuple, | | -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/models/IntegerSettings.md b/docs/models/IntegerSettings.md new file mode 100644 index 0000000..f033072 --- /dev/null +++ b/docs/models/IntegerSettings.md @@ -0,0 +1,27 @@ +# icasdk.model.integer_settings.IntegerSettings + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[defaultValues](#defaultValues)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# defaultValues + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LoadDataInBaseRequest.md b/docs/models/LoadDataInBaseRequest.md index e7667ca..20d8506 100644 --- a/docs/models/LoadDataInBaseRequest.md +++ b/docs/models/LoadDataInBaseRequest.md @@ -9,7 +9,7 @@ dict, frozendict.frozendict, | frozendict.frozendict, | | Key | Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- | ------------- **dataId** | str, | str, | ID of the data to load into the table | -**allowQuotedNewlines** | None, bool, | NoneClass, BoolClass, | Enable to include newlines contained in quoted data sections in the cell’s value. When disabled, newlines will signal a new row | [optional] if omitted the server will use the default value of False +**allowQuotedNewlines** | None, bool, | NoneClass, BoolClass, | Enable to include newlines contained in quoted data sections in the cell’s value. When disabled, newlines will signal a new row | [optional] if omitted the server will use the default value of False **delimiter** | None, str, | NoneClass, str, | field delimiter | [optional] if omitted the server will use the default value of "," **encoding** | None, str, | NoneClass, str, | Encoding | [optional] must be one of ["UTF8", "ISO88591", ] if omitted the server will use the default value of "UTF8" **forceLoad** | None, bool, | NoneClass, BoolClass, | When false (default): the data will not be loaded if it was already previously loaded to table ; when true, the data will be loaded even if already loaded in the past | [optional] if omitted the server will use the default value of False diff --git a/docs/models/MultipartFormDataInput.md b/docs/models/MultipartFormDataInput.md index 1cfc187..b7ec7fb 100644 --- a/docs/models/MultipartFormDataInput.md +++ b/docs/models/MultipartFormDataInput.md @@ -8,24 +8,12 @@ dict, frozendict.frozendict, | frozendict.frozendict, | | ### Dictionary Keys Key | Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- | ------------- -**[formData](#formData)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] **[formDataMap](#formDataMap)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[formData](#formData)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] **[parts](#parts)** | list, tuple, | tuple, | | [optional] **preamble** | str, | str, | | [optional] **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] -# formData - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | [**InputPart**](InputPart.md) | [**InputPart**](InputPart.md) | any string name can be used but the value must be the correct type | [optional] - # formDataMap ## Model Type Info @@ -50,6 +38,18 @@ Class Name | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- [**InputPart**](InputPart.md) | [**InputPart**](InputPart.md) | [**InputPart**](InputPart.md) | | +# formData + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**InputPart**](InputPart.md) | [**InputPart**](InputPart.md) | any string name can be used but the value must be the correct type | [optional] + # parts ## Model Type Info diff --git a/docs/models/OptionSettings.md b/docs/models/OptionSettings.md new file mode 100644 index 0000000..1de0782 --- /dev/null +++ b/docs/models/OptionSettings.md @@ -0,0 +1,40 @@ +# icasdk.model.option_settings.OptionSettings + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[options](#options)** | list, tuple, | tuple, | | [optional] +**[defaultValues](#defaultValues)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# options + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# defaultValues + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PipelineConfigurationParameter.md b/docs/models/PipelineConfigurationParameter.md index edf623f..efcd1d9 100644 --- a/docs/models/PipelineConfigurationParameter.md +++ b/docs/models/PipelineConfigurationParameter.md @@ -10,7 +10,9 @@ Key | Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- | ------------- **code** | str, | str, | The code of the parameter | **multiValue** | bool, | BoolClass, | Indicates whether multiple values are allowed for this parameter | +**type** | str, | str, | The type for each parameter | **required** | bool, | BoolClass, | Indicates whether this parameter is required | +**settings** | [**Settings**](Settings.md) | [**Settings**](Settings.md) | | [optional] **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/models/PipelineFile.md b/docs/models/PipelineFile.md new file mode 100644 index 0000000..b68e908 --- /dev/null +++ b/docs/models/PipelineFile.md @@ -0,0 +1,16 @@ +# icasdk.model.pipeline_file.PipelineFile + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str, | str, | | +**id** | str, uuid.UUID, | str, | | value must be a uuid +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PipelineFileContentSpec.md b/docs/models/PipelineFileContentSpec.md new file mode 100644 index 0000000..78780e2 --- /dev/null +++ b/docs/models/PipelineFileContentSpec.md @@ -0,0 +1,15 @@ +# icasdk.model.pipeline_file_content_spec.PipelineFileContentSpec + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**content** | bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PipelineFileList.md b/docs/models/PipelineFileList.md new file mode 100644 index 0000000..13606b5 --- /dev/null +++ b/docs/models/PipelineFileList.md @@ -0,0 +1,27 @@ +# icasdk.model.pipeline_file_list.PipelineFileList + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[items](#items)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**PipelineFile**](PipelineFile.md) | [**PipelineFile**](PipelineFile.md) | [**PipelineFile**](PipelineFile.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Project.md b/docs/models/Project.md index 9266c34..4ee6a0d 100644 --- a/docs/models/Project.md +++ b/docs/models/Project.md @@ -26,7 +26,7 @@ Key | Input Type | Accessed Type | Description | Notes **dataSharingEnabled** | None, bool, | NoneClass, BoolClass, | Indicates whether the Data and Samples created in this Project can be linked to other Projects. | [optional] **storageBundle** | [**StorageBundle**](StorageBundle.md) | [**StorageBundle**](StorageBundle.md) | | [optional] **selfManagedStorageConfiguration** | [**StorageConfiguration**](StorageConfiguration.md) | [**StorageConfiguration**](StorageConfiguration.md) | | [optional] -**analysisPriority** | None, str, | NoneClass, str, | Indicates the priority given to a project and its analyses within a single tenant. Note that for a PUT call, when not providing a value for this attribute (null value or absent attribute), the persisted value will not change. | [optional] must be one of ["Low", "Medium", "High", ] +**analysisPriority** | None, str, | NoneClass, str, | Indicates the priority given to a project and its analyses within a single tenant. Note that for a PUT call, when not providing a value for this attribute (null value or absent attribute), the persisted value will not change. | [optional] must be one of ["LOW", "MEDIUM", "HIGH", ] **metadataModel** | [**MetadataModel**](MetadataModel.md) | [**MetadataModel**](MetadataModel.md) | | [optional] **application** | [**Application**](Application.md) | [**Application**](Application.md) | | [optional] **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] diff --git a/docs/models/ProjectDataUpdateBatch.md b/docs/models/ProjectDataUpdateBatch.md new file mode 100644 index 0000000..a966c1f --- /dev/null +++ b/docs/models/ProjectDataUpdateBatch.md @@ -0,0 +1,16 @@ +# icasdk.model.project_data_update_batch.ProjectDataUpdateBatch + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, uuid.UUID, | str, | | value must be a uuid +**job** | [**Job**](Job.md) | [**Job**](Job.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ProjectDataUpdateBatchItem.md b/docs/models/ProjectDataUpdateBatchItem.md new file mode 100644 index 0000000..123afaf --- /dev/null +++ b/docs/models/ProjectDataUpdateBatchItem.md @@ -0,0 +1,17 @@ +# icasdk.model.project_data_update_batch_item.ProjectDataUpdateBatchItem + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**request** | [**ProjectDataUpdateBatchItemRequest**](ProjectDataUpdateBatchItemRequest.md) | [**ProjectDataUpdateBatchItemRequest**](ProjectDataUpdateBatchItemRequest.md) | | +**processing** | [**ProjectDataUpdateBatchItemProcessing**](ProjectDataUpdateBatchItemProcessing.md) | [**ProjectDataUpdateBatchItemProcessing**](ProjectDataUpdateBatchItemProcessing.md) | | +**id** | str, uuid.UUID, | str, | | value must be a uuid +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ProjectDataUpdateBatchItemPagedList.md b/docs/models/ProjectDataUpdateBatchItemPagedList.md new file mode 100644 index 0000000..2f0cdb5 --- /dev/null +++ b/docs/models/ProjectDataUpdateBatchItemPagedList.md @@ -0,0 +1,30 @@ +# icasdk.model.project_data_update_batch_item_paged_list.ProjectDataUpdateBatchItemPagedList + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[items](#items)** | list, tuple, | tuple, | | +**nextPageToken** | None, str, | NoneClass, str, | The cursor to request the next page. For offset-based paging the value is an empty string. | [optional] +**remainingRecords** | None, decimal.Decimal, int, | NoneClass, decimal.Decimal, | The number of records remaining (used in cursor based pagination) | [optional] value must be a 64 bit integer +**totalItemCount** | None, decimal.Decimal, int, | NoneClass, decimal.Decimal, | The total number of records matching the search criteria (used in offset based pagination) | [optional] value must be a 64 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ProjectDataUpdateBatchItem**](ProjectDataUpdateBatchItem.md) | [**ProjectDataUpdateBatchItem**](ProjectDataUpdateBatchItem.md) | [**ProjectDataUpdateBatchItem**](ProjectDataUpdateBatchItem.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ProjectDataUpdateBatchItemProcessing.md b/docs/models/ProjectDataUpdateBatchItemProcessing.md new file mode 100644 index 0000000..c56b939 --- /dev/null +++ b/docs/models/ProjectDataUpdateBatchItemProcessing.md @@ -0,0 +1,16 @@ +# icasdk.model.project_data_update_batch_item_processing.ProjectDataUpdateBatchItemProcessing + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**status** | str, | str, | | must be one of ["INITIALISED", "WAITING_RESOURCES", "UPDATING", "UPDATED", "PARTIALLY_UPDATED", "FAILED", ] +**additionalStatusInformation** | None, str, | NoneClass, str, | Additional information regarding the status of this batch item. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ProjectDataUpdateBatchItemRequest.md b/docs/models/ProjectDataUpdateBatchItemRequest.md new file mode 100644 index 0000000..b69f53f --- /dev/null +++ b/docs/models/ProjectDataUpdateBatchItemRequest.md @@ -0,0 +1,17 @@ +# icasdk.model.project_data_update_batch_item_request.ProjectDataUpdateBatchItemRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**dataId** | str, | str, | Data to apply the update to (recursively, if it's a folder). | +**userTags** | [**TagUpdate**](TagUpdate.md) | [**TagUpdate**](TagUpdate.md) | | [optional] +**technicalTags** | [**TagUpdate**](TagUpdate.md) | [**TagUpdate**](TagUpdate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ProjectPermissionListV4.md b/docs/models/ProjectPermissionListV4.md new file mode 100644 index 0000000..f9cb700 --- /dev/null +++ b/docs/models/ProjectPermissionListV4.md @@ -0,0 +1,27 @@ +# icasdk.model.project_permission_list_v4.ProjectPermissionListV4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[items](#items)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ProjectPermissionV4**](ProjectPermissionV4.md) | [**ProjectPermissionV4**](ProjectPermissionV4.md) | [**ProjectPermissionV4**](ProjectPermissionV4.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ProjectPermissionV4.md b/docs/models/ProjectPermissionV4.md new file mode 100644 index 0000000..9de7508 --- /dev/null +++ b/docs/models/ProjectPermissionV4.md @@ -0,0 +1,32 @@ +# icasdk.model.project_permission_v4.ProjectPermissionV4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**uploadAllowed** | bool, | BoolClass, | | +**membershipType** | str, | str, | | must be one of ["USER", "EMAIL", "WORKGROUP", ] +**roleFlow** | str, | str, | Possible values are: NONE, VIEWER, CONTRIBUTOR. More types could be added in a future release. | +**roleBase** | str, | str, | Possible values are: NONE, VIEWER, CONTRIBUTOR. More types could be added in a future release. | +**tenantId** | str, uuid.UUID, | str, | | value must be a uuid +**downloadAllowed** | bool, | BoolClass, | | +**timeCreated** | str, datetime, | str, | | value must conform to RFC-3339 date-time +**id** | str, uuid.UUID, | str, | | value must be a uuid +**ownerId** | str, uuid.UUID, | str, | | value must be a uuid +**roleBench** | str, | str, | Possible values are: NONE, CONTRIBUTOR, ADMINISTRATOR. More types could be added in a future release. | +**roleProject** | str, | str, | Possible values are: NONE, VIEWER, CONTRIBUTOR, ADMINISTRATOR, DATA_PROVIDER. More types could be added in a future release. | +**timeModified** | str, datetime, | str, | | value must conform to RFC-3339 date-time +**tenantName** | None, str, | NoneClass, str, | | [optional] +**user** | [**User**](User.md) | [**User**](User.md) | | [optional] +**emailAddress** | None, str, | NoneClass, str, | Only present when membershipType is EMAIL | [optional] +**workgroup** | [**Workgroup**](Workgroup.md) | [**Workgroup**](Workgroup.md) | | [optional] +**invitationAccepted** | None, bool, | NoneClass, BoolClass, | Only present when membershipType is EMAIL | [optional] +**invitationRejected** | None, bool, | NoneClass, BoolClass, | Only present when user is invited by EMAIL | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/SampleCreationBatch.md b/docs/models/SampleCreationBatch.md index 774bc20..abbb784 100644 --- a/docs/models/SampleCreationBatch.md +++ b/docs/models/SampleCreationBatch.md @@ -10,6 +10,7 @@ Key | Input Type | Accessed Type | Description | Notes ------------ | ------------- | ------------- | ------------- | ------------- **id** | str, uuid.UUID, | str, | | value must be a uuid **job** | [**Job**](Job.md) | [**Job**](Job.md) | | [optional] +**sequencingRunId** | None, str, uuid.UUID, | NoneClass, str, | The sequencingRunId to link to all created samples and linked data | [optional] value must be a uuid **any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/models/Settings.md b/docs/models/Settings.md new file mode 100644 index 0000000..d6f240c --- /dev/null +++ b/docs/models/Settings.md @@ -0,0 +1,19 @@ +# icasdk.model.settings.Settings + +This object contains a \"oneOf\" construct. Depending on which type, you will receive a StringSettings-, IntegerSettings or OptionsSettings object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | This object contains a \"oneOf\" construct. Depending on which type, you will receive a StringSettings-, IntegerSettings or OptionsSettings object. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[StringSettings](StringSettings.md) | [**StringSettings**](StringSettings.md) | [**StringSettings**](StringSettings.md) | | +[IntegerSettings](IntegerSettings.md) | [**IntegerSettings**](IntegerSettings.md) | [**IntegerSettings**](IntegerSettings.md) | | +[OptionSettings](OptionSettings.md) | [**OptionSettings**](OptionSettings.md) | [**OptionSettings**](OptionSettings.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/StringSettings.md b/docs/models/StringSettings.md new file mode 100644 index 0000000..bd2f5ae --- /dev/null +++ b/docs/models/StringSettings.md @@ -0,0 +1,27 @@ +# icasdk.model.string_settings.StringSettings + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[defaultValues](#defaultValues)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# defaultValues + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/SystemInfo.md b/docs/models/SystemInfo.md new file mode 100644 index 0000000..03f5ea1 --- /dev/null +++ b/docs/models/SystemInfo.md @@ -0,0 +1,16 @@ +# icasdk.model.system_info.SystemInfo + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str, | str, | | +**version** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TagUpdate.md b/docs/models/TagUpdate.md new file mode 100644 index 0000000..4aae475 --- /dev/null +++ b/docs/models/TagUpdate.md @@ -0,0 +1,40 @@ +# icasdk.model.tag_update.TagUpdate + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[addTags](#addTags)** | list, tuple, | tuple, | | [optional] +**[removeTags](#removeTags)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# addTags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# removeTags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TermsOfUseAcceptance.md b/docs/models/TermsOfUseAcceptance.md new file mode 100644 index 0000000..0d8e69a --- /dev/null +++ b/docs/models/TermsOfUseAcceptance.md @@ -0,0 +1,19 @@ +# icasdk.model.terms_of_use_acceptance.TermsOfUseAcceptance + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**accepted** | bool, | BoolClass, | Are the terms of use accepted | +**firstAcceptanceDate** | str, datetime, | str, | Date of the first time the terms of use were accepted. | value must conform to RFC-3339 date-time +**versionTermsOfUseFirstAccept** | str, | str, | Version of the first accepted Terms of Use. | +**lastAcceptanceDate** | str, datetime, | str, | Date of the last time the terms of use were accepted. | [optional] value must conform to RFC-3339 date-time +**versionTermsOfUseLastAccept** | str, | str, | Version of the last accepted Terms of Use. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/icasdk/apis/path_to_api.py b/icasdk/apis/path_to_api.py index cbd1cfc..189f6e1 100644 --- a/icasdk/apis/path_to_api.py +++ b/icasdk/apis/path_to_api.py @@ -4,8 +4,10 @@ from icasdk.apis.paths.api_analysis_storages import ApiAnalysisStorages from icasdk.apis.paths.api_bundles import ApiBundles from icasdk.apis.paths.api_bundles_bundle_id import ApiBundlesBundleId +from icasdk.apis.paths.api_bundles_bundle_id_terms_of_useaccept import ApiBundlesBundleIdTermsOfUseaccept from icasdk.apis.paths.api_bundles_bundle_idrelease import ApiBundlesBundleIdrelease from icasdk.apis.paths.api_bundles_bundle_id_terms_of_use import ApiBundlesBundleIdTermsOfUse +from icasdk.apis.paths.api_bundles_bundle_id_terms_of_use_user_acceptance_current_user import ApiBundlesBundleIdTermsOfUseUserAcceptanceCurrentUser from icasdk.apis.paths.api_bundles_bundle_id_terms_of_usenew import ApiBundlesBundleIdTermsOfUsenew from icasdk.apis.paths.api_bundles_bundle_iddeprecate import ApiBundlesBundleIddeprecate from icasdk.apis.paths.api_bundles_bundle_id_data import ApiBundlesBundleIdData @@ -52,6 +54,8 @@ from icasdk.apis.paths.api_pipelines_pipeline_id_configuration_parameters import ApiPipelinesPipelineIdConfigurationParameters from icasdk.apis.paths.api_pipelines_pipeline_id_reference_sets import ApiPipelinesPipelineIdReferenceSets from icasdk.apis.paths.api_pipelines_pipeline_id_documentation_html import ApiPipelinesPipelineIdDocumentationHTML +from icasdk.apis.paths.api_pipelines_pipeline_id_files import ApiPipelinesPipelineIdFiles +from icasdk.apis.paths.api_pipelines_pipeline_id_files_file_id_content import ApiPipelinesPipelineIdFilesFileIdContent from icasdk.apis.paths.api_pipeline_languages_nextflow_versions import ApiPipelineLanguagesNextflowVersions from icasdk.apis.paths.api_projects_project_id_analyses import ApiProjectsProjectIdAnalyses from icasdk.apis.paths.api_projects_project_id_analyses_analysis_id import ApiProjectsProjectIdAnalysesAnalysisId @@ -109,6 +113,10 @@ from icasdk.apis.paths.api_projects_project_id_data_transfers import ApiProjectsProjectIdDataTransfers from icasdk.apis.paths.api_projects_project_id_data_transfers_data_transfer_id import ApiProjectsProjectIdDataTransfersDataTransferId from icasdk.apis.paths.api_projects_project_id_data_transfers_data_transfer_idabort import ApiProjectsProjectIdDataTransfersDataTransferIdabort +from icasdk.apis.paths.api_projects_project_id_data_update_batch import ApiProjectsProjectIdDataUpdateBatch +from icasdk.apis.paths.api_projects_project_id_data_update_batch_batch_id import ApiProjectsProjectIdDataUpdateBatchBatchId +from icasdk.apis.paths.api_projects_project_id_data_update_batch_batch_id_items import ApiProjectsProjectIdDataUpdateBatchBatchIdItems +from icasdk.apis.paths.api_projects_project_id_data_update_batch_batch_id_items_item_id import ApiProjectsProjectIdDataUpdateBatchBatchIdItemsItemId from icasdk.apis.paths.api_projects_project_id_notification_subscriptions import ApiProjectsProjectIdNotificationSubscriptions from icasdk.apis.paths.api_projects_project_id_notification_subscriptions_subscription_id import ApiProjectsProjectIdNotificationSubscriptionsSubscriptionId from icasdk.apis.paths.api_projects_project_id_permissions import ApiProjectsProjectIdPermissions @@ -120,6 +128,9 @@ from icasdk.apis.paths.api_projects_project_id_pipelines_pipeline_id_reference_sets import ApiProjectsProjectIdPipelinesPipelineIdReferenceSets from icasdk.apis.paths.api_projects_project_id_pipelines_pipeline_idrelease import ApiProjectsProjectIdPipelinesPipelineIdrelease from icasdk.apis.paths.api_projects_project_id_pipelines_pipeline_id_documentation_html import ApiProjectsProjectIdPipelinesPipelineIdDocumentationHTML +from icasdk.apis.paths.api_projects_project_id_pipelines_pipeline_id_files import ApiProjectsProjectIdPipelinesPipelineIdFiles +from icasdk.apis.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id_content import ApiProjectsProjectIdPipelinesPipelineIdFilesFileIdContent +from icasdk.apis.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id import ApiProjectsProjectIdPipelinesPipelineIdFilesFileId from icasdk.apis.paths.api_projects_project_id_pipelinescreate_nextflow_pipeline import ApiProjectsProjectIdPipelinescreateNextflowPipeline from icasdk.apis.paths.api_projects_project_id_pipelinescreate_cwl_pipeline import ApiProjectsProjectIdPipelinescreateCwlPipeline from icasdk.apis.paths.api_projects_project_id_samples import ApiProjectsProjectIdSamples @@ -128,6 +139,7 @@ from icasdk.apis.paths.api_projects_project_id_samples_sample_idcomplete import ApiProjectsProjectIdSamplesSampleIdcomplete from icasdk.apis.paths.api_projects_project_id_samples_sample_idunlink import ApiProjectsProjectIdSamplesSampleIdunlink from icasdk.apis.paths.api_projects_project_id_samples_sample_id_projects import ApiProjectsProjectIdSamplesSampleIdProjects +from icasdk.apis.paths.api_projects_project_id_samples_sample_id_analyses import ApiProjectsProjectIdSamplesSampleIdAnalyses from icasdk.apis.paths.api_projects_project_id_samples_sample_id_data import ApiProjectsProjectIdSamplesSampleIdData from icasdk.apis.paths.api_projects_project_id_samples_sample_id_data_data_id import ApiProjectsProjectIdSamplesSampleIdDataDataId from icasdk.apis.paths.api_projects_project_id_samples_sample_id_data_data_idunlink import ApiProjectsProjectIdSamplesSampleIdDataDataIdunlink @@ -148,6 +160,7 @@ from icasdk.apis.paths.api_regions import ApiRegions from icasdk.apis.paths.api_regions_region_id import ApiRegionsRegionId from icasdk.apis.paths.api_samples import ApiSamples +from icasdk.apis.paths.api_sequencing_runs_sequencing_run_id import ApiSequencingRunsSequencingRunId from icasdk.apis.paths.api_storage_bundles import ApiStorageBundles from icasdk.apis.paths.api_storage_configurations import ApiStorageConfigurations from icasdk.apis.paths.api_storage_configurations_storage_configuration_id import ApiStorageConfigurationsStorageConfigurationId @@ -157,6 +170,7 @@ from icasdk.apis.paths.api_storage_credentials_storage_credential_id import ApiStorageCredentialsStorageCredentialId from icasdk.apis.paths.api_storage_credentials_storage_credential_idshare import ApiStorageCredentialsStorageCredentialIdshare from icasdk.apis.paths.api_storage_credentials_storage_credential_idupdate_secrets import ApiStorageCredentialsStorageCredentialIdupdateSecrets +from icasdk.apis.paths.api_system_info import ApiSystemInfo from icasdk.apis.paths.api_tokens import ApiTokens from icasdk.apis.paths.api_tokensrefresh import ApiTokensrefresh from icasdk.apis.paths.api_users import ApiUsers @@ -175,8 +189,10 @@ PathValues.API_ANALYSIS_STORAGES: ApiAnalysisStorages, PathValues.API_BUNDLES: ApiBundles, PathValues.API_BUNDLES_BUNDLE_ID: ApiBundlesBundleId, + PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USEACCEPT: ApiBundlesBundleIdTermsOfUseaccept, PathValues.API_BUNDLES_BUNDLE_IDRELEASE: ApiBundlesBundleIdrelease, PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USE: ApiBundlesBundleIdTermsOfUse, + PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USE_USER_ACCEPTANCE_CURRENT_USER: ApiBundlesBundleIdTermsOfUseUserAcceptanceCurrentUser, PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USENEW: ApiBundlesBundleIdTermsOfUsenew, PathValues.API_BUNDLES_BUNDLE_IDDEPRECATE: ApiBundlesBundleIddeprecate, PathValues.API_BUNDLES_BUNDLE_ID_DATA: ApiBundlesBundleIdData, @@ -223,6 +239,8 @@ PathValues.API_PIPELINES_PIPELINE_ID_CONFIGURATION_PARAMETERS: ApiPipelinesPipelineIdConfigurationParameters, PathValues.API_PIPELINES_PIPELINE_ID_REFERENCE_SETS: ApiPipelinesPipelineIdReferenceSets, PathValues.API_PIPELINES_PIPELINE_ID_DOCUMENTATION_HTML: ApiPipelinesPipelineIdDocumentationHTML, + PathValues.API_PIPELINES_PIPELINE_ID_FILES: ApiPipelinesPipelineIdFiles, + PathValues.API_PIPELINES_PIPELINE_ID_FILES_FILE_ID_CONTENT: ApiPipelinesPipelineIdFilesFileIdContent, PathValues.API_PIPELINE_LANGUAGES_NEXTFLOW_VERSIONS: ApiPipelineLanguagesNextflowVersions, PathValues.API_PROJECTS_PROJECT_ID_ANALYSES: ApiProjectsProjectIdAnalyses, PathValues.API_PROJECTS_PROJECT_ID_ANALYSES_ANALYSIS_ID: ApiProjectsProjectIdAnalysesAnalysisId, @@ -280,6 +298,10 @@ PathValues.API_PROJECTS_PROJECT_ID_DATA_TRANSFERS: ApiProjectsProjectIdDataTransfers, PathValues.API_PROJECTS_PROJECT_ID_DATA_TRANSFERS_DATA_TRANSFER_ID: ApiProjectsProjectIdDataTransfersDataTransferId, PathValues.API_PROJECTS_PROJECT_ID_DATA_TRANSFERS_DATA_TRANSFER_IDABORT: ApiProjectsProjectIdDataTransfersDataTransferIdabort, + PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH: ApiProjectsProjectIdDataUpdateBatch, + PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID: ApiProjectsProjectIdDataUpdateBatchBatchId, + PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID_ITEMS: ApiProjectsProjectIdDataUpdateBatchBatchIdItems, + PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID_ITEMS_ITEM_ID: ApiProjectsProjectIdDataUpdateBatchBatchIdItemsItemId, PathValues.API_PROJECTS_PROJECT_ID_NOTIFICATION_SUBSCRIPTIONS: ApiProjectsProjectIdNotificationSubscriptions, PathValues.API_PROJECTS_PROJECT_ID_NOTIFICATION_SUBSCRIPTIONS_SUBSCRIPTION_ID: ApiProjectsProjectIdNotificationSubscriptionsSubscriptionId, PathValues.API_PROJECTS_PROJECT_ID_PERMISSIONS: ApiProjectsProjectIdPermissions, @@ -291,6 +313,9 @@ PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_REFERENCE_SETS: ApiProjectsProjectIdPipelinesPipelineIdReferenceSets, PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_IDRELEASE: ApiProjectsProjectIdPipelinesPipelineIdrelease, PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_DOCUMENTATION_HTML: ApiProjectsProjectIdPipelinesPipelineIdDocumentationHTML, + PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES: ApiProjectsProjectIdPipelinesPipelineIdFiles, + PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES_FILE_ID_CONTENT: ApiProjectsProjectIdPipelinesPipelineIdFilesFileIdContent, + PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES_FILE_ID: ApiProjectsProjectIdPipelinesPipelineIdFilesFileId, PathValues.API_PROJECTS_PROJECT_ID_PIPELINESCREATE_NEXTFLOW_PIPELINE: ApiProjectsProjectIdPipelinescreateNextflowPipeline, PathValues.API_PROJECTS_PROJECT_ID_PIPELINESCREATE_CWL_PIPELINE: ApiProjectsProjectIdPipelinescreateCwlPipeline, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES: ApiProjectsProjectIdSamples, @@ -299,6 +324,7 @@ PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_IDCOMPLETE: ApiProjectsProjectIdSamplesSampleIdcomplete, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_IDUNLINK: ApiProjectsProjectIdSamplesSampleIdunlink, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_PROJECTS: ApiProjectsProjectIdSamplesSampleIdProjects, + PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_ANALYSES: ApiProjectsProjectIdSamplesSampleIdAnalyses, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_DATA: ApiProjectsProjectIdSamplesSampleIdData, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_DATA_DATA_ID: ApiProjectsProjectIdSamplesSampleIdDataDataId, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_DATA_DATA_IDUNLINK: ApiProjectsProjectIdSamplesSampleIdDataDataIdunlink, @@ -319,6 +345,7 @@ PathValues.API_REGIONS: ApiRegions, PathValues.API_REGIONS_REGION_ID: ApiRegionsRegionId, PathValues.API_SAMPLES: ApiSamples, + PathValues.API_SEQUENCING_RUNS_SEQUENCING_RUN_ID: ApiSequencingRunsSequencingRunId, PathValues.API_STORAGE_BUNDLES: ApiStorageBundles, PathValues.API_STORAGE_CONFIGURATIONS: ApiStorageConfigurations, PathValues.API_STORAGE_CONFIGURATIONS_STORAGE_CONFIGURATION_ID: ApiStorageConfigurationsStorageConfigurationId, @@ -328,6 +355,7 @@ PathValues.API_STORAGE_CREDENTIALS_STORAGE_CREDENTIAL_ID: ApiStorageCredentialsStorageCredentialId, PathValues.API_STORAGE_CREDENTIALS_STORAGE_CREDENTIAL_IDSHARE: ApiStorageCredentialsStorageCredentialIdshare, PathValues.API_STORAGE_CREDENTIALS_STORAGE_CREDENTIAL_IDUPDATE_SECRETS: ApiStorageCredentialsStorageCredentialIdupdateSecrets, + PathValues.API_SYSTEM_INFO: ApiSystemInfo, PathValues.API_TOKENS: ApiTokens, PathValues.API_TOKENSREFRESH: ApiTokensrefresh, PathValues.API_USERS: ApiUsers, @@ -347,8 +375,10 @@ PathValues.API_ANALYSIS_STORAGES: ApiAnalysisStorages, PathValues.API_BUNDLES: ApiBundles, PathValues.API_BUNDLES_BUNDLE_ID: ApiBundlesBundleId, + PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USEACCEPT: ApiBundlesBundleIdTermsOfUseaccept, PathValues.API_BUNDLES_BUNDLE_IDRELEASE: ApiBundlesBundleIdrelease, PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USE: ApiBundlesBundleIdTermsOfUse, + PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USE_USER_ACCEPTANCE_CURRENT_USER: ApiBundlesBundleIdTermsOfUseUserAcceptanceCurrentUser, PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USENEW: ApiBundlesBundleIdTermsOfUsenew, PathValues.API_BUNDLES_BUNDLE_IDDEPRECATE: ApiBundlesBundleIddeprecate, PathValues.API_BUNDLES_BUNDLE_ID_DATA: ApiBundlesBundleIdData, @@ -395,6 +425,8 @@ PathValues.API_PIPELINES_PIPELINE_ID_CONFIGURATION_PARAMETERS: ApiPipelinesPipelineIdConfigurationParameters, PathValues.API_PIPELINES_PIPELINE_ID_REFERENCE_SETS: ApiPipelinesPipelineIdReferenceSets, PathValues.API_PIPELINES_PIPELINE_ID_DOCUMENTATION_HTML: ApiPipelinesPipelineIdDocumentationHTML, + PathValues.API_PIPELINES_PIPELINE_ID_FILES: ApiPipelinesPipelineIdFiles, + PathValues.API_PIPELINES_PIPELINE_ID_FILES_FILE_ID_CONTENT: ApiPipelinesPipelineIdFilesFileIdContent, PathValues.API_PIPELINE_LANGUAGES_NEXTFLOW_VERSIONS: ApiPipelineLanguagesNextflowVersions, PathValues.API_PROJECTS_PROJECT_ID_ANALYSES: ApiProjectsProjectIdAnalyses, PathValues.API_PROJECTS_PROJECT_ID_ANALYSES_ANALYSIS_ID: ApiProjectsProjectIdAnalysesAnalysisId, @@ -452,6 +484,10 @@ PathValues.API_PROJECTS_PROJECT_ID_DATA_TRANSFERS: ApiProjectsProjectIdDataTransfers, PathValues.API_PROJECTS_PROJECT_ID_DATA_TRANSFERS_DATA_TRANSFER_ID: ApiProjectsProjectIdDataTransfersDataTransferId, PathValues.API_PROJECTS_PROJECT_ID_DATA_TRANSFERS_DATA_TRANSFER_IDABORT: ApiProjectsProjectIdDataTransfersDataTransferIdabort, + PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH: ApiProjectsProjectIdDataUpdateBatch, + PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID: ApiProjectsProjectIdDataUpdateBatchBatchId, + PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID_ITEMS: ApiProjectsProjectIdDataUpdateBatchBatchIdItems, + PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID_ITEMS_ITEM_ID: ApiProjectsProjectIdDataUpdateBatchBatchIdItemsItemId, PathValues.API_PROJECTS_PROJECT_ID_NOTIFICATION_SUBSCRIPTIONS: ApiProjectsProjectIdNotificationSubscriptions, PathValues.API_PROJECTS_PROJECT_ID_NOTIFICATION_SUBSCRIPTIONS_SUBSCRIPTION_ID: ApiProjectsProjectIdNotificationSubscriptionsSubscriptionId, PathValues.API_PROJECTS_PROJECT_ID_PERMISSIONS: ApiProjectsProjectIdPermissions, @@ -463,6 +499,9 @@ PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_REFERENCE_SETS: ApiProjectsProjectIdPipelinesPipelineIdReferenceSets, PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_IDRELEASE: ApiProjectsProjectIdPipelinesPipelineIdrelease, PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_DOCUMENTATION_HTML: ApiProjectsProjectIdPipelinesPipelineIdDocumentationHTML, + PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES: ApiProjectsProjectIdPipelinesPipelineIdFiles, + PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES_FILE_ID_CONTENT: ApiProjectsProjectIdPipelinesPipelineIdFilesFileIdContent, + PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES_FILE_ID: ApiProjectsProjectIdPipelinesPipelineIdFilesFileId, PathValues.API_PROJECTS_PROJECT_ID_PIPELINESCREATE_NEXTFLOW_PIPELINE: ApiProjectsProjectIdPipelinescreateNextflowPipeline, PathValues.API_PROJECTS_PROJECT_ID_PIPELINESCREATE_CWL_PIPELINE: ApiProjectsProjectIdPipelinescreateCwlPipeline, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES: ApiProjectsProjectIdSamples, @@ -471,6 +510,7 @@ PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_IDCOMPLETE: ApiProjectsProjectIdSamplesSampleIdcomplete, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_IDUNLINK: ApiProjectsProjectIdSamplesSampleIdunlink, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_PROJECTS: ApiProjectsProjectIdSamplesSampleIdProjects, + PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_ANALYSES: ApiProjectsProjectIdSamplesSampleIdAnalyses, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_DATA: ApiProjectsProjectIdSamplesSampleIdData, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_DATA_DATA_ID: ApiProjectsProjectIdSamplesSampleIdDataDataId, PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_DATA_DATA_IDUNLINK: ApiProjectsProjectIdSamplesSampleIdDataDataIdunlink, @@ -491,6 +531,7 @@ PathValues.API_REGIONS: ApiRegions, PathValues.API_REGIONS_REGION_ID: ApiRegionsRegionId, PathValues.API_SAMPLES: ApiSamples, + PathValues.API_SEQUENCING_RUNS_SEQUENCING_RUN_ID: ApiSequencingRunsSequencingRunId, PathValues.API_STORAGE_BUNDLES: ApiStorageBundles, PathValues.API_STORAGE_CONFIGURATIONS: ApiStorageConfigurations, PathValues.API_STORAGE_CONFIGURATIONS_STORAGE_CONFIGURATION_ID: ApiStorageConfigurationsStorageConfigurationId, @@ -500,6 +541,7 @@ PathValues.API_STORAGE_CREDENTIALS_STORAGE_CREDENTIAL_ID: ApiStorageCredentialsStorageCredentialId, PathValues.API_STORAGE_CREDENTIALS_STORAGE_CREDENTIAL_IDSHARE: ApiStorageCredentialsStorageCredentialIdshare, PathValues.API_STORAGE_CREDENTIALS_STORAGE_CREDENTIAL_IDUPDATE_SECRETS: ApiStorageCredentialsStorageCredentialIdupdateSecrets, + PathValues.API_SYSTEM_INFO: ApiSystemInfo, PathValues.API_TOKENS: ApiTokens, PathValues.API_TOKENSREFRESH: ApiTokensrefresh, PathValues.API_USERS: ApiUsers, diff --git a/icasdk/apis/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user.py b/icasdk/apis/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user.py new file mode 100644 index 0000000..c3badb3 --- /dev/null +++ b/icasdk/apis/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_bundles_bundle_id_terms_of_use_user_acceptance_current_user.get import ApiForget + + +class ApiBundlesBundleIdTermsOfUseUserAcceptanceCurrentUser( + ApiForget, +): + pass diff --git a/icasdk/apis/paths/api_bundles_bundle_id_terms_of_useaccept.py b/icasdk/apis/paths/api_bundles_bundle_id_terms_of_useaccept.py new file mode 100644 index 0000000..6229526 --- /dev/null +++ b/icasdk/apis/paths/api_bundles_bundle_id_terms_of_useaccept.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_bundles_bundle_id_terms_of_useaccept.post import ApiForpost + + +class ApiBundlesBundleIdTermsOfUseaccept( + ApiForpost, +): + pass diff --git a/icasdk/apis/paths/api_pipelines_pipeline_id_files.py b/icasdk/apis/paths/api_pipelines_pipeline_id_files.py new file mode 100644 index 0000000..46c6610 --- /dev/null +++ b/icasdk/apis/paths/api_pipelines_pipeline_id_files.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_pipelines_pipeline_id_files.get import ApiForget + + +class ApiPipelinesPipelineIdFiles( + ApiForget, +): + pass diff --git a/icasdk/apis/paths/api_pipelines_pipeline_id_files_file_id_content.py b/icasdk/apis/paths/api_pipelines_pipeline_id_files_file_id_content.py new file mode 100644 index 0000000..163bcac --- /dev/null +++ b/icasdk/apis/paths/api_pipelines_pipeline_id_files_file_id_content.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_pipelines_pipeline_id_files_file_id_content.get import ApiForget + + +class ApiPipelinesPipelineIdFilesFileIdContent( + ApiForget, +): + pass diff --git a/icasdk/apis/paths/api_projects_project_id_data_update_batch.py b/icasdk/apis/paths/api_projects_project_id_data_update_batch.py new file mode 100644 index 0000000..d96e274 --- /dev/null +++ b/icasdk/apis/paths/api_projects_project_id_data_update_batch.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_projects_project_id_data_update_batch.post import ApiForpost + + +class ApiProjectsProjectIdDataUpdateBatch( + ApiForpost, +): + pass diff --git a/icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id.py b/icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id.py new file mode 100644 index 0000000..d0341fa --- /dev/null +++ b/icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_projects_project_id_data_update_batch_batch_id.get import ApiForget + + +class ApiProjectsProjectIdDataUpdateBatchBatchId( + ApiForget, +): + pass diff --git a/icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id_items.py b/icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id_items.py new file mode 100644 index 0000000..94268b7 --- /dev/null +++ b/icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id_items.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_projects_project_id_data_update_batch_batch_id_items.get import ApiForget + + +class ApiProjectsProjectIdDataUpdateBatchBatchIdItems( + ApiForget, +): + pass diff --git a/icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id.py b/icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id.py new file mode 100644 index 0000000..b67ae63 --- /dev/null +++ b/icasdk/apis/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_projects_project_id_data_update_batch_batch_id_items_item_id.get import ApiForget + + +class ApiProjectsProjectIdDataUpdateBatchBatchIdItemsItemId( + ApiForget, +): + pass diff --git a/icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files.py b/icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files.py new file mode 100644 index 0000000..f21483c --- /dev/null +++ b/icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files.py @@ -0,0 +1,9 @@ +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files.get import ApiForget +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files.post import ApiForpost + + +class ApiProjectsProjectIdPipelinesPipelineIdFiles( + ApiForget, + ApiForpost, +): + pass diff --git a/icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id.py b/icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id.py new file mode 100644 index 0000000..31b6582 --- /dev/null +++ b/icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id.delete import ApiFordelete + + +class ApiProjectsProjectIdPipelinesPipelineIdFilesFileId( + ApiFordelete, +): + pass diff --git a/icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content.py b/icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content.py new file mode 100644 index 0000000..9f2a95f --- /dev/null +++ b/icasdk/apis/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content.py @@ -0,0 +1,9 @@ +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id_content.get import ApiForget +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id_content.put import ApiForput + + +class ApiProjectsProjectIdPipelinesPipelineIdFilesFileIdContent( + ApiForget, + ApiForput, +): + pass diff --git a/icasdk/apis/paths/api_projects_project_id_samples_sample_id_analyses.py b/icasdk/apis/paths/api_projects_project_id_samples_sample_id_analyses.py new file mode 100644 index 0000000..5d0fcd1 --- /dev/null +++ b/icasdk/apis/paths/api_projects_project_id_samples_sample_id_analyses.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_projects_project_id_samples_sample_id_analyses.get import ApiForget + + +class ApiProjectsProjectIdSamplesSampleIdAnalyses( + ApiForget, +): + pass diff --git a/icasdk/apis/paths/api_sequencing_runs_sequencing_run_id.py b/icasdk/apis/paths/api_sequencing_runs_sequencing_run_id.py new file mode 100644 index 0000000..275d8d6 --- /dev/null +++ b/icasdk/apis/paths/api_sequencing_runs_sequencing_run_id.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_sequencing_runs_sequencing_run_id.get import ApiForget + + +class ApiSequencingRunsSequencingRunId( + ApiForget, +): + pass diff --git a/icasdk/apis/paths/api_system_info.py b/icasdk/apis/paths/api_system_info.py new file mode 100644 index 0000000..8adca20 --- /dev/null +++ b/icasdk/apis/paths/api_system_info.py @@ -0,0 +1,7 @@ +from icasdk.paths.api_system_info.get import ApiForget + + +class ApiSystemInfo( + ApiForget, +): + pass diff --git a/icasdk/apis/tag_to_api.py b/icasdk/apis/tag_to_api.py index 30b6ff4..e73e79b 100644 --- a/icasdk/apis/tag_to_api.py +++ b/icasdk/apis/tag_to_api.py @@ -28,6 +28,7 @@ from icasdk.apis.tags.project_data_api import ProjectDataApi from icasdk.apis.tags.project_data_linking_batch_api import ProjectDataLinkingBatchApi from icasdk.apis.tags.project_data_transfer_api import ProjectDataTransferApi +from icasdk.apis.tags.project_data_update_batch_api import ProjectDataUpdateBatchApi from icasdk.apis.tags.project_notification_subscriptions_api import ProjectNotificationSubscriptionsApi from icasdk.apis.tags.project_permission_api import ProjectPermissionApi from icasdk.apis.tags.project_pipeline_api import ProjectPipelineApi @@ -36,9 +37,11 @@ from icasdk.apis.tags.reference_set_api import ReferenceSetApi from icasdk.apis.tags.region_api import RegionApi from icasdk.apis.tags.sample_api import SampleApi +from icasdk.apis.tags.sequencing_run_api import SequencingRunApi from icasdk.apis.tags.storage_bundle_api import StorageBundleApi from icasdk.apis.tags.storage_configuration_api import StorageConfigurationApi from icasdk.apis.tags.storage_credentials_api import StorageCredentialsApi +from icasdk.apis.tags.system_api import SystemApi from icasdk.apis.tags.token_api import TokenApi from icasdk.apis.tags.user_api import UserApi from icasdk.apis.tags.workgroup_api import WorkgroupApi @@ -73,6 +76,7 @@ TagValues.PROJECT_DATA: ProjectDataApi, TagValues.PROJECT_DATA_LINKING_BATCH: ProjectDataLinkingBatchApi, TagValues.PROJECT_DATA_TRANSFER: ProjectDataTransferApi, + TagValues.PROJECT_DATA_UPDATE_BATCH: ProjectDataUpdateBatchApi, TagValues.PROJECT_NOTIFICATION_SUBSCRIPTIONS: ProjectNotificationSubscriptionsApi, TagValues.PROJECT_PERMISSION: ProjectPermissionApi, TagValues.PROJECT_PIPELINE: ProjectPipelineApi, @@ -81,9 +85,11 @@ TagValues.REFERENCE_SET: ReferenceSetApi, TagValues.REGION: RegionApi, TagValues.SAMPLE: SampleApi, + TagValues.SEQUENCING_RUN: SequencingRunApi, TagValues.STORAGE_BUNDLE: StorageBundleApi, TagValues.STORAGE_CONFIGURATION: StorageConfigurationApi, TagValues.STORAGE_CREDENTIALS: StorageCredentialsApi, + TagValues.SYSTEM: SystemApi, TagValues.TOKEN: TokenApi, TagValues.USER: UserApi, TagValues.WORKGROUP: WorkgroupApi, @@ -119,6 +125,7 @@ TagValues.PROJECT_DATA: ProjectDataApi, TagValues.PROJECT_DATA_LINKING_BATCH: ProjectDataLinkingBatchApi, TagValues.PROJECT_DATA_TRANSFER: ProjectDataTransferApi, + TagValues.PROJECT_DATA_UPDATE_BATCH: ProjectDataUpdateBatchApi, TagValues.PROJECT_NOTIFICATION_SUBSCRIPTIONS: ProjectNotificationSubscriptionsApi, TagValues.PROJECT_PERMISSION: ProjectPermissionApi, TagValues.PROJECT_PIPELINE: ProjectPipelineApi, @@ -127,9 +134,11 @@ TagValues.REFERENCE_SET: ReferenceSetApi, TagValues.REGION: RegionApi, TagValues.SAMPLE: SampleApi, + TagValues.SEQUENCING_RUN: SequencingRunApi, TagValues.STORAGE_BUNDLE: StorageBundleApi, TagValues.STORAGE_CONFIGURATION: StorageConfigurationApi, TagValues.STORAGE_CREDENTIALS: StorageCredentialsApi, + TagValues.SYSTEM: SystemApi, TagValues.TOKEN: TokenApi, TagValues.USER: UserApi, TagValues.WORKGROUP: WorkgroupApi, diff --git a/icasdk/apis/tags/__init__.py b/icasdk/apis/tags/__init__.py index 7411675..24c99f3 100644 --- a/icasdk/apis/tags/__init__.py +++ b/icasdk/apis/tags/__init__.py @@ -33,6 +33,7 @@ class TagValues(str, enum.Enum): PROJECT_DATA = "Project Data" PROJECT_DATA_LINKING_BATCH = "Project Data Linking Batch" PROJECT_DATA_TRANSFER = "Project Data Transfer" + PROJECT_DATA_UPDATE_BATCH = "Project Data Update Batch" PROJECT_NOTIFICATION_SUBSCRIPTIONS = "Project Notification Subscriptions" PROJECT_PERMISSION = "Project Permission" PROJECT_PIPELINE = "Project Pipeline" @@ -41,9 +42,11 @@ class TagValues(str, enum.Enum): REFERENCE_SET = "Reference Set" REGION = "Region" SAMPLE = "Sample" + SEQUENCING_RUN = "Sequencing Run" STORAGE_BUNDLE = "Storage Bundle" STORAGE_CONFIGURATION = "Storage Configuration" STORAGE_CREDENTIALS = "Storage Credentials" + SYSTEM = "System" TOKEN = "Token" USER = "User" WORKGROUP = "Workgroup" diff --git a/icasdk/apis/tags/bundle_api.py b/icasdk/apis/tags/bundle_api.py index e5ee778..49224a1 100644 --- a/icasdk/apis/tags/bundle_api.py +++ b/icasdk/apis/tags/bundle_api.py @@ -9,21 +9,25 @@ Generated by: https://openapi-generator.tech """ +from icasdk.paths.api_bundles_bundle_id_terms_of_useaccept.post import AcceptTermsOfUseBundle from icasdk.paths.api_bundles.post import CreateBundle from icasdk.paths.api_bundles_bundle_iddeprecate.post import DeprecateBundle from icasdk.paths.api_bundles_bundle_id.get import GetBundle from icasdk.paths.api_bundles_bundle_id_terms_of_use.get import GetBundleTermsOfUse from icasdk.paths.api_bundles.get import GetBundles +from icasdk.paths.api_bundles_bundle_id_terms_of_use_user_acceptance_current_user.get import GetTermsOfUseAcceptance from icasdk.paths.api_bundles_bundle_id_terms_of_usenew.post import InsertBundleTermsOfUse from icasdk.paths.api_bundles_bundle_idrelease.post import ReleaseBundle class BundleApi( + AcceptTermsOfUseBundle, CreateBundle, DeprecateBundle, GetBundle, GetBundleTermsOfUse, GetBundles, + GetTermsOfUseAcceptance, InsertBundleTermsOfUse, ReleaseBundle, ): diff --git a/icasdk/apis/tags/pipeline_api.py b/icasdk/apis/tags/pipeline_api.py index 022e57d..11088ef 100644 --- a/icasdk/apis/tags/pipeline_api.py +++ b/icasdk/apis/tags/pipeline_api.py @@ -9,8 +9,10 @@ Generated by: https://openapi-generator.tech """ +from icasdk.paths.api_pipelines_pipeline_id_files_file_id_content.get import DownloadPipelineFileContent from icasdk.paths.api_pipelines_pipeline_id.get import GetPipeline from icasdk.paths.api_pipelines_pipeline_id_configuration_parameters.get import GetPipelineConfigurationParameters +from icasdk.paths.api_pipelines_pipeline_id_files.get import GetPipelineFiles from icasdk.paths.api_pipelines_pipeline_id_documentation_html.get import GetPipelineHtmlDocumentation from icasdk.paths.api_pipelines_pipeline_id_input_parameters.get import GetPipelineInputParameters from icasdk.paths.api_pipelines_pipeline_id_reference_sets.get import GetPipelineReferenceSets @@ -18,8 +20,10 @@ class PipelineApi( + DownloadPipelineFileContent, GetPipeline, GetPipelineConfigurationParameters, + GetPipelineFiles, GetPipelineHtmlDocumentation, GetPipelineInputParameters, GetPipelineReferenceSets, diff --git a/icasdk/apis/tags/project_data_update_batch_api.py b/icasdk/apis/tags/project_data_update_batch_api.py new file mode 100644 index 0000000..0fd3cf1 --- /dev/null +++ b/icasdk/apis/tags/project_data_update_batch_api.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from icasdk.paths.api_projects_project_id_data_update_batch.post import CreateProjectDataUpdateBatch +from icasdk.paths.api_projects_project_id_data_update_batch_batch_id.get import GetProjectDataUpdateBatch +from icasdk.paths.api_projects_project_id_data_update_batch_batch_id_items_item_id.get import GetProjectDataUpdateBatchItem +from icasdk.paths.api_projects_project_id_data_update_batch_batch_id_items.get import GetProjectDataUpdateBatchItems + + +class ProjectDataUpdateBatchApi( + CreateProjectDataUpdateBatch, + GetProjectDataUpdateBatch, + GetProjectDataUpdateBatchItem, + GetProjectDataUpdateBatchItems, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/icasdk/apis/tags/project_pipeline_api.py b/icasdk/apis/tags/project_pipeline_api.py index 5f02407..8a996b3 100644 --- a/icasdk/apis/tags/project_pipeline_api.py +++ b/icasdk/apis/tags/project_pipeline_api.py @@ -11,6 +11,10 @@ from icasdk.paths.api_projects_project_id_pipelinescreate_cwl_pipeline.post import CreateCwlPipeline from icasdk.paths.api_projects_project_id_pipelinescreate_nextflow_pipeline.post import CreateNextflowPipeline +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files.post import CreatePipelineFile +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id.delete import DeletePipelineFile +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id_content.get import DownloadPipelineFileContent1 +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files.get import GetPipelineFiles1 from icasdk.paths.api_projects_project_id_pipelines_pipeline_id.get import GetProjectPipeline from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_configuration_parameters.get import GetProjectPipelineConfigurationParameters from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_documentation_html.get import GetProjectPipelineHtmlDocumentation @@ -20,11 +24,16 @@ from icasdk.paths.api_projects_project_id_pipelines_pipeline_id.post import LinkPipelineToProject from icasdk.paths.api_projects_project_id_pipelines_pipeline_idrelease.post import ReleasePipeline from icasdk.paths.api_projects_project_id_pipelines_pipeline_id.delete import UnlinkPipelineFromProject +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id_content.put import UpdatePipelineFile class ProjectPipelineApi( CreateCwlPipeline, CreateNextflowPipeline, + CreatePipelineFile, + DeletePipelineFile, + DownloadPipelineFileContent1, + GetPipelineFiles1, GetProjectPipeline, GetProjectPipelineConfigurationParameters, GetProjectPipelineHtmlDocumentation, @@ -34,6 +43,7 @@ class ProjectPipelineApi( LinkPipelineToProject, ReleasePipeline, UnlinkPipelineFromProject, + UpdatePipelineFile, ): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/icasdk/apis/tags/project_sample_api.py b/icasdk/apis/tags/project_sample_api.py index d961185..c3929cd 100644 --- a/icasdk/apis/tags/project_sample_api.py +++ b/icasdk/apis/tags/project_sample_api.py @@ -16,6 +16,7 @@ from icasdk.paths.api_projects_project_id_samples_sample_iddelete_unlink.post import DeleteAndUnlinkSample from icasdk.paths.api_projects_project_id_samples_sample_iddelete_with_input.post import DeleteSampleWithInput from icasdk.paths.api_projects_project_id_samples_sample_id.get import GetProjectSample +from icasdk.paths.api_projects_project_id_samples_sample_id_analyses.get import GetProjectSampleAnalyses from icasdk.paths.api_projects_project_id_samplessearch.post import GetProjectSamples from icasdk.paths.api_projects_project_id_samples_sample_id_projects.get import GetProjectsForSample from icasdk.paths.api_projects_project_id_samples_sample_id_data.get import GetSampleDataList @@ -39,6 +40,7 @@ class ProjectSampleApi( DeleteAndUnlinkSample, DeleteSampleWithInput, GetProjectSample, + GetProjectSampleAnalyses, GetProjectSamples, GetProjectsForSample, GetSampleDataList, diff --git a/icasdk/apis/tags/sequencing_run_api.py b/icasdk/apis/tags/sequencing_run_api.py new file mode 100644 index 0000000..59604cf --- /dev/null +++ b/icasdk/apis/tags/sequencing_run_api.py @@ -0,0 +1,23 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from icasdk.paths.api_sequencing_runs_sequencing_run_id.get import GetSequencingRun + + +class SequencingRunApi( + GetSequencingRun, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/icasdk/apis/tags/system_api.py b/icasdk/apis/tags/system_api.py new file mode 100644 index 0000000..5f249ed --- /dev/null +++ b/icasdk/apis/tags/system_api.py @@ -0,0 +1,23 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from icasdk.paths.api_system_info.get import GetSystemInfo + + +class SystemApi( + GetSystemInfo, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/icasdk/model/analysis.py b/icasdk/model/analysis.py index 2859ba6..dbc6053 100644 --- a/icasdk/model/analysis.py +++ b/icasdk/model/analysis.py @@ -238,22 +238,22 @@ class analysisPriority( class MetaOapg: enum_value_to_name = { - "Low": "LOW", - "Medium": "MEDIUM", - "High": "HIGH", + "LOW": "LOW", + "MEDIUM": "MEDIUM", + "HIGH": "HIGH", } @schemas.classproperty def LOW(cls): - return cls("Low") + return cls("LOW") @schemas.classproperty def MEDIUM(cls): - return cls("Medium") + return cls("MEDIUM") @schemas.classproperty def HIGH(cls): - return cls("High") + return cls("HIGH") def __new__( diff --git a/icasdk/model/analysis.pyi b/icasdk/model/analysis.pyi index 29998ca..bc6233d 100644 --- a/icasdk/model/analysis.pyi +++ b/icasdk/model/analysis.pyi @@ -218,22 +218,22 @@ class Analysis( class MetaOapg: enum_value_to_name = { - "Low": "LOW", - "Medium": "MEDIUM", - "High": "HIGH", + "LOW": "LOW", + "MEDIUM": "MEDIUM", + "HIGH": "HIGH", } @schemas.classproperty def LOW(cls): - return cls("Low") + return cls("LOW") @schemas.classproperty def MEDIUM(cls): - return cls("Medium") + return cls("MEDIUM") @schemas.classproperty def HIGH(cls): - return cls("High") + return cls("HIGH") def __new__( diff --git a/icasdk/model/analysis_data.py b/icasdk/model/analysis_data.py index adb007c..6228d63 100644 --- a/icasdk/model/analysis_data.py +++ b/icasdk/model/analysis_data.py @@ -104,12 +104,14 @@ def __new__( def __getitem__(self, i: int) -> 'AnalysisData': return super().__getitem__(i) + mountPath = schemas.StrSchema __annotations__ = { "dataId": dataId, "format": format, "name": name, "dataType": dataType, "children": children, + "mountPath": mountPath, } dataId: MetaOapg.properties.dataId @@ -132,10 +134,13 @@ def __getitem__(self, name: typing_extensions.Literal["dataType"]) -> MetaOapg.p @typing.overload def __getitem__(self, name: typing_extensions.Literal["children"]) -> MetaOapg.properties.children: ... + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["mountPath"]) -> MetaOapg.properties.mountPath: ... + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataId", "format", "name", "dataType", "children", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataId", "format", "name", "dataType", "children", "mountPath", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -155,10 +160,13 @@ def get_item_oapg(self, name: typing_extensions.Literal["dataType"]) -> MetaOapg @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["children"]) -> typing.Union[MetaOapg.properties.children, schemas.Unset]: ... + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["mountPath"]) -> typing.Union[MetaOapg.properties.mountPath, schemas.Unset]: ... + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataId", "format", "name", "dataType", "children", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataId", "format", "name", "dataType", "children", "mountPath", ], str]): return super().get_item_oapg(name) @@ -170,6 +178,7 @@ def __new__( format: 'DataFormat', name: typing.Union[MetaOapg.properties.name, str, ], children: typing.Union[MetaOapg.properties.children, list, tuple, schemas.Unset] = schemas.unset, + mountPath: typing.Union[MetaOapg.properties.mountPath, str, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'AnalysisData': @@ -181,6 +190,7 @@ def __new__( format=format, name=name, children=children, + mountPath=mountPath, _configuration=_configuration, **kwargs, ) diff --git a/icasdk/model/analysis_data.pyi b/icasdk/model/analysis_data.pyi index 15ee090..1070980 100644 --- a/icasdk/model/analysis_data.pyi +++ b/icasdk/model/analysis_data.pyi @@ -93,12 +93,14 @@ class AnalysisData( def __getitem__(self, i: int) -> 'AnalysisData': return super().__getitem__(i) + mountPath = schemas.StrSchema __annotations__ = { "dataId": dataId, "format": format, "name": name, "dataType": dataType, "children": children, + "mountPath": mountPath, } dataId: MetaOapg.properties.dataId @@ -121,10 +123,13 @@ class AnalysisData( @typing.overload def __getitem__(self, name: typing_extensions.Literal["children"]) -> MetaOapg.properties.children: ... + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["mountPath"]) -> MetaOapg.properties.mountPath: ... + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataId", "format", "name", "dataType", "children", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataId", "format", "name", "dataType", "children", "mountPath", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -144,10 +149,13 @@ class AnalysisData( @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["children"]) -> typing.Union[MetaOapg.properties.children, schemas.Unset]: ... + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["mountPath"]) -> typing.Union[MetaOapg.properties.mountPath, schemas.Unset]: ... + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataId", "format", "name", "dataType", "children", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataId", "format", "name", "dataType", "children", "mountPath", ], str]): return super().get_item_oapg(name) @@ -159,6 +167,7 @@ class AnalysisData( format: 'DataFormat', name: typing.Union[MetaOapg.properties.name, str, ], children: typing.Union[MetaOapg.properties.children, list, tuple, schemas.Unset] = schemas.unset, + mountPath: typing.Union[MetaOapg.properties.mountPath, str, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'AnalysisData': @@ -170,6 +179,7 @@ class AnalysisData( format=format, name=name, children=children, + mountPath=mountPath, _configuration=_configuration, **kwargs, ) diff --git a/icasdk/model/analysis_storage.py b/icasdk/model/analysis_storage.py index ed22e7e..cf1f87b 100644 --- a/icasdk/model/analysis_storage.py +++ b/icasdk/model/analysis_storage.py @@ -24,7 +24,10 @@ class AnalysisStorage( - schemas.DictSchema + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin ): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -109,6 +112,7 @@ def __new__( "tenantName": tenantName, "description": description, } + name: MetaOapg.properties.name tenantId: MetaOapg.properties.tenantId @@ -182,13 +186,7 @@ def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "time def __new__( cls, - *args: typing.Union[dict, frozendict.frozendict, ], - name: typing.Union[MetaOapg.properties.name, str, ], - tenantId: typing.Union[MetaOapg.properties.tenantId, str, uuid.UUID, ], - timeCreated: typing.Union[MetaOapg.properties.timeCreated, str, datetime, ], - id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], - ownerId: typing.Union[MetaOapg.properties.ownerId, str, uuid.UUID, ], - timeModified: typing.Union[MetaOapg.properties.timeModified, str, datetime, ], + *args: typing.Union[dict, frozendict.frozendict, None, ], tenantName: typing.Union[MetaOapg.properties.tenantName, None, str, schemas.Unset] = schemas.unset, description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, @@ -197,12 +195,6 @@ def __new__( return super().__new__( cls, *args, - name=name, - tenantId=tenantId, - timeCreated=timeCreated, - id=id, - ownerId=ownerId, - timeModified=timeModified, tenantName=tenantName, description=description, _configuration=_configuration, diff --git a/icasdk/model/analysis_storage.pyi b/icasdk/model/analysis_storage.pyi index d388870..6566ca0 100644 --- a/icasdk/model/analysis_storage.pyi +++ b/icasdk/model/analysis_storage.pyi @@ -24,7 +24,10 @@ from icasdk import schemas # noqa: F401 class AnalysisStorage( - schemas.DictSchema + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin ): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -105,6 +108,7 @@ class AnalysisStorage( "tenantName": tenantName, "description": description, } + name: MetaOapg.properties.name tenantId: MetaOapg.properties.tenantId @@ -178,13 +182,7 @@ class AnalysisStorage( def __new__( cls, - *args: typing.Union[dict, frozendict.frozendict, ], - name: typing.Union[MetaOapg.properties.name, str, ], - tenantId: typing.Union[MetaOapg.properties.tenantId, str, uuid.UUID, ], - timeCreated: typing.Union[MetaOapg.properties.timeCreated, str, datetime, ], - id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], - ownerId: typing.Union[MetaOapg.properties.ownerId, str, uuid.UUID, ], - timeModified: typing.Union[MetaOapg.properties.timeModified, str, datetime, ], + *args: typing.Union[dict, frozendict.frozendict, None, ], tenantName: typing.Union[MetaOapg.properties.tenantName, None, str, schemas.Unset] = schemas.unset, description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, @@ -193,12 +191,6 @@ class AnalysisStorage( return super().__new__( cls, *args, - name=name, - tenantId=tenantId, - timeCreated=timeCreated, - id=id, - ownerId=ownerId, - timeModified=timeModified, tenantName=tenantName, description=description, _configuration=_configuration, diff --git a/icasdk/model/create_cwl_analysis.py b/icasdk/model/create_cwl_analysis.py index dc5f0dd..9b5763b 100644 --- a/icasdk/model/create_cwl_analysis.py +++ b/icasdk/model/create_cwl_analysis.py @@ -35,7 +35,6 @@ class CreateCwlAnalysis( class MetaOapg: required = { - "activationCodeDetailId", "userReference", "analysisInput", "pipelineId", @@ -61,11 +60,11 @@ class MetaOapg: @staticmethod def tags() -> typing.Type['AnalysisTag']: return AnalysisTag - activationCodeDetailId = schemas.UUIDSchema @staticmethod def analysisInput() -> typing.Type['CwlAnalysisInput']: return CwlAnalysisInput + activationCodeDetailId = schemas.UUIDSchema class analysisStorageId( @@ -142,14 +141,13 @@ def __new__( "userReference": userReference, "pipelineId": pipelineId, "tags": tags, - "activationCodeDetailId": activationCodeDetailId, "analysisInput": analysisInput, + "activationCodeDetailId": activationCodeDetailId, "analysisStorageId": analysisStorageId, "outputParentFolderId": outputParentFolderId, "analysisOutput": analysisOutput, } - activationCodeDetailId: MetaOapg.properties.activationCodeDetailId userReference: MetaOapg.properties.userReference analysisInput: 'CwlAnalysisInput' pipelineId: MetaOapg.properties.pipelineId @@ -165,10 +163,10 @@ def __getitem__(self, name: typing_extensions.Literal["pipelineId"]) -> MetaOapg def __getitem__(self, name: typing_extensions.Literal["tags"]) -> 'AnalysisTag': ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... + def __getitem__(self, name: typing_extensions.Literal["analysisInput"]) -> 'CwlAnalysisInput': ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["analysisInput"]) -> 'CwlAnalysisInput': ... + def __getitem__(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... @typing.overload def __getitem__(self, name: typing_extensions.Literal["analysisStorageId"]) -> MetaOapg.properties.analysisStorageId: ... @@ -182,7 +180,7 @@ def __getitem__(self, name: typing_extensions.Literal["analysisOutput"]) -> Meta @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "activationCodeDetailId", "analysisInput", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "analysisInput", "activationCodeDetailId", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -197,10 +195,10 @@ def get_item_oapg(self, name: typing_extensions.Literal["pipelineId"]) -> MetaOa def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> 'AnalysisTag': ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... + def get_item_oapg(self, name: typing_extensions.Literal["analysisInput"]) -> 'CwlAnalysisInput': ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["analysisInput"]) -> 'CwlAnalysisInput': ... + def get_item_oapg(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> typing.Union[MetaOapg.properties.activationCodeDetailId, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["analysisStorageId"]) -> typing.Union[MetaOapg.properties.analysisStorageId, schemas.Unset]: ... @@ -214,18 +212,18 @@ def get_item_oapg(self, name: typing_extensions.Literal["analysisOutput"]) -> ty @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "activationCodeDetailId", "analysisInput", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "analysisInput", "activationCodeDetailId", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): return super().get_item_oapg(name) def __new__( cls, *args: typing.Union[dict, frozendict.frozendict, ], - activationCodeDetailId: typing.Union[MetaOapg.properties.activationCodeDetailId, str, uuid.UUID, ], userReference: typing.Union[MetaOapg.properties.userReference, str, ], analysisInput: 'CwlAnalysisInput', pipelineId: typing.Union[MetaOapg.properties.pipelineId, str, ], tags: 'AnalysisTag', + activationCodeDetailId: typing.Union[MetaOapg.properties.activationCodeDetailId, str, uuid.UUID, schemas.Unset] = schemas.unset, analysisStorageId: typing.Union[MetaOapg.properties.analysisStorageId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, outputParentFolderId: typing.Union[MetaOapg.properties.outputParentFolderId, None, str, schemas.Unset] = schemas.unset, analysisOutput: typing.Union[MetaOapg.properties.analysisOutput, list, tuple, None, schemas.Unset] = schemas.unset, @@ -235,11 +233,11 @@ def __new__( return super().__new__( cls, *args, - activationCodeDetailId=activationCodeDetailId, userReference=userReference, analysisInput=analysisInput, pipelineId=pipelineId, tags=tags, + activationCodeDetailId=activationCodeDetailId, analysisStorageId=analysisStorageId, outputParentFolderId=outputParentFolderId, analysisOutput=analysisOutput, diff --git a/icasdk/model/create_cwl_analysis.pyi b/icasdk/model/create_cwl_analysis.pyi index c8cf26e..7e1794e 100644 --- a/icasdk/model/create_cwl_analysis.pyi +++ b/icasdk/model/create_cwl_analysis.pyi @@ -35,7 +35,6 @@ class CreateCwlAnalysis( class MetaOapg: required = { - "activationCodeDetailId", "userReference", "analysisInput", "pipelineId", @@ -54,11 +53,11 @@ class CreateCwlAnalysis( @staticmethod def tags() -> typing.Type['AnalysisTag']: return AnalysisTag - activationCodeDetailId = schemas.UUIDSchema @staticmethod def analysisInput() -> typing.Type['CwlAnalysisInput']: return CwlAnalysisInput + activationCodeDetailId = schemas.UUIDSchema class analysisStorageId( @@ -135,14 +134,13 @@ class CreateCwlAnalysis( "userReference": userReference, "pipelineId": pipelineId, "tags": tags, - "activationCodeDetailId": activationCodeDetailId, "analysisInput": analysisInput, + "activationCodeDetailId": activationCodeDetailId, "analysisStorageId": analysisStorageId, "outputParentFolderId": outputParentFolderId, "analysisOutput": analysisOutput, } - activationCodeDetailId: MetaOapg.properties.activationCodeDetailId userReference: MetaOapg.properties.userReference analysisInput: 'CwlAnalysisInput' pipelineId: MetaOapg.properties.pipelineId @@ -158,10 +156,10 @@ class CreateCwlAnalysis( def __getitem__(self, name: typing_extensions.Literal["tags"]) -> 'AnalysisTag': ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... + def __getitem__(self, name: typing_extensions.Literal["analysisInput"]) -> 'CwlAnalysisInput': ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["analysisInput"]) -> 'CwlAnalysisInput': ... + def __getitem__(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... @typing.overload def __getitem__(self, name: typing_extensions.Literal["analysisStorageId"]) -> MetaOapg.properties.analysisStorageId: ... @@ -175,7 +173,7 @@ class CreateCwlAnalysis( @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "activationCodeDetailId", "analysisInput", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "analysisInput", "activationCodeDetailId", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -190,10 +188,10 @@ class CreateCwlAnalysis( def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> 'AnalysisTag': ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... + def get_item_oapg(self, name: typing_extensions.Literal["analysisInput"]) -> 'CwlAnalysisInput': ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["analysisInput"]) -> 'CwlAnalysisInput': ... + def get_item_oapg(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> typing.Union[MetaOapg.properties.activationCodeDetailId, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["analysisStorageId"]) -> typing.Union[MetaOapg.properties.analysisStorageId, schemas.Unset]: ... @@ -207,18 +205,18 @@ class CreateCwlAnalysis( @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "activationCodeDetailId", "analysisInput", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "analysisInput", "activationCodeDetailId", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): return super().get_item_oapg(name) def __new__( cls, *args: typing.Union[dict, frozendict.frozendict, ], - activationCodeDetailId: typing.Union[MetaOapg.properties.activationCodeDetailId, str, uuid.UUID, ], userReference: typing.Union[MetaOapg.properties.userReference, str, ], analysisInput: 'CwlAnalysisInput', pipelineId: typing.Union[MetaOapg.properties.pipelineId, str, ], tags: 'AnalysisTag', + activationCodeDetailId: typing.Union[MetaOapg.properties.activationCodeDetailId, str, uuid.UUID, schemas.Unset] = schemas.unset, analysisStorageId: typing.Union[MetaOapg.properties.analysisStorageId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, outputParentFolderId: typing.Union[MetaOapg.properties.outputParentFolderId, None, str, schemas.Unset] = schemas.unset, analysisOutput: typing.Union[MetaOapg.properties.analysisOutput, list, tuple, None, schemas.Unset] = schemas.unset, @@ -228,11 +226,11 @@ class CreateCwlAnalysis( return super().__new__( cls, *args, - activationCodeDetailId=activationCodeDetailId, userReference=userReference, analysisInput=analysisInput, pipelineId=pipelineId, tags=tags, + activationCodeDetailId=activationCodeDetailId, analysisStorageId=analysisStorageId, outputParentFolderId=outputParentFolderId, analysisOutput=analysisOutput, diff --git a/icasdk/model/create_nextflow_analysis.py b/icasdk/model/create_nextflow_analysis.py index 5571bca..851962b 100644 --- a/icasdk/model/create_nextflow_analysis.py +++ b/icasdk/model/create_nextflow_analysis.py @@ -35,7 +35,6 @@ class CreateNextflowAnalysis( class MetaOapg: required = { - "activationCodeDetailId", "userReference", "analysisInput", "pipelineId", @@ -61,11 +60,11 @@ class MetaOapg: @staticmethod def tags() -> typing.Type['AnalysisTag']: return AnalysisTag - activationCodeDetailId = schemas.UUIDSchema @staticmethod def analysisInput() -> typing.Type['NextflowAnalysisInput']: return NextflowAnalysisInput + activationCodeDetailId = schemas.UUIDSchema class analysisStorageId( @@ -142,14 +141,13 @@ def __new__( "userReference": userReference, "pipelineId": pipelineId, "tags": tags, - "activationCodeDetailId": activationCodeDetailId, "analysisInput": analysisInput, + "activationCodeDetailId": activationCodeDetailId, "analysisStorageId": analysisStorageId, "outputParentFolderId": outputParentFolderId, "analysisOutput": analysisOutput, } - activationCodeDetailId: MetaOapg.properties.activationCodeDetailId userReference: MetaOapg.properties.userReference analysisInput: 'NextflowAnalysisInput' pipelineId: MetaOapg.properties.pipelineId @@ -165,10 +163,10 @@ def __getitem__(self, name: typing_extensions.Literal["pipelineId"]) -> MetaOapg def __getitem__(self, name: typing_extensions.Literal["tags"]) -> 'AnalysisTag': ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... + def __getitem__(self, name: typing_extensions.Literal["analysisInput"]) -> 'NextflowAnalysisInput': ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["analysisInput"]) -> 'NextflowAnalysisInput': ... + def __getitem__(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... @typing.overload def __getitem__(self, name: typing_extensions.Literal["analysisStorageId"]) -> MetaOapg.properties.analysisStorageId: ... @@ -182,7 +180,7 @@ def __getitem__(self, name: typing_extensions.Literal["analysisOutput"]) -> Meta @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "activationCodeDetailId", "analysisInput", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "analysisInput", "activationCodeDetailId", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -197,10 +195,10 @@ def get_item_oapg(self, name: typing_extensions.Literal["pipelineId"]) -> MetaOa def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> 'AnalysisTag': ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... + def get_item_oapg(self, name: typing_extensions.Literal["analysisInput"]) -> 'NextflowAnalysisInput': ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["analysisInput"]) -> 'NextflowAnalysisInput': ... + def get_item_oapg(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> typing.Union[MetaOapg.properties.activationCodeDetailId, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["analysisStorageId"]) -> typing.Union[MetaOapg.properties.analysisStorageId, schemas.Unset]: ... @@ -214,18 +212,18 @@ def get_item_oapg(self, name: typing_extensions.Literal["analysisOutput"]) -> ty @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "activationCodeDetailId", "analysisInput", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "analysisInput", "activationCodeDetailId", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): return super().get_item_oapg(name) def __new__( cls, *args: typing.Union[dict, frozendict.frozendict, ], - activationCodeDetailId: typing.Union[MetaOapg.properties.activationCodeDetailId, str, uuid.UUID, ], userReference: typing.Union[MetaOapg.properties.userReference, str, ], analysisInput: 'NextflowAnalysisInput', pipelineId: typing.Union[MetaOapg.properties.pipelineId, str, ], tags: 'AnalysisTag', + activationCodeDetailId: typing.Union[MetaOapg.properties.activationCodeDetailId, str, uuid.UUID, schemas.Unset] = schemas.unset, analysisStorageId: typing.Union[MetaOapg.properties.analysisStorageId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, outputParentFolderId: typing.Union[MetaOapg.properties.outputParentFolderId, None, str, schemas.Unset] = schemas.unset, analysisOutput: typing.Union[MetaOapg.properties.analysisOutput, list, tuple, None, schemas.Unset] = schemas.unset, @@ -235,11 +233,11 @@ def __new__( return super().__new__( cls, *args, - activationCodeDetailId=activationCodeDetailId, userReference=userReference, analysisInput=analysisInput, pipelineId=pipelineId, tags=tags, + activationCodeDetailId=activationCodeDetailId, analysisStorageId=analysisStorageId, outputParentFolderId=outputParentFolderId, analysisOutput=analysisOutput, diff --git a/icasdk/model/create_nextflow_analysis.pyi b/icasdk/model/create_nextflow_analysis.pyi index 103b1fb..a569a0b 100644 --- a/icasdk/model/create_nextflow_analysis.pyi +++ b/icasdk/model/create_nextflow_analysis.pyi @@ -35,7 +35,6 @@ class CreateNextflowAnalysis( class MetaOapg: required = { - "activationCodeDetailId", "userReference", "analysisInput", "pipelineId", @@ -54,11 +53,11 @@ class CreateNextflowAnalysis( @staticmethod def tags() -> typing.Type['AnalysisTag']: return AnalysisTag - activationCodeDetailId = schemas.UUIDSchema @staticmethod def analysisInput() -> typing.Type['NextflowAnalysisInput']: return NextflowAnalysisInput + activationCodeDetailId = schemas.UUIDSchema class analysisStorageId( @@ -135,14 +134,13 @@ class CreateNextflowAnalysis( "userReference": userReference, "pipelineId": pipelineId, "tags": tags, - "activationCodeDetailId": activationCodeDetailId, "analysisInput": analysisInput, + "activationCodeDetailId": activationCodeDetailId, "analysisStorageId": analysisStorageId, "outputParentFolderId": outputParentFolderId, "analysisOutput": analysisOutput, } - activationCodeDetailId: MetaOapg.properties.activationCodeDetailId userReference: MetaOapg.properties.userReference analysisInput: 'NextflowAnalysisInput' pipelineId: MetaOapg.properties.pipelineId @@ -158,10 +156,10 @@ class CreateNextflowAnalysis( def __getitem__(self, name: typing_extensions.Literal["tags"]) -> 'AnalysisTag': ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... + def __getitem__(self, name: typing_extensions.Literal["analysisInput"]) -> 'NextflowAnalysisInput': ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["analysisInput"]) -> 'NextflowAnalysisInput': ... + def __getitem__(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... @typing.overload def __getitem__(self, name: typing_extensions.Literal["analysisStorageId"]) -> MetaOapg.properties.analysisStorageId: ... @@ -175,7 +173,7 @@ class CreateNextflowAnalysis( @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "activationCodeDetailId", "analysisInput", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "analysisInput", "activationCodeDetailId", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -190,10 +188,10 @@ class CreateNextflowAnalysis( def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> 'AnalysisTag': ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> MetaOapg.properties.activationCodeDetailId: ... + def get_item_oapg(self, name: typing_extensions.Literal["analysisInput"]) -> 'NextflowAnalysisInput': ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["analysisInput"]) -> 'NextflowAnalysisInput': ... + def get_item_oapg(self, name: typing_extensions.Literal["activationCodeDetailId"]) -> typing.Union[MetaOapg.properties.activationCodeDetailId, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["analysisStorageId"]) -> typing.Union[MetaOapg.properties.analysisStorageId, schemas.Unset]: ... @@ -207,18 +205,18 @@ class CreateNextflowAnalysis( @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "activationCodeDetailId", "analysisInput", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["userReference", "pipelineId", "tags", "analysisInput", "activationCodeDetailId", "analysisStorageId", "outputParentFolderId", "analysisOutput", ], str]): return super().get_item_oapg(name) def __new__( cls, *args: typing.Union[dict, frozendict.frozendict, ], - activationCodeDetailId: typing.Union[MetaOapg.properties.activationCodeDetailId, str, uuid.UUID, ], userReference: typing.Union[MetaOapg.properties.userReference, str, ], analysisInput: 'NextflowAnalysisInput', pipelineId: typing.Union[MetaOapg.properties.pipelineId, str, ], tags: 'AnalysisTag', + activationCodeDetailId: typing.Union[MetaOapg.properties.activationCodeDetailId, str, uuid.UUID, schemas.Unset] = schemas.unset, analysisStorageId: typing.Union[MetaOapg.properties.analysisStorageId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, outputParentFolderId: typing.Union[MetaOapg.properties.outputParentFolderId, None, str, schemas.Unset] = schemas.unset, analysisOutput: typing.Union[MetaOapg.properties.analysisOutput, list, tuple, None, schemas.Unset] = schemas.unset, @@ -228,11 +226,11 @@ class CreateNextflowAnalysis( return super().__new__( cls, *args, - activationCodeDetailId=activationCodeDetailId, userReference=userReference, analysisInput=analysisInput, pipelineId=pipelineId, tags=tags, + activationCodeDetailId=activationCodeDetailId, analysisStorageId=analysisStorageId, outputParentFolderId=outputParentFolderId, analysisOutput=analysisOutput, diff --git a/icasdk/model/create_project.py b/icasdk/model/create_project.py index fb1a295..73cce74 100644 --- a/icasdk/model/create_project.py +++ b/icasdk/model/create_project.py @@ -237,22 +237,22 @@ class analysisPriority( class MetaOapg: enum_value_to_name = { - "Low": "LOW", - "Medium": "MEDIUM", - "High": "HIGH", + "LOW": "LOW", + "MEDIUM": "MEDIUM", + "HIGH": "HIGH", } @schemas.classproperty def LOW(cls): - return cls("Low") + return cls("LOW") @schemas.classproperty def MEDIUM(cls): - return cls("Medium") + return cls("MEDIUM") @schemas.classproperty def HIGH(cls): - return cls("High") + return cls("HIGH") def __new__( diff --git a/icasdk/model/create_project.pyi b/icasdk/model/create_project.pyi index 73d8748..3d116b7 100644 --- a/icasdk/model/create_project.pyi +++ b/icasdk/model/create_project.pyi @@ -221,22 +221,22 @@ class CreateProject( class MetaOapg: enum_value_to_name = { - "Low": "LOW", - "Medium": "MEDIUM", - "High": "HIGH", + "LOW": "LOW", + "MEDIUM": "MEDIUM", + "HIGH": "HIGH", } @schemas.classproperty def LOW(cls): - return cls("Low") + return cls("LOW") @schemas.classproperty def MEDIUM(cls): - return cls("Medium") + return cls("MEDIUM") @schemas.classproperty def HIGH(cls): - return cls("High") + return cls("HIGH") def __new__( diff --git a/icasdk/model/create_project_data_update_batch.py b/icasdk/model/create_project_data_update_batch.py new file mode 100644 index 0000000..4b08251 --- /dev/null +++ b/icasdk/model/create_project_data_update_batch.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class CreateProjectDataUpdateBatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "dataUpdateGroups", + } + + class properties: + + + class dataUpdateGroups( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DataUpdateGroup']: + return DataUpdateGroup + + def __new__( + cls, + arg: typing.Union[typing.Tuple['DataUpdateGroup'], typing.List['DataUpdateGroup']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dataUpdateGroups': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DataUpdateGroup': + return super().__getitem__(i) + __annotations__ = { + "dataUpdateGroups": dataUpdateGroups, + } + + dataUpdateGroups: MetaOapg.properties.dataUpdateGroups + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataUpdateGroups"]) -> MetaOapg.properties.dataUpdateGroups: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataUpdateGroups", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataUpdateGroups"]) -> MetaOapg.properties.dataUpdateGroups: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataUpdateGroups", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + dataUpdateGroups: typing.Union[MetaOapg.properties.dataUpdateGroups, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CreateProjectDataUpdateBatch': + return super().__new__( + cls, + *args, + dataUpdateGroups=dataUpdateGroups, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.data_update_group import DataUpdateGroup diff --git a/icasdk/model/create_project_data_update_batch.pyi b/icasdk/model/create_project_data_update_batch.pyi new file mode 100644 index 0000000..4b08251 --- /dev/null +++ b/icasdk/model/create_project_data_update_batch.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class CreateProjectDataUpdateBatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "dataUpdateGroups", + } + + class properties: + + + class dataUpdateGroups( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DataUpdateGroup']: + return DataUpdateGroup + + def __new__( + cls, + arg: typing.Union[typing.Tuple['DataUpdateGroup'], typing.List['DataUpdateGroup']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dataUpdateGroups': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DataUpdateGroup': + return super().__getitem__(i) + __annotations__ = { + "dataUpdateGroups": dataUpdateGroups, + } + + dataUpdateGroups: MetaOapg.properties.dataUpdateGroups + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataUpdateGroups"]) -> MetaOapg.properties.dataUpdateGroups: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataUpdateGroups", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataUpdateGroups"]) -> MetaOapg.properties.dataUpdateGroups: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataUpdateGroups", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + dataUpdateGroups: typing.Union[MetaOapg.properties.dataUpdateGroups, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CreateProjectDataUpdateBatch': + return super().__new__( + cls, + *args, + dataUpdateGroups=dataUpdateGroups, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.data_update_group import DataUpdateGroup diff --git a/icasdk/model/create_project_permission_v4.py b/icasdk/model/create_project_permission_v4.py new file mode 100644 index 0000000..307b530 --- /dev/null +++ b/icasdk/model/create_project_permission_v4.py @@ -0,0 +1,317 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class CreateProjectPermissionV4( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "uploadAllowed", + "membershipType", + "roleFlow", + "roleBase", + "downloadAllowed", + "roleBench", + "roleProject", + } + + class properties: + + + class roleProject( + schemas.StrSchema + ): + + + class MetaOapg: + regex=[{ + 'pattern': r'NONE|VIEWER|CONTRIBUTOR|ADMINISTRATOR|DATA_PROVIDER', # noqa: E501 + }] + + + class roleFlow( + schemas.StrSchema + ): + + + class MetaOapg: + regex=[{ + 'pattern': r'NONE|VIEWER|CONTRIBUTOR', # noqa: E501 + }] + + + class roleBase( + schemas.StrSchema + ): + + + class MetaOapg: + regex=[{ + 'pattern': r'NONE|VIEWER|CONTRIBUTOR', # noqa: E501 + }] + + + class roleBench( + schemas.StrSchema + ): + + + class MetaOapg: + regex=[{ + 'pattern': r'NONE|CONTRIBUTOR|ADMINISTRATOR', # noqa: E501 + }] + + + class membershipType( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "USER": "USER", + "EMAIL": "EMAIL", + "WORKGROUP": "WORKGROUP", + } + + @schemas.classproperty + def USER(cls): + return cls("USER") + + @schemas.classproperty + def EMAIL(cls): + return cls("EMAIL") + + @schemas.classproperty + def WORKGROUP(cls): + return cls("WORKGROUP") + uploadAllowed = schemas.BoolSchema + downloadAllowed = schemas.BoolSchema + + + class userId( + schemas.UUIDBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'uuid' + + + def __new__( + cls, + *args: typing.Union[None, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'userId': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class emailAddress( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'emailAddress': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class workgroupId( + schemas.UUIDBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'uuid' + + + def __new__( + cls, + *args: typing.Union[None, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'workgroupId': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + __annotations__ = { + "roleProject": roleProject, + "roleFlow": roleFlow, + "roleBase": roleBase, + "roleBench": roleBench, + "membershipType": membershipType, + "uploadAllowed": uploadAllowed, + "downloadAllowed": downloadAllowed, + "userId": userId, + "emailAddress": emailAddress, + "workgroupId": workgroupId, + } + + uploadAllowed: MetaOapg.properties.uploadAllowed + membershipType: MetaOapg.properties.membershipType + roleFlow: MetaOapg.properties.roleFlow + roleBase: MetaOapg.properties.roleBase + downloadAllowed: MetaOapg.properties.downloadAllowed + roleBench: MetaOapg.properties.roleBench + roleProject: MetaOapg.properties.roleProject + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleProject"]) -> MetaOapg.properties.roleProject: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleFlow"]) -> MetaOapg.properties.roleFlow: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleBase"]) -> MetaOapg.properties.roleBase: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleBench"]) -> MetaOapg.properties.roleBench: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["membershipType"]) -> MetaOapg.properties.membershipType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["uploadAllowed"]) -> MetaOapg.properties.uploadAllowed: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["downloadAllowed"]) -> MetaOapg.properties.downloadAllowed: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userId"]) -> MetaOapg.properties.userId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["emailAddress"]) -> MetaOapg.properties.emailAddress: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workgroupId"]) -> MetaOapg.properties.workgroupId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["roleProject", "roleFlow", "roleBase", "roleBench", "membershipType", "uploadAllowed", "downloadAllowed", "userId", "emailAddress", "workgroupId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleProject"]) -> MetaOapg.properties.roleProject: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleFlow"]) -> MetaOapg.properties.roleFlow: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleBase"]) -> MetaOapg.properties.roleBase: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleBench"]) -> MetaOapg.properties.roleBench: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["membershipType"]) -> MetaOapg.properties.membershipType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["uploadAllowed"]) -> MetaOapg.properties.uploadAllowed: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["downloadAllowed"]) -> MetaOapg.properties.downloadAllowed: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userId"]) -> typing.Union[MetaOapg.properties.userId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["emailAddress"]) -> typing.Union[MetaOapg.properties.emailAddress, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workgroupId"]) -> typing.Union[MetaOapg.properties.workgroupId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["roleProject", "roleFlow", "roleBase", "roleBench", "membershipType", "uploadAllowed", "downloadAllowed", "userId", "emailAddress", "workgroupId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + uploadAllowed: typing.Union[MetaOapg.properties.uploadAllowed, bool, ], + membershipType: typing.Union[MetaOapg.properties.membershipType, str, ], + roleFlow: typing.Union[MetaOapg.properties.roleFlow, str, ], + roleBase: typing.Union[MetaOapg.properties.roleBase, str, ], + downloadAllowed: typing.Union[MetaOapg.properties.downloadAllowed, bool, ], + roleBench: typing.Union[MetaOapg.properties.roleBench, str, ], + roleProject: typing.Union[MetaOapg.properties.roleProject, str, ], + userId: typing.Union[MetaOapg.properties.userId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, + emailAddress: typing.Union[MetaOapg.properties.emailAddress, None, str, schemas.Unset] = schemas.unset, + workgroupId: typing.Union[MetaOapg.properties.workgroupId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CreateProjectPermissionV4': + return super().__new__( + cls, + *args, + uploadAllowed=uploadAllowed, + membershipType=membershipType, + roleFlow=roleFlow, + roleBase=roleBase, + downloadAllowed=downloadAllowed, + roleBench=roleBench, + roleProject=roleProject, + userId=userId, + emailAddress=emailAddress, + workgroupId=workgroupId, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/create_project_permission_v4.pyi b/icasdk/model/create_project_permission_v4.pyi new file mode 100644 index 0000000..cc7d304 --- /dev/null +++ b/icasdk/model/create_project_permission_v4.pyi @@ -0,0 +1,289 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class CreateProjectPermissionV4( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "uploadAllowed", + "membershipType", + "roleFlow", + "roleBase", + "downloadAllowed", + "roleBench", + "roleProject", + } + + class properties: + + + class roleProject( + schemas.StrSchema + ): + pass + + + class roleFlow( + schemas.StrSchema + ): + pass + + + class roleBase( + schemas.StrSchema + ): + pass + + + class roleBench( + schemas.StrSchema + ): + pass + + + class membershipType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER(cls): + return cls("USER") + + @schemas.classproperty + def EMAIL(cls): + return cls("EMAIL") + + @schemas.classproperty + def WORKGROUP(cls): + return cls("WORKGROUP") + uploadAllowed = schemas.BoolSchema + downloadAllowed = schemas.BoolSchema + + + class userId( + schemas.UUIDBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'uuid' + + + def __new__( + cls, + *args: typing.Union[None, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'userId': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class emailAddress( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'emailAddress': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class workgroupId( + schemas.UUIDBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'uuid' + + + def __new__( + cls, + *args: typing.Union[None, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'workgroupId': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + __annotations__ = { + "roleProject": roleProject, + "roleFlow": roleFlow, + "roleBase": roleBase, + "roleBench": roleBench, + "membershipType": membershipType, + "uploadAllowed": uploadAllowed, + "downloadAllowed": downloadAllowed, + "userId": userId, + "emailAddress": emailAddress, + "workgroupId": workgroupId, + } + + uploadAllowed: MetaOapg.properties.uploadAllowed + membershipType: MetaOapg.properties.membershipType + roleFlow: MetaOapg.properties.roleFlow + roleBase: MetaOapg.properties.roleBase + downloadAllowed: MetaOapg.properties.downloadAllowed + roleBench: MetaOapg.properties.roleBench + roleProject: MetaOapg.properties.roleProject + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleProject"]) -> MetaOapg.properties.roleProject: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleFlow"]) -> MetaOapg.properties.roleFlow: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleBase"]) -> MetaOapg.properties.roleBase: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleBench"]) -> MetaOapg.properties.roleBench: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["membershipType"]) -> MetaOapg.properties.membershipType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["uploadAllowed"]) -> MetaOapg.properties.uploadAllowed: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["downloadAllowed"]) -> MetaOapg.properties.downloadAllowed: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userId"]) -> MetaOapg.properties.userId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["emailAddress"]) -> MetaOapg.properties.emailAddress: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workgroupId"]) -> MetaOapg.properties.workgroupId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["roleProject", "roleFlow", "roleBase", "roleBench", "membershipType", "uploadAllowed", "downloadAllowed", "userId", "emailAddress", "workgroupId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleProject"]) -> MetaOapg.properties.roleProject: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleFlow"]) -> MetaOapg.properties.roleFlow: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleBase"]) -> MetaOapg.properties.roleBase: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleBench"]) -> MetaOapg.properties.roleBench: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["membershipType"]) -> MetaOapg.properties.membershipType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["uploadAllowed"]) -> MetaOapg.properties.uploadAllowed: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["downloadAllowed"]) -> MetaOapg.properties.downloadAllowed: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userId"]) -> typing.Union[MetaOapg.properties.userId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["emailAddress"]) -> typing.Union[MetaOapg.properties.emailAddress, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workgroupId"]) -> typing.Union[MetaOapg.properties.workgroupId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["roleProject", "roleFlow", "roleBase", "roleBench", "membershipType", "uploadAllowed", "downloadAllowed", "userId", "emailAddress", "workgroupId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + uploadAllowed: typing.Union[MetaOapg.properties.uploadAllowed, bool, ], + membershipType: typing.Union[MetaOapg.properties.membershipType, str, ], + roleFlow: typing.Union[MetaOapg.properties.roleFlow, str, ], + roleBase: typing.Union[MetaOapg.properties.roleBase, str, ], + downloadAllowed: typing.Union[MetaOapg.properties.downloadAllowed, bool, ], + roleBench: typing.Union[MetaOapg.properties.roleBench, str, ], + roleProject: typing.Union[MetaOapg.properties.roleProject, str, ], + userId: typing.Union[MetaOapg.properties.userId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, + emailAddress: typing.Union[MetaOapg.properties.emailAddress, None, str, schemas.Unset] = schemas.unset, + workgroupId: typing.Union[MetaOapg.properties.workgroupId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CreateProjectPermissionV4': + return super().__new__( + cls, + *args, + uploadAllowed=uploadAllowed, + membershipType=membershipType, + roleFlow=roleFlow, + roleBase=roleBase, + downloadAllowed=downloadAllowed, + roleBench=roleBench, + roleProject=roleProject, + userId=userId, + emailAddress=emailAddress, + workgroupId=workgroupId, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/data_update_group.py b/icasdk/model/data_update_group.py new file mode 100644 index 0000000..b5aa5e8 --- /dev/null +++ b/icasdk/model/data_update_group.py @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class DataUpdateGroup( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Updates to apply. + """ + + + class MetaOapg: + required = { + "dataIds", + } + + class properties: + + + class dataIds( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dataIds': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def userTags() -> typing.Type['TagUpdate']: + return TagUpdate + + @staticmethod + def technicalTags() -> typing.Type['TagUpdate']: + return TagUpdate + __annotations__ = { + "dataIds": dataIds, + "userTags": userTags, + "technicalTags": technicalTags, + } + + dataIds: MetaOapg.properties.dataIds + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataIds"]) -> MetaOapg.properties.dataIds: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userTags"]) -> 'TagUpdate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["technicalTags"]) -> 'TagUpdate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataIds", "userTags", "technicalTags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataIds"]) -> MetaOapg.properties.dataIds: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userTags"]) -> typing.Union['TagUpdate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["technicalTags"]) -> typing.Union['TagUpdate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataIds", "userTags", "technicalTags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + dataIds: typing.Union[MetaOapg.properties.dataIds, list, tuple, ], + userTags: typing.Union['TagUpdate', schemas.Unset] = schemas.unset, + technicalTags: typing.Union['TagUpdate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DataUpdateGroup': + return super().__new__( + cls, + *args, + dataIds=dataIds, + userTags=userTags, + technicalTags=technicalTags, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.tag_update import TagUpdate diff --git a/icasdk/model/data_update_group.pyi b/icasdk/model/data_update_group.pyi new file mode 100644 index 0000000..b5aa5e8 --- /dev/null +++ b/icasdk/model/data_update_group.pyi @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class DataUpdateGroup( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Updates to apply. + """ + + + class MetaOapg: + required = { + "dataIds", + } + + class properties: + + + class dataIds( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dataIds': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def userTags() -> typing.Type['TagUpdate']: + return TagUpdate + + @staticmethod + def technicalTags() -> typing.Type['TagUpdate']: + return TagUpdate + __annotations__ = { + "dataIds": dataIds, + "userTags": userTags, + "technicalTags": technicalTags, + } + + dataIds: MetaOapg.properties.dataIds + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataIds"]) -> MetaOapg.properties.dataIds: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userTags"]) -> 'TagUpdate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["technicalTags"]) -> 'TagUpdate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataIds", "userTags", "technicalTags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataIds"]) -> MetaOapg.properties.dataIds: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userTags"]) -> typing.Union['TagUpdate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["technicalTags"]) -> typing.Union['TagUpdate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataIds", "userTags", "technicalTags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + dataIds: typing.Union[MetaOapg.properties.dataIds, list, tuple, ], + userTags: typing.Union['TagUpdate', schemas.Unset] = schemas.unset, + technicalTags: typing.Union['TagUpdate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DataUpdateGroup': + return super().__new__( + cls, + *args, + dataIds=dataIds, + userTags=userTags, + technicalTags=technicalTags, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.tag_update import TagUpdate diff --git a/icasdk/model/input_part.py b/icasdk/model/input_part.py index 29cf8ab..64466b7 100644 --- a/icasdk/model/input_part.py +++ b/icasdk/model/input_part.py @@ -38,57 +38,6 @@ class MetaOapg: class properties: - class headers( - schemas.DictSchema - ): - - - class MetaOapg: - - - class additional_properties( - schemas.ListSchema - ): - - - class MetaOapg: - items = schemas.StrSchema - - def __new__( - cls, - arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], - _configuration: typing.Optional[schemas.Configuration] = None, - ) -> 'additional_properties': - return super().__new__( - cls, - arg, - _configuration=_configuration, - ) - - def __getitem__(self, i: int) -> MetaOapg.items: - return super().__getitem__(i) - - def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: - # dict_instance[name] accessor - return super().__getitem__(name) - - def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: - return super().get_item_oapg(name) - - def __new__( - cls, - *args: typing.Union[dict, frozendict.frozendict, ], - _configuration: typing.Optional[schemas.Configuration] = None, - **kwargs: typing.Union[MetaOapg.additional_properties, list, tuple, ], - ) -> 'headers': - return super().__new__( - cls, - *args, - _configuration=_configuration, - **kwargs, - ) - - class mediaType( schemas.DictSchema ): @@ -205,71 +154,122 @@ def __new__( _configuration=_configuration, **kwargs, ) - bodyAsString = schemas.StrSchema contentTypeFromMessage = schemas.BoolSchema + bodyAsString = schemas.StrSchema + + + class headers( + schemas.DictSchema + ): + + + class MetaOapg: + + + class additional_properties( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'additional_properties': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, list, tuple, ], + ) -> 'headers': + return super().__new__( + cls, + *args, + _configuration=_configuration, + **kwargs, + ) __annotations__ = { - "headers": headers, "mediaType": mediaType, - "bodyAsString": bodyAsString, "contentTypeFromMessage": contentTypeFromMessage, + "bodyAsString": bodyAsString, + "headers": headers, } @typing.overload - def __getitem__(self, name: typing_extensions.Literal["headers"]) -> MetaOapg.properties.headers: ... + def __getitem__(self, name: typing_extensions.Literal["mediaType"]) -> MetaOapg.properties.mediaType: ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["mediaType"]) -> MetaOapg.properties.mediaType: ... + def __getitem__(self, name: typing_extensions.Literal["contentTypeFromMessage"]) -> MetaOapg.properties.contentTypeFromMessage: ... @typing.overload def __getitem__(self, name: typing_extensions.Literal["bodyAsString"]) -> MetaOapg.properties.bodyAsString: ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["contentTypeFromMessage"]) -> MetaOapg.properties.contentTypeFromMessage: ... + def __getitem__(self, name: typing_extensions.Literal["headers"]) -> MetaOapg.properties.headers: ... @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["headers", "mediaType", "bodyAsString", "contentTypeFromMessage", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["mediaType", "contentTypeFromMessage", "bodyAsString", "headers", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["headers"]) -> typing.Union[MetaOapg.properties.headers, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["mediaType"]) -> typing.Union[MetaOapg.properties.mediaType, schemas.Unset]: ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["mediaType"]) -> typing.Union[MetaOapg.properties.mediaType, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["contentTypeFromMessage"]) -> typing.Union[MetaOapg.properties.contentTypeFromMessage, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["bodyAsString"]) -> typing.Union[MetaOapg.properties.bodyAsString, schemas.Unset]: ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["contentTypeFromMessage"]) -> typing.Union[MetaOapg.properties.contentTypeFromMessage, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["headers"]) -> typing.Union[MetaOapg.properties.headers, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["headers", "mediaType", "bodyAsString", "contentTypeFromMessage", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["mediaType", "contentTypeFromMessage", "bodyAsString", "headers", ], str]): return super().get_item_oapg(name) def __new__( cls, *args: typing.Union[dict, frozendict.frozendict, ], - headers: typing.Union[MetaOapg.properties.headers, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, mediaType: typing.Union[MetaOapg.properties.mediaType, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, - bodyAsString: typing.Union[MetaOapg.properties.bodyAsString, str, schemas.Unset] = schemas.unset, contentTypeFromMessage: typing.Union[MetaOapg.properties.contentTypeFromMessage, bool, schemas.Unset] = schemas.unset, + bodyAsString: typing.Union[MetaOapg.properties.bodyAsString, str, schemas.Unset] = schemas.unset, + headers: typing.Union[MetaOapg.properties.headers, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'InputPart': return super().__new__( cls, *args, - headers=headers, mediaType=mediaType, - bodyAsString=bodyAsString, contentTypeFromMessage=contentTypeFromMessage, + bodyAsString=bodyAsString, + headers=headers, _configuration=_configuration, **kwargs, ) diff --git a/icasdk/model/input_part.pyi b/icasdk/model/input_part.pyi index 29cf8ab..64466b7 100644 --- a/icasdk/model/input_part.pyi +++ b/icasdk/model/input_part.pyi @@ -38,57 +38,6 @@ class InputPart( class properties: - class headers( - schemas.DictSchema - ): - - - class MetaOapg: - - - class additional_properties( - schemas.ListSchema - ): - - - class MetaOapg: - items = schemas.StrSchema - - def __new__( - cls, - arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], - _configuration: typing.Optional[schemas.Configuration] = None, - ) -> 'additional_properties': - return super().__new__( - cls, - arg, - _configuration=_configuration, - ) - - def __getitem__(self, i: int) -> MetaOapg.items: - return super().__getitem__(i) - - def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: - # dict_instance[name] accessor - return super().__getitem__(name) - - def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: - return super().get_item_oapg(name) - - def __new__( - cls, - *args: typing.Union[dict, frozendict.frozendict, ], - _configuration: typing.Optional[schemas.Configuration] = None, - **kwargs: typing.Union[MetaOapg.additional_properties, list, tuple, ], - ) -> 'headers': - return super().__new__( - cls, - *args, - _configuration=_configuration, - **kwargs, - ) - - class mediaType( schemas.DictSchema ): @@ -205,71 +154,122 @@ class InputPart( _configuration=_configuration, **kwargs, ) - bodyAsString = schemas.StrSchema contentTypeFromMessage = schemas.BoolSchema + bodyAsString = schemas.StrSchema + + + class headers( + schemas.DictSchema + ): + + + class MetaOapg: + + + class additional_properties( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'additional_properties': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, list, tuple, ], + ) -> 'headers': + return super().__new__( + cls, + *args, + _configuration=_configuration, + **kwargs, + ) __annotations__ = { - "headers": headers, "mediaType": mediaType, - "bodyAsString": bodyAsString, "contentTypeFromMessage": contentTypeFromMessage, + "bodyAsString": bodyAsString, + "headers": headers, } @typing.overload - def __getitem__(self, name: typing_extensions.Literal["headers"]) -> MetaOapg.properties.headers: ... + def __getitem__(self, name: typing_extensions.Literal["mediaType"]) -> MetaOapg.properties.mediaType: ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["mediaType"]) -> MetaOapg.properties.mediaType: ... + def __getitem__(self, name: typing_extensions.Literal["contentTypeFromMessage"]) -> MetaOapg.properties.contentTypeFromMessage: ... @typing.overload def __getitem__(self, name: typing_extensions.Literal["bodyAsString"]) -> MetaOapg.properties.bodyAsString: ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["contentTypeFromMessage"]) -> MetaOapg.properties.contentTypeFromMessage: ... + def __getitem__(self, name: typing_extensions.Literal["headers"]) -> MetaOapg.properties.headers: ... @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["headers", "mediaType", "bodyAsString", "contentTypeFromMessage", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["mediaType", "contentTypeFromMessage", "bodyAsString", "headers", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["headers"]) -> typing.Union[MetaOapg.properties.headers, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["mediaType"]) -> typing.Union[MetaOapg.properties.mediaType, schemas.Unset]: ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["mediaType"]) -> typing.Union[MetaOapg.properties.mediaType, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["contentTypeFromMessage"]) -> typing.Union[MetaOapg.properties.contentTypeFromMessage, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["bodyAsString"]) -> typing.Union[MetaOapg.properties.bodyAsString, schemas.Unset]: ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["contentTypeFromMessage"]) -> typing.Union[MetaOapg.properties.contentTypeFromMessage, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["headers"]) -> typing.Union[MetaOapg.properties.headers, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["headers", "mediaType", "bodyAsString", "contentTypeFromMessage", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["mediaType", "contentTypeFromMessage", "bodyAsString", "headers", ], str]): return super().get_item_oapg(name) def __new__( cls, *args: typing.Union[dict, frozendict.frozendict, ], - headers: typing.Union[MetaOapg.properties.headers, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, mediaType: typing.Union[MetaOapg.properties.mediaType, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, - bodyAsString: typing.Union[MetaOapg.properties.bodyAsString, str, schemas.Unset] = schemas.unset, contentTypeFromMessage: typing.Union[MetaOapg.properties.contentTypeFromMessage, bool, schemas.Unset] = schemas.unset, + bodyAsString: typing.Union[MetaOapg.properties.bodyAsString, str, schemas.Unset] = schemas.unset, + headers: typing.Union[MetaOapg.properties.headers, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'InputPart': return super().__new__( cls, *args, - headers=headers, mediaType=mediaType, - bodyAsString=bodyAsString, contentTypeFromMessage=contentTypeFromMessage, + bodyAsString=bodyAsString, + headers=headers, _configuration=_configuration, **kwargs, ) diff --git a/icasdk/model/integer_settings.py b/icasdk/model/integer_settings.py new file mode 100644 index 0000000..838030f --- /dev/null +++ b/icasdk/model/integer_settings.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class IntegerSettings( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class defaultValues( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.Int32Schema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, decimal.Decimal, int, ]], typing.List[typing.Union[MetaOapg.items, decimal.Decimal, int, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'defaultValues': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "defaultValues": defaultValues, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultValues"]) -> MetaOapg.properties.defaultValues: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["defaultValues", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultValues"]) -> typing.Union[MetaOapg.properties.defaultValues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["defaultValues", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + defaultValues: typing.Union[MetaOapg.properties.defaultValues, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'IntegerSettings': + return super().__new__( + cls, + *args, + defaultValues=defaultValues, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/integer_settings.pyi b/icasdk/model/integer_settings.pyi new file mode 100644 index 0000000..838030f --- /dev/null +++ b/icasdk/model/integer_settings.pyi @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class IntegerSettings( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class defaultValues( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.Int32Schema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, decimal.Decimal, int, ]], typing.List[typing.Union[MetaOapg.items, decimal.Decimal, int, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'defaultValues': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "defaultValues": defaultValues, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultValues"]) -> MetaOapg.properties.defaultValues: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["defaultValues", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultValues"]) -> typing.Union[MetaOapg.properties.defaultValues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["defaultValues", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + defaultValues: typing.Union[MetaOapg.properties.defaultValues, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'IntegerSettings': + return super().__new__( + cls, + *args, + defaultValues=defaultValues, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/multipart_form_data_input.py b/icasdk/model/multipart_form_data_input.py index e754ca2..660d5db 100644 --- a/icasdk/model/multipart_form_data_input.py +++ b/icasdk/model/multipart_form_data_input.py @@ -38,38 +38,6 @@ class MetaOapg: class properties: - class formData( - schemas.DictSchema - ): - - - class MetaOapg: - - @staticmethod - def additional_properties() -> typing.Type['InputPart']: - return InputPart - - def __getitem__(self, name: typing.Union[str, ]) -> 'InputPart': - # dict_instance[name] accessor - return super().__getitem__(name) - - def get_item_oapg(self, name: typing.Union[str, ]) -> 'InputPart': - return super().get_item_oapg(name) - - def __new__( - cls, - *args: typing.Union[dict, frozendict.frozendict, ], - _configuration: typing.Optional[schemas.Configuration] = None, - **kwargs: 'InputPart', - ) -> 'formData': - return super().__new__( - cls, - *args, - _configuration=_configuration, - **kwargs, - ) - - class formDataMap( schemas.DictSchema ): @@ -124,6 +92,38 @@ def __new__( ) + class formData( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['InputPart']: + return InputPart + + def __getitem__(self, name: typing.Union[str, ]) -> 'InputPart': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'InputPart': + return super().get_item_oapg(name) + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'InputPart', + ) -> 'formData': + return super().__new__( + cls, + *args, + _configuration=_configuration, + **kwargs, + ) + + class parts( schemas.ListSchema ): @@ -150,17 +150,17 @@ def __getitem__(self, i: int) -> 'InputPart': return super().__getitem__(i) preamble = schemas.StrSchema __annotations__ = { - "formData": formData, "formDataMap": formDataMap, + "formData": formData, "parts": parts, "preamble": preamble, } @typing.overload - def __getitem__(self, name: typing_extensions.Literal["formData"]) -> MetaOapg.properties.formData: ... + def __getitem__(self, name: typing_extensions.Literal["formDataMap"]) -> MetaOapg.properties.formDataMap: ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["formDataMap"]) -> MetaOapg.properties.formDataMap: ... + def __getitem__(self, name: typing_extensions.Literal["formData"]) -> MetaOapg.properties.formData: ... @typing.overload def __getitem__(self, name: typing_extensions.Literal["parts"]) -> MetaOapg.properties.parts: ... @@ -171,16 +171,16 @@ def __getitem__(self, name: typing_extensions.Literal["preamble"]) -> MetaOapg.p @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["formData", "formDataMap", "parts", "preamble", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["formDataMap", "formData", "parts", "preamble", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["formData"]) -> typing.Union[MetaOapg.properties.formData, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["formDataMap"]) -> typing.Union[MetaOapg.properties.formDataMap, schemas.Unset]: ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["formDataMap"]) -> typing.Union[MetaOapg.properties.formDataMap, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["formData"]) -> typing.Union[MetaOapg.properties.formData, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parts"]) -> typing.Union[MetaOapg.properties.parts, schemas.Unset]: ... @@ -191,15 +191,15 @@ def get_item_oapg(self, name: typing_extensions.Literal["preamble"]) -> typing.U @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["formData", "formDataMap", "parts", "preamble", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["formDataMap", "formData", "parts", "preamble", ], str]): return super().get_item_oapg(name) def __new__( cls, *args: typing.Union[dict, frozendict.frozendict, ], - formData: typing.Union[MetaOapg.properties.formData, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, formDataMap: typing.Union[MetaOapg.properties.formDataMap, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + formData: typing.Union[MetaOapg.properties.formData, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, parts: typing.Union[MetaOapg.properties.parts, list, tuple, schemas.Unset] = schemas.unset, preamble: typing.Union[MetaOapg.properties.preamble, str, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, @@ -208,8 +208,8 @@ def __new__( return super().__new__( cls, *args, - formData=formData, formDataMap=formDataMap, + formData=formData, parts=parts, preamble=preamble, _configuration=_configuration, diff --git a/icasdk/model/multipart_form_data_input.pyi b/icasdk/model/multipart_form_data_input.pyi index e754ca2..660d5db 100644 --- a/icasdk/model/multipart_form_data_input.pyi +++ b/icasdk/model/multipart_form_data_input.pyi @@ -38,38 +38,6 @@ class MultipartFormDataInput( class properties: - class formData( - schemas.DictSchema - ): - - - class MetaOapg: - - @staticmethod - def additional_properties() -> typing.Type['InputPart']: - return InputPart - - def __getitem__(self, name: typing.Union[str, ]) -> 'InputPart': - # dict_instance[name] accessor - return super().__getitem__(name) - - def get_item_oapg(self, name: typing.Union[str, ]) -> 'InputPart': - return super().get_item_oapg(name) - - def __new__( - cls, - *args: typing.Union[dict, frozendict.frozendict, ], - _configuration: typing.Optional[schemas.Configuration] = None, - **kwargs: 'InputPart', - ) -> 'formData': - return super().__new__( - cls, - *args, - _configuration=_configuration, - **kwargs, - ) - - class formDataMap( schemas.DictSchema ): @@ -124,6 +92,38 @@ class MultipartFormDataInput( ) + class formData( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['InputPart']: + return InputPart + + def __getitem__(self, name: typing.Union[str, ]) -> 'InputPart': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'InputPart': + return super().get_item_oapg(name) + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'InputPart', + ) -> 'formData': + return super().__new__( + cls, + *args, + _configuration=_configuration, + **kwargs, + ) + + class parts( schemas.ListSchema ): @@ -150,17 +150,17 @@ class MultipartFormDataInput( return super().__getitem__(i) preamble = schemas.StrSchema __annotations__ = { - "formData": formData, "formDataMap": formDataMap, + "formData": formData, "parts": parts, "preamble": preamble, } @typing.overload - def __getitem__(self, name: typing_extensions.Literal["formData"]) -> MetaOapg.properties.formData: ... + def __getitem__(self, name: typing_extensions.Literal["formDataMap"]) -> MetaOapg.properties.formDataMap: ... @typing.overload - def __getitem__(self, name: typing_extensions.Literal["formDataMap"]) -> MetaOapg.properties.formDataMap: ... + def __getitem__(self, name: typing_extensions.Literal["formData"]) -> MetaOapg.properties.formData: ... @typing.overload def __getitem__(self, name: typing_extensions.Literal["parts"]) -> MetaOapg.properties.parts: ... @@ -171,16 +171,16 @@ class MultipartFormDataInput( @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["formData", "formDataMap", "parts", "preamble", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["formDataMap", "formData", "parts", "preamble", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["formData"]) -> typing.Union[MetaOapg.properties.formData, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["formDataMap"]) -> typing.Union[MetaOapg.properties.formDataMap, schemas.Unset]: ... @typing.overload - def get_item_oapg(self, name: typing_extensions.Literal["formDataMap"]) -> typing.Union[MetaOapg.properties.formDataMap, schemas.Unset]: ... + def get_item_oapg(self, name: typing_extensions.Literal["formData"]) -> typing.Union[MetaOapg.properties.formData, schemas.Unset]: ... @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["parts"]) -> typing.Union[MetaOapg.properties.parts, schemas.Unset]: ... @@ -191,15 +191,15 @@ class MultipartFormDataInput( @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["formData", "formDataMap", "parts", "preamble", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["formDataMap", "formData", "parts", "preamble", ], str]): return super().get_item_oapg(name) def __new__( cls, *args: typing.Union[dict, frozendict.frozendict, ], - formData: typing.Union[MetaOapg.properties.formData, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, formDataMap: typing.Union[MetaOapg.properties.formDataMap, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + formData: typing.Union[MetaOapg.properties.formData, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, parts: typing.Union[MetaOapg.properties.parts, list, tuple, schemas.Unset] = schemas.unset, preamble: typing.Union[MetaOapg.properties.preamble, str, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, @@ -208,8 +208,8 @@ class MultipartFormDataInput( return super().__new__( cls, *args, - formData=formData, formDataMap=formDataMap, + formData=formData, parts=parts, preamble=preamble, _configuration=_configuration, diff --git a/icasdk/model/option_settings.py b/icasdk/model/option_settings.py new file mode 100644 index 0000000..4b6aec5 --- /dev/null +++ b/icasdk/model/option_settings.py @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class OptionSettings( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class options( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'options': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class defaultValues( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'defaultValues': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "options": options, + "defaultValues": defaultValues, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["options"]) -> MetaOapg.properties.options: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultValues"]) -> MetaOapg.properties.defaultValues: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["options", "defaultValues", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["options"]) -> typing.Union[MetaOapg.properties.options, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultValues"]) -> typing.Union[MetaOapg.properties.defaultValues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["options", "defaultValues", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + options: typing.Union[MetaOapg.properties.options, list, tuple, schemas.Unset] = schemas.unset, + defaultValues: typing.Union[MetaOapg.properties.defaultValues, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OptionSettings': + return super().__new__( + cls, + *args, + options=options, + defaultValues=defaultValues, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/option_settings.pyi b/icasdk/model/option_settings.pyi new file mode 100644 index 0000000..4b6aec5 --- /dev/null +++ b/icasdk/model/option_settings.pyi @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class OptionSettings( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class options( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'options': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class defaultValues( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'defaultValues': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "options": options, + "defaultValues": defaultValues, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["options"]) -> MetaOapg.properties.options: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultValues"]) -> MetaOapg.properties.defaultValues: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["options", "defaultValues", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["options"]) -> typing.Union[MetaOapg.properties.options, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultValues"]) -> typing.Union[MetaOapg.properties.defaultValues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["options", "defaultValues", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + options: typing.Union[MetaOapg.properties.options, list, tuple, schemas.Unset] = schemas.unset, + defaultValues: typing.Union[MetaOapg.properties.defaultValues, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OptionSettings': + return super().__new__( + cls, + *args, + options=options, + defaultValues=defaultValues, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/pipeline_configuration_parameter.py b/icasdk/model/pipeline_configuration_parameter.py index 27cd169..6b1de93 100644 --- a/icasdk/model/pipeline_configuration_parameter.py +++ b/icasdk/model/pipeline_configuration_parameter.py @@ -37,6 +37,7 @@ class MetaOapg: required = { "code", "multiValue", + "type", "required", } @@ -53,14 +54,22 @@ class MetaOapg: min_length = 1 required = schemas.BoolSchema multiValue = schemas.BoolSchema + type = schemas.StrSchema + + @staticmethod + def settings() -> typing.Type['Settings']: + return Settings __annotations__ = { "code": code, "required": required, "multiValue": multiValue, + "type": type, + "settings": settings, } code: MetaOapg.properties.code multiValue: MetaOapg.properties.multiValue + type: MetaOapg.properties.type required: MetaOapg.properties.required @typing.overload @@ -72,10 +81,16 @@ def __getitem__(self, name: typing_extensions.Literal["required"]) -> MetaOapg.p @typing.overload def __getitem__(self, name: typing_extensions.Literal["multiValue"]) -> MetaOapg.properties.multiValue: ... + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["settings"]) -> 'Settings': ... + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["code", "required", "multiValue", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["code", "required", "multiValue", "type", "settings", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -89,10 +104,16 @@ def get_item_oapg(self, name: typing_extensions.Literal["required"]) -> MetaOapg @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["multiValue"]) -> MetaOapg.properties.multiValue: ... + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["settings"]) -> typing.Union['Settings', schemas.Unset]: ... + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["code", "required", "multiValue", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["code", "required", "multiValue", "type", "settings", ], str]): return super().get_item_oapg(name) @@ -101,7 +122,9 @@ def __new__( *args: typing.Union[dict, frozendict.frozendict, ], code: typing.Union[MetaOapg.properties.code, str, ], multiValue: typing.Union[MetaOapg.properties.multiValue, bool, ], + type: typing.Union[MetaOapg.properties.type, str, ], required: typing.Union[MetaOapg.properties.required, bool, ], + settings: typing.Union['Settings', schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'PipelineConfigurationParameter': @@ -110,7 +133,11 @@ def __new__( *args, code=code, multiValue=multiValue, + type=type, required=required, + settings=settings, _configuration=_configuration, **kwargs, ) + +from icasdk.model.settings import Settings diff --git a/icasdk/model/pipeline_configuration_parameter.pyi b/icasdk/model/pipeline_configuration_parameter.pyi index 7188afa..b43bbb5 100644 --- a/icasdk/model/pipeline_configuration_parameter.pyi +++ b/icasdk/model/pipeline_configuration_parameter.pyi @@ -37,6 +37,7 @@ class PipelineConfigurationParameter( required = { "code", "multiValue", + "type", "required", } @@ -49,14 +50,22 @@ class PipelineConfigurationParameter( pass required = schemas.BoolSchema multiValue = schemas.BoolSchema + type = schemas.StrSchema + + @staticmethod + def settings() -> typing.Type['Settings']: + return Settings __annotations__ = { "code": code, "required": required, "multiValue": multiValue, + "type": type, + "settings": settings, } code: MetaOapg.properties.code multiValue: MetaOapg.properties.multiValue + type: MetaOapg.properties.type required: MetaOapg.properties.required @typing.overload @@ -68,10 +77,16 @@ class PipelineConfigurationParameter( @typing.overload def __getitem__(self, name: typing_extensions.Literal["multiValue"]) -> MetaOapg.properties.multiValue: ... + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["settings"]) -> 'Settings': ... + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["code", "required", "multiValue", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["code", "required", "multiValue", "type", "settings", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -85,10 +100,16 @@ class PipelineConfigurationParameter( @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["multiValue"]) -> MetaOapg.properties.multiValue: ... + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["settings"]) -> typing.Union['Settings', schemas.Unset]: ... + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["code", "required", "multiValue", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["code", "required", "multiValue", "type", "settings", ], str]): return super().get_item_oapg(name) @@ -97,7 +118,9 @@ class PipelineConfigurationParameter( *args: typing.Union[dict, frozendict.frozendict, ], code: typing.Union[MetaOapg.properties.code, str, ], multiValue: typing.Union[MetaOapg.properties.multiValue, bool, ], + type: typing.Union[MetaOapg.properties.type, str, ], required: typing.Union[MetaOapg.properties.required, bool, ], + settings: typing.Union['Settings', schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'PipelineConfigurationParameter': @@ -106,7 +129,11 @@ class PipelineConfigurationParameter( *args, code=code, multiValue=multiValue, + type=type, required=required, + settings=settings, _configuration=_configuration, **kwargs, ) + +from icasdk.model.settings import Settings diff --git a/icasdk/model/pipeline_file.py b/icasdk/model/pipeline_file.py new file mode 100644 index 0000000..5d94004 --- /dev/null +++ b/icasdk/model/pipeline_file.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class PipelineFile( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "name", + "id", + } + + class properties: + id = schemas.UUIDSchema + name = schemas.StrSchema + __annotations__ = { + "id": id, + "name": name, + } + + name: MetaOapg.properties.name + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PipelineFile': + return super().__new__( + cls, + *args, + name=name, + id=id, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/pipeline_file.pyi b/icasdk/model/pipeline_file.pyi new file mode 100644 index 0000000..5d94004 --- /dev/null +++ b/icasdk/model/pipeline_file.pyi @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class PipelineFile( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "name", + "id", + } + + class properties: + id = schemas.UUIDSchema + name = schemas.StrSchema + __annotations__ = { + "id": id, + "name": name, + } + + name: MetaOapg.properties.name + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PipelineFile': + return super().__new__( + cls, + *args, + name=name, + id=id, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/pipeline_file_content_spec.py b/icasdk/model/pipeline_file_content_spec.py new file mode 100644 index 0000000..3fced9c --- /dev/null +++ b/icasdk/model/pipeline_file_content_spec.py @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class PipelineFileContentSpec( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "content", + } + + class properties: + content = schemas.BinarySchema + __annotations__ = { + "content": content, + } + + content: MetaOapg.properties.content + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + content: typing.Union[MetaOapg.properties.content, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PipelineFileContentSpec': + return super().__new__( + cls, + *args, + content=content, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/pipeline_file_content_spec.pyi b/icasdk/model/pipeline_file_content_spec.pyi new file mode 100644 index 0000000..3fced9c --- /dev/null +++ b/icasdk/model/pipeline_file_content_spec.pyi @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class PipelineFileContentSpec( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "content", + } + + class properties: + content = schemas.BinarySchema + __annotations__ = { + "content": content, + } + + content: MetaOapg.properties.content + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + content: typing.Union[MetaOapg.properties.content, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PipelineFileContentSpec': + return super().__new__( + cls, + *args, + content=content, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/pipeline_file_list.py b/icasdk/model/pipeline_file_list.py new file mode 100644 index 0000000..6e1e99b --- /dev/null +++ b/icasdk/model/pipeline_file_list.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class PipelineFileList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "items", + } + + class properties: + + + class items( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['PipelineFile']: + return PipelineFile + + def __new__( + cls, + arg: typing.Union[typing.Tuple['PipelineFile'], typing.List['PipelineFile']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'PipelineFile': + return super().__getitem__(i) + __annotations__ = { + "items": items, + } + + items: MetaOapg.properties.items + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["items", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["items", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + items: typing.Union[MetaOapg.properties.items, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PipelineFileList': + return super().__new__( + cls, + *args, + items=items, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.pipeline_file import PipelineFile diff --git a/icasdk/model/pipeline_file_list.pyi b/icasdk/model/pipeline_file_list.pyi new file mode 100644 index 0000000..6e1e99b --- /dev/null +++ b/icasdk/model/pipeline_file_list.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class PipelineFileList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "items", + } + + class properties: + + + class items( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['PipelineFile']: + return PipelineFile + + def __new__( + cls, + arg: typing.Union[typing.Tuple['PipelineFile'], typing.List['PipelineFile']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'PipelineFile': + return super().__getitem__(i) + __annotations__ = { + "items": items, + } + + items: MetaOapg.properties.items + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["items", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["items", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + items: typing.Union[MetaOapg.properties.items, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PipelineFileList': + return super().__new__( + cls, + *args, + items=items, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.pipeline_file import PipelineFile diff --git a/icasdk/model/project.py b/icasdk/model/project.py index 2953f44..5bfe3a0 100644 --- a/icasdk/model/project.py +++ b/icasdk/model/project.py @@ -247,22 +247,22 @@ class analysisPriority( class MetaOapg: enum_value_to_name = { - "Low": "LOW", - "Medium": "MEDIUM", - "High": "HIGH", + "LOW": "LOW", + "MEDIUM": "MEDIUM", + "HIGH": "HIGH", } @schemas.classproperty def LOW(cls): - return cls("Low") + return cls("LOW") @schemas.classproperty def MEDIUM(cls): - return cls("Medium") + return cls("MEDIUM") @schemas.classproperty def HIGH(cls): - return cls("High") + return cls("HIGH") def __new__( diff --git a/icasdk/model/project.pyi b/icasdk/model/project.pyi index 2d0c8a1..30dce87 100644 --- a/icasdk/model/project.pyi +++ b/icasdk/model/project.pyi @@ -232,22 +232,22 @@ class Project( class MetaOapg: enum_value_to_name = { - "Low": "LOW", - "Medium": "MEDIUM", - "High": "HIGH", + "LOW": "LOW", + "MEDIUM": "MEDIUM", + "HIGH": "HIGH", } @schemas.classproperty def LOW(cls): - return cls("Low") + return cls("LOW") @schemas.classproperty def MEDIUM(cls): - return cls("Medium") + return cls("MEDIUM") @schemas.classproperty def HIGH(cls): - return cls("High") + return cls("HIGH") def __new__( diff --git a/icasdk/model/project_data_update_batch.py b/icasdk/model/project_data_update_batch.py new file mode 100644 index 0000000..ffef544 --- /dev/null +++ b/icasdk/model/project_data_update_batch.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "job", + } + + class properties: + id = schemas.UUIDSchema + + @staticmethod + def job() -> typing.Type['Job']: + return Job + __annotations__ = { + "id": id, + "job": job, + } + + id: MetaOapg.properties.id + job: 'Job' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["job"]) -> 'Job': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "job", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["job"]) -> 'Job': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "job", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], + job: 'Job', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatch': + return super().__new__( + cls, + *args, + id=id, + job=job, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.job import Job diff --git a/icasdk/model/project_data_update_batch.pyi b/icasdk/model/project_data_update_batch.pyi new file mode 100644 index 0000000..ffef544 --- /dev/null +++ b/icasdk/model/project_data_update_batch.pyi @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "job", + } + + class properties: + id = schemas.UUIDSchema + + @staticmethod + def job() -> typing.Type['Job']: + return Job + __annotations__ = { + "id": id, + "job": job, + } + + id: MetaOapg.properties.id + job: 'Job' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["job"]) -> 'Job': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "job", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["job"]) -> 'Job': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "job", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], + job: 'Job', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatch': + return super().__new__( + cls, + *args, + id=id, + job=job, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.job import Job diff --git a/icasdk/model/project_data_update_batch_item.py b/icasdk/model/project_data_update_batch_item.py new file mode 100644 index 0000000..cdb314a --- /dev/null +++ b/icasdk/model/project_data_update_batch_item.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatchItem( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "request", + "processing", + "id", + } + + class properties: + id = schemas.UUIDSchema + + @staticmethod + def request() -> typing.Type['ProjectDataUpdateBatchItemRequest']: + return ProjectDataUpdateBatchItemRequest + + @staticmethod + def processing() -> typing.Type['ProjectDataUpdateBatchItemProcessing']: + return ProjectDataUpdateBatchItemProcessing + __annotations__ = { + "id": id, + "request": request, + "processing": processing, + } + + request: 'ProjectDataUpdateBatchItemRequest' + processing: 'ProjectDataUpdateBatchItemProcessing' + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["request"]) -> 'ProjectDataUpdateBatchItemRequest': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["processing"]) -> 'ProjectDataUpdateBatchItemProcessing': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "request", "processing", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["request"]) -> 'ProjectDataUpdateBatchItemRequest': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["processing"]) -> 'ProjectDataUpdateBatchItemProcessing': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "request", "processing", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + request: 'ProjectDataUpdateBatchItemRequest', + processing: 'ProjectDataUpdateBatchItemProcessing', + id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatchItem': + return super().__new__( + cls, + *args, + request=request, + processing=processing, + id=id, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.project_data_update_batch_item_processing import ProjectDataUpdateBatchItemProcessing +from icasdk.model.project_data_update_batch_item_request import ProjectDataUpdateBatchItemRequest diff --git a/icasdk/model/project_data_update_batch_item.pyi b/icasdk/model/project_data_update_batch_item.pyi new file mode 100644 index 0000000..cdb314a --- /dev/null +++ b/icasdk/model/project_data_update_batch_item.pyi @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatchItem( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "request", + "processing", + "id", + } + + class properties: + id = schemas.UUIDSchema + + @staticmethod + def request() -> typing.Type['ProjectDataUpdateBatchItemRequest']: + return ProjectDataUpdateBatchItemRequest + + @staticmethod + def processing() -> typing.Type['ProjectDataUpdateBatchItemProcessing']: + return ProjectDataUpdateBatchItemProcessing + __annotations__ = { + "id": id, + "request": request, + "processing": processing, + } + + request: 'ProjectDataUpdateBatchItemRequest' + processing: 'ProjectDataUpdateBatchItemProcessing' + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["request"]) -> 'ProjectDataUpdateBatchItemRequest': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["processing"]) -> 'ProjectDataUpdateBatchItemProcessing': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "request", "processing", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["request"]) -> 'ProjectDataUpdateBatchItemRequest': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["processing"]) -> 'ProjectDataUpdateBatchItemProcessing': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "request", "processing", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + request: 'ProjectDataUpdateBatchItemRequest', + processing: 'ProjectDataUpdateBatchItemProcessing', + id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatchItem': + return super().__new__( + cls, + *args, + request=request, + processing=processing, + id=id, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.project_data_update_batch_item_processing import ProjectDataUpdateBatchItemProcessing +from icasdk.model.project_data_update_batch_item_request import ProjectDataUpdateBatchItemRequest diff --git a/icasdk/model/project_data_update_batch_item_paged_list.py b/icasdk/model/project_data_update_batch_item_paged_list.py new file mode 100644 index 0000000..cd6b43d --- /dev/null +++ b/icasdk/model/project_data_update_batch_item_paged_list.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatchItemPagedList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "items", + } + + class properties: + + + class items( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ProjectDataUpdateBatchItem']: + return ProjectDataUpdateBatchItem + + def __new__( + cls, + arg: typing.Union[typing.Tuple['ProjectDataUpdateBatchItem'], typing.List['ProjectDataUpdateBatchItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ProjectDataUpdateBatchItem': + return super().__getitem__(i) + + + class nextPageToken( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + max_length = 2000 + min_length = 0 + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'nextPageToken': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class remainingRecords( + schemas.Int64Base, + schemas.IntBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + class MetaOapg: + format = 'int64' + inclusive_minimum = 0 + + + def __new__( + cls, + *args: typing.Union[None, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'remainingRecords': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class totalItemCount( + schemas.Int64Base, + schemas.IntBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + class MetaOapg: + format = 'int64' + inclusive_minimum = 0 + + + def __new__( + cls, + *args: typing.Union[None, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'totalItemCount': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + __annotations__ = { + "items": items, + "nextPageToken": nextPageToken, + "remainingRecords": remainingRecords, + "totalItemCount": totalItemCount, + } + + items: MetaOapg.properties.items + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["nextPageToken"]) -> MetaOapg.properties.nextPageToken: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["remainingRecords"]) -> MetaOapg.properties.remainingRecords: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalItemCount"]) -> MetaOapg.properties.totalItemCount: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["items", "nextPageToken", "remainingRecords", "totalItemCount", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["nextPageToken"]) -> typing.Union[MetaOapg.properties.nextPageToken, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["remainingRecords"]) -> typing.Union[MetaOapg.properties.remainingRecords, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalItemCount"]) -> typing.Union[MetaOapg.properties.totalItemCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["items", "nextPageToken", "remainingRecords", "totalItemCount", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + items: typing.Union[MetaOapg.properties.items, list, tuple, ], + nextPageToken: typing.Union[MetaOapg.properties.nextPageToken, None, str, schemas.Unset] = schemas.unset, + remainingRecords: typing.Union[MetaOapg.properties.remainingRecords, None, decimal.Decimal, int, schemas.Unset] = schemas.unset, + totalItemCount: typing.Union[MetaOapg.properties.totalItemCount, None, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatchItemPagedList': + return super().__new__( + cls, + *args, + items=items, + nextPageToken=nextPageToken, + remainingRecords=remainingRecords, + totalItemCount=totalItemCount, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.project_data_update_batch_item import ProjectDataUpdateBatchItem diff --git a/icasdk/model/project_data_update_batch_item_paged_list.pyi b/icasdk/model/project_data_update_batch_item_paged_list.pyi new file mode 100644 index 0000000..e690442 --- /dev/null +++ b/icasdk/model/project_data_update_batch_item_paged_list.pyi @@ -0,0 +1,210 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatchItemPagedList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "items", + } + + class properties: + + + class items( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ProjectDataUpdateBatchItem']: + return ProjectDataUpdateBatchItem + + def __new__( + cls, + arg: typing.Union[typing.Tuple['ProjectDataUpdateBatchItem'], typing.List['ProjectDataUpdateBatchItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ProjectDataUpdateBatchItem': + return super().__getitem__(i) + + + class nextPageToken( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'nextPageToken': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class remainingRecords( + schemas.Int64Base, + schemas.IntBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + class MetaOapg: + format = 'int64' + + + def __new__( + cls, + *args: typing.Union[None, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'remainingRecords': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class totalItemCount( + schemas.Int64Base, + schemas.IntBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + class MetaOapg: + format = 'int64' + + + def __new__( + cls, + *args: typing.Union[None, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'totalItemCount': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + __annotations__ = { + "items": items, + "nextPageToken": nextPageToken, + "remainingRecords": remainingRecords, + "totalItemCount": totalItemCount, + } + + items: MetaOapg.properties.items + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["nextPageToken"]) -> MetaOapg.properties.nextPageToken: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["remainingRecords"]) -> MetaOapg.properties.remainingRecords: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalItemCount"]) -> MetaOapg.properties.totalItemCount: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["items", "nextPageToken", "remainingRecords", "totalItemCount", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["nextPageToken"]) -> typing.Union[MetaOapg.properties.nextPageToken, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["remainingRecords"]) -> typing.Union[MetaOapg.properties.remainingRecords, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalItemCount"]) -> typing.Union[MetaOapg.properties.totalItemCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["items", "nextPageToken", "remainingRecords", "totalItemCount", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + items: typing.Union[MetaOapg.properties.items, list, tuple, ], + nextPageToken: typing.Union[MetaOapg.properties.nextPageToken, None, str, schemas.Unset] = schemas.unset, + remainingRecords: typing.Union[MetaOapg.properties.remainingRecords, None, decimal.Decimal, int, schemas.Unset] = schemas.unset, + totalItemCount: typing.Union[MetaOapg.properties.totalItemCount, None, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatchItemPagedList': + return super().__new__( + cls, + *args, + items=items, + nextPageToken=nextPageToken, + remainingRecords=remainingRecords, + totalItemCount=totalItemCount, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.project_data_update_batch_item import ProjectDataUpdateBatchItem diff --git a/icasdk/model/project_data_update_batch_item_processing.py b/icasdk/model/project_data_update_batch_item_processing.py new file mode 100644 index 0000000..70a266a --- /dev/null +++ b/icasdk/model/project_data_update_batch_item_processing.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatchItemProcessing( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "status", + } + + class properties: + + + class status( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "INITIALISED": "INITIALISED", + "WAITING_RESOURCES": "WAITING_RESOURCES", + "UPDATING": "UPDATING", + "UPDATED": "UPDATED", + "PARTIALLY_UPDATED": "PARTIALLY_UPDATED", + "FAILED": "FAILED", + } + + @schemas.classproperty + def INITIALISED(cls): + return cls("INITIALISED") + + @schemas.classproperty + def WAITING_RESOURCES(cls): + return cls("WAITING_RESOURCES") + + @schemas.classproperty + def UPDATING(cls): + return cls("UPDATING") + + @schemas.classproperty + def UPDATED(cls): + return cls("UPDATED") + + @schemas.classproperty + def PARTIALLY_UPDATED(cls): + return cls("PARTIALLY_UPDATED") + + @schemas.classproperty + def FAILED(cls): + return cls("FAILED") + + + class additionalStatusInformation( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'additionalStatusInformation': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + __annotations__ = { + "status": status, + "additionalStatusInformation": additionalStatusInformation, + } + + status: MetaOapg.properties.status + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalStatusInformation"]) -> MetaOapg.properties.additionalStatusInformation: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["status", "additionalStatusInformation", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalStatusInformation"]) -> typing.Union[MetaOapg.properties.additionalStatusInformation, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["status", "additionalStatusInformation", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + status: typing.Union[MetaOapg.properties.status, str, ], + additionalStatusInformation: typing.Union[MetaOapg.properties.additionalStatusInformation, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatchItemProcessing': + return super().__new__( + cls, + *args, + status=status, + additionalStatusInformation=additionalStatusInformation, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/project_data_update_batch_item_processing.pyi b/icasdk/model/project_data_update_batch_item_processing.pyi new file mode 100644 index 0000000..ef9e2b3 --- /dev/null +++ b/icasdk/model/project_data_update_batch_item_processing.pyi @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatchItemProcessing( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "status", + } + + class properties: + + + class status( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INITIALISED(cls): + return cls("INITIALISED") + + @schemas.classproperty + def WAITING_RESOURCES(cls): + return cls("WAITING_RESOURCES") + + @schemas.classproperty + def UPDATING(cls): + return cls("UPDATING") + + @schemas.classproperty + def UPDATED(cls): + return cls("UPDATED") + + @schemas.classproperty + def PARTIALLY_UPDATED(cls): + return cls("PARTIALLY_UPDATED") + + @schemas.classproperty + def FAILED(cls): + return cls("FAILED") + + + class additionalStatusInformation( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'additionalStatusInformation': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + __annotations__ = { + "status": status, + "additionalStatusInformation": additionalStatusInformation, + } + + status: MetaOapg.properties.status + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalStatusInformation"]) -> MetaOapg.properties.additionalStatusInformation: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["status", "additionalStatusInformation", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalStatusInformation"]) -> typing.Union[MetaOapg.properties.additionalStatusInformation, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["status", "additionalStatusInformation", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + status: typing.Union[MetaOapg.properties.status, str, ], + additionalStatusInformation: typing.Union[MetaOapg.properties.additionalStatusInformation, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatchItemProcessing': + return super().__new__( + cls, + *args, + status=status, + additionalStatusInformation=additionalStatusInformation, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/project_data_update_batch_item_request.py b/icasdk/model/project_data_update_batch_item_request.py new file mode 100644 index 0000000..cf2cf2e --- /dev/null +++ b/icasdk/model/project_data_update_batch_item_request.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatchItemRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "dataId", + } + + class properties: + dataId = schemas.StrSchema + + @staticmethod + def userTags() -> typing.Type['TagUpdate']: + return TagUpdate + + @staticmethod + def technicalTags() -> typing.Type['TagUpdate']: + return TagUpdate + __annotations__ = { + "dataId": dataId, + "userTags": userTags, + "technicalTags": technicalTags, + } + + dataId: MetaOapg.properties.dataId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataId"]) -> MetaOapg.properties.dataId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userTags"]) -> 'TagUpdate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["technicalTags"]) -> 'TagUpdate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataId", "userTags", "technicalTags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataId"]) -> MetaOapg.properties.dataId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userTags"]) -> typing.Union['TagUpdate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["technicalTags"]) -> typing.Union['TagUpdate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataId", "userTags", "technicalTags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + dataId: typing.Union[MetaOapg.properties.dataId, str, ], + userTags: typing.Union['TagUpdate', schemas.Unset] = schemas.unset, + technicalTags: typing.Union['TagUpdate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatchItemRequest': + return super().__new__( + cls, + *args, + dataId=dataId, + userTags=userTags, + technicalTags=technicalTags, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.tag_update import TagUpdate diff --git a/icasdk/model/project_data_update_batch_item_request.pyi b/icasdk/model/project_data_update_batch_item_request.pyi new file mode 100644 index 0000000..cf2cf2e --- /dev/null +++ b/icasdk/model/project_data_update_batch_item_request.pyi @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectDataUpdateBatchItemRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "dataId", + } + + class properties: + dataId = schemas.StrSchema + + @staticmethod + def userTags() -> typing.Type['TagUpdate']: + return TagUpdate + + @staticmethod + def technicalTags() -> typing.Type['TagUpdate']: + return TagUpdate + __annotations__ = { + "dataId": dataId, + "userTags": userTags, + "technicalTags": technicalTags, + } + + dataId: MetaOapg.properties.dataId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataId"]) -> MetaOapg.properties.dataId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userTags"]) -> 'TagUpdate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["technicalTags"]) -> 'TagUpdate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataId", "userTags", "technicalTags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataId"]) -> MetaOapg.properties.dataId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userTags"]) -> typing.Union['TagUpdate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["technicalTags"]) -> typing.Union['TagUpdate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataId", "userTags", "technicalTags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + dataId: typing.Union[MetaOapg.properties.dataId, str, ], + userTags: typing.Union['TagUpdate', schemas.Unset] = schemas.unset, + technicalTags: typing.Union['TagUpdate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectDataUpdateBatchItemRequest': + return super().__new__( + cls, + *args, + dataId=dataId, + userTags=userTags, + technicalTags=technicalTags, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.tag_update import TagUpdate diff --git a/icasdk/model/project_permission_list_v4.py b/icasdk/model/project_permission_list_v4.py new file mode 100644 index 0000000..b88bbeb --- /dev/null +++ b/icasdk/model/project_permission_list_v4.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectPermissionListV4( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "items", + } + + class properties: + + + class items( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ProjectPermissionV4']: + return ProjectPermissionV4 + + def __new__( + cls, + arg: typing.Union[typing.Tuple['ProjectPermissionV4'], typing.List['ProjectPermissionV4']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ProjectPermissionV4': + return super().__getitem__(i) + __annotations__ = { + "items": items, + } + + items: MetaOapg.properties.items + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["items", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["items", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + items: typing.Union[MetaOapg.properties.items, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectPermissionListV4': + return super().__new__( + cls, + *args, + items=items, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.project_permission_v4 import ProjectPermissionV4 diff --git a/icasdk/model/project_permission_list_v4.pyi b/icasdk/model/project_permission_list_v4.pyi new file mode 100644 index 0000000..b88bbeb --- /dev/null +++ b/icasdk/model/project_permission_list_v4.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectPermissionListV4( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "items", + } + + class properties: + + + class items( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ProjectPermissionV4']: + return ProjectPermissionV4 + + def __new__( + cls, + arg: typing.Union[typing.Tuple['ProjectPermissionV4'], typing.List['ProjectPermissionV4']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ProjectPermissionV4': + return super().__getitem__(i) + __annotations__ = { + "items": items, + } + + items: MetaOapg.properties.items + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["items", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["items"]) -> MetaOapg.properties.items: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["items", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + items: typing.Union[MetaOapg.properties.items, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectPermissionListV4': + return super().__new__( + cls, + *args, + items=items, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.project_permission_v4 import ProjectPermissionV4 diff --git a/icasdk/model/project_permission_v4.py b/icasdk/model/project_permission_v4.py new file mode 100644 index 0000000..1e9f2ea --- /dev/null +++ b/icasdk/model/project_permission_v4.py @@ -0,0 +1,385 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectPermissionV4( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "uploadAllowed", + "membershipType", + "roleFlow", + "roleBase", + "tenantId", + "downloadAllowed", + "timeCreated", + "id", + "ownerId", + "roleBench", + "roleProject", + "timeModified", + } + + class properties: + id = schemas.UUIDSchema + timeCreated = schemas.DateTimeSchema + timeModified = schemas.DateTimeSchema + ownerId = schemas.UUIDSchema + tenantId = schemas.UUIDSchema + roleProject = schemas.StrSchema + roleFlow = schemas.StrSchema + roleBase = schemas.StrSchema + roleBench = schemas.StrSchema + + + class membershipType( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "USER": "USER", + "EMAIL": "EMAIL", + "WORKGROUP": "WORKGROUP", + } + + @schemas.classproperty + def USER(cls): + return cls("USER") + + @schemas.classproperty + def EMAIL(cls): + return cls("EMAIL") + + @schemas.classproperty + def WORKGROUP(cls): + return cls("WORKGROUP") + uploadAllowed = schemas.BoolSchema + downloadAllowed = schemas.BoolSchema + + + class tenantName( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tenantName': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + @staticmethod + def user() -> typing.Type['User']: + return User + + + class emailAddress( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'emailAddress': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + @staticmethod + def workgroup() -> typing.Type['Workgroup']: + return Workgroup + + + class invitationAccepted( + schemas.BoolBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneBoolMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'invitationAccepted': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class invitationRejected( + schemas.BoolBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneBoolMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'invitationRejected': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + __annotations__ = { + "id": id, + "timeCreated": timeCreated, + "timeModified": timeModified, + "ownerId": ownerId, + "tenantId": tenantId, + "roleProject": roleProject, + "roleFlow": roleFlow, + "roleBase": roleBase, + "roleBench": roleBench, + "membershipType": membershipType, + "uploadAllowed": uploadAllowed, + "downloadAllowed": downloadAllowed, + "tenantName": tenantName, + "user": user, + "emailAddress": emailAddress, + "workgroup": workgroup, + "invitationAccepted": invitationAccepted, + "invitationRejected": invitationRejected, + } + + uploadAllowed: MetaOapg.properties.uploadAllowed + membershipType: MetaOapg.properties.membershipType + roleFlow: MetaOapg.properties.roleFlow + roleBase: MetaOapg.properties.roleBase + tenantId: MetaOapg.properties.tenantId + downloadAllowed: MetaOapg.properties.downloadAllowed + timeCreated: MetaOapg.properties.timeCreated + id: MetaOapg.properties.id + ownerId: MetaOapg.properties.ownerId + roleBench: MetaOapg.properties.roleBench + roleProject: MetaOapg.properties.roleProject + timeModified: MetaOapg.properties.timeModified + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timeCreated"]) -> MetaOapg.properties.timeCreated: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timeModified"]) -> MetaOapg.properties.timeModified: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ownerId"]) -> MetaOapg.properties.ownerId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tenantId"]) -> MetaOapg.properties.tenantId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleProject"]) -> MetaOapg.properties.roleProject: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleFlow"]) -> MetaOapg.properties.roleFlow: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleBase"]) -> MetaOapg.properties.roleBase: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleBench"]) -> MetaOapg.properties.roleBench: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["membershipType"]) -> MetaOapg.properties.membershipType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["uploadAllowed"]) -> MetaOapg.properties.uploadAllowed: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["downloadAllowed"]) -> MetaOapg.properties.downloadAllowed: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tenantName"]) -> MetaOapg.properties.tenantName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user"]) -> 'User': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["emailAddress"]) -> MetaOapg.properties.emailAddress: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workgroup"]) -> 'Workgroup': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["invitationAccepted"]) -> MetaOapg.properties.invitationAccepted: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["invitationRejected"]) -> MetaOapg.properties.invitationRejected: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "timeCreated", "timeModified", "ownerId", "tenantId", "roleProject", "roleFlow", "roleBase", "roleBench", "membershipType", "uploadAllowed", "downloadAllowed", "tenantName", "user", "emailAddress", "workgroup", "invitationAccepted", "invitationRejected", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timeCreated"]) -> MetaOapg.properties.timeCreated: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timeModified"]) -> MetaOapg.properties.timeModified: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ownerId"]) -> MetaOapg.properties.ownerId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tenantId"]) -> MetaOapg.properties.tenantId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleProject"]) -> MetaOapg.properties.roleProject: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleFlow"]) -> MetaOapg.properties.roleFlow: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleBase"]) -> MetaOapg.properties.roleBase: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleBench"]) -> MetaOapg.properties.roleBench: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["membershipType"]) -> MetaOapg.properties.membershipType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["uploadAllowed"]) -> MetaOapg.properties.uploadAllowed: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["downloadAllowed"]) -> MetaOapg.properties.downloadAllowed: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tenantName"]) -> typing.Union[MetaOapg.properties.tenantName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union['User', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["emailAddress"]) -> typing.Union[MetaOapg.properties.emailAddress, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workgroup"]) -> typing.Union['Workgroup', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["invitationAccepted"]) -> typing.Union[MetaOapg.properties.invitationAccepted, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["invitationRejected"]) -> typing.Union[MetaOapg.properties.invitationRejected, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "timeCreated", "timeModified", "ownerId", "tenantId", "roleProject", "roleFlow", "roleBase", "roleBench", "membershipType", "uploadAllowed", "downloadAllowed", "tenantName", "user", "emailAddress", "workgroup", "invitationAccepted", "invitationRejected", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + uploadAllowed: typing.Union[MetaOapg.properties.uploadAllowed, bool, ], + membershipType: typing.Union[MetaOapg.properties.membershipType, str, ], + roleFlow: typing.Union[MetaOapg.properties.roleFlow, str, ], + roleBase: typing.Union[MetaOapg.properties.roleBase, str, ], + tenantId: typing.Union[MetaOapg.properties.tenantId, str, uuid.UUID, ], + downloadAllowed: typing.Union[MetaOapg.properties.downloadAllowed, bool, ], + timeCreated: typing.Union[MetaOapg.properties.timeCreated, str, datetime, ], + id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], + ownerId: typing.Union[MetaOapg.properties.ownerId, str, uuid.UUID, ], + roleBench: typing.Union[MetaOapg.properties.roleBench, str, ], + roleProject: typing.Union[MetaOapg.properties.roleProject, str, ], + timeModified: typing.Union[MetaOapg.properties.timeModified, str, datetime, ], + tenantName: typing.Union[MetaOapg.properties.tenantName, None, str, schemas.Unset] = schemas.unset, + user: typing.Union['User', schemas.Unset] = schemas.unset, + emailAddress: typing.Union[MetaOapg.properties.emailAddress, None, str, schemas.Unset] = schemas.unset, + workgroup: typing.Union['Workgroup', schemas.Unset] = schemas.unset, + invitationAccepted: typing.Union[MetaOapg.properties.invitationAccepted, None, bool, schemas.Unset] = schemas.unset, + invitationRejected: typing.Union[MetaOapg.properties.invitationRejected, None, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectPermissionV4': + return super().__new__( + cls, + *args, + uploadAllowed=uploadAllowed, + membershipType=membershipType, + roleFlow=roleFlow, + roleBase=roleBase, + tenantId=tenantId, + downloadAllowed=downloadAllowed, + timeCreated=timeCreated, + id=id, + ownerId=ownerId, + roleBench=roleBench, + roleProject=roleProject, + timeModified=timeModified, + tenantName=tenantName, + user=user, + emailAddress=emailAddress, + workgroup=workgroup, + invitationAccepted=invitationAccepted, + invitationRejected=invitationRejected, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.user import User +from icasdk.model.workgroup import Workgroup diff --git a/icasdk/model/project_permission_v4.pyi b/icasdk/model/project_permission_v4.pyi new file mode 100644 index 0000000..725f255 --- /dev/null +++ b/icasdk/model/project_permission_v4.pyi @@ -0,0 +1,377 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class ProjectPermissionV4( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "uploadAllowed", + "membershipType", + "roleFlow", + "roleBase", + "tenantId", + "downloadAllowed", + "timeCreated", + "id", + "ownerId", + "roleBench", + "roleProject", + "timeModified", + } + + class properties: + id = schemas.UUIDSchema + timeCreated = schemas.DateTimeSchema + timeModified = schemas.DateTimeSchema + ownerId = schemas.UUIDSchema + tenantId = schemas.UUIDSchema + roleProject = schemas.StrSchema + roleFlow = schemas.StrSchema + roleBase = schemas.StrSchema + roleBench = schemas.StrSchema + + + class membershipType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER(cls): + return cls("USER") + + @schemas.classproperty + def EMAIL(cls): + return cls("EMAIL") + + @schemas.classproperty + def WORKGROUP(cls): + return cls("WORKGROUP") + uploadAllowed = schemas.BoolSchema + downloadAllowed = schemas.BoolSchema + + + class tenantName( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tenantName': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + @staticmethod + def user() -> typing.Type['User']: + return User + + + class emailAddress( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'emailAddress': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + @staticmethod + def workgroup() -> typing.Type['Workgroup']: + return Workgroup + + + class invitationAccepted( + schemas.BoolBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneBoolMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'invitationAccepted': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + + + class invitationRejected( + schemas.BoolBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneBoolMixin + ): + + + def __new__( + cls, + *args: typing.Union[None, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'invitationRejected': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) + __annotations__ = { + "id": id, + "timeCreated": timeCreated, + "timeModified": timeModified, + "ownerId": ownerId, + "tenantId": tenantId, + "roleProject": roleProject, + "roleFlow": roleFlow, + "roleBase": roleBase, + "roleBench": roleBench, + "membershipType": membershipType, + "uploadAllowed": uploadAllowed, + "downloadAllowed": downloadAllowed, + "tenantName": tenantName, + "user": user, + "emailAddress": emailAddress, + "workgroup": workgroup, + "invitationAccepted": invitationAccepted, + "invitationRejected": invitationRejected, + } + + uploadAllowed: MetaOapg.properties.uploadAllowed + membershipType: MetaOapg.properties.membershipType + roleFlow: MetaOapg.properties.roleFlow + roleBase: MetaOapg.properties.roleBase + tenantId: MetaOapg.properties.tenantId + downloadAllowed: MetaOapg.properties.downloadAllowed + timeCreated: MetaOapg.properties.timeCreated + id: MetaOapg.properties.id + ownerId: MetaOapg.properties.ownerId + roleBench: MetaOapg.properties.roleBench + roleProject: MetaOapg.properties.roleProject + timeModified: MetaOapg.properties.timeModified + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timeCreated"]) -> MetaOapg.properties.timeCreated: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timeModified"]) -> MetaOapg.properties.timeModified: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ownerId"]) -> MetaOapg.properties.ownerId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tenantId"]) -> MetaOapg.properties.tenantId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleProject"]) -> MetaOapg.properties.roleProject: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleFlow"]) -> MetaOapg.properties.roleFlow: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleBase"]) -> MetaOapg.properties.roleBase: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["roleBench"]) -> MetaOapg.properties.roleBench: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["membershipType"]) -> MetaOapg.properties.membershipType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["uploadAllowed"]) -> MetaOapg.properties.uploadAllowed: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["downloadAllowed"]) -> MetaOapg.properties.downloadAllowed: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tenantName"]) -> MetaOapg.properties.tenantName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user"]) -> 'User': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["emailAddress"]) -> MetaOapg.properties.emailAddress: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workgroup"]) -> 'Workgroup': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["invitationAccepted"]) -> MetaOapg.properties.invitationAccepted: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["invitationRejected"]) -> MetaOapg.properties.invitationRejected: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "timeCreated", "timeModified", "ownerId", "tenantId", "roleProject", "roleFlow", "roleBase", "roleBench", "membershipType", "uploadAllowed", "downloadAllowed", "tenantName", "user", "emailAddress", "workgroup", "invitationAccepted", "invitationRejected", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timeCreated"]) -> MetaOapg.properties.timeCreated: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timeModified"]) -> MetaOapg.properties.timeModified: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ownerId"]) -> MetaOapg.properties.ownerId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tenantId"]) -> MetaOapg.properties.tenantId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleProject"]) -> MetaOapg.properties.roleProject: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleFlow"]) -> MetaOapg.properties.roleFlow: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleBase"]) -> MetaOapg.properties.roleBase: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["roleBench"]) -> MetaOapg.properties.roleBench: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["membershipType"]) -> MetaOapg.properties.membershipType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["uploadAllowed"]) -> MetaOapg.properties.uploadAllowed: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["downloadAllowed"]) -> MetaOapg.properties.downloadAllowed: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tenantName"]) -> typing.Union[MetaOapg.properties.tenantName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union['User', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["emailAddress"]) -> typing.Union[MetaOapg.properties.emailAddress, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workgroup"]) -> typing.Union['Workgroup', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["invitationAccepted"]) -> typing.Union[MetaOapg.properties.invitationAccepted, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["invitationRejected"]) -> typing.Union[MetaOapg.properties.invitationRejected, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "timeCreated", "timeModified", "ownerId", "tenantId", "roleProject", "roleFlow", "roleBase", "roleBench", "membershipType", "uploadAllowed", "downloadAllowed", "tenantName", "user", "emailAddress", "workgroup", "invitationAccepted", "invitationRejected", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + uploadAllowed: typing.Union[MetaOapg.properties.uploadAllowed, bool, ], + membershipType: typing.Union[MetaOapg.properties.membershipType, str, ], + roleFlow: typing.Union[MetaOapg.properties.roleFlow, str, ], + roleBase: typing.Union[MetaOapg.properties.roleBase, str, ], + tenantId: typing.Union[MetaOapg.properties.tenantId, str, uuid.UUID, ], + downloadAllowed: typing.Union[MetaOapg.properties.downloadAllowed, bool, ], + timeCreated: typing.Union[MetaOapg.properties.timeCreated, str, datetime, ], + id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], + ownerId: typing.Union[MetaOapg.properties.ownerId, str, uuid.UUID, ], + roleBench: typing.Union[MetaOapg.properties.roleBench, str, ], + roleProject: typing.Union[MetaOapg.properties.roleProject, str, ], + timeModified: typing.Union[MetaOapg.properties.timeModified, str, datetime, ], + tenantName: typing.Union[MetaOapg.properties.tenantName, None, str, schemas.Unset] = schemas.unset, + user: typing.Union['User', schemas.Unset] = schemas.unset, + emailAddress: typing.Union[MetaOapg.properties.emailAddress, None, str, schemas.Unset] = schemas.unset, + workgroup: typing.Union['Workgroup', schemas.Unset] = schemas.unset, + invitationAccepted: typing.Union[MetaOapg.properties.invitationAccepted, None, bool, schemas.Unset] = schemas.unset, + invitationRejected: typing.Union[MetaOapg.properties.invitationRejected, None, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProjectPermissionV4': + return super().__new__( + cls, + *args, + uploadAllowed=uploadAllowed, + membershipType=membershipType, + roleFlow=roleFlow, + roleBase=roleBase, + tenantId=tenantId, + downloadAllowed=downloadAllowed, + timeCreated=timeCreated, + id=id, + ownerId=ownerId, + roleBench=roleBench, + roleProject=roleProject, + timeModified=timeModified, + tenantName=tenantName, + user=user, + emailAddress=emailAddress, + workgroup=workgroup, + invitationAccepted=invitationAccepted, + invitationRejected=invitationRejected, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.user import User +from icasdk.model.workgroup import Workgroup diff --git a/icasdk/model/sample_creation_batch.py b/icasdk/model/sample_creation_batch.py index aa5d163..088f0ed 100644 --- a/icasdk/model/sample_creation_batch.py +++ b/icasdk/model/sample_creation_batch.py @@ -44,9 +44,35 @@ class properties: @staticmethod def job() -> typing.Type['Job']: return Job + + + class sequencingRunId( + schemas.UUIDBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'uuid' + + + def __new__( + cls, + *args: typing.Union[None, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sequencingRunId': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) __annotations__ = { "id": id, "job": job, + "sequencingRunId": sequencingRunId, } id: MetaOapg.properties.id @@ -57,10 +83,13 @@ def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.propert @typing.overload def __getitem__(self, name: typing_extensions.Literal["job"]) -> 'Job': ... + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sequencingRunId"]) -> MetaOapg.properties.sequencingRunId: ... + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "job", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "job", "sequencingRunId", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -71,10 +100,13 @@ def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.prope @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["job"]) -> typing.Union['Job', schemas.Unset]: ... + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sequencingRunId"]) -> typing.Union[MetaOapg.properties.sequencingRunId, schemas.Unset]: ... + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "job", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "job", "sequencingRunId", ], str]): return super().get_item_oapg(name) @@ -83,6 +115,7 @@ def __new__( *args: typing.Union[dict, frozendict.frozendict, ], id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], job: typing.Union['Job', schemas.Unset] = schemas.unset, + sequencingRunId: typing.Union[MetaOapg.properties.sequencingRunId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'SampleCreationBatch': @@ -91,6 +124,7 @@ def __new__( *args, id=id, job=job, + sequencingRunId=sequencingRunId, _configuration=_configuration, **kwargs, ) diff --git a/icasdk/model/sample_creation_batch.pyi b/icasdk/model/sample_creation_batch.pyi index aa5d163..088f0ed 100644 --- a/icasdk/model/sample_creation_batch.pyi +++ b/icasdk/model/sample_creation_batch.pyi @@ -44,9 +44,35 @@ class SampleCreationBatch( @staticmethod def job() -> typing.Type['Job']: return Job + + + class sequencingRunId( + schemas.UUIDBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'uuid' + + + def __new__( + cls, + *args: typing.Union[None, str, uuid.UUID, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sequencingRunId': + return super().__new__( + cls, + *args, + _configuration=_configuration, + ) __annotations__ = { "id": id, "job": job, + "sequencingRunId": sequencingRunId, } id: MetaOapg.properties.id @@ -57,10 +83,13 @@ class SampleCreationBatch( @typing.overload def __getitem__(self, name: typing_extensions.Literal["job"]) -> 'Job': ... + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sequencingRunId"]) -> MetaOapg.properties.sequencingRunId: ... + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "job", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "job", "sequencingRunId", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -71,10 +100,13 @@ class SampleCreationBatch( @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["job"]) -> typing.Union['Job', schemas.Unset]: ... + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sequencingRunId"]) -> typing.Union[MetaOapg.properties.sequencingRunId, schemas.Unset]: ... + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "job", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "job", "sequencingRunId", ], str]): return super().get_item_oapg(name) @@ -83,6 +115,7 @@ class SampleCreationBatch( *args: typing.Union[dict, frozendict.frozendict, ], id: typing.Union[MetaOapg.properties.id, str, uuid.UUID, ], job: typing.Union['Job', schemas.Unset] = schemas.unset, + sequencingRunId: typing.Union[MetaOapg.properties.sequencingRunId, None, str, uuid.UUID, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'SampleCreationBatch': @@ -91,6 +124,7 @@ class SampleCreationBatch( *args, id=id, job=job, + sequencingRunId=sequencingRunId, _configuration=_configuration, **kwargs, ) diff --git a/icasdk/model/settings.py b/icasdk/model/settings.py new file mode 100644 index 0000000..152cf80 --- /dev/null +++ b/icasdk/model/settings.py @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class Settings( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + This object contains a "oneOf" construct. Depending on which type, you will receive a StringSettings-, IntegerSettings or OptionsSettings object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + return [ + StringSettings, + IntegerSettings, + OptionSettings, + ] + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Settings': + return super().__new__( + cls, + *args, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.integer_settings import IntegerSettings +from icasdk.model.option_settings import OptionSettings +from icasdk.model.string_settings import StringSettings diff --git a/icasdk/model/settings.pyi b/icasdk/model/settings.pyi new file mode 100644 index 0000000..152cf80 --- /dev/null +++ b/icasdk/model/settings.pyi @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class Settings( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + This object contains a "oneOf" construct. Depending on which type, you will receive a StringSettings-, IntegerSettings or OptionsSettings object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + return [ + StringSettings, + IntegerSettings, + OptionSettings, + ] + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Settings': + return super().__new__( + cls, + *args, + _configuration=_configuration, + **kwargs, + ) + +from icasdk.model.integer_settings import IntegerSettings +from icasdk.model.option_settings import OptionSettings +from icasdk.model.string_settings import StringSettings diff --git a/icasdk/model/string_settings.py b/icasdk/model/string_settings.py new file mode 100644 index 0000000..61335fc --- /dev/null +++ b/icasdk/model/string_settings.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class StringSettings( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class defaultValues( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'defaultValues': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "defaultValues": defaultValues, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultValues"]) -> MetaOapg.properties.defaultValues: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["defaultValues", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultValues"]) -> typing.Union[MetaOapg.properties.defaultValues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["defaultValues", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + defaultValues: typing.Union[MetaOapg.properties.defaultValues, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'StringSettings': + return super().__new__( + cls, + *args, + defaultValues=defaultValues, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/string_settings.pyi b/icasdk/model/string_settings.pyi new file mode 100644 index 0000000..61335fc --- /dev/null +++ b/icasdk/model/string_settings.pyi @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class StringSettings( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class defaultValues( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'defaultValues': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "defaultValues": defaultValues, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultValues"]) -> MetaOapg.properties.defaultValues: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["defaultValues", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultValues"]) -> typing.Union[MetaOapg.properties.defaultValues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["defaultValues", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + defaultValues: typing.Union[MetaOapg.properties.defaultValues, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'StringSettings': + return super().__new__( + cls, + *args, + defaultValues=defaultValues, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/system_info.py b/icasdk/model/system_info.py new file mode 100644 index 0000000..3ea4428 --- /dev/null +++ b/icasdk/model/system_info.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class SystemInfo( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "name", + "version", + } + + class properties: + name = schemas.StrSchema + version = schemas.StrSchema + __annotations__ = { + "name": name, + "version": version, + } + + name: MetaOapg.properties.name + version: MetaOapg.properties.version + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["version"]) -> MetaOapg.properties.version: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["name", "version", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["version"]) -> MetaOapg.properties.version: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["name", "version", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + version: typing.Union[MetaOapg.properties.version, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SystemInfo': + return super().__new__( + cls, + *args, + name=name, + version=version, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/system_info.pyi b/icasdk/model/system_info.pyi new file mode 100644 index 0000000..3ea4428 --- /dev/null +++ b/icasdk/model/system_info.pyi @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class SystemInfo( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "name", + "version", + } + + class properties: + name = schemas.StrSchema + version = schemas.StrSchema + __annotations__ = { + "name": name, + "version": version, + } + + name: MetaOapg.properties.name + version: MetaOapg.properties.version + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["version"]) -> MetaOapg.properties.version: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["name", "version", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["version"]) -> MetaOapg.properties.version: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["name", "version", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + version: typing.Union[MetaOapg.properties.version, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SystemInfo': + return super().__new__( + cls, + *args, + name=name, + version=version, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/tag_update.py b/icasdk/model/tag_update.py new file mode 100644 index 0000000..2530129 --- /dev/null +++ b/icasdk/model/tag_update.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class TagUpdate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class addTags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'addTags': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class removeTags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'removeTags': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "addTags": addTags, + "removeTags": removeTags, + } + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["addTags"]) -> MetaOapg.properties.addTags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["removeTags"]) -> MetaOapg.properties.removeTags: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["addTags", "removeTags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["addTags"]) -> typing.Union[MetaOapg.properties.addTags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["removeTags"]) -> typing.Union[MetaOapg.properties.removeTags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["addTags", "removeTags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, None, ], + addTags: typing.Union[MetaOapg.properties.addTags, list, tuple, schemas.Unset] = schemas.unset, + removeTags: typing.Union[MetaOapg.properties.removeTags, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TagUpdate': + return super().__new__( + cls, + *args, + addTags=addTags, + removeTags=removeTags, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/tag_update.pyi b/icasdk/model/tag_update.pyi new file mode 100644 index 0000000..2530129 --- /dev/null +++ b/icasdk/model/tag_update.pyi @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class TagUpdate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class addTags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'addTags': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class removeTags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'removeTags': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "addTags": addTags, + "removeTags": removeTags, + } + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["addTags"]) -> MetaOapg.properties.addTags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["removeTags"]) -> MetaOapg.properties.removeTags: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["addTags", "removeTags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["addTags"]) -> typing.Union[MetaOapg.properties.addTags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["removeTags"]) -> typing.Union[MetaOapg.properties.removeTags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["addTags", "removeTags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, None, ], + addTags: typing.Union[MetaOapg.properties.addTags, list, tuple, schemas.Unset] = schemas.unset, + removeTags: typing.Union[MetaOapg.properties.removeTags, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TagUpdate': + return super().__new__( + cls, + *args, + addTags=addTags, + removeTags=removeTags, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/terms_of_use_acceptance.py b/icasdk/model/terms_of_use_acceptance.py new file mode 100644 index 0000000..ffefec5 --- /dev/null +++ b/icasdk/model/terms_of_use_acceptance.py @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class TermsOfUseAcceptance( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "accepted", + "firstAcceptanceDate", + "versionTermsOfUseFirstAccept", + } + + class properties: + accepted = schemas.BoolSchema + firstAcceptanceDate = schemas.DateTimeSchema + versionTermsOfUseFirstAccept = schemas.StrSchema + lastAcceptanceDate = schemas.DateTimeSchema + versionTermsOfUseLastAccept = schemas.StrSchema + __annotations__ = { + "accepted": accepted, + "firstAcceptanceDate": firstAcceptanceDate, + "versionTermsOfUseFirstAccept": versionTermsOfUseFirstAccept, + "lastAcceptanceDate": lastAcceptanceDate, + "versionTermsOfUseLastAccept": versionTermsOfUseLastAccept, + } + + accepted: MetaOapg.properties.accepted + firstAcceptanceDate: MetaOapg.properties.firstAcceptanceDate + versionTermsOfUseFirstAccept: MetaOapg.properties.versionTermsOfUseFirstAccept + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["accepted"]) -> MetaOapg.properties.accepted: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstAcceptanceDate"]) -> MetaOapg.properties.firstAcceptanceDate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["versionTermsOfUseFirstAccept"]) -> MetaOapg.properties.versionTermsOfUseFirstAccept: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["lastAcceptanceDate"]) -> MetaOapg.properties.lastAcceptanceDate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["versionTermsOfUseLastAccept"]) -> MetaOapg.properties.versionTermsOfUseLastAccept: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["accepted", "firstAcceptanceDate", "versionTermsOfUseFirstAccept", "lastAcceptanceDate", "versionTermsOfUseLastAccept", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["accepted"]) -> MetaOapg.properties.accepted: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstAcceptanceDate"]) -> MetaOapg.properties.firstAcceptanceDate: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["versionTermsOfUseFirstAccept"]) -> MetaOapg.properties.versionTermsOfUseFirstAccept: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["lastAcceptanceDate"]) -> typing.Union[MetaOapg.properties.lastAcceptanceDate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["versionTermsOfUseLastAccept"]) -> typing.Union[MetaOapg.properties.versionTermsOfUseLastAccept, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["accepted", "firstAcceptanceDate", "versionTermsOfUseFirstAccept", "lastAcceptanceDate", "versionTermsOfUseLastAccept", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + accepted: typing.Union[MetaOapg.properties.accepted, bool, ], + firstAcceptanceDate: typing.Union[MetaOapg.properties.firstAcceptanceDate, str, datetime, ], + versionTermsOfUseFirstAccept: typing.Union[MetaOapg.properties.versionTermsOfUseFirstAccept, str, ], + lastAcceptanceDate: typing.Union[MetaOapg.properties.lastAcceptanceDate, str, datetime, schemas.Unset] = schemas.unset, + versionTermsOfUseLastAccept: typing.Union[MetaOapg.properties.versionTermsOfUseLastAccept, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TermsOfUseAcceptance': + return super().__new__( + cls, + *args, + accepted=accepted, + firstAcceptanceDate=firstAcceptanceDate, + versionTermsOfUseFirstAccept=versionTermsOfUseFirstAccept, + lastAcceptanceDate=lastAcceptanceDate, + versionTermsOfUseLastAccept=versionTermsOfUseLastAccept, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/model/terms_of_use_acceptance.pyi b/icasdk/model/terms_of_use_acceptance.pyi new file mode 100644 index 0000000..ffefec5 --- /dev/null +++ b/icasdk/model/terms_of_use_acceptance.pyi @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + + +class TermsOfUseAcceptance( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "accepted", + "firstAcceptanceDate", + "versionTermsOfUseFirstAccept", + } + + class properties: + accepted = schemas.BoolSchema + firstAcceptanceDate = schemas.DateTimeSchema + versionTermsOfUseFirstAccept = schemas.StrSchema + lastAcceptanceDate = schemas.DateTimeSchema + versionTermsOfUseLastAccept = schemas.StrSchema + __annotations__ = { + "accepted": accepted, + "firstAcceptanceDate": firstAcceptanceDate, + "versionTermsOfUseFirstAccept": versionTermsOfUseFirstAccept, + "lastAcceptanceDate": lastAcceptanceDate, + "versionTermsOfUseLastAccept": versionTermsOfUseLastAccept, + } + + accepted: MetaOapg.properties.accepted + firstAcceptanceDate: MetaOapg.properties.firstAcceptanceDate + versionTermsOfUseFirstAccept: MetaOapg.properties.versionTermsOfUseFirstAccept + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["accepted"]) -> MetaOapg.properties.accepted: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstAcceptanceDate"]) -> MetaOapg.properties.firstAcceptanceDate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["versionTermsOfUseFirstAccept"]) -> MetaOapg.properties.versionTermsOfUseFirstAccept: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["lastAcceptanceDate"]) -> MetaOapg.properties.lastAcceptanceDate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["versionTermsOfUseLastAccept"]) -> MetaOapg.properties.versionTermsOfUseLastAccept: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["accepted", "firstAcceptanceDate", "versionTermsOfUseFirstAccept", "lastAcceptanceDate", "versionTermsOfUseLastAccept", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["accepted"]) -> MetaOapg.properties.accepted: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstAcceptanceDate"]) -> MetaOapg.properties.firstAcceptanceDate: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["versionTermsOfUseFirstAccept"]) -> MetaOapg.properties.versionTermsOfUseFirstAccept: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["lastAcceptanceDate"]) -> typing.Union[MetaOapg.properties.lastAcceptanceDate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["versionTermsOfUseLastAccept"]) -> typing.Union[MetaOapg.properties.versionTermsOfUseLastAccept, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["accepted", "firstAcceptanceDate", "versionTermsOfUseFirstAccept", "lastAcceptanceDate", "versionTermsOfUseLastAccept", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *args: typing.Union[dict, frozendict.frozendict, ], + accepted: typing.Union[MetaOapg.properties.accepted, bool, ], + firstAcceptanceDate: typing.Union[MetaOapg.properties.firstAcceptanceDate, str, datetime, ], + versionTermsOfUseFirstAccept: typing.Union[MetaOapg.properties.versionTermsOfUseFirstAccept, str, ], + lastAcceptanceDate: typing.Union[MetaOapg.properties.lastAcceptanceDate, str, datetime, schemas.Unset] = schemas.unset, + versionTermsOfUseLastAccept: typing.Union[MetaOapg.properties.versionTermsOfUseLastAccept, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TermsOfUseAcceptance': + return super().__new__( + cls, + *args, + accepted=accepted, + firstAcceptanceDate=firstAcceptanceDate, + versionTermsOfUseFirstAccept=versionTermsOfUseFirstAccept, + lastAcceptanceDate=lastAcceptanceDate, + versionTermsOfUseLastAccept=versionTermsOfUseLastAccept, + _configuration=_configuration, + **kwargs, + ) diff --git a/icasdk/models/__init__.py b/icasdk/models/__init__.py index fd5416f..50cc9ad 100644 --- a/icasdk/models/__init__.py +++ b/icasdk/models/__init__.py @@ -80,7 +80,9 @@ from icasdk.model.create_project import CreateProject from icasdk.model.create_project_data_linking_batch import CreateProjectDataLinkingBatch from icasdk.model.create_project_data_linking_batch_item import CreateProjectDataLinkingBatchItem +from icasdk.model.create_project_data_update_batch import CreateProjectDataUpdateBatch from icasdk.model.create_project_permission import CreateProjectPermission +from icasdk.model.create_project_permission_v4 import CreateProjectPermissionV4 from icasdk.model.create_sample import CreateSample from icasdk.model.create_sample_creation_batch import CreateSampleCreationBatch from icasdk.model.create_sample_creation_batch_data_item import CreateSampleCreationBatchDataItem @@ -108,6 +110,7 @@ from icasdk.model.data_tag import DataTag from icasdk.model.data_transfer import DataTransfer from icasdk.model.data_transfer_paged_list import DataTransferPagedList +from icasdk.model.data_update_group import DataUpdateGroup from icasdk.model.data_url_with_path import DataUrlWithPath from icasdk.model.data_url_with_path_list import DataUrlWithPathList from icasdk.model.download import Download @@ -132,6 +135,7 @@ from icasdk.model.input_parameter import InputParameter from icasdk.model.input_parameter_list import InputParameterList from icasdk.model.input_part import InputPart +from icasdk.model.integer_settings import IntegerSettings from icasdk.model.job import Job from icasdk.model.job_paged_list import JobPagedList from icasdk.model.link import Link @@ -147,11 +151,15 @@ from icasdk.model.notification_channel_list import NotificationChannelList from icasdk.model.notification_subscription import NotificationSubscription from icasdk.model.notification_subscription_list import NotificationSubscriptionList +from icasdk.model.option_settings import OptionSettings from icasdk.model.optional_sample_tags import OptionalSampleTags from icasdk.model.pipeline import Pipeline from icasdk.model.pipeline_bundle import PipelineBundle from icasdk.model.pipeline_configuration_parameter import PipelineConfigurationParameter from icasdk.model.pipeline_configuration_parameter_list import PipelineConfigurationParameterList +from icasdk.model.pipeline_file import PipelineFile +from icasdk.model.pipeline_file_content_spec import PipelineFileContentSpec +from icasdk.model.pipeline_file_list import PipelineFileList from icasdk.model.pipeline_html_documentation import PipelineHtmlDocumentation from icasdk.model.pipeline_language_version import PipelineLanguageVersion from icasdk.model.pipeline_language_version_list import PipelineLanguageVersionList @@ -170,10 +178,17 @@ from icasdk.model.project_data_linking_batch_item_processing import ProjectDataLinkingBatchItemProcessing from icasdk.model.project_data_linking_batch_item_request import ProjectDataLinkingBatchItemRequest from icasdk.model.project_data_paged_list import ProjectDataPagedList +from icasdk.model.project_data_update_batch import ProjectDataUpdateBatch +from icasdk.model.project_data_update_batch_item import ProjectDataUpdateBatchItem +from icasdk.model.project_data_update_batch_item_paged_list import ProjectDataUpdateBatchItemPagedList +from icasdk.model.project_data_update_batch_item_processing import ProjectDataUpdateBatchItemProcessing +from icasdk.model.project_data_update_batch_item_request import ProjectDataUpdateBatchItemRequest from icasdk.model.project_list import ProjectList from icasdk.model.project_paged_list import ProjectPagedList from icasdk.model.project_permission import ProjectPermission from icasdk.model.project_permission_list import ProjectPermissionList +from icasdk.model.project_permission_list_v4 import ProjectPermissionListV4 +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.project_pipeline import ProjectPipeline from icasdk.model.project_pipeline_list import ProjectPipelineList from icasdk.model.project_sample import ProjectSample @@ -200,6 +215,7 @@ from icasdk.model.search_matching_activation_codes_for_cwl_analysis import SearchMatchingActivationCodesForCwlAnalysis from icasdk.model.search_matching_activation_codes_for_nextflow_analysis import SearchMatchingActivationCodesForNextflowAnalysis from icasdk.model.sequencing_run import SequencingRun +from icasdk.model.settings import Settings from icasdk.model.species import Species from icasdk.model.species_list import SpeciesList from icasdk.model.storage_bundle import StorageBundle @@ -210,8 +226,12 @@ from icasdk.model.storage_configuration_with_details_list import StorageConfigurationWithDetailsList from icasdk.model.storage_credential import StorageCredential from icasdk.model.storage_credential_list import StorageCredentialList +from icasdk.model.string_settings import StringSettings +from icasdk.model.system_info import SystemInfo +from icasdk.model.tag_update import TagUpdate from icasdk.model.temp_credentials import TempCredentials from icasdk.model.terms_of_use import TermsOfUse +from icasdk.model.terms_of_use_acceptance import TermsOfUseAcceptance from icasdk.model.token import Token from icasdk.model.type import Type from icasdk.model.type_list import TypeList diff --git a/icasdk/paths/__init__.py b/icasdk/paths/__init__.py index aebb4fc..5add474 100644 --- a/icasdk/paths/__init__.py +++ b/icasdk/paths/__init__.py @@ -9,8 +9,10 @@ class PathValues(str, enum.Enum): API_ANALYSIS_STORAGES = "/api/analysisStorages" API_BUNDLES = "/api/bundles" API_BUNDLES_BUNDLE_ID = "/api/bundles/{bundleId}" + API_BUNDLES_BUNDLE_ID_TERMS_OF_USEACCEPT = "/api/bundles/{bundleId}/termsOfUse:accept" API_BUNDLES_BUNDLE_IDRELEASE = "/api/bundles/{bundleId}:release" API_BUNDLES_BUNDLE_ID_TERMS_OF_USE = "/api/bundles/{bundleId}/termsOfUse" + API_BUNDLES_BUNDLE_ID_TERMS_OF_USE_USER_ACCEPTANCE_CURRENT_USER = "/api/bundles/{bundleId}/termsOfUse/userAcceptance/currentUser" API_BUNDLES_BUNDLE_ID_TERMS_OF_USENEW = "/api/bundles/{bundleId}/termsOfUse:new" API_BUNDLES_BUNDLE_IDDEPRECATE = "/api/bundles/{bundleId}:deprecate" API_BUNDLES_BUNDLE_ID_DATA = "/api/bundles/{bundleId}/data" @@ -57,6 +59,8 @@ class PathValues(str, enum.Enum): API_PIPELINES_PIPELINE_ID_CONFIGURATION_PARAMETERS = "/api/pipelines/{pipelineId}/configurationParameters" API_PIPELINES_PIPELINE_ID_REFERENCE_SETS = "/api/pipelines/{pipelineId}/referenceSets" API_PIPELINES_PIPELINE_ID_DOCUMENTATION_HTML = "/api/pipelines/{pipelineId}/documentation/HTML" + API_PIPELINES_PIPELINE_ID_FILES = "/api/pipelines/{pipelineId}/files" + API_PIPELINES_PIPELINE_ID_FILES_FILE_ID_CONTENT = "/api/pipelines/{pipelineId}/files/{fileId}/content" API_PIPELINE_LANGUAGES_NEXTFLOW_VERSIONS = "/api/pipelineLanguages/nextflow/versions" API_PROJECTS_PROJECT_ID_ANALYSES = "/api/projects/{projectId}/analyses" API_PROJECTS_PROJECT_ID_ANALYSES_ANALYSIS_ID = "/api/projects/{projectId}/analyses/{analysisId}" @@ -114,6 +118,10 @@ class PathValues(str, enum.Enum): API_PROJECTS_PROJECT_ID_DATA_TRANSFERS = "/api/projects/{projectId}/dataTransfers" API_PROJECTS_PROJECT_ID_DATA_TRANSFERS_DATA_TRANSFER_ID = "/api/projects/{projectId}/dataTransfers/{dataTransferId}" API_PROJECTS_PROJECT_ID_DATA_TRANSFERS_DATA_TRANSFER_IDABORT = "/api/projects/{projectId}/dataTransfers/{dataTransferId}:abort" + API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH = "/api/projects/{projectId}/dataUpdateBatch" + API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID = "/api/projects/{projectId}/dataUpdateBatch/{batchId}" + API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID_ITEMS = "/api/projects/{projectId}/dataUpdateBatch/{batchId}/items" + API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID_ITEMS_ITEM_ID = "/api/projects/{projectId}/dataUpdateBatch/{batchId}/items/{itemId}" API_PROJECTS_PROJECT_ID_NOTIFICATION_SUBSCRIPTIONS = "/api/projects/{projectId}/notificationSubscriptions" API_PROJECTS_PROJECT_ID_NOTIFICATION_SUBSCRIPTIONS_SUBSCRIPTION_ID = "/api/projects/{projectId}/notificationSubscriptions/{subscriptionId}" API_PROJECTS_PROJECT_ID_PERMISSIONS = "/api/projects/{projectId}/permissions" @@ -125,6 +133,9 @@ class PathValues(str, enum.Enum): API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_REFERENCE_SETS = "/api/projects/{projectId}/pipelines/{pipelineId}/referenceSets" API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_IDRELEASE = "/api/projects/{projectId}/pipelines/{pipelineId}:release" API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_DOCUMENTATION_HTML = "/api/projects/{projectId}/pipelines/{pipelineId}/documentation/HTML" + API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES = "/api/projects/{projectId}/pipelines/{pipelineId}/files" + API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES_FILE_ID_CONTENT = "/api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}/content" + API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES_FILE_ID = "/api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}" API_PROJECTS_PROJECT_ID_PIPELINESCREATE_NEXTFLOW_PIPELINE = "/api/projects/{projectId}/pipelines:createNextflowPipeline" API_PROJECTS_PROJECT_ID_PIPELINESCREATE_CWL_PIPELINE = "/api/projects/{projectId}/pipelines:createCwlPipeline" API_PROJECTS_PROJECT_ID_SAMPLES = "/api/projects/{projectId}/samples" @@ -133,6 +144,7 @@ class PathValues(str, enum.Enum): API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_IDCOMPLETE = "/api/projects/{projectId}/samples/{sampleId}:complete" API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_IDUNLINK = "/api/projects/{projectId}/samples/{sampleId}:unlink" API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_PROJECTS = "/api/projects/{projectId}/samples/{sampleId}/projects" + API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_ANALYSES = "/api/projects/{projectId}/samples/{sampleId}/analyses" API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_DATA = "/api/projects/{projectId}/samples/{sampleId}/data" API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_DATA_DATA_ID = "/api/projects/{projectId}/samples/{sampleId}/data/{dataId}" API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_DATA_DATA_IDUNLINK = "/api/projects/{projectId}/samples/{sampleId}/data/{dataId}:unlink" @@ -153,6 +165,7 @@ class PathValues(str, enum.Enum): API_REGIONS = "/api/regions" API_REGIONS_REGION_ID = "/api/regions/{regionId}" API_SAMPLES = "/api/samples" + API_SEQUENCING_RUNS_SEQUENCING_RUN_ID = "/api/sequencingRuns/{sequencingRunId}" API_STORAGE_BUNDLES = "/api/storageBundles" API_STORAGE_CONFIGURATIONS = "/api/storageConfigurations" API_STORAGE_CONFIGURATIONS_STORAGE_CONFIGURATION_ID = "/api/storageConfigurations/{storageConfigurationId}" @@ -162,6 +175,7 @@ class PathValues(str, enum.Enum): API_STORAGE_CREDENTIALS_STORAGE_CREDENTIAL_ID = "/api/storageCredentials/{storageCredentialId}" API_STORAGE_CREDENTIALS_STORAGE_CREDENTIAL_IDSHARE = "/api/storageCredentials/{storageCredentialId}:share" API_STORAGE_CREDENTIALS_STORAGE_CREDENTIAL_IDUPDATE_SECRETS = "/api/storageCredentials/{storageCredentialId}:updateSecrets" + API_SYSTEM_INFO = "/api/system/info" API_TOKENS = "/api/tokens" API_TOKENSREFRESH = "/api/tokens:refresh" API_USERS = "/api/users" diff --git a/icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/__init__.py b/icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/__init__.py new file mode 100644 index 0000000..a29ebd5 --- /dev/null +++ b/icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_bundles_bundle_id_terms_of_use_user_acceptance_current_user import Api + +from icasdk.paths import PathValues + +path = PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USE_USER_ACCEPTANCE_CURRENT_USER \ No newline at end of file diff --git a/icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/get.py b/icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/get.py new file mode 100644 index 0000000..eb43c8e --- /dev/null +++ b/icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/get.py @@ -0,0 +1,326 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.terms_of_use_acceptance import TermsOfUseAcceptance + +from . import path + +# Path params +BundleIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'bundleId': typing.Union[BundleIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_bundle_id = api_client.PathParameter( + name="bundleId", + style=api_client.ParameterStyle.SIMPLE, + schema=BundleIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = TermsOfUseAcceptance + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_terms_of_use_acceptance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_terms_of_use_acceptance_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_terms_of_use_acceptance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_terms_of_use_acceptance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve the acceptance record for a bundle for the current user. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_bundle_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetTermsOfUseAcceptance(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_terms_of_use_acceptance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_terms_of_use_acceptance( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_terms_of_use_acceptance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_terms_of_use_acceptance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_terms_of_use_acceptance_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_terms_of_use_acceptance_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/get.pyi b/icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/get.pyi new file mode 100644 index 0000000..c363f3f --- /dev/null +++ b/icasdk/paths/api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/get.pyi @@ -0,0 +1,316 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.terms_of_use_acceptance import TermsOfUseAcceptance + +# Path params +BundleIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'bundleId': typing.Union[BundleIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_bundle_id = api_client.PathParameter( + name="bundleId", + style=api_client.ParameterStyle.SIMPLE, + schema=BundleIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = TermsOfUseAcceptance + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_terms_of_use_acceptance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_terms_of_use_acceptance_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_terms_of_use_acceptance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_terms_of_use_acceptance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve the acceptance record for a bundle for the current user. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_bundle_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetTermsOfUseAcceptance(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_terms_of_use_acceptance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_terms_of_use_acceptance( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_terms_of_use_acceptance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_terms_of_use_acceptance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_terms_of_use_acceptance_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_terms_of_use_acceptance_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/__init__.py b/icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/__init__.py new file mode 100644 index 0000000..266eb0a --- /dev/null +++ b/icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_bundles_bundle_id_terms_of_useaccept import Api + +from icasdk.paths import PathValues + +path = PathValues.API_BUNDLES_BUNDLE_ID_TERMS_OF_USEACCEPT \ No newline at end of file diff --git a/icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/post.py b/icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/post.py new file mode 100644 index 0000000..8c673e2 --- /dev/null +++ b/icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/post.py @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem + +from . import path + +# Path params +BundleIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'bundleId': typing.Union[BundleIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_bundle_id = api_client.PathParameter( + name="bundleId", + style=api_client.ParameterStyle.SIMPLE, + schema=BundleIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType(), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '204': _response_for_204, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _accept_terms_of_use_bundle_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _accept_terms_of_use_bundle_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _accept_terms_of_use_bundle_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _accept_terms_of_use_bundle_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + accept terms of use for a bundle + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_bundle_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class AcceptTermsOfUseBundle(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def accept_terms_of_use_bundle( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def accept_terms_of_use_bundle( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def accept_terms_of_use_bundle( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def accept_terms_of_use_bundle( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._accept_terms_of_use_bundle_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._accept_terms_of_use_bundle_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/post.pyi b/icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/post.pyi new file mode 100644 index 0000000..ff45d1b --- /dev/null +++ b/icasdk/paths/api_bundles_bundle_id_terms_of_useaccept/post.pyi @@ -0,0 +1,313 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem + +# Path params +BundleIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'bundleId': typing.Union[BundleIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_bundle_id = api_client.PathParameter( + name="bundleId", + style=api_client.ParameterStyle.SIMPLE, + schema=BundleIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType(), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _accept_terms_of_use_bundle_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _accept_terms_of_use_bundle_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _accept_terms_of_use_bundle_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _accept_terms_of_use_bundle_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + accept terms of use for a bundle + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_bundle_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class AcceptTermsOfUseBundle(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def accept_terms_of_use_bundle( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def accept_terms_of_use_bundle( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def accept_terms_of_use_bundle( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def accept_terms_of_use_bundle( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._accept_terms_of_use_bundle_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._accept_terms_of_use_bundle_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_pipelines_pipeline_id_files/__init__.py b/icasdk/paths/api_pipelines_pipeline_id_files/__init__.py new file mode 100644 index 0000000..18f0a34 --- /dev/null +++ b/icasdk/paths/api_pipelines_pipeline_id_files/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_pipelines_pipeline_id_files import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PIPELINES_PIPELINE_ID_FILES \ No newline at end of file diff --git a/icasdk/paths/api_pipelines_pipeline_id_files/get.py b/icasdk/paths/api_pipelines_pipeline_id_files/get.py new file mode 100644 index 0000000..97eb250 --- /dev/null +++ b/icasdk/paths/api_pipelines_pipeline_id_files/get.py @@ -0,0 +1,326 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_list import PipelineFileList + +from . import path + +# Path params +PipelineIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = PipelineFileList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_pipeline_files_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_pipeline_files_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_pipeline_files_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_pipeline_files_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve files for a pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_pipeline_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetPipelineFiles(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_pipeline_files( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_pipeline_files( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_pipeline_files( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_pipeline_files( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_pipeline_files_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_pipeline_files_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_pipelines_pipeline_id_files/get.pyi b/icasdk/paths/api_pipelines_pipeline_id_files/get.pyi new file mode 100644 index 0000000..0a8adac --- /dev/null +++ b/icasdk/paths/api_pipelines_pipeline_id_files/get.pyi @@ -0,0 +1,316 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_list import PipelineFileList + +# Path params +PipelineIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = PipelineFileList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_pipeline_files_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_pipeline_files_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_pipeline_files_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_pipeline_files_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve files for a pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_pipeline_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetPipelineFiles(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_pipeline_files( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_pipeline_files( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_pipeline_files( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_pipeline_files( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_pipeline_files_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_pipeline_files_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/__init__.py b/icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/__init__.py new file mode 100644 index 0000000..4895d44 --- /dev/null +++ b/icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_pipelines_pipeline_id_files_file_id_content import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PIPELINES_PIPELINE_ID_FILES_FILE_ID_CONTENT \ No newline at end of file diff --git a/icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/get.py b/icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/get.py new file mode 100644 index 0000000..80eec4a --- /dev/null +++ b/icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/get.py @@ -0,0 +1,349 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem + +from . import path + +# Path params +PipelineIdSchema = schemas.StrSchema +FileIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + 'fileId': typing.Union[FileIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +request_path_file_id = api_client.PathParameter( + name="fileId", + style=api_client.ParameterStyle.SIMPLE, + schema=FileIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +ContentDispositionSchema = schemas.StrSchema +content_disposition_parameter = api_client.HeaderParameter( + name="Content-Disposition", + style=api_client.ParameterStyle.SIMPLE, + schema=ContentDispositionSchema, +) +SchemaFor200ResponseBodyApplicationOctetStream = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationOctetStream, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/octet-stream': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationOctetStream), + }, + headers=[ + content_disposition_parameter, + ] +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/octet-stream', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _download_pipeline_file_content_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _download_pipeline_file_content_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _download_pipeline_file_content_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _download_pipeline_file_content_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Download the contents of a pipeline file. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_pipeline_id, + request_path_file_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class DownloadPipelineFileContent(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def download_pipeline_file_content( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def download_pipeline_file_content( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def download_pipeline_file_content( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def download_pipeline_file_content( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._download_pipeline_file_content_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._download_pipeline_file_content_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/get.pyi b/icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/get.pyi new file mode 100644 index 0000000..9a09c8d --- /dev/null +++ b/icasdk/paths/api_pipelines_pipeline_id_files_file_id_content/get.pyi @@ -0,0 +1,334 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem + +# Path params +PipelineIdSchema = schemas.StrSchema +FileIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + 'fileId': typing.Union[FileIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +request_path_file_id = api_client.PathParameter( + name="fileId", + style=api_client.ParameterStyle.SIMPLE, + schema=FileIdSchema, + required=True, +) +ContentDispositionSchema = schemas.StrSchema +SchemaFor200ResponseBodyApplicationOctetStream = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationOctetStream, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/octet-stream': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationOctetStream), + }, + headers=[ + content_disposition_parameter, + ] +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/octet-stream', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _download_pipeline_file_content_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _download_pipeline_file_content_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _download_pipeline_file_content_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _download_pipeline_file_content_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Download the contents of a pipeline file. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_pipeline_id, + request_path_file_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class DownloadPipelineFileContent(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def download_pipeline_file_content( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def download_pipeline_file_content( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def download_pipeline_file_content( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def download_pipeline_file_content( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._download_pipeline_file_content_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._download_pipeline_file_content_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_data_data_idcreate_temporary_credentials/post.py b/icasdk/paths/api_projects_project_id_data_data_idcreate_temporary_credentials/post.py index 479f941..74f59d2 100644 --- a/icasdk/paths/api_projects_project_id_data_data_idcreate_temporary_credentials/post.py +++ b/icasdk/paths/api_projects_project_id_data_data_idcreate_temporary_credentials/post.py @@ -77,7 +77,6 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): 'application/json': api_client.MediaType( schema=SchemaForRequestBodyApplicationJson), }, - required=True, ) _auth = [ 'JwtAuth', @@ -135,8 +134,8 @@ class BaseApi(api_client.Api): @typing.overload def _create_temporary_credentials_for_data_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -151,9 +150,9 @@ def _create_temporary_credentials_for_data_oapg( @typing.overload def _create_temporary_credentials_for_data_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -163,8 +162,8 @@ def _create_temporary_credentials_for_data_oapg( @typing.overload def _create_temporary_credentials_for_data_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -178,8 +177,8 @@ def _create_temporary_credentials_for_data_oapg( def _create_temporary_credentials_for_data_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -215,17 +214,15 @@ class instances for accept_content_type in accept_content_types: _headers.add('Accept', accept_content_type) - if body is schemas.unset: - raise exceptions.ApiValueError( - 'The required body parameter has an invalid value of: unset. Set a valid value instead') _fields = None _body = None - serialized_data = request_body_create_temporary_credentials.serialize(body, content_type) - _headers.add('Content-Type', content_type) - if 'fields' in serialized_data: - _fields = serialized_data['fields'] - elif 'body' in serialized_data: - _body = serialized_data['body'] + if body is not schemas.unset: + serialized_data = request_body_create_temporary_credentials.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] response = self.api_client.call_api( resource_path=used_path, method='post'.upper(), @@ -262,8 +259,8 @@ class CreateTemporaryCredentialsForData(BaseApi): @typing.overload def create_temporary_credentials_for_data( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -278,9 +275,9 @@ def create_temporary_credentials_for_data( @typing.overload def create_temporary_credentials_for_data( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -290,8 +287,8 @@ def create_temporary_credentials_for_data( @typing.overload def create_temporary_credentials_for_data( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -305,8 +302,8 @@ def create_temporary_credentials_for_data( def create_temporary_credentials_for_data( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -330,8 +327,8 @@ class ApiForpost(BaseApi): @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -346,9 +343,9 @@ def post( @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -358,8 +355,8 @@ def post( @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -373,8 +370,8 @@ def post( def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, diff --git a/icasdk/paths/api_projects_project_id_data_data_idcreate_temporary_credentials/post.pyi b/icasdk/paths/api_projects_project_id_data_data_idcreate_temporary_credentials/post.pyi index 775889b..c4f3824 100644 --- a/icasdk/paths/api_projects_project_id_data_data_idcreate_temporary_credentials/post.pyi +++ b/icasdk/paths/api_projects_project_id_data_data_idcreate_temporary_credentials/post.pyi @@ -75,7 +75,6 @@ request_body_create_temporary_credentials = api_client.RequestBody( 'application/json': api_client.MediaType( schema=SchemaForRequestBodyApplicationJson), }, - required=True, ) SchemaFor200ResponseBodyApplicationVndIlluminaV3json = TempCredentials @@ -125,8 +124,8 @@ class BaseApi(api_client.Api): @typing.overload def _create_temporary_credentials_for_data_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -141,9 +140,9 @@ class BaseApi(api_client.Api): @typing.overload def _create_temporary_credentials_for_data_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -153,8 +152,8 @@ class BaseApi(api_client.Api): @typing.overload def _create_temporary_credentials_for_data_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -168,8 +167,8 @@ class BaseApi(api_client.Api): def _create_temporary_credentials_for_data_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -205,17 +204,15 @@ class BaseApi(api_client.Api): for accept_content_type in accept_content_types: _headers.add('Accept', accept_content_type) - if body is schemas.unset: - raise exceptions.ApiValueError( - 'The required body parameter has an invalid value of: unset. Set a valid value instead') _fields = None _body = None - serialized_data = request_body_create_temporary_credentials.serialize(body, content_type) - _headers.add('Content-Type', content_type) - if 'fields' in serialized_data: - _fields = serialized_data['fields'] - elif 'body' in serialized_data: - _body = serialized_data['body'] + if body is not schemas.unset: + serialized_data = request_body_create_temporary_credentials.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] response = self.api_client.call_api( resource_path=used_path, method='post'.upper(), @@ -252,8 +249,8 @@ class CreateTemporaryCredentialsForData(BaseApi): @typing.overload def create_temporary_credentials_for_data( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -268,9 +265,9 @@ class CreateTemporaryCredentialsForData(BaseApi): @typing.overload def create_temporary_credentials_for_data( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -280,8 +277,8 @@ class CreateTemporaryCredentialsForData(BaseApi): @typing.overload def create_temporary_credentials_for_data( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -295,8 +292,8 @@ class CreateTemporaryCredentialsForData(BaseApi): def create_temporary_credentials_for_data( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -320,8 +317,8 @@ class ApiForpost(BaseApi): @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -336,9 +333,9 @@ class ApiForpost(BaseApi): @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -348,8 +345,8 @@ class ApiForpost(BaseApi): @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -363,8 +360,8 @@ class ApiForpost(BaseApi): def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json, SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, diff --git a/icasdk/paths/api_projects_project_id_data_update_batch/__init__.py b/icasdk/paths/api_projects_project_id_data_update_batch/__init__.py new file mode 100644 index 0000000..6f34e5c --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_projects_project_id_data_update_batch import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH \ No newline at end of file diff --git a/icasdk/paths/api_projects_project_id_data_update_batch/post.py b/icasdk/paths/api_projects_project_id_data_update_batch/post.py new file mode 100644 index 0000000..1a084ec --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch/post.py @@ -0,0 +1,385 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.project_data_update_batch import ProjectDataUpdateBatch +from icasdk.model.create_project_data_update_batch import CreateProjectDataUpdateBatch + +from . import path + +# Path params +ProjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationVndIlluminaV3json = CreateProjectDataUpdateBatch +SchemaForRequestBodyApplicationJson = CreateProjectDataUpdateBatch + + +request_body_create_project_data_update_batch = api_client.RequestBody( + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndIlluminaV3json), + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor201ResponseBodyApplicationVndIlluminaV3json = ProjectDataUpdateBatch + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '201': _response_for_201, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_project_data_update_batch_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def _create_project_data_update_batch_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_project_data_update_batch_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_project_data_update_batch_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v3+json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Create a project data update batch. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_create_project_data_update_batch.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class CreateProjectDataUpdateBatch(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_project_data_update_batch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def create_project_data_update_batch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_project_data_update_batch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_project_data_update_batch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v3+json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_project_data_update_batch_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v3+json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_project_data_update_batch_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_data_update_batch/post.pyi b/icasdk/paths/api_projects_project_id_data_update_batch/post.pyi new file mode 100644 index 0000000..60139ba --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch/post.pyi @@ -0,0 +1,375 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.project_data_update_batch import ProjectDataUpdateBatch +from icasdk.model.create_project_data_update_batch import CreateProjectDataUpdateBatch + +# Path params +ProjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationVndIlluminaV3json = CreateProjectDataUpdateBatch +SchemaForRequestBodyApplicationJson = CreateProjectDataUpdateBatch + + +request_body_create_project_data_update_batch = api_client.RequestBody( + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndIlluminaV3json), + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationVndIlluminaV3json = ProjectDataUpdateBatch + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_project_data_update_batch_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def _create_project_data_update_batch_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_project_data_update_batch_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_project_data_update_batch_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v3+json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Create a project data update batch. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_create_project_data_update_batch.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class CreateProjectDataUpdateBatch(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_project_data_update_batch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def create_project_data_update_batch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_project_data_update_batch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_project_data_update_batch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v3+json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_project_data_update_batch_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v3+json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_project_data_update_batch_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_data_update_batch_batch_id/__init__.py b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id/__init__.py new file mode 100644 index 0000000..55a5e81 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_projects_project_id_data_update_batch_batch_id import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID \ No newline at end of file diff --git a/icasdk/paths/api_projects_project_id_data_update_batch_batch_id/get.py b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id/get.py new file mode 100644 index 0000000..921564c --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id/get.py @@ -0,0 +1,335 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.project_data_update_batch import ProjectDataUpdateBatch + +from . import path + +# Path params +ProjectIdSchema = schemas.StrSchema +BatchIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'batchId': typing.Union[BatchIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_batch_id = api_client.PathParameter( + name="batchId", + style=api_client.ParameterStyle.SIMPLE, + schema=BatchIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectDataUpdateBatch + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_project_data_update_batch_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_project_data_update_batch_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_project_data_update_batch_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_project_data_update_batch_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve a project data update batch. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_batch_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetProjectDataUpdateBatch(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_project_data_update_batch( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_project_data_update_batch( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_project_data_update_batch( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_project_data_update_batch( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_data_update_batch_batch_id/get.pyi b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id/get.pyi new file mode 100644 index 0000000..8699c5f --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id/get.pyi @@ -0,0 +1,325 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.project_data_update_batch import ProjectDataUpdateBatch + +# Path params +ProjectIdSchema = schemas.StrSchema +BatchIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'batchId': typing.Union[BatchIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_batch_id = api_client.PathParameter( + name="batchId", + style=api_client.ParameterStyle.SIMPLE, + schema=BatchIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectDataUpdateBatch + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_project_data_update_batch_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_project_data_update_batch_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_project_data_update_batch_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_project_data_update_batch_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve a project data update batch. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_batch_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetProjectDataUpdateBatch(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_project_data_update_batch( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_project_data_update_batch( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_project_data_update_batch( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_project_data_update_batch( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/__init__.py b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/__init__.py new file mode 100644 index 0000000..2c201ae --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_projects_project_id_data_update_batch_batch_id_items import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID_ITEMS \ No newline at end of file diff --git a/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/get.py b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/get.py new file mode 100644 index 0000000..292d776 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/get.py @@ -0,0 +1,487 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.project_data_update_batch_item_paged_list import ProjectDataUpdateBatchItemPagedList + +from . import path + +# Query params + + +class StatusSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "INITIALISED": "INITIALISED", + "WAITING_RESOURCES": "WAITING_RESOURCES", + "UPDATING": "UPDATING", + "UPDATED": "UPDATED", + "PARTIALLY_UPDATED": "PARTIALLY_UPDATED", + "FAILED": "FAILED", + } + + @schemas.classproperty + def INITIALISED(cls): + return cls("INITIALISED") + + @schemas.classproperty + def WAITING_RESOURCES(cls): + return cls("WAITING_RESOURCES") + + @schemas.classproperty + def UPDATING(cls): + return cls("UPDATING") + + @schemas.classproperty + def UPDATED(cls): + return cls("UPDATED") + + @schemas.classproperty + def PARTIALLY_UPDATED(cls): + return cls("PARTIALLY_UPDATED") + + @schemas.classproperty + def FAILED(cls): + return cls("FAILED") + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'StatusSchema': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageOffsetSchema = schemas.StrSchema +PageTokenSchema = schemas.StrSchema +PageSizeSchema = schemas.StrSchema +SortSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'status': typing.Union[StatusSchema, list, tuple, ], + 'pageOffset': typing.Union[PageOffsetSchema, str, ], + 'pageToken': typing.Union[PageTokenSchema, str, ], + 'pageSize': typing.Union[PageSizeSchema, str, ], + 'sort': typing.Union[SortSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_status = api_client.QueryParameter( + name="status", + style=api_client.ParameterStyle.FORM, + schema=StatusSchema, + explode=True, +) +request_query_page_offset = api_client.QueryParameter( + name="pageOffset", + style=api_client.ParameterStyle.FORM, + schema=PageOffsetSchema, + explode=True, +) +request_query_page_token = api_client.QueryParameter( + name="pageToken", + style=api_client.ParameterStyle.FORM, + schema=PageTokenSchema, + explode=True, +) +request_query_page_size = api_client.QueryParameter( + name="pageSize", + style=api_client.ParameterStyle.FORM, + schema=PageSizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +# Path params +ProjectIdSchema = schemas.StrSchema +BatchIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'batchId': typing.Union[BatchIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_batch_id = api_client.PathParameter( + name="batchId", + style=api_client.ParameterStyle.SIMPLE, + schema=BatchIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectDataUpdateBatchItemPagedList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_project_data_update_batch_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_project_data_update_batch_items_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_project_data_update_batch_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_project_data_update_batch_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve a list of project data update batch items. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_batch_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_status, + request_query_page_offset, + request_query_page_token, + request_query_page_size, + request_query_sort, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetProjectDataUpdateBatchItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_project_data_update_batch_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_project_data_update_batch_items( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_project_data_update_batch_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_project_data_update_batch_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_items_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_items_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/get.pyi b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/get.pyi new file mode 100644 index 0000000..c969f6f --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items/get.pyi @@ -0,0 +1,466 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.project_data_update_batch_item_paged_list import ProjectDataUpdateBatchItemPagedList + +# Query params + + +class StatusSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INITIALISED(cls): + return cls("INITIALISED") + + @schemas.classproperty + def WAITING_RESOURCES(cls): + return cls("WAITING_RESOURCES") + + @schemas.classproperty + def UPDATING(cls): + return cls("UPDATING") + + @schemas.classproperty + def UPDATED(cls): + return cls("UPDATED") + + @schemas.classproperty + def PARTIALLY_UPDATED(cls): + return cls("PARTIALLY_UPDATED") + + @schemas.classproperty + def FAILED(cls): + return cls("FAILED") + + def __new__( + cls, + arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'StatusSchema': + return super().__new__( + cls, + arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageOffsetSchema = schemas.StrSchema +PageTokenSchema = schemas.StrSchema +PageSizeSchema = schemas.StrSchema +SortSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'status': typing.Union[StatusSchema, list, tuple, ], + 'pageOffset': typing.Union[PageOffsetSchema, str, ], + 'pageToken': typing.Union[PageTokenSchema, str, ], + 'pageSize': typing.Union[PageSizeSchema, str, ], + 'sort': typing.Union[SortSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_status = api_client.QueryParameter( + name="status", + style=api_client.ParameterStyle.FORM, + schema=StatusSchema, + explode=True, +) +request_query_page_offset = api_client.QueryParameter( + name="pageOffset", + style=api_client.ParameterStyle.FORM, + schema=PageOffsetSchema, + explode=True, +) +request_query_page_token = api_client.QueryParameter( + name="pageToken", + style=api_client.ParameterStyle.FORM, + schema=PageTokenSchema, + explode=True, +) +request_query_page_size = api_client.QueryParameter( + name="pageSize", + style=api_client.ParameterStyle.FORM, + schema=PageSizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +# Path params +ProjectIdSchema = schemas.StrSchema +BatchIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'batchId': typing.Union[BatchIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_batch_id = api_client.PathParameter( + name="batchId", + style=api_client.ParameterStyle.SIMPLE, + schema=BatchIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectDataUpdateBatchItemPagedList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_project_data_update_batch_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_project_data_update_batch_items_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_project_data_update_batch_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_project_data_update_batch_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve a list of project data update batch items. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_batch_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_status, + request_query_page_offset, + request_query_page_token, + request_query_page_size, + request_query_sort, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetProjectDataUpdateBatchItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_project_data_update_batch_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_project_data_update_batch_items( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_project_data_update_batch_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_project_data_update_batch_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_items_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_items_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/__init__.py b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/__init__.py new file mode 100644 index 0000000..d34d1f5 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_projects_project_id_data_update_batch_batch_id_items_item_id import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PROJECTS_PROJECT_ID_DATA_UPDATE_BATCH_BATCH_ID_ITEMS_ITEM_ID \ No newline at end of file diff --git a/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/get.py b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/get.py new file mode 100644 index 0000000..0166ce3 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/get.py @@ -0,0 +1,344 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.project_data_update_batch_item import ProjectDataUpdateBatchItem +from icasdk.model.problem import Problem + +from . import path + +# Path params +ProjectIdSchema = schemas.StrSchema +BatchIdSchema = schemas.UUIDSchema +ItemIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'batchId': typing.Union[BatchIdSchema, str, uuid.UUID, ], + 'itemId': typing.Union[ItemIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_batch_id = api_client.PathParameter( + name="batchId", + style=api_client.ParameterStyle.SIMPLE, + schema=BatchIdSchema, + required=True, +) +request_path_item_id = api_client.PathParameter( + name="itemId", + style=api_client.ParameterStyle.SIMPLE, + schema=ItemIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectDataUpdateBatchItem + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_project_data_update_batch_item_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_project_data_update_batch_item_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_project_data_update_batch_item_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_project_data_update_batch_item_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve a project data update batch item. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_batch_id, + request_path_item_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetProjectDataUpdateBatchItem(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_project_data_update_batch_item( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_project_data_update_batch_item( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_project_data_update_batch_item( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_project_data_update_batch_item( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_item_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_item_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/get.pyi b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/get.pyi new file mode 100644 index 0000000..1d57c85 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_data_update_batch_batch_id_items_item_id/get.pyi @@ -0,0 +1,334 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.project_data_update_batch_item import ProjectDataUpdateBatchItem +from icasdk.model.problem import Problem + +# Path params +ProjectIdSchema = schemas.StrSchema +BatchIdSchema = schemas.UUIDSchema +ItemIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'batchId': typing.Union[BatchIdSchema, str, uuid.UUID, ], + 'itemId': typing.Union[ItemIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_batch_id = api_client.PathParameter( + name="batchId", + style=api_client.ParameterStyle.SIMPLE, + schema=BatchIdSchema, + required=True, +) +request_path_item_id = api_client.PathParameter( + name="itemId", + style=api_client.ParameterStyle.SIMPLE, + schema=ItemIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectDataUpdateBatchItem + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_project_data_update_batch_item_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_project_data_update_batch_item_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_project_data_update_batch_item_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_project_data_update_batch_item_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve a project data update batch item. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_batch_id, + request_path_item_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetProjectDataUpdateBatchItem(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_project_data_update_batch_item( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_project_data_update_batch_item( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_project_data_update_batch_item( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_project_data_update_batch_item( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_item_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_data_update_batch_item_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_permissions/get.py b/icasdk/paths/api_projects_project_id_permissions/get.py index c464eaf..50c43a1 100644 --- a/icasdk/paths/api_projects_project_id_permissions/get.py +++ b/icasdk/paths/api_projects_project_id_permissions/get.py @@ -25,6 +25,7 @@ from icasdk import schemas # noqa: F401 +from icasdk.model.project_permission_list_v4 import ProjectPermissionListV4 from icasdk.model.problem import Problem from icasdk.model.project_permission_list import ProjectPermissionList @@ -60,6 +61,7 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): 'JwtAuth', 'ApiKeyAuth', ] +SchemaFor200ResponseBodyApplicationVndIlluminaV4json = ProjectPermissionListV4 SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectPermissionList @@ -67,6 +69,7 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): class ApiResponseFor200(api_client.ApiResponse): response: urllib3.HTTPResponse body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV4json, SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] headers: schemas.Unset = schemas.unset @@ -75,6 +78,8 @@ class ApiResponseFor200(api_client.ApiResponse): _response_for_200 = api_client.OpenApiResponse( response_cls=ApiResponseFor200, content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), }, @@ -104,6 +109,7 @@ class ApiResponseForDefault(api_client.ApiResponse): } _all_accept_content_types = ( 'application/problem+json', + 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) diff --git a/icasdk/paths/api_projects_project_id_permissions/get.pyi b/icasdk/paths/api_projects_project_id_permissions/get.pyi index 44ac840..eaa1dbb 100644 --- a/icasdk/paths/api_projects_project_id_permissions/get.pyi +++ b/icasdk/paths/api_projects_project_id_permissions/get.pyi @@ -25,6 +25,7 @@ import frozendict # noqa: F401 from icasdk import schemas # noqa: F401 +from icasdk.model.project_permission_list_v4 import ProjectPermissionListV4 from icasdk.model.problem import Problem from icasdk.model.project_permission_list import ProjectPermissionList @@ -54,6 +55,7 @@ request_path_project_id = api_client.PathParameter( schema=ProjectIdSchema, required=True, ) +SchemaFor200ResponseBodyApplicationVndIlluminaV4json = ProjectPermissionListV4 SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectPermissionList @@ -61,6 +63,7 @@ SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectPermissionList class ApiResponseFor200(api_client.ApiResponse): response: urllib3.HTTPResponse body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV4json, SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] headers: schemas.Unset = schemas.unset @@ -69,6 +72,8 @@ class ApiResponseFor200(api_client.ApiResponse): _response_for_200 = api_client.OpenApiResponse( response_cls=ApiResponseFor200, content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), }, @@ -94,6 +99,7 @@ _response_for_default = api_client.OpenApiResponse( ) _all_accept_content_types = ( 'application/problem+json', + 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) diff --git a/icasdk/paths/api_projects_project_id_permissions/post.py b/icasdk/paths/api_projects_project_id_permissions/post.py index 5fc702c..7a79d22 100644 --- a/icasdk/paths/api_projects_project_id_permissions/post.py +++ b/icasdk/paths/api_projects_project_id_permissions/post.py @@ -25,7 +25,9 @@ from icasdk import schemas # noqa: F401 +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.create_project_permission import CreateProjectPermission +from icasdk.model.create_project_permission_v4 import CreateProjectPermissionV4 from icasdk.model.problem import Problem from icasdk.model.project_permission import ProjectPermission @@ -58,12 +60,15 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): required=True, ) # body param +SchemaForRequestBodyApplicationVndIlluminaV4json = CreateProjectPermissionV4 SchemaForRequestBodyApplicationVndIlluminaV3json = CreateProjectPermission SchemaForRequestBodyApplicationJson = CreateProjectPermission -request_body_create_project_permission = api_client.RequestBody( +request_body_create_project_permission_v4 = api_client.RequestBody( content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaForRequestBodyApplicationVndIlluminaV3json), 'application/json': api_client.MediaType( @@ -81,6 +86,7 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): style=api_client.ParameterStyle.SIMPLE, schema=ETagSchema, ) +SchemaFor201ResponseBodyApplicationVndIlluminaV4json = ProjectPermissionV4 SchemaFor201ResponseBodyApplicationVndIlluminaV3json = ProjectPermission ResponseHeadersFor201 = typing_extensions.TypedDict( 'ResponseHeadersFor201', @@ -94,6 +100,7 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): class ApiResponseFor201(api_client.ApiResponse): response: urllib3.HTTPResponse body: typing.Union[ + SchemaFor201ResponseBodyApplicationVndIlluminaV4json, SchemaFor201ResponseBodyApplicationVndIlluminaV3json, ] headers: ResponseHeadersFor201 @@ -102,6 +109,8 @@ class ApiResponseFor201(api_client.ApiResponse): _response_for_201 = api_client.OpenApiResponse( response_cls=ApiResponseFor201, content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaFor201ResponseBodyApplicationVndIlluminaV3json), }, @@ -134,6 +143,7 @@ class ApiResponseForDefault(api_client.ApiResponse): } _all_accept_content_types = ( 'application/problem+json', + 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) @@ -142,7 +152,7 @@ class BaseApi(api_client.Api): @typing.overload def _create_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -158,7 +168,7 @@ def _create_project_permission_oapg( @typing.overload def _create_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), @@ -170,7 +180,7 @@ def _create_project_permission_oapg( @typing.overload def _create_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -185,8 +195,8 @@ def _create_project_permission_oapg( def _create_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -226,7 +236,7 @@ class instances 'The required body parameter has an invalid value of: unset. Set a valid value instead') _fields = None _body = None - serialized_data = request_body_create_project_permission.serialize(body, content_type) + serialized_data = request_body_create_project_permission_v4.serialize(body, content_type) _headers.add('Content-Type', content_type) if 'fields' in serialized_data: _fields = serialized_data['fields'] @@ -268,7 +278,7 @@ class CreateProjectPermission(BaseApi): @typing.overload def create_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -284,7 +294,7 @@ def create_project_permission( @typing.overload def create_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), @@ -296,7 +306,7 @@ def create_project_permission( @typing.overload def create_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -311,8 +321,8 @@ def create_project_permission( def create_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -336,7 +346,7 @@ class ApiForpost(BaseApi): @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -352,7 +362,7 @@ def post( @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), @@ -364,7 +374,7 @@ def post( @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -379,8 +389,8 @@ def post( def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, diff --git a/icasdk/paths/api_projects_project_id_permissions/post.pyi b/icasdk/paths/api_projects_project_id_permissions/post.pyi index 335eba5..7733e18 100644 --- a/icasdk/paths/api_projects_project_id_permissions/post.pyi +++ b/icasdk/paths/api_projects_project_id_permissions/post.pyi @@ -25,7 +25,9 @@ import frozendict # noqa: F401 from icasdk import schemas # noqa: F401 +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.create_project_permission import CreateProjectPermission +from icasdk.model.create_project_permission_v4 import CreateProjectPermissionV4 from icasdk.model.problem import Problem from icasdk.model.project_permission import ProjectPermission @@ -56,12 +58,15 @@ request_path_project_id = api_client.PathParameter( required=True, ) # body param +SchemaForRequestBodyApplicationVndIlluminaV4json = CreateProjectPermissionV4 SchemaForRequestBodyApplicationVndIlluminaV3json = CreateProjectPermission SchemaForRequestBodyApplicationJson = CreateProjectPermission -request_body_create_project_permission = api_client.RequestBody( +request_body_create_project_permission_v4 = api_client.RequestBody( content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaForRequestBodyApplicationVndIlluminaV3json), 'application/json': api_client.MediaType( @@ -70,6 +75,7 @@ request_body_create_project_permission = api_client.RequestBody( required=True, ) ETagSchema = schemas.StrSchema +SchemaFor201ResponseBodyApplicationVndIlluminaV4json = ProjectPermissionV4 SchemaFor201ResponseBodyApplicationVndIlluminaV3json = ProjectPermission ResponseHeadersFor201 = typing_extensions.TypedDict( 'ResponseHeadersFor201', @@ -83,6 +89,7 @@ ResponseHeadersFor201 = typing_extensions.TypedDict( class ApiResponseFor201(api_client.ApiResponse): response: urllib3.HTTPResponse body: typing.Union[ + SchemaFor201ResponseBodyApplicationVndIlluminaV4json, SchemaFor201ResponseBodyApplicationVndIlluminaV3json, ] headers: ResponseHeadersFor201 @@ -91,6 +98,8 @@ class ApiResponseFor201(api_client.ApiResponse): _response_for_201 = api_client.OpenApiResponse( response_cls=ApiResponseFor201, content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaFor201ResponseBodyApplicationVndIlluminaV3json), }, @@ -119,6 +128,7 @@ _response_for_default = api_client.OpenApiResponse( ) _all_accept_content_types = ( 'application/problem+json', + 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) @@ -127,7 +137,7 @@ class BaseApi(api_client.Api): @typing.overload def _create_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -143,7 +153,7 @@ class BaseApi(api_client.Api): @typing.overload def _create_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), @@ -155,7 +165,7 @@ class BaseApi(api_client.Api): @typing.overload def _create_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -170,8 +180,8 @@ class BaseApi(api_client.Api): def _create_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -211,7 +221,7 @@ class BaseApi(api_client.Api): 'The required body parameter has an invalid value of: unset. Set a valid value instead') _fields = None _body = None - serialized_data = request_body_create_project_permission.serialize(body, content_type) + serialized_data = request_body_create_project_permission_v4.serialize(body, content_type) _headers.add('Content-Type', content_type) if 'fields' in serialized_data: _fields = serialized_data['fields'] @@ -253,7 +263,7 @@ class CreateProjectPermission(BaseApi): @typing.overload def create_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -269,7 +279,7 @@ class CreateProjectPermission(BaseApi): @typing.overload def create_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), @@ -281,7 +291,7 @@ class CreateProjectPermission(BaseApi): @typing.overload def create_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -296,8 +306,8 @@ class CreateProjectPermission(BaseApi): def create_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, @@ -321,7 +331,7 @@ class ApiForpost(BaseApi): @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -337,7 +347,7 @@ class ApiForpost(BaseApi): @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), @@ -349,7 +359,7 @@ class ApiForpost(BaseApi): @typing.overload def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -364,8 +374,8 @@ class ApiForpost(BaseApi): def post( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, stream: bool = False, diff --git a/icasdk/paths/api_projects_project_id_permissions_permission_id/get.py b/icasdk/paths/api_projects_project_id_permissions_permission_id/get.py index 0f0b267..fc2b215 100644 --- a/icasdk/paths/api_projects_project_id_permissions_permission_id/get.py +++ b/icasdk/paths/api_projects_project_id_permissions_permission_id/get.py @@ -25,6 +25,7 @@ from icasdk import schemas # noqa: F401 +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.problem import Problem from icasdk.model.project_permission import ProjectPermission @@ -74,6 +75,7 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): style=api_client.ParameterStyle.SIMPLE, schema=ETagSchema, ) +SchemaFor200ResponseBodyApplicationVndIlluminaV4json = ProjectPermissionV4 SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectPermission ResponseHeadersFor200 = typing_extensions.TypedDict( 'ResponseHeadersFor200', @@ -87,6 +89,7 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): class ApiResponseFor200(api_client.ApiResponse): response: urllib3.HTTPResponse body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV4json, SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] headers: ResponseHeadersFor200 @@ -95,6 +98,8 @@ class ApiResponseFor200(api_client.ApiResponse): _response_for_200 = api_client.OpenApiResponse( response_cls=ApiResponseFor200, content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), }, @@ -127,6 +132,7 @@ class ApiResponseForDefault(api_client.ApiResponse): } _all_accept_content_types = ( 'application/problem+json', + 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) diff --git a/icasdk/paths/api_projects_project_id_permissions_permission_id/get.pyi b/icasdk/paths/api_projects_project_id_permissions_permission_id/get.pyi index 646fe45..5b12865 100644 --- a/icasdk/paths/api_projects_project_id_permissions_permission_id/get.pyi +++ b/icasdk/paths/api_projects_project_id_permissions_permission_id/get.pyi @@ -25,6 +25,7 @@ import frozendict # noqa: F401 from icasdk import schemas # noqa: F401 +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.problem import Problem from icasdk.model.project_permission import ProjectPermission @@ -63,6 +64,7 @@ request_path_permission_id = api_client.PathParameter( required=True, ) ETagSchema = schemas.StrSchema +SchemaFor200ResponseBodyApplicationVndIlluminaV4json = ProjectPermissionV4 SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectPermission ResponseHeadersFor200 = typing_extensions.TypedDict( 'ResponseHeadersFor200', @@ -76,6 +78,7 @@ ResponseHeadersFor200 = typing_extensions.TypedDict( class ApiResponseFor200(api_client.ApiResponse): response: urllib3.HTTPResponse body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV4json, SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] headers: ResponseHeadersFor200 @@ -84,6 +87,8 @@ class ApiResponseFor200(api_client.ApiResponse): _response_for_200 = api_client.OpenApiResponse( response_cls=ApiResponseFor200, content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), }, @@ -112,6 +117,7 @@ _response_for_default = api_client.OpenApiResponse( ) _all_accept_content_types = ( 'application/problem+json', + 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) diff --git a/icasdk/paths/api_projects_project_id_permissions_permission_id/put.py b/icasdk/paths/api_projects_project_id_permissions_permission_id/put.py index 4924c7c..1751fec 100644 --- a/icasdk/paths/api_projects_project_id_permissions_permission_id/put.py +++ b/icasdk/paths/api_projects_project_id_permissions_permission_id/put.py @@ -25,6 +25,7 @@ from icasdk import schemas # noqa: F401 +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.problem import Problem from icasdk.model.project_permission import ProjectPermission @@ -90,12 +91,15 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): required=True, ) # body param +SchemaForRequestBodyApplicationVndIlluminaV4json = ProjectPermissionV4 SchemaForRequestBodyApplicationVndIlluminaV3json = ProjectPermission SchemaForRequestBodyApplicationJson = ProjectPermission -request_body_project_permission = api_client.RequestBody( +request_body_project_permission_v4 = api_client.RequestBody( content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaForRequestBodyApplicationVndIlluminaV3json), 'application/json': api_client.MediaType( @@ -113,6 +117,7 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): style=api_client.ParameterStyle.SIMPLE, schema=ETagSchema, ) +SchemaFor200ResponseBodyApplicationVndIlluminaV4json = ProjectPermissionV4 SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectPermission ResponseHeadersFor200 = typing_extensions.TypedDict( 'ResponseHeadersFor200', @@ -126,6 +131,7 @@ class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): class ApiResponseFor200(api_client.ApiResponse): response: urllib3.HTTPResponse body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV4json, SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] headers: ResponseHeadersFor200 @@ -134,6 +140,8 @@ class ApiResponseFor200(api_client.ApiResponse): _response_for_200 = api_client.OpenApiResponse( response_cls=ApiResponseFor200, content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), }, @@ -166,6 +174,7 @@ class ApiResponseForDefault(api_client.ApiResponse): } _all_accept_content_types = ( 'application/problem+json', + 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) @@ -174,7 +183,7 @@ class BaseApi(api_client.Api): @typing.overload def _update_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -191,7 +200,7 @@ def _update_project_permission_oapg( @typing.overload def _update_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), @@ -204,7 +213,7 @@ def _update_project_permission_oapg( @typing.overload def _update_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -220,8 +229,8 @@ def _update_project_permission_oapg( def _update_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -272,7 +281,7 @@ class instances 'The required body parameter has an invalid value of: unset. Set a valid value instead') _fields = None _body = None - serialized_data = request_body_project_permission.serialize(body, content_type) + serialized_data = request_body_project_permission_v4.serialize(body, content_type) _headers.add('Content-Type', content_type) if 'fields' in serialized_data: _fields = serialized_data['fields'] @@ -314,7 +323,7 @@ class UpdateProjectPermission(BaseApi): @typing.overload def update_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -331,7 +340,7 @@ def update_project_permission( @typing.overload def update_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), @@ -344,7 +353,7 @@ def update_project_permission( @typing.overload def update_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -360,8 +369,8 @@ def update_project_permission( def update_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -387,7 +396,7 @@ class ApiForput(BaseApi): @typing.overload def put( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -404,7 +413,7 @@ def put( @typing.overload def put( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), @@ -417,7 +426,7 @@ def put( @typing.overload def put( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -433,8 +442,8 @@ def put( def put( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, diff --git a/icasdk/paths/api_projects_project_id_permissions_permission_id/put.pyi b/icasdk/paths/api_projects_project_id_permissions_permission_id/put.pyi index 3e8f7e8..4438846 100644 --- a/icasdk/paths/api_projects_project_id_permissions_permission_id/put.pyi +++ b/icasdk/paths/api_projects_project_id_permissions_permission_id/put.pyi @@ -25,6 +25,7 @@ import frozendict # noqa: F401 from icasdk import schemas # noqa: F401 +from icasdk.model.project_permission_v4 import ProjectPermissionV4 from icasdk.model.problem import Problem from icasdk.model.project_permission import ProjectPermission @@ -88,12 +89,15 @@ request_path_permission_id = api_client.PathParameter( required=True, ) # body param +SchemaForRequestBodyApplicationVndIlluminaV4json = ProjectPermissionV4 SchemaForRequestBodyApplicationVndIlluminaV3json = ProjectPermission SchemaForRequestBodyApplicationJson = ProjectPermission -request_body_project_permission = api_client.RequestBody( +request_body_project_permission_v4 = api_client.RequestBody( content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaForRequestBodyApplicationVndIlluminaV3json), 'application/json': api_client.MediaType( @@ -102,6 +106,7 @@ request_body_project_permission = api_client.RequestBody( required=True, ) ETagSchema = schemas.StrSchema +SchemaFor200ResponseBodyApplicationVndIlluminaV4json = ProjectPermissionV4 SchemaFor200ResponseBodyApplicationVndIlluminaV3json = ProjectPermission ResponseHeadersFor200 = typing_extensions.TypedDict( 'ResponseHeadersFor200', @@ -115,6 +120,7 @@ ResponseHeadersFor200 = typing_extensions.TypedDict( class ApiResponseFor200(api_client.ApiResponse): response: urllib3.HTTPResponse body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV4json, SchemaFor200ResponseBodyApplicationVndIlluminaV3json, ] headers: ResponseHeadersFor200 @@ -123,6 +129,8 @@ class ApiResponseFor200(api_client.ApiResponse): _response_for_200 = api_client.OpenApiResponse( response_cls=ApiResponseFor200, content={ + 'application/vnd.illumina.v4+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV4json), 'application/vnd.illumina.v3+json': api_client.MediaType( schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), }, @@ -151,6 +159,7 @@ _response_for_default = api_client.OpenApiResponse( ) _all_accept_content_types = ( 'application/problem+json', + 'application/vnd.illumina.v4+json', 'application/vnd.illumina.v3+json', ) @@ -159,7 +168,7 @@ class BaseApi(api_client.Api): @typing.overload def _update_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -176,7 +185,7 @@ class BaseApi(api_client.Api): @typing.overload def _update_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), @@ -189,7 +198,7 @@ class BaseApi(api_client.Api): @typing.overload def _update_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -205,8 +214,8 @@ class BaseApi(api_client.Api): def _update_project_permission_oapg( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -257,7 +266,7 @@ class BaseApi(api_client.Api): 'The required body parameter has an invalid value of: unset. Set a valid value instead') _fields = None _body = None - serialized_data = request_body_project_permission.serialize(body, content_type) + serialized_data = request_body_project_permission_v4.serialize(body, content_type) _headers.add('Content-Type', content_type) if 'fields' in serialized_data: _fields = serialized_data['fields'] @@ -299,7 +308,7 @@ class UpdateProjectPermission(BaseApi): @typing.overload def update_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -316,7 +325,7 @@ class UpdateProjectPermission(BaseApi): @typing.overload def update_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), @@ -329,7 +338,7 @@ class UpdateProjectPermission(BaseApi): @typing.overload def update_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -345,8 +354,8 @@ class UpdateProjectPermission(BaseApi): def update_project_permission( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, @@ -372,7 +381,7 @@ class ApiForput(BaseApi): @typing.overload def put( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -389,7 +398,7 @@ class ApiForput(BaseApi): @typing.overload def put( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], skip_deserialization: typing_extensions.Literal[True], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), @@ -402,7 +411,7 @@ class ApiForput(BaseApi): @typing.overload def put( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], content_type: str = ..., header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), @@ -418,8 +427,8 @@ class ApiForput(BaseApi): def put( self, - body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], - content_type: str = 'application/vnd.illumina.v3+json', + body: typing.Union[SchemaForRequestBodyApplicationVndIlluminaV4json,SchemaForRequestBodyApplicationVndIlluminaV3json,SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/vnd.illumina.v4+json', header_params: RequestHeaderParams = frozendict.frozendict(), path_params: RequestPathParams = frozendict.frozendict(), accept_content_types: typing.Tuple[str] = _all_accept_content_types, diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/__init__.py b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/__init__.py new file mode 100644 index 0000000..848756c --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES \ No newline at end of file diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/get.py b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/get.py new file mode 100644 index 0000000..bd0dc99 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/get.py @@ -0,0 +1,335 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_list import PipelineFileList + +from . import path + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = PipelineFileList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_pipeline_files1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_pipeline_files1_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_pipeline_files1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_pipeline_files1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve files for a project pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetPipelineFiles1(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_pipeline_files1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_pipeline_files1( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_pipeline_files1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_pipeline_files1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_pipeline_files1_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_pipeline_files1_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/get.pyi b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/get.pyi new file mode 100644 index 0000000..10f4936 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/get.pyi @@ -0,0 +1,325 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_list import PipelineFileList + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = PipelineFileList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_pipeline_files1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_pipeline_files1_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_pipeline_files1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_pipeline_files1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve files for a project pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetPipelineFiles1(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_pipeline_files1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_pipeline_files1( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_pipeline_files1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_pipeline_files1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_pipeline_files1_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_pipeline_files1_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/post.py b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/post.py new file mode 100644 index 0000000..824c504 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/post.py @@ -0,0 +1,388 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.pipeline_file import PipelineFile +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_content_spec import PipelineFileContentSpec + +from . import path + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +# body param +SchemaForRequestBodyMultipartFormData = PipelineFileContentSpec + + +request_body_body = api_client.RequestBody( + content={ + 'multipart/form-data': api_client.MediaType( + schema=SchemaForRequestBodyMultipartFormData), + }, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor201ResponseBodyApplicationVndIlluminaV3json = PipelineFile + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '201': _response_for_201, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_pipeline_file_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def _create_pipeline_file_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_pipeline_file_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_pipeline_file_oapg( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Create a file for a pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + _fields = None + _body = None + if body is not schemas.unset: + serialized_data = request_body_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class CreatePipelineFile(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_pipeline_file( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def create_pipeline_file( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_pipeline_file( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_pipeline_file( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_pipeline_file_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_pipeline_file_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/post.pyi b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/post.pyi new file mode 100644 index 0000000..bfe571a --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files/post.pyi @@ -0,0 +1,378 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.pipeline_file import PipelineFile +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_content_spec import PipelineFileContentSpec + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +# body param +SchemaForRequestBodyMultipartFormData = PipelineFileContentSpec + + +request_body_body = api_client.RequestBody( + content={ + 'multipart/form-data': api_client.MediaType( + schema=SchemaForRequestBodyMultipartFormData), + }, +) +SchemaFor201ResponseBodyApplicationVndIlluminaV3json = PipelineFile + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_pipeline_file_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def _create_pipeline_file_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_pipeline_file_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_pipeline_file_oapg( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Create a file for a pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + _fields = None + _body = None + if body is not schemas.unset: + serialized_data = request_body_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class CreatePipelineFile(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_pipeline_file( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def create_pipeline_file( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_pipeline_file( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_pipeline_file( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_pipeline_file_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_pipeline_file_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/__init__.py b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/__init__.py new file mode 100644 index 0000000..6612a6a --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES_FILE_ID \ No newline at end of file diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/delete.py b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/delete.py new file mode 100644 index 0000000..184aa77 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/delete.py @@ -0,0 +1,341 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem + +from . import path + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +FileIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + 'fileId': typing.Union[FileIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +request_path_file_id = api_client.PathParameter( + name="fileId", + style=api_client.ParameterStyle.SIMPLE, + schema=FileIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType(), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '204': _response_for_204, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_pipeline_file_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _delete_pipeline_file_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_pipeline_file_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_pipeline_file_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete a file for a pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + request_path_file_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class DeletePipelineFile(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_pipeline_file( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def delete_pipeline_file( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_pipeline_file( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_pipeline_file( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_pipeline_file_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_pipeline_file_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/delete.pyi b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/delete.pyi new file mode 100644 index 0000000..992864f --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id/delete.pyi @@ -0,0 +1,331 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +FileIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + 'fileId': typing.Union[FileIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +request_path_file_id = api_client.PathParameter( + name="fileId", + style=api_client.ParameterStyle.SIMPLE, + schema=FileIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType(), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_pipeline_file_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _delete_pipeline_file_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_pipeline_file_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_pipeline_file_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete a file for a pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + request_path_file_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class DeletePipelineFile(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_pipeline_file( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def delete_pipeline_file( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_pipeline_file( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_pipeline_file( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_pipeline_file_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_pipeline_file_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/__init__.py b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/__init__.py new file mode 100644 index 0000000..f1364ad --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id_content import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PROJECTS_PROJECT_ID_PIPELINES_PIPELINE_ID_FILES_FILE_ID_CONTENT \ No newline at end of file diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/get.py b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/get.py new file mode 100644 index 0000000..8de4848 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/get.py @@ -0,0 +1,358 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem + +from . import path + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +FileIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + 'fileId': typing.Union[FileIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +request_path_file_id = api_client.PathParameter( + name="fileId", + style=api_client.ParameterStyle.SIMPLE, + schema=FileIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +ContentDispositionSchema = schemas.StrSchema +content_disposition_parameter = api_client.HeaderParameter( + name="Content-Disposition", + style=api_client.ParameterStyle.SIMPLE, + schema=ContentDispositionSchema, +) +SchemaFor200ResponseBodyApplicationOctetStream = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationOctetStream, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/octet-stream': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationOctetStream), + }, + headers=[ + content_disposition_parameter, + ] +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/octet-stream', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _download_pipeline_file_content1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _download_pipeline_file_content1_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _download_pipeline_file_content1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _download_pipeline_file_content1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Download the contents of a pipeline file. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + request_path_file_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class DownloadPipelineFileContent1(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def download_pipeline_file_content1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def download_pipeline_file_content1( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def download_pipeline_file_content1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def download_pipeline_file_content1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._download_pipeline_file_content1_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._download_pipeline_file_content1_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/get.pyi b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/get.pyi new file mode 100644 index 0000000..b279a0b --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/get.pyi @@ -0,0 +1,343 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +FileIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + 'fileId': typing.Union[FileIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +request_path_file_id = api_client.PathParameter( + name="fileId", + style=api_client.ParameterStyle.SIMPLE, + schema=FileIdSchema, + required=True, +) +ContentDispositionSchema = schemas.StrSchema +SchemaFor200ResponseBodyApplicationOctetStream = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationOctetStream, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/octet-stream': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationOctetStream), + }, + headers=[ + content_disposition_parameter, + ] +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/octet-stream', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _download_pipeline_file_content1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _download_pipeline_file_content1_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _download_pipeline_file_content1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _download_pipeline_file_content1_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Download the contents of a pipeline file. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + request_path_file_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class DownloadPipelineFileContent1(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def download_pipeline_file_content1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def download_pipeline_file_content1( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def download_pipeline_file_content1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def download_pipeline_file_content1( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._download_pipeline_file_content1_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._download_pipeline_file_content1_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/put.py b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/put.py new file mode 100644 index 0000000..ac15a85 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/put.py @@ -0,0 +1,394 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_content_spec import PipelineFileContentSpec + +from . import path + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +FileIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + 'fileId': typing.Union[FileIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +request_path_file_id = api_client.PathParameter( + name="fileId", + style=api_client.ParameterStyle.SIMPLE, + schema=FileIdSchema, + required=True, +) +# body param +SchemaForRequestBodyMultipartFormData = PipelineFileContentSpec + + +request_body_body = api_client.RequestBody( + content={ + 'multipart/form-data': api_client.MediaType( + schema=SchemaForRequestBodyMultipartFormData), + }, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType(), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_pipeline_file_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def _update_pipeline_file_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_pipeline_file_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_pipeline_file_oapg( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Update the contents of a file for a pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + request_path_file_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + _fields = None + _body = None + if body is not schemas.unset: + serialized_data = request_body_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class UpdatePipelineFile(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_pipeline_file( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def update_pipeline_file( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_pipeline_file( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_pipeline_file( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_pipeline_file_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def put( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_pipeline_file_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/put.pyi b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/put.pyi new file mode 100644 index 0000000..07d711f --- /dev/null +++ b/icasdk/paths/api_projects_project_id_pipelines_pipeline_id_files_file_id_content/put.pyi @@ -0,0 +1,384 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.problem import Problem +from icasdk.model.pipeline_file_content_spec import PipelineFileContentSpec + +# Path params +ProjectIdSchema = schemas.StrSchema +PipelineIdSchema = schemas.StrSchema +FileIdSchema = schemas.UUIDSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'pipelineId': typing.Union[PipelineIdSchema, str, ], + 'fileId': typing.Union[FileIdSchema, str, uuid.UUID, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_pipeline_id = api_client.PathParameter( + name="pipelineId", + style=api_client.ParameterStyle.SIMPLE, + schema=PipelineIdSchema, + required=True, +) +request_path_file_id = api_client.PathParameter( + name="fileId", + style=api_client.ParameterStyle.SIMPLE, + schema=FileIdSchema, + required=True, +) +# body param +SchemaForRequestBodyMultipartFormData = PipelineFileContentSpec + + +request_body_body = api_client.RequestBody( + content={ + 'multipart/form-data': api_client.MediaType( + schema=SchemaForRequestBodyMultipartFormData), + }, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType(), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_pipeline_file_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def _update_pipeline_file_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_pipeline_file_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_pipeline_file_oapg( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Update the contents of a file for a pipeline. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_pipeline_id, + request_path_file_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + _fields = None + _body = None + if body is not schemas.unset: + serialized_data = request_body_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class UpdatePipelineFile(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_pipeline_file( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def update_pipeline_file( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_pipeline_file( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_pipeline_file( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_pipeline_file_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + + @typing.overload + def put( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + content_type: str = 'multipart/form-data', + body: typing.Union[SchemaForRequestBodyMultipartFormData, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_pipeline_file_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_samples_sample_id_analyses/__init__.py b/icasdk/paths/api_projects_project_id_samples_sample_id_analyses/__init__.py new file mode 100644 index 0000000..48f97d9 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_samples_sample_id_analyses/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_projects_project_id_samples_sample_id_analyses import Api + +from icasdk.paths import PathValues + +path = PathValues.API_PROJECTS_PROJECT_ID_SAMPLES_SAMPLE_ID_ANALYSES \ No newline at end of file diff --git a/icasdk/paths/api_projects_project_id_samples_sample_id_analyses/get.py b/icasdk/paths/api_projects_project_id_samples_sample_id_analyses/get.py new file mode 100644 index 0000000..bcd31c8 --- /dev/null +++ b/icasdk/paths/api_projects_project_id_samples_sample_id_analyses/get.py @@ -0,0 +1,470 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.analysis_paged_list import AnalysisPagedList +from icasdk.model.problem import Problem + +from . import path + +# Query params +ReferenceSchema = schemas.StrSchema +UserreferenceSchema = schemas.StrSchema +StatusSchema = schemas.StrSchema +UsertagSchema = schemas.StrSchema +TechnicaltagSchema = schemas.StrSchema +ReferencetagSchema = schemas.StrSchema +PageOffsetSchema = schemas.StrSchema +PageTokenSchema = schemas.StrSchema +PageSizeSchema = schemas.StrSchema +SortSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'reference': typing.Union[ReferenceSchema, str, ], + 'userreference': typing.Union[UserreferenceSchema, str, ], + 'status': typing.Union[StatusSchema, str, ], + 'usertag': typing.Union[UsertagSchema, str, ], + 'technicaltag': typing.Union[TechnicaltagSchema, str, ], + 'referencetag': typing.Union[ReferencetagSchema, str, ], + 'pageOffset': typing.Union[PageOffsetSchema, str, ], + 'pageToken': typing.Union[PageTokenSchema, str, ], + 'pageSize': typing.Union[PageSizeSchema, str, ], + 'sort': typing.Union[SortSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_reference = api_client.QueryParameter( + name="reference", + style=api_client.ParameterStyle.FORM, + schema=ReferenceSchema, + explode=True, +) +request_query_userreference = api_client.QueryParameter( + name="userreference", + style=api_client.ParameterStyle.FORM, + schema=UserreferenceSchema, + explode=True, +) +request_query_status = api_client.QueryParameter( + name="status", + style=api_client.ParameterStyle.FORM, + schema=StatusSchema, + explode=True, +) +request_query_usertag = api_client.QueryParameter( + name="usertag", + style=api_client.ParameterStyle.FORM, + schema=UsertagSchema, + explode=True, +) +request_query_technicaltag = api_client.QueryParameter( + name="technicaltag", + style=api_client.ParameterStyle.FORM, + schema=TechnicaltagSchema, + explode=True, +) +request_query_referencetag = api_client.QueryParameter( + name="referencetag", + style=api_client.ParameterStyle.FORM, + schema=ReferencetagSchema, + explode=True, +) +request_query_page_offset = api_client.QueryParameter( + name="pageOffset", + style=api_client.ParameterStyle.FORM, + schema=PageOffsetSchema, + explode=True, +) +request_query_page_token = api_client.QueryParameter( + name="pageToken", + style=api_client.ParameterStyle.FORM, + schema=PageTokenSchema, + explode=True, +) +request_query_page_size = api_client.QueryParameter( + name="pageSize", + style=api_client.ParameterStyle.FORM, + schema=PageSizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +# Path params +ProjectIdSchema = schemas.StrSchema +SampleIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'sampleId': typing.Union[SampleIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_sample_id = api_client.PathParameter( + name="sampleId", + style=api_client.ParameterStyle.SIMPLE, + schema=SampleIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = AnalysisPagedList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_project_sample_analyses_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_project_sample_analyses_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_project_sample_analyses_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_project_sample_analyses_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve the list of analyses. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_sample_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_reference, + request_query_userreference, + request_query_status, + request_query_usertag, + request_query_technicaltag, + request_query_referencetag, + request_query_page_offset, + request_query_page_token, + request_query_page_size, + request_query_sort, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetProjectSampleAnalyses(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_project_sample_analyses( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_project_sample_analyses( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_project_sample_analyses( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_project_sample_analyses( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_sample_analyses_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_sample_analyses_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_projects_project_id_samples_sample_id_analyses/get.pyi b/icasdk/paths/api_projects_project_id_samples_sample_id_analyses/get.pyi new file mode 100644 index 0000000..409090a --- /dev/null +++ b/icasdk/paths/api_projects_project_id_samples_sample_id_analyses/get.pyi @@ -0,0 +1,460 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.analysis_paged_list import AnalysisPagedList +from icasdk.model.problem import Problem + +# Query params +ReferenceSchema = schemas.StrSchema +UserreferenceSchema = schemas.StrSchema +StatusSchema = schemas.StrSchema +UsertagSchema = schemas.StrSchema +TechnicaltagSchema = schemas.StrSchema +ReferencetagSchema = schemas.StrSchema +PageOffsetSchema = schemas.StrSchema +PageTokenSchema = schemas.StrSchema +PageSizeSchema = schemas.StrSchema +SortSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'reference': typing.Union[ReferenceSchema, str, ], + 'userreference': typing.Union[UserreferenceSchema, str, ], + 'status': typing.Union[StatusSchema, str, ], + 'usertag': typing.Union[UsertagSchema, str, ], + 'technicaltag': typing.Union[TechnicaltagSchema, str, ], + 'referencetag': typing.Union[ReferencetagSchema, str, ], + 'pageOffset': typing.Union[PageOffsetSchema, str, ], + 'pageToken': typing.Union[PageTokenSchema, str, ], + 'pageSize': typing.Union[PageSizeSchema, str, ], + 'sort': typing.Union[SortSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_reference = api_client.QueryParameter( + name="reference", + style=api_client.ParameterStyle.FORM, + schema=ReferenceSchema, + explode=True, +) +request_query_userreference = api_client.QueryParameter( + name="userreference", + style=api_client.ParameterStyle.FORM, + schema=UserreferenceSchema, + explode=True, +) +request_query_status = api_client.QueryParameter( + name="status", + style=api_client.ParameterStyle.FORM, + schema=StatusSchema, + explode=True, +) +request_query_usertag = api_client.QueryParameter( + name="usertag", + style=api_client.ParameterStyle.FORM, + schema=UsertagSchema, + explode=True, +) +request_query_technicaltag = api_client.QueryParameter( + name="technicaltag", + style=api_client.ParameterStyle.FORM, + schema=TechnicaltagSchema, + explode=True, +) +request_query_referencetag = api_client.QueryParameter( + name="referencetag", + style=api_client.ParameterStyle.FORM, + schema=ReferencetagSchema, + explode=True, +) +request_query_page_offset = api_client.QueryParameter( + name="pageOffset", + style=api_client.ParameterStyle.FORM, + schema=PageOffsetSchema, + explode=True, +) +request_query_page_token = api_client.QueryParameter( + name="pageToken", + style=api_client.ParameterStyle.FORM, + schema=PageTokenSchema, + explode=True, +) +request_query_page_size = api_client.QueryParameter( + name="pageSize", + style=api_client.ParameterStyle.FORM, + schema=PageSizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +# Path params +ProjectIdSchema = schemas.StrSchema +SampleIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'projectId': typing.Union[ProjectIdSchema, str, ], + 'sampleId': typing.Union[SampleIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_project_id = api_client.PathParameter( + name="projectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProjectIdSchema, + required=True, +) +request_path_sample_id = api_client.PathParameter( + name="sampleId", + style=api_client.ParameterStyle.SIMPLE, + schema=SampleIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = AnalysisPagedList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_project_sample_analyses_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_project_sample_analyses_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_project_sample_analyses_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_project_sample_analyses_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve the list of analyses. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_project_id, + request_path_sample_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_reference, + request_query_userreference, + request_query_status, + request_query_usertag, + request_query_technicaltag, + request_query_referencetag, + request_query_page_offset, + request_query_page_token, + request_query_page_size, + request_query_sort, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetProjectSampleAnalyses(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_project_sample_analyses( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_project_sample_analyses( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_project_sample_analyses( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_project_sample_analyses( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_sample_analyses_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_project_sample_analyses_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_sequencing_runs_sequencing_run_id/__init__.py b/icasdk/paths/api_sequencing_runs_sequencing_run_id/__init__.py new file mode 100644 index 0000000..a4f59a1 --- /dev/null +++ b/icasdk/paths/api_sequencing_runs_sequencing_run_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_sequencing_runs_sequencing_run_id import Api + +from icasdk.paths import PathValues + +path = PathValues.API_SEQUENCING_RUNS_SEQUENCING_RUN_ID \ No newline at end of file diff --git a/icasdk/paths/api_sequencing_runs_sequencing_run_id/get.py b/icasdk/paths/api_sequencing_runs_sequencing_run_id/get.py new file mode 100644 index 0000000..8b20113 --- /dev/null +++ b/icasdk/paths/api_sequencing_runs_sequencing_run_id/get.py @@ -0,0 +1,341 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.sequencing_run import SequencingRun +from icasdk.model.problem import Problem + +from . import path + +# Path params +SequencingRunIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'sequencingRunId': typing.Union[SequencingRunIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_sequencing_run_id = api_client.PathParameter( + name="sequencingRunId", + style=api_client.ParameterStyle.SIMPLE, + schema=SequencingRunIdSchema, + required=True, +) +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +ETagSchema = schemas.StrSchema +e_tag_parameter = api_client.HeaderParameter( + name="ETag", + style=api_client.ParameterStyle.SIMPLE, + schema=ETagSchema, +) +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = SequencingRun +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'ETag': ETagSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, + headers=[ + e_tag_parameter, + ] +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_sequencing_run_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_sequencing_run_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_sequencing_run_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_sequencing_run_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve a sequencing run. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_sequencing_run_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetSequencingRun(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_sequencing_run( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_sequencing_run( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_sequencing_run( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_sequencing_run( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_sequencing_run_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_sequencing_run_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_sequencing_runs_sequencing_run_id/get.pyi b/icasdk/paths/api_sequencing_runs_sequencing_run_id/get.pyi new file mode 100644 index 0000000..50f19db --- /dev/null +++ b/icasdk/paths/api_sequencing_runs_sequencing_run_id/get.pyi @@ -0,0 +1,326 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.sequencing_run import SequencingRun +from icasdk.model.problem import Problem + +# Path params +SequencingRunIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'sequencingRunId': typing.Union[SequencingRunIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_sequencing_run_id = api_client.PathParameter( + name="sequencingRunId", + style=api_client.ParameterStyle.SIMPLE, + schema=SequencingRunIdSchema, + required=True, +) +ETagSchema = schemas.StrSchema +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = SequencingRun +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'ETag': ETagSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, + headers=[ + e_tag_parameter, + ] +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_sequencing_run_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_sequencing_run_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_sequencing_run_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_sequencing_run_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve a sequencing run. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_sequencing_run_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetSequencingRun(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_sequencing_run( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_sequencing_run( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_sequencing_run( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_sequencing_run( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_sequencing_run_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_sequencing_run_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_system_info/__init__.py b/icasdk/paths/api_system_info/__init__.py new file mode 100644 index 0000000..717a7d4 --- /dev/null +++ b/icasdk/paths/api_system_info/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from icasdk.paths.api_system_info import Api + +from icasdk.paths import PathValues + +path = PathValues.API_SYSTEM_INFO \ No newline at end of file diff --git a/icasdk/paths/api_system_info/get.py b/icasdk/paths/api_system_info/get.py new file mode 100644 index 0000000..9ff71b4 --- /dev/null +++ b/icasdk/paths/api_system_info/get.py @@ -0,0 +1,272 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.system_info import SystemInfo +from icasdk.model.problem import Problem + +from . import path + +_auth = [ + 'JwtAuth', + 'ApiKeyAuth', +] +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = SystemInfo + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_status_code_to_response = { + '200': _response_for_200, + 'default': _response_for_default, +} +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_system_info_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_system_info_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_system_info_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_system_info_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve system information. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetSystemInfo(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_system_info( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_system_info( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_system_info( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_system_info( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_system_info_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_system_info_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/icasdk/paths/api_system_info/get.pyi b/icasdk/paths/api_system_info/get.pyi new file mode 100644 index 0000000..5efbc9c --- /dev/null +++ b/icasdk/paths/api_system_info/get.pyi @@ -0,0 +1,262 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from icasdk import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from icasdk import schemas # noqa: F401 + +from icasdk.model.system_info import SystemInfo +from icasdk.model.problem import Problem + +SchemaFor200ResponseBodyApplicationVndIlluminaV3json = SystemInfo + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndIlluminaV3json, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.illumina.v3+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndIlluminaV3json), + }, +) +SchemaFor0ResponseBodyApplicationProblemjson = Problem + + +@dataclass +class ApiResponseForDefault(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor0ResponseBodyApplicationProblemjson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_default = api_client.OpenApiResponse( + response_cls=ApiResponseForDefault, + content={ + 'application/problem+json': api_client.MediaType( + schema=SchemaFor0ResponseBodyApplicationProblemjson), + }, +) +_all_accept_content_types = ( + 'application/problem+json', + 'application/vnd.illumina.v3+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_system_info_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def _get_system_info_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_system_info_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_system_info_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve system information. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + auth_settings=_auth, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + default_response = _status_code_to_response.get('default') + if default_response: + api_response = default_response.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException(api_response=api_response) + + return api_response + + +class GetSystemInfo(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_system_info( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get_system_info( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_system_info( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_system_info( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_system_info_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseForDefault, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_system_info_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/sample/sample.py b/sample/sample.py index b5113fb..378d1f0 100644 --- a/sample/sample.py +++ b/sample/sample.py @@ -1,11 +1,17 @@ import os - +from dotenv import load_dotenv import icasdk -from apis.tags import token_api, project_api, analysis_storage_api, project_pipeline_api +from icasdk.apis.tags import ( + token_api, + project_api, + analysis_storage_api, + project_pipeline_api, +) from icasdk import ApiException -from model.create_nextflow_pipeline import CreateNextflowPipeline +from icasdk.model.create_nextflow_pipeline import CreateNextflowPipeline -host = 'https://ica.illumina.com/ica/rest' +load_dotenv() +host = "https://ica.illumina.com/ica/rest" # Set API_KEY as an environment variable # It is best practice to exchange the API key with a JWT @@ -13,11 +19,11 @@ api_client=icasdk.ApiClient( icasdk.Configuration( host=host, - api_key={'ApiKeyAuth': os.getenv('API_KEY')}, + api_key={"ApiKeyAuth": os.getenv("APIKEY")}, ) ) ).create_jwt_token() -jwt = token_response.body.get_item_oapg('token') +jwt = token_response.body.get_item_oapg("token") # See configuration.py for a list of all supported configuration parameters. configuration = icasdk.Configuration( @@ -30,53 +36,77 @@ # Retrieve the list of projects. The results are paged. # Find project with name "DRAGEN Dev" # The program will halt at this point if the project is not found - project_name = 'DRAGEN Dev' + # project_name = "DRAGEN Dev" + project_name = "emedgene-demo" project_api_client = project_api.ProjectApi(api_client) - next_page_token = '' + next_page_token = "" while True: projects_response = project_api_client.get_projects( query_params={ - 'search': project_name, - 'pageToken': next_page_token, - } + "search": project_name, + "pageToken": next_page_token, + }, ) + print(projects_response) project_id = next( - (project.id for project in projects_response.body['items'] if project.name == project_name), - None + ( + project.id + for project in projects_response.body["items"] + if project.name == project_name + ), + None, ) if project_id is not None: break - next_page_token = projects_response.body.get_item_oapg('nextPageToken') + next_page_token = projects_response.body.get_item_oapg("nextPageToken") if not next_page_token: raise ValueError(f'Project with name "{project_name}" not found') # Find the ID for the small storage size - storage_options = analysis_storage_api.AnalysisStorageApi(api_client).get_analysis_storage_options() - small_storage_id = next(storage.id for storage in storage_options.body['items'] if storage.name == 'Small') + storage_options = analysis_storage_api.AnalysisStorageApi( + api_client + ).get_analysis_storage_options() + small_storage_id = next( + storage.id + for storage in storage_options.body["items"] + if storage.name == "Small" + ) # Deploy the sample pipeline # If the pipeline with the same name already exists, we'll get a 409 - pipeline_code = 'icasdk Sample DRAGEN pipeline' + pipeline_code = "icasdk Sample DRAGEN pipeline" try: - with open('sample-dragen.nf', 'rb') as main_wf_file, open('sample-dragen.xml', 'rb') as xml_file: - pipeline = project_pipeline_api.CreateNextflowPipeline(api_client).create_nextflow_pipeline( - body=CreateNextflowPipeline( - code=pipeline_code, - description='Sample DRAGEN pipeline', - parametersXmlFile=xml_file, - mainNextflowFile=main_wf_file, - analysisStorageId=small_storage_id, - ), - path_params={'projectId': project_id} - ).body.pipeline + with open("sample-dragen.nf", "rb") as main_wf_file, open( + "sample-dragen.xml", "rb" + ) as xml_file: + pipeline = ( + project_pipeline_api.CreateNextflowPipeline(api_client) + .create_nextflow_pipeline( + body=CreateNextflowPipeline( + code=pipeline_code, + description="Sample DRAGEN pipeline", + parametersXmlFile=xml_file, + mainNextflowFile=main_wf_file, + analysisStorageId=small_storage_id, + ), + path_params={"projectId": project_id}, + ) + .body.pipeline + ) except ApiException as e: if not e.status == 409: raise e - project_pipelines = project_pipeline_api.ProjectPipelineApi(api_client).get_project_pipelines( - path_params={'projectId': project_id}, + project_pipelines = project_pipeline_api.ProjectPipelineApi( + api_client + ).get_project_pipelines( + path_params={"projectId": project_id}, + ) + pipeline = next( + p.pipeline + for p in project_pipelines.body["items"] + if p.pipeline.code == pipeline_code ) - pipeline = next(p.pipeline for p in project_pipelines.body['items'] if p.pipeline.code == pipeline_code) print(pipeline) diff --git a/test-requirements.txt b/test-requirements.txt index f24aa61..2d88b03 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,4 +1,3 @@ pytest~=4.6.7 # needed for python 3.4 pytest-cov>=2.8.1 pytest-randomly==1.2.3 # needed for python 3.4 -python-dotenv==1.0.0 diff --git a/test/test_integration/test_projects.py b/test/test_integration/test_projects.py new file mode 100755 index 0000000..9fa8a30 --- /dev/null +++ b/test/test_integration/test_projects.py @@ -0,0 +1,41 @@ +import icasdk +from icasdk.apis.tags import project_api +from icasdk.model.project_paged_list import ProjectPagedList +from icasdk.model.problem import Problem +from pprint import pprint + +import os +from dotenv import load_dotenv + + +def test_get_projects(): + load_dotenv() + configuration = icasdk.Configuration(host="https://ica.illumina.com/ica/rest") + + # Configure HTTP basic authorization: BasicAuth + configuration.api_key["ApiKeyAuth"] = os.getenv("APIKEY") + with icasdk.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_api.ProjectApi(api_client) + project_name = "emedgene-demo" + next_page_token = "" + # example passing only optional values + query_params = { + "search": project_name, + "pageToken": next_page_token, + } + try: + # Retrieve a list of projects. + api_response = api_instance.get_projects(query_params=query_params) + pprint(api_response) + except icasdk.ApiException as e: + print("Exception when calling ProjectApi->get_projects: %s\n" % e) + + items = api_response.body["items"] + projectList = [] + for i in items: + projectList.append(i.get_item_oapg("id")) + pprint(i.get_item_oapg("id")) + + assert "test" in projectList + assert api_response.response.status == 200 diff --git a/test/test_models/test_create_project_data_update_batch.py b/test/test_models/test_create_project_data_update_batch.py new file mode 100644 index 0000000..9e336b0 --- /dev/null +++ b/test/test_models/test_create_project_data_update_batch.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.create_project_data_update_batch import CreateProjectDataUpdateBatch +from icasdk import configuration + + +class TestCreateProjectDataUpdateBatch(unittest.TestCase): + """CreateProjectDataUpdateBatch unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_create_project_permission_v4.py b/test/test_models/test_create_project_permission_v4.py new file mode 100644 index 0000000..eca64b2 --- /dev/null +++ b/test/test_models/test_create_project_permission_v4.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.create_project_permission_v4 import CreateProjectPermissionV4 +from icasdk import configuration + + +class TestCreateProjectPermissionV4(unittest.TestCase): + """CreateProjectPermissionV4 unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_data_update_group.py b/test/test_models/test_data_update_group.py new file mode 100644 index 0000000..e336d33 --- /dev/null +++ b/test/test_models/test_data_update_group.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.data_update_group import DataUpdateGroup +from icasdk import configuration + + +class TestDataUpdateGroup(unittest.TestCase): + """DataUpdateGroup unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_integer_settings.py b/test/test_models/test_integer_settings.py new file mode 100644 index 0000000..509ed5a --- /dev/null +++ b/test/test_models/test_integer_settings.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.integer_settings import IntegerSettings +from icasdk import configuration + + +class TestIntegerSettings(unittest.TestCase): + """IntegerSettings unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_option_settings.py b/test/test_models/test_option_settings.py new file mode 100644 index 0000000..de23003 --- /dev/null +++ b/test/test_models/test_option_settings.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.option_settings import OptionSettings +from icasdk import configuration + + +class TestOptionSettings(unittest.TestCase): + """OptionSettings unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_pipeline_file.py b/test/test_models/test_pipeline_file.py new file mode 100644 index 0000000..45525a4 --- /dev/null +++ b/test/test_models/test_pipeline_file.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.pipeline_file import PipelineFile +from icasdk import configuration + + +class TestPipelineFile(unittest.TestCase): + """PipelineFile unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_pipeline_file_content_spec.py b/test/test_models/test_pipeline_file_content_spec.py new file mode 100644 index 0000000..2cb5723 --- /dev/null +++ b/test/test_models/test_pipeline_file_content_spec.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.pipeline_file_content_spec import PipelineFileContentSpec +from icasdk import configuration + + +class TestPipelineFileContentSpec(unittest.TestCase): + """PipelineFileContentSpec unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_pipeline_file_list.py b/test/test_models/test_pipeline_file_list.py new file mode 100644 index 0000000..fe37d2c --- /dev/null +++ b/test/test_models/test_pipeline_file_list.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.pipeline_file_list import PipelineFileList +from icasdk import configuration + + +class TestPipelineFileList(unittest.TestCase): + """PipelineFileList unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_project_data_update_batch.py b/test/test_models/test_project_data_update_batch.py new file mode 100644 index 0000000..74a3df9 --- /dev/null +++ b/test/test_models/test_project_data_update_batch.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.project_data_update_batch import ProjectDataUpdateBatch +from icasdk import configuration + + +class TestProjectDataUpdateBatch(unittest.TestCase): + """ProjectDataUpdateBatch unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_project_data_update_batch_item.py b/test/test_models/test_project_data_update_batch_item.py new file mode 100644 index 0000000..6ac6470 --- /dev/null +++ b/test/test_models/test_project_data_update_batch_item.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.project_data_update_batch_item import ProjectDataUpdateBatchItem +from icasdk import configuration + + +class TestProjectDataUpdateBatchItem(unittest.TestCase): + """ProjectDataUpdateBatchItem unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_project_data_update_batch_item_paged_list.py b/test/test_models/test_project_data_update_batch_item_paged_list.py new file mode 100644 index 0000000..1af4572 --- /dev/null +++ b/test/test_models/test_project_data_update_batch_item_paged_list.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.project_data_update_batch_item_paged_list import ProjectDataUpdateBatchItemPagedList +from icasdk import configuration + + +class TestProjectDataUpdateBatchItemPagedList(unittest.TestCase): + """ProjectDataUpdateBatchItemPagedList unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_project_data_update_batch_item_processing.py b/test/test_models/test_project_data_update_batch_item_processing.py new file mode 100644 index 0000000..b02df75 --- /dev/null +++ b/test/test_models/test_project_data_update_batch_item_processing.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.project_data_update_batch_item_processing import ProjectDataUpdateBatchItemProcessing +from icasdk import configuration + + +class TestProjectDataUpdateBatchItemProcessing(unittest.TestCase): + """ProjectDataUpdateBatchItemProcessing unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_project_data_update_batch_item_request.py b/test/test_models/test_project_data_update_batch_item_request.py new file mode 100644 index 0000000..24eac16 --- /dev/null +++ b/test/test_models/test_project_data_update_batch_item_request.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.project_data_update_batch_item_request import ProjectDataUpdateBatchItemRequest +from icasdk import configuration + + +class TestProjectDataUpdateBatchItemRequest(unittest.TestCase): + """ProjectDataUpdateBatchItemRequest unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_project_permission_list_v4.py b/test/test_models/test_project_permission_list_v4.py new file mode 100644 index 0000000..8c0a546 --- /dev/null +++ b/test/test_models/test_project_permission_list_v4.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.project_permission_list_v4 import ProjectPermissionListV4 +from icasdk import configuration + + +class TestProjectPermissionListV4(unittest.TestCase): + """ProjectPermissionListV4 unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_project_permission_v4.py b/test/test_models/test_project_permission_v4.py new file mode 100644 index 0000000..199ce11 --- /dev/null +++ b/test/test_models/test_project_permission_v4.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.project_permission_v4 import ProjectPermissionV4 +from icasdk import configuration + + +class TestProjectPermissionV4(unittest.TestCase): + """ProjectPermissionV4 unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_settings.py b/test/test_models/test_settings.py new file mode 100644 index 0000000..4383e7b --- /dev/null +++ b/test/test_models/test_settings.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.settings import Settings +from icasdk import configuration + + +class TestSettings(unittest.TestCase): + """Settings unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_string_settings.py b/test/test_models/test_string_settings.py new file mode 100644 index 0000000..b3d8816 --- /dev/null +++ b/test/test_models/test_string_settings.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.string_settings import StringSettings +from icasdk import configuration + + +class TestStringSettings(unittest.TestCase): + """StringSettings unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_system_info.py b/test/test_models/test_system_info.py new file mode 100644 index 0000000..0130c2f --- /dev/null +++ b/test/test_models/test_system_info.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.system_info import SystemInfo +from icasdk import configuration + + +class TestSystemInfo(unittest.TestCase): + """SystemInfo unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_tag_update.py b/test/test_models/test_tag_update.py new file mode 100644 index 0000000..ecfaad7 --- /dev/null +++ b/test/test_models/test_tag_update.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.tag_update import TagUpdate +from icasdk import configuration + + +class TestTagUpdate(unittest.TestCase): + """TagUpdate unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_models/test_terms_of_use_acceptance.py b/test/test_models/test_terms_of_use_acceptance.py new file mode 100644 index 0000000..033b46a --- /dev/null +++ b/test/test_models/test_terms_of_use_acceptance.py @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + ICA Rest API + + This API can be used to interact with Illumina Connected Analytics.

Authentication

Authentication to the API can be done in multiple ways:

API-key

API keys are managed within the Illumina portal where you can manage your profile after you have logged on. The API-key has to be provided in the X-API-Key header parameter when executing API calls to ICA. In the background, a JWT will be requested at the IDP of Illumina to create a session. A good practice is to not use the API-key for every API call, but to first generate a JWT and to use that for authentication in subsequent calls.

JWT

To avoid using an API-key for each call, we recommend to request a JWT via the POST /tokens endpoint using this API-key. The JWT will expire after a pre-configured period specified by a tenant administrator through the IAM console in the Illumina portal. The JWT is the preferred way for authentication.
A not yet expired, still valid JWT could be refreshed using the POST /tokens:refresh endpoint.
Refreshing the JWT is not possible if the JWT was generated by using an API-key.

Basic Authentication

Basic authentication is only supported by the POST /tokens endpoint for generating a JWT. Use \"Basic base64encoded(emailaddress:password)\" in the \"Authorization\" header parameter for this authentication method. In case having access to multiple tenants using the same email-address, also provide the \"tenant\" request parameter to indicate what tenant you would like to request a JWT for.

Compression

If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

# noqa: E501 + + The version of the OpenAPI document: 3 + Generated by: https://openapi-generator.tech +""" + +import unittest + +import icasdk +from icasdk.model.terms_of_use_acceptance import TermsOfUseAcceptance +from icasdk import configuration + + +class TestTermsOfUseAcceptance(unittest.TestCase): + """TermsOfUseAcceptance unit test stubs""" + _configuration = configuration.Configuration() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/__init__.py b/test/test_paths/test_api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/test_get.py b/test/test_paths/test_api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/test_get.py new file mode 100644 index 0000000..a7a6109 --- /dev/null +++ b/test/test_paths/test_api_bundles_bundle_id_terms_of_use_user_acceptance_current_user/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_bundles_bundle_id_terms_of_use_user_acceptance_current_user import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiBundlesBundleIdTermsOfUseUserAcceptanceCurrentUser(ApiTestMixin, unittest.TestCase): + """ + ApiBundlesBundleIdTermsOfUseUserAcceptanceCurrentUser unit test stubs + Retrieve the acceptance record for a bundle for the current user. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_bundles_bundle_id_terms_of_useaccept/__init__.py b/test/test_paths/test_api_bundles_bundle_id_terms_of_useaccept/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_bundles_bundle_id_terms_of_useaccept/test_post.py b/test/test_paths/test_api_bundles_bundle_id_terms_of_useaccept/test_post.py new file mode 100644 index 0000000..a84a17c --- /dev/null +++ b/test/test_paths/test_api_bundles_bundle_id_terms_of_useaccept/test_post.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_bundles_bundle_id_terms_of_useaccept import post # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiBundlesBundleIdTermsOfUseaccept(ApiTestMixin, unittest.TestCase): + """ + ApiBundlesBundleIdTermsOfUseaccept unit test stubs + accept terms of use for a bundle # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = post.ApiForpost(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 204 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_pipelines_pipeline_id_files/__init__.py b/test/test_paths/test_api_pipelines_pipeline_id_files/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_pipelines_pipeline_id_files/test_get.py b/test/test_paths/test_api_pipelines_pipeline_id_files/test_get.py new file mode 100644 index 0000000..d123187 --- /dev/null +++ b/test/test_paths/test_api_pipelines_pipeline_id_files/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_pipelines_pipeline_id_files import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiPipelinesPipelineIdFiles(ApiTestMixin, unittest.TestCase): + """ + ApiPipelinesPipelineIdFiles unit test stubs + Retrieve files for a pipeline. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_pipelines_pipeline_id_files_file_id_content/__init__.py b/test/test_paths/test_api_pipelines_pipeline_id_files_file_id_content/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_pipelines_pipeline_id_files_file_id_content/test_get.py b/test/test_paths/test_api_pipelines_pipeline_id_files_file_id_content/test_get.py new file mode 100644 index 0000000..d172b20 --- /dev/null +++ b/test/test_paths/test_api_pipelines_pipeline_id_files_file_id_content/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_pipelines_pipeline_id_files_file_id_content import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiPipelinesPipelineIdFilesFileIdContent(ApiTestMixin, unittest.TestCase): + """ + ApiPipelinesPipelineIdFilesFileIdContent unit test stubs + Download the contents of a pipeline file. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_data_data_idcreate_temporary_credentials/test_post.py b/test/test_paths/test_api_projects_project_id_data_data_idcreate_temporary_credentials/test_post.py index 90d4d17..9a57610 100644 --- a/test/test_paths/test_api_projects_project_id_data_data_idcreate_temporary_credentials/test_post.py +++ b/test/test_paths/test_api_projects_project_id_data_data_idcreate_temporary_credentials/test_post.py @@ -37,9 +37,5 @@ def tearDown(self): - - - - if __name__ == '__main__': unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_data_update_batch/__init__.py b/test/test_paths/test_api_projects_project_id_data_update_batch/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_projects_project_id_data_update_batch/test_post.py b/test/test_paths/test_api_projects_project_id_data_update_batch/test_post.py new file mode 100644 index 0000000..f75b934 --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_data_update_batch/test_post.py @@ -0,0 +1,45 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_data_update_batch import post # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdDataUpdateBatch(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdDataUpdateBatch unit test stubs + Create a project data update batch. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = post.ApiForpost(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 201 + + + + + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id/__init__.py b/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id/test_get.py b/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id/test_get.py new file mode 100644 index 0000000..08dd8df --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_data_update_batch_batch_id import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdDataUpdateBatchBatchId(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdDataUpdateBatchBatchId unit test stubs + Retrieve a project data update batch. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items/__init__.py b/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items/test_get.py b/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items/test_get.py new file mode 100644 index 0000000..e56b5a3 --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_data_update_batch_batch_id_items import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdDataUpdateBatchBatchIdItems(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdDataUpdateBatchBatchIdItems unit test stubs + Retrieve a list of project data update batch items. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items_item_id/__init__.py b/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items_item_id/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items_item_id/test_get.py b/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items_item_id/test_get.py new file mode 100644 index 0000000..e3f4c6b --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_data_update_batch_batch_id_items_item_id/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_data_update_batch_batch_id_items_item_id import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdDataUpdateBatchBatchIdItemsItemId(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdDataUpdateBatchBatchIdItemsItemId unit test stubs + Retrieve a project data update batch item. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_permissions/test_get.py b/test/test_paths/test_api_projects_project_id_permissions/test_get.py index 1137850..d487e32 100644 --- a/test/test_paths/test_api_projects_project_id_permissions/test_get.py +++ b/test/test_paths/test_api_projects_project_id_permissions/test_get.py @@ -37,5 +37,7 @@ def tearDown(self): + + if __name__ == '__main__': unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_permissions/test_post.py b/test/test_paths/test_api_projects_project_id_permissions/test_post.py index e8d6766..b8f3568 100644 --- a/test/test_paths/test_api_projects_project_id_permissions/test_post.py +++ b/test/test_paths/test_api_projects_project_id_permissions/test_post.py @@ -41,5 +41,9 @@ def tearDown(self): + + + + if __name__ == '__main__': unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_permissions_permission_id/test_get.py b/test/test_paths/test_api_projects_project_id_permissions_permission_id/test_get.py index a2bf6c8..569994b 100644 --- a/test/test_paths/test_api_projects_project_id_permissions_permission_id/test_get.py +++ b/test/test_paths/test_api_projects_project_id_permissions_permission_id/test_get.py @@ -37,5 +37,7 @@ def tearDown(self): + + if __name__ == '__main__': unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_permissions_permission_id/test_put.py b/test/test_paths/test_api_projects_project_id_permissions_permission_id/test_put.py index 854de73..011e12d 100644 --- a/test/test_paths/test_api_projects_project_id_permissions_permission_id/test_put.py +++ b/test/test_paths/test_api_projects_project_id_permissions_permission_id/test_put.py @@ -41,5 +41,9 @@ def tearDown(self): + + + + if __name__ == '__main__': unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/__init__.py b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/test_get.py b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/test_get.py new file mode 100644 index 0000000..c317229 --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdPipelinesPipelineIdFiles(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdPipelinesPipelineIdFiles unit test stubs + Retrieve files for a project pipeline. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/test_post.py b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/test_post.py new file mode 100644 index 0000000..43e8047 --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files/test_post.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files import post # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdPipelinesPipelineIdFiles(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdPipelinesPipelineIdFiles unit test stubs + Create a file for a pipeline. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = post.ApiForpost(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 201 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id/__init__.py b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id/test_delete.py b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id/test_delete.py new file mode 100644 index 0000000..fefed40 --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id/test_delete.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id import delete # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdPipelinesPipelineIdFilesFileId(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdPipelinesPipelineIdFilesFileId unit test stubs + Delete a file for a pipeline. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = delete.ApiFordelete(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 204 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/__init__.py b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/test_get.py b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/test_get.py new file mode 100644 index 0000000..772d82d --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id_content import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdPipelinesPipelineIdFilesFileIdContent(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdPipelinesPipelineIdFilesFileIdContent unit test stubs + Download the contents of a pipeline file. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/test_put.py b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/test_put.py new file mode 100644 index 0000000..54ecb6d --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_pipelines_pipeline_id_files_file_id_content/test_put.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_pipelines_pipeline_id_files_file_id_content import put # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdPipelinesPipelineIdFilesFileIdContent(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdPipelinesPipelineIdFilesFileIdContent unit test stubs + Update the contents of a file for a pipeline. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = put.ApiForput(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_projects_project_id_samples_sample_id_analyses/__init__.py b/test/test_paths/test_api_projects_project_id_samples_sample_id_analyses/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_projects_project_id_samples_sample_id_analyses/test_get.py b/test/test_paths/test_api_projects_project_id_samples_sample_id_analyses/test_get.py new file mode 100644 index 0000000..ab41eb4 --- /dev/null +++ b/test/test_paths/test_api_projects_project_id_samples_sample_id_analyses/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_projects_project_id_samples_sample_id_analyses import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiProjectsProjectIdSamplesSampleIdAnalyses(ApiTestMixin, unittest.TestCase): + """ + ApiProjectsProjectIdSamplesSampleIdAnalyses unit test stubs + Retrieve the list of analyses. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_sequencing_runs_sequencing_run_id/__init__.py b/test/test_paths/test_api_sequencing_runs_sequencing_run_id/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_sequencing_runs_sequencing_run_id/test_get.py b/test/test_paths/test_api_sequencing_runs_sequencing_run_id/test_get.py new file mode 100644 index 0000000..8e7dc4d --- /dev/null +++ b/test/test_paths/test_api_sequencing_runs_sequencing_run_id/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_sequencing_runs_sequencing_run_id import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiSequencingRunsSequencingRunId(ApiTestMixin, unittest.TestCase): + """ + ApiSequencingRunsSequencingRunId unit test stubs + Retrieve a sequencing run. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paths/test_api_system_info/__init__.py b/test/test_paths/test_api_system_info/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_paths/test_api_system_info/test_get.py b/test/test_paths/test_api_system_info/test_get.py new file mode 100644 index 0000000..e281275 --- /dev/null +++ b/test/test_paths/test_api_system_info/test_get.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +import unittest +from unittest.mock import patch + +import urllib3 + +import icasdk +from icasdk.paths.api_system_info import get # noqa: E501 +from icasdk import configuration, schemas, api_client + +from .. import ApiTestMixin + + +class TestApiSystemInfo(ApiTestMixin, unittest.TestCase): + """ + ApiSystemInfo unit test stubs + Retrieve system information. # noqa: E501 + """ + _configuration = configuration.Configuration() + + def setUp(self): + used_api_client = api_client.ApiClient(configuration=self._configuration) + self.api = get.ApiForget(api_client=used_api_client) # noqa: E501 + + def tearDown(self): + pass + + response_status = 200 + + + + +if __name__ == '__main__': + unittest.main() From c6d66f3aaa3f4e629ff99717d5f8b4bc991b41e4 Mon Sep 17 00:00:00 2001 From: kcutler Date: Tue, 5 Sep 2023 15:48:43 -0700 Subject: [PATCH 2/5] add dotenv --- test-requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/test-requirements.txt b/test-requirements.txt index 2d88b03..f24aa61 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,3 +1,4 @@ pytest~=4.6.7 # needed for python 3.4 pytest-cov>=2.8.1 pytest-randomly==1.2.3 # needed for python 3.4 +python-dotenv==1.0.0 From c708d3f6fa30d95d33eb3fd5e03ebcab6e663317 Mon Sep 17 00:00:00 2001 From: kcutler Date: Tue, 5 Sep 2023 15:51:09 -0700 Subject: [PATCH 3/5] remove sample --- .gitignore | 8 - sample/sample-dragen.nf | 50 ----- sample/sample-dragen.xml | 33 --- sample/sample.py | 112 ---------- sample/sdk_basic_tutorial.md | 402 ----------------------------------- sample/tutorial.md | 0 6 files changed, 605 deletions(-) delete mode 100644 sample/sample-dragen.nf delete mode 100644 sample/sample-dragen.xml delete mode 100644 sample/sample.py delete mode 100644 sample/sdk_basic_tutorial.md delete mode 100644 sample/tutorial.md diff --git a/.gitignore b/.gitignore index 48c25b1..a62e8ab 100644 --- a/.gitignore +++ b/.gitignore @@ -65,11 +65,3 @@ target/ #Ipython Notebook .ipynb_checkpoints -test/.vs/VSWorkspaceState.json -test/.vs/test/v17/workspaceFileList.bin -test/.vs/test/v17/.wsuo -test/.vs/test/FileContentIndex/read.lock -test/.vs/test/FileContentIndex/c26a4ef8-52f5-4d99-9c90-b88d216688e1.vsidx -test/.vs/test/FileContentIndex/435f8305-4f9b-4638-b89d-50fcb0654a7d.vsidx -test/.vs/slnx.sqlite -test/.vs/ProjectSettings.json diff --git a/sample/sample-dragen.nf b/sample/sample-dragen.nf deleted file mode 100644 index c934e17..0000000 --- a/sample/sample-dragen.nf +++ /dev/null @@ -1,50 +0,0 @@ -nextflow.enable.dsl = 2 - -params.ref_tar = "NO_TAR" -params.read1 = "NO_READ1" -params.read2 = "NO_READ2" -params.sample_id = "dragen" - -process DRAGEN { - - container '102576526753.dkr.ecr.us-east-1.amazonaws.com/dragen/dragen:3.9.5-159' - pod annotation: 'scheduler.illumina.com/presetSize', value: 'fpga-medium' - - publishDir "out", mode: "copy" - - input: - tuple path(read1),path(read2) - val sample_id - path ref_tar - - output: - stdout emit: result - path '*', emit: output - - script: - """ - set -ex - mkdir -p /scratch/reference - tar -C /scratch/reference -xf ${ref_tar} - - /opt/edico/bin/dragen --partial-reconfig HMM --ignore-version-check true - /opt/edico/bin/dragen --lic-instance-id-location /opt/instance-identity \\ - --output-directory ./ \\ - -1 ${read1} \\ - -2 ${read2} \\ - --intermediate-results-dir /scratch \\ - --output-file-prefix ${sample_id} \\ - --RGID ${sample_id} \\ - --RGSM ${sample_id} \\ - --ref-dir /scratch/reference \\ - --enable-variant-caller true - """ -} - -workflow { - DRAGEN( - Channel.of([file(params.read1), file(params.read2)]), - Channel.of(params.sample_id), - Channel.fromPath(params.ref_tar) - ) -} \ No newline at end of file diff --git a/sample/sample-dragen.xml b/sample/sample-dragen.xml deleted file mode 100644 index 76dceee..0000000 --- a/sample/sample-dragen.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - FASTQ Read 1 - FASTQ Read 1 - - - FASTQ Read 2 - FASTQ Read 2 - - - Reference - Reference TAR - - - - - General - - - General Parameters - - - Sample ID - - - - - - - - \ No newline at end of file diff --git a/sample/sample.py b/sample/sample.py deleted file mode 100644 index 378d1f0..0000000 --- a/sample/sample.py +++ /dev/null @@ -1,112 +0,0 @@ -import os -from dotenv import load_dotenv -import icasdk -from icasdk.apis.tags import ( - token_api, - project_api, - analysis_storage_api, - project_pipeline_api, -) -from icasdk import ApiException -from icasdk.model.create_nextflow_pipeline import CreateNextflowPipeline - -load_dotenv() -host = "https://ica.illumina.com/ica/rest" - -# Set API_KEY as an environment variable -# It is best practice to exchange the API key with a JWT -token_response = token_api.CreateJwtToken( - api_client=icasdk.ApiClient( - icasdk.Configuration( - host=host, - api_key={"ApiKeyAuth": os.getenv("APIKEY")}, - ) - ) -).create_jwt_token() -jwt = token_response.body.get_item_oapg("token") - -# See configuration.py for a list of all supported configuration parameters. -configuration = icasdk.Configuration( - host=host, - access_token=jwt, -) - -# Enter a context with an instance of the API client -with icasdk.ApiClient(configuration) as api_client: - # Retrieve the list of projects. The results are paged. - # Find project with name "DRAGEN Dev" - # The program will halt at this point if the project is not found - # project_name = "DRAGEN Dev" - project_name = "emedgene-demo" - project_api_client = project_api.ProjectApi(api_client) - next_page_token = "" - while True: - projects_response = project_api_client.get_projects( - query_params={ - "search": project_name, - "pageToken": next_page_token, - }, - ) - print(projects_response) - project_id = next( - ( - project.id - for project in projects_response.body["items"] - if project.name == project_name - ), - None, - ) - if project_id is not None: - break - - next_page_token = projects_response.body.get_item_oapg("nextPageToken") - if not next_page_token: - raise ValueError(f'Project with name "{project_name}" not found') - - # Find the ID for the small storage size - storage_options = analysis_storage_api.AnalysisStorageApi( - api_client - ).get_analysis_storage_options() - small_storage_id = next( - storage.id - for storage in storage_options.body["items"] - if storage.name == "Small" - ) - - # Deploy the sample pipeline - # If the pipeline with the same name already exists, we'll get a 409 - pipeline_code = "icasdk Sample DRAGEN pipeline" - try: - with open("sample-dragen.nf", "rb") as main_wf_file, open( - "sample-dragen.xml", "rb" - ) as xml_file: - pipeline = ( - project_pipeline_api.CreateNextflowPipeline(api_client) - .create_nextflow_pipeline( - body=CreateNextflowPipeline( - code=pipeline_code, - description="Sample DRAGEN pipeline", - parametersXmlFile=xml_file, - mainNextflowFile=main_wf_file, - analysisStorageId=small_storage_id, - ), - path_params={"projectId": project_id}, - ) - .body.pipeline - ) - except ApiException as e: - if not e.status == 409: - raise e - - project_pipelines = project_pipeline_api.ProjectPipelineApi( - api_client - ).get_project_pipelines( - path_params={"projectId": project_id}, - ) - pipeline = next( - p.pipeline - for p in project_pipelines.body["items"] - if p.pipeline.code == pipeline_code - ) - - print(pipeline) diff --git a/sample/sdk_basic_tutorial.md b/sample/sdk_basic_tutorial.md deleted file mode 100644 index 34d6ac0..0000000 --- a/sample/sdk_basic_tutorial.md +++ /dev/null @@ -1,402 +0,0 @@ -# Introduction to ICA Python SDK - -### Areas Covered -- Installation and Authentication -- Projects -- Project Data -- Project Pipelines -- Project Analysis - - -### Installation and Authentication -#### How to download and install ICA Python SDK -You can access the git repository for the ICA Python SDK at the following link [Illumina Git](https://github.com/Illumina) - -**Install using pip** -``` bash -pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git -``` -(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git) -Then import the package: - -``` bash -import icasdk -``` - -**Install using Setuptools** -``` python -python setup.py install --user -``` -``` -sudo python setup.py install -``` -Then import the pacakage: -``` bash -import icasdk -``` - -#### How to generate a JWT token using APIKEY or Username/Password - -After install the SDK and confirming the package is imported you can use the APIKEY from platform authentication to generate a JWT -Adapted from [Link to TokenApi](https://git.illumina.com/SEES/ica-sdk-python/blob/main/docs/apis/tags/TokenApi.md) - -Via APIKEY -``` python -import icasdk -from icasdk.apis.tags import token_api -from icasdk.model.token import Token -from icasdk.model.problem import Problem -from pprint import pprint - -# Defining the host is optional and defaults to /ica/rest -# See configuration.py for a list of all supported configuration parameters. -configuration = icasdk.Configuration(host="https://ica.illumina.com/ica/rest") - -# Configure API key authorization: ApiKeyAuth -configuration.api_key["ApiKeyAuth"] = "APIKEY" - -# Enter a context with an instance of the API client -with icasdk.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = token_api.TokenApi(api_client) - - # example passing only optional values - query_params = { - "tenant": "TENANT", - } - try: - # Generate a JWT using an API-key, Basic Authentication or a psToken. - api_response = api_instance.create_jwt_token( - query_params=query_params, - ) - pprint(api_response) - jwt = api_response.body["token"] - except icasdk.ApiException as e: - print("Exception when calling TokenApi->create_jwt_token: %s\n" % e) -``` -Via Username and Password -``` python -import icasdk -from icasdk.apis.tags import token_api -from icasdk.model.token import Token -from icasdk.model.problem import Problem -from pprint import pprint - -# Defining the host is optional and defaults to /ica/rest -# See configuration.py for a list of all supported configuration parameters. -configuration = icasdk.Configuration(host="https://ica.illumina.com/ica/rest") - -# Configure HTTP basic authorization: BasicAuth -configuration.username = "USERNAME" -configuration.password = "PASSWORD" -configuration.access_token = None - -# Enter a context with an instance of the API client -with icasdk.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = token_api.TokenApi(api_client) - - # example passing only optional values - query_params = { - "tenant": "TENANT", - } - try: - # Generate a JWT using an API-key, Basic Authentication or a psToken. - api_response = api_instance.create_jwt_token( - query_params=query_params, - ) - pprint(api_response) - jwt = api_response.body["token"] - except icasdk.ApiException as e: - print("Exception when calling TokenApi->create_jwt_token: %s\n" % e) -``` - -### Projects -Adapted from [Link to ProjectApi](https://git.illumina.com/SEES/ica-sdk-python/blob/main/docs/apis/tags/ProjectApi.md) - -#### How to create a new project -Required parameters to create a project via API request -- name (User Supplied String) -- storageBundleId (Explained below) -- billingMode( Only option is "Project") -- dataSharingEnabled (True or False) -- regionId (Based on desired ICA regions, explained below) - -You can use the storageBunldeId API endpoint to grab both the storageBundleId and associated region, as seen below. Data sharing mode allows you to bundle data for cross-project or cross-tenant data sharing. - -``` python -import icasdk -from icasdk.apis.tags import project_api -from icasdk.model.create_project import CreateProject -from icasdk.model.project import Project -from icasdk.model.problem import Problem -from icasdk.apis.tags import storage_bundle_api -from icasdk.model.storage_bundle_list import StorageBundleList -from pprint import pprint - -# Defining the host is optional and defaults to /ica/rest -# See configuration.py for a list of all supported configuration parameters. -configuration = icasdk.Configuration(host="https://ica.illumina.com/ica/rest") - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: ApiKeyAuth -configuration.api_key["ApiKeyAuth"] = "YOUR_API_KEY" - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' - -# Enter a context with an instance of the API client -with icasdk.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = storage_bundle_api.StorageBundleApi(api_client) - try: - # Retrieve a list of storage bundles. - api_response = api_instance.get_storage_bundles() - pprint(api_response) - items = api_response.body["items"] - for i in items: - pprint(f"storageBundleName:Id={i.entitlementName}:{i.id}") - pprint(f"regionName:Id={i.region.country.name}:{i.region.id}") - storageId = i.id - regionId = i.region.id - - except icasdk.ApiException as e: - print("Exception when calling StorageBundleApi->get_storage_bundles: %s\n" % e) - - api_instance = project_api.ProjectApi(api_client) - - # example passing only optional values - body = { - "name": "ProjectTestName", - "regionId": regionId, - "billingMode": "PROJECT", - "dataSharingEnabled": True, - "storageBundleId": storageId, - } - try: - # Create a new project. - api_response = api_instance.create_project( - body=body, - ) - pprint(api_response) - except icasdk.ApiException as e: - print("Exception when calling ProjectApi->create_project: %s\n" % e) -``` - -#### How to list projects and find project ID -``` python -import icasdk -from icasdk.apis.tags import project_api -from icasdk.model.problem import Problem -from icasdk.model.project_paged_list import ProjectPagedList -from pprint import pprint -configuration = icasdk.Configuration(host="https://ica.illumina.com/ica/rest") - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: ApiKeyAuth -configuration.api_key["ApiKeyAuth"] = "YOUR_API_KEY" - -with icasdk.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = project_api.ProjectApi(api_client) - - # example passing only optional values - query_params = {"pageSize": "50"} - try: - # Retrieve a list of projects. - api_response = api_instance.get_projects( - query_params=query_params, - ) - pprint(api_response) - for i in api_response.body["items"]: - pprint(f"{i.name}:{i.id}") - except icasdk.ApiException as e: - print("Exception when calling ProjectApi->get_projects: %s\n" % e) - -``` - - - -### Project Data -Adapated from [Project Data Api](https://git.illumina.com/SEES/ica-sdk-python/blob/main/docs/apis/tags/ProjectDataApi.md) -#### How to list data and search within a project -There are several options for how to search through folders and data using combinations of file paths, full text search, filePathMatchModes which can be case sensitive or insensitive -```python -import icasdk -from icasdk.apis.tags import project_data_api -from icasdk.model.project_data_paged_list import ProjectDataPagedList -from icasdk.model.problem import Problem -from pprint import pprint - -# Defining the host is optional and defaults to /ica/rest -# See configuration.py for a list of all supported configuration parameters. -configuration = icasdk.Configuration(host="https://ica.illumina.com/ica/rest") - -# Configure API key authorization: ApiKeyAuth -configuration.api_key["ApiKeyAuth"] = "YOUR_API_KEY" - -# Enter a context with an instance of the API client -with icasdk.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = project_data_api.ProjectDataApi(api_client) - - projectId = "e501a0d5-f5e7-458c-a590-586c79bb87e0" - # example passing only required values which don't have defaults set - path_params = { - "projectId": projectId, - } - query_params = {} - try: - # Retrieve the list of project data. - api_response = api_instance.get_project_data_list( - path_params=path_params, - query_params=query_params, - ) - pprint(api_response) - except icasdk.ApiException as e: - print("Exception when calling ProjectDataApi->get_project_data_list: %s\n" % e) - - # example passing only optional values - path_params = { - "projectId": projectId, - } - query_params = {"fullText": ".gvcf", "pageSize": "100"} - try: - # Retrieve the list of project data. - api_response = api_instance.get_project_data_list( - path_params=path_params, - query_params=query_params, - ) - pprint(api_response) - for i in api_response.body["items"]: - print( - f"{i.data.get_item_oapg('details').get_item_oapg('path')}/{i.data.get_item_oapg('details').name}" - ) - except icasdk.ApiException as e: - print("Exception when calling ProjectDataApi->get_project_data_list: %s\n" % e) - -``` - -#### How to download a set of data from a project -Building on the previous code snippet of how to get a list of data from a project, you can create download URLs and download a list of files -```python -import icasdk -from icasdk.apis.tags import project_data_api -from icasdk.model.project_data_paged_list import ProjectDataPagedList -from icasdk.model.problem import Problem -from pprint import pprint - -from icasdk.model.download import Download -import requests - -# Defining the host is optional and defaults to /ica/rest -# See configuration.py for a list of all supported configuration parameters. -configuration = icasdk.Configuration(host="https://ica.illumina.com/ica/rest") - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: ApiKeyAuth -configuration.api_key["ApiKeyAuth"] = "YOUR_API_KEY" - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' - - -# Enter a context with an instance of the API client -with icasdk.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = project_data_api.ProjectDataApi(api_client) - - projectId = "e501a0d5-f5e7-458c-a590-586c79bb87e0" - # example passing only required values which don't have defaults set - path_params = { - "projectId": projectId, - } - query_params = {} - try: - # Retrieve the list of project data. - api_response = api_instance.get_project_data_list( - path_params=path_params, - query_params=query_params, - ) - # pprint(api_response) - except icasdk.ApiException as e: - print("Exception when calling ProjectDataApi->get_project_data_list: %s\n" % e) - - # example passing only optional values - path_params = { - "projectId": projectId, - } - query_params = {"fullText": ".gvcf", "pageSize": "5"} - try: - # Retrieve the list of project data. - api_response = api_instance.get_project_data_list( - path_params=path_params, - query_params=query_params, - ) - # pprint(api_response) - fileList = {} - for i in api_response.body["items"]: - # fileList[ - # f"{i.data.get_item_oapg('details').get_item_oapg('path')}/{i.data.get_item_oapg('details').name}" - # ] = i.data.get_item_oapg("id") - fileList[i.data.get_item_oapg("id")] = { - "path": i.data.get_item_oapg("details").get_item_oapg("path"), - "name": i.data.get_item_oapg("details").name, - } - print(i.data.get_item_oapg("id")) - print( - f"{i.data.get_item_oapg('details').get_item_oapg('path')}/{i.data.get_item_oapg('details').name}" - ) - except icasdk.ApiException as e: - print("Exception when calling ProjectDataApi->get_project_data_list: %s\n" % e) - - try: - # Retrieve a download URL for this data. - for file in fileList: - api_response = api_instance.create_download_url_for_data( - path_params={ - "projectId": projectId, - "dataId": file, - } - ) - # pprint(api_response) - url = api_response.body["url"] - pprint(url) - response = requests.get(url) - fileName = fileList[file]["name"] - open(fileName, "wb").write(response.content) - - except icasdk.ApiException as e: - print( - "Exception when calling ProjectDataApi->create_download_url_for_data: %s\n" - % e - ) - -``` - - -### Project Pipelines -How to upload a CWL pipeline - -How to upload a Nextflow pipeline - -How to retrieve input parameters for a pipeline - -### Project Analysis -How to get the status of an analyses - -How to launch a CWL pipeline - -How to launch a Nextflow pipeline diff --git a/sample/tutorial.md b/sample/tutorial.md deleted file mode 100644 index e69de29..0000000 From b449649c1319201fd13d6cd135ef81c1431693cc Mon Sep 17 00:00:00 2001 From: kcutler Date: Tue, 5 Sep 2023 16:29:36 -0700 Subject: [PATCH 4/5] updated specs --- openapi_public.yaml | 1232 ++++++++++++++++++++++-- test/test_integration/test_projects.py | 2 +- 2 files changed, 1127 insertions(+), 107 deletions(-) diff --git a/openapi_public.yaml b/openapi_public.yaml index 5e41ffd..b96772f 100644 --- a/openapi_public.yaml +++ b/openapi_public.yaml @@ -187,6 +187,30 @@ paths: application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/Bundle' + /api/bundles/{bundleId}/termsOfUse:accept: + post: + tags: + - Bundle + summary: accept terms of use for a bundle + operationId: acceptTermsOfUseBundle + parameters: + - name: bundleId + in: path + description: The ID of the bundle where the terms of use are accepted of. + required: true + schema: + type: string + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "204": + description: The terms of use of the bundle is accepted + content: + application/vnd.illumina.v3+json: {} /api/bundles/{bundleId}:release: post: tags: @@ -238,6 +262,32 @@ paths: application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/TermsOfUse' + /api/bundles/{bundleId}/termsOfUse/userAcceptance/currentUser: + get: + tags: + - Bundle + summary: Retrieve the acceptance record for a bundle for the current user. + operationId: getTermsOfUseAcceptance + parameters: + - name: bundleId + in: path + description: The ID of the bundle of the terms of use acceptance records. + required: true + schema: + type: string + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: Terms of use acceptance is successfully retrieved. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/TermsOfUseAcceptance' /api/bundles/{bundleId}/termsOfUse:new: post: tags: @@ -2432,6 +2482,72 @@ paths: application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/PipelineHtmlDocumentation' + /api/pipelines/{pipelineId}/files: + get: + tags: + - Pipeline + summary: Retrieve files for a pipeline. + operationId: getPipelineFiles + parameters: + - name: pipelineId + in: path + description: The ID of the project pipeline to retrieve files for + required: true + schema: + type: string + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The files are successfully retrieved. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/PipelineFileList' + /api/pipelines/{pipelineId}/files/{fileId}/content: + get: + tags: + - Pipeline + summary: Download the contents of a pipeline file. + operationId: downloadPipelineFileContent + parameters: + - name: pipelineId + in: path + description: The ID of the project pipeline to retrieve files for + required: true + schema: + type: string + - name: fileId + in: path + description: The ID of the pipeline file + required: true + schema: + type: string + format: uuid + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The pipeline file is successfully downloaded. + headers: + Content-Disposition: + description: Contains name of the file to be downloaded. + style: simple + schema: + type: string + content: + application/octet-stream: + schema: + type: string + format: binary /api/pipelineLanguages/nextflow/versions: get: tags: @@ -2831,9 +2947,8 @@ paths: - name: Idempotency-Key in: header description: "The Idempotency-Key header can be used to prevent duplicate\ - \ requests and support retries. It is implemented according to the IETF spec\ - \ and is allowed to be max 255 characters long. If the header is supplied,\ + \ requests and support retries. It is implemented according to the IETF\ + \ spec and is allowed to be max 255 characters long. If the header is supplied,\ \ the response of the request will be saved for 7 days for the specific\ \ API endpoint, header value and user reference. When the same user makes\ \ a new request within 7 days to the same API endpoint with the same Idempotency-Key\ @@ -3026,9 +3141,8 @@ paths: - name: Idempotency-Key in: header description: "The Idempotency-Key header can be used to prevent duplicate\ - \ requests and support retries. It is implemented according to the IETF spec\ - \ and is allowed to be max 255 characters long. If the header is supplied,\ + \ requests and support retries. It is implemented according to the IETF\ + \ spec and is allowed to be max 255 characters long. If the header is supplied,\ \ the response of the request will be saved for 7 days for the specific\ \ API endpoint, header value and user reference. When the same user makes\ \ a new request within 7 days to the same API endpoint with the same Idempotency-Key\ @@ -3083,9 +3197,8 @@ paths: - name: Idempotency-Key in: header description: "The Idempotency-Key header can be used to prevent duplicate\ - \ requests and support retries. It is implemented according to the IETF spec\ - \ and is allowed to be max 255 characters long. If the header is supplied,\ + \ requests and support retries. It is implemented according to the IETF\ + \ spec and is allowed to be max 255 characters long. If the header is supplied,\ \ the response of the request will be saved for 7 days for the specific\ \ API endpoint, header value and user reference. When the same user makes\ \ a new request within 7 days to the same API endpoint with the same Idempotency-Key\ @@ -5049,7 +5162,8 @@ paths: - Project Data summary: Retrieve temporary credentials for this data. description: "Can be used to upload or download a file directly from the region\ - \ where it is located, no connector is needed." + \ where it is located, no connector is needed. The returned credentials expire\ + \ after 36 hours." operationId: createTemporaryCredentialsForData parameters: - name: projectId @@ -5071,7 +5185,6 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateTemporaryCredentials' - required: true responses: default: description: A problem occurred. @@ -5693,6 +5806,182 @@ paths: description: The data transfer is successfully aborted. content: application/vnd.illumina.v3+json: {} + /api/projects/{projectId}/dataUpdateBatch: + post: + tags: + - Project Data Update Batch + summary: Create a project data update batch. + operationId: createProjectDataUpdateBatch + parameters: + - name: projectId + in: path + required: true + schema: + type: string + requestBody: + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/CreateProjectDataUpdateBatch' + application/json: + schema: + $ref: '#/components/schemas/CreateProjectDataUpdateBatch' + required: true + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "201": + description: The project data update batch is successfully created. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/ProjectDataUpdateBatch' + /api/projects/{projectId}/dataUpdateBatch/{batchId}: + get: + tags: + - Project Data Update Batch + summary: Retrieve a project data update batch. + operationId: getProjectDataUpdateBatch + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: batchId + in: path + required: true + schema: + type: string + format: uuid + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The project data update batch is successfully retrieved. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/ProjectDataUpdateBatch' + /api/projects/{projectId}/dataUpdateBatch/{batchId}/items: + get: + tags: + - Project Data Update Batch + summary: Retrieve a list of project data update batch items. + operationId: getProjectDataUpdateBatchItems + parameters: + - name: status + in: query + description: The statuses to filter on. + schema: + type: array + items: + type: string + enum: + - INITIALISED + - WAITING_RESOURCES + - UPDATING + - UPDATED + - PARTIALLY_UPDATED + - FAILED + - name: pageOffset + in: query + description: The amount of rows to skip in the result. Ideally this is a multiple + of the size parameter. Offset-based pagination has a result limit of 200K + rows and does not guarantee unique results across pages + schema: + type: string + - name: pageToken + in: query + description: The cursor to get subsequent results. The value to use is returned + in the result when using cursor-based pagination. Cursor-based pagination + guarantees complete and unique results across all pages. + schema: + type: string + - name: pageSize + in: query + description: The amount of rows to return. Use in combination with the offset + or cursor parameter to get subsequent results. + schema: + type: string + - name: sort + in: query + description: "Which field to order the results by. The default order is ascending,\ + \ suffix with ' desc' to sort descending (suffix ' asc' also works for ascending).\ + \ Multiple values should be separated with commas. An example: \"?sort=dateCreated,\ + \ lastName desc\"" + schema: + type: string + - name: projectId + in: path + required: true + schema: + type: string + - name: batchId + in: path + required: true + schema: + type: string + format: uuid + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The list of project data update batch items is successfully + retrieved. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/ProjectDataUpdateBatchItemPagedList' + /api/projects/{projectId}/dataUpdateBatch/{batchId}/items/{itemId}: + get: + tags: + - Project Data Update Batch + summary: Retrieve a project data update batch item. + operationId: getProjectDataUpdateBatchItem + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: batchId + in: path + required: true + schema: + type: string + format: uuid + - name: itemId + in: path + required: true + schema: + type: string + format: uuid + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The project data update batch item is successfully retrieved. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/ProjectDataUpdateBatchItem' /api/projects/{projectId}/notificationSubscriptions: get: tags: @@ -5899,6 +6188,11 @@ paths: tags: - Project Permission summary: Retrieve a list of project permissions. + description: "# Changelog\nFor this endpoint multiple versions exist. Note that\ + \ the values for request headers 'Content-Type' and 'Accept' must contain\ + \ a matching version.\n\n## [V3]\nInitial version\n## [V4]\nAdded 'Administrator'\ + \ role for Bench.\nThe role attributes are strings instead of enums to support\ + \ future additions in a backward compatible manner.\n" operationId: getProjectPermissions parameters: - name: projectId @@ -5916,6 +6210,9 @@ paths: "200": description: The list of project permissions is successfully retrieved. content: + application/vnd.illumina.v4+json: + schema: + $ref: '#/components/schemas/ProjectPermissionListV4' application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/ProjectPermissionList' @@ -5923,6 +6220,11 @@ paths: tags: - Project Permission summary: Create a project permission. + description: "# Changelog\nFor this endpoint multiple versions exist. Note that\ + \ the values for request headers 'Content-Type' and 'Accept' must contain\ + \ a matching version.\n\n## [V3]\nInitial version\n## [V4]\nAdded 'Administrator'\ + \ role for Bench.\nThe role attributes are strings instead of enums to support\ + \ future additions in a backward compatible manner.\n" operationId: createProjectPermission parameters: - name: projectId @@ -5932,6 +6234,9 @@ paths: type: string requestBody: content: + application/vnd.illumina.v4+json: + schema: + $ref: '#/components/schemas/CreateProjectPermissionV4' application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/CreateProjectPermission' @@ -5956,6 +6261,9 @@ paths: schema: type: string content: + application/vnd.illumina.v4+json: + schema: + $ref: '#/components/schemas/ProjectPermissionV4' application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/ProjectPermission' @@ -5964,6 +6272,11 @@ paths: tags: - Project Permission summary: Retrieve a project permission. + description: "# Changelog\nFor this endpoint multiple versions exist. Note that\ + \ the values for request headers 'Content-Type' and 'Accept' must contain\ + \ a matching version.\n\n## [V3]\nInitial version\n## [V4]\nAdded 'Administrator'\ + \ role for Bench.\nThe role attributes are strings instead of enums to support\ + \ future additions in a backward compatible manner.\n" operationId: getProjectPermission parameters: - name: projectId @@ -5993,6 +6306,9 @@ paths: schema: type: string content: + application/vnd.illumina.v4+json: + schema: + $ref: '#/components/schemas/ProjectPermissionV4' application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/ProjectPermission' @@ -6000,14 +6316,13 @@ paths: tags: - Project Permission summary: Update a project permission. - description: |- - Fields which can be updated: - - uploadAllowed - - downloadAllowed - - roleProject - - roleFlow - - roleBase - - roleBench + description: "# Changelog\nFor this endpoint multiple versions exist. Note that\ + \ the values for request headers 'Content-Type' and 'Accept' must contain\ + \ a matching version.\n\n## [V3]\nInitial version\n## [V4]\nAdded 'Administrator'\ + \ role for Bench.\nThe role attributes are strings instead of enums to support\ + \ future additions in a backward compatible manner.\nFields which can be updated:\n\ + - uploadAllowed\n- downloadAllowed\n- roleProject\n- roleFlow\n- roleBase\n\ + - roleBench" operationId: updateProjectPermission parameters: - name: projectId @@ -6033,6 +6348,9 @@ paths: type: string requestBody: content: + application/vnd.illumina.v4+json: + schema: + $ref: '#/components/schemas/ProjectPermissionV4' application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/ProjectPermission' @@ -6057,6 +6375,9 @@ paths: schema: type: string content: + application/vnd.illumina.v4+json: + schema: + $ref: '#/components/schemas/ProjectPermissionV4' application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/ProjectPermission' @@ -6343,6 +6664,195 @@ paths: application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/PipelineHtmlDocumentation' + /api/projects/{projectId}/pipelines/{pipelineId}/files: + get: + tags: + - Project Pipeline + summary: Retrieve files for a project pipeline. + operationId: getPipelineFiles_1 + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: pipelineId + in: path + description: The ID of the project pipeline to retrieve files for + required: true + schema: + type: string + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The files are successfully retrieved. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/PipelineFileList' + post: + tags: + - Project Pipeline + summary: Create a file for a pipeline. + operationId: createPipelineFile + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: pipelineId + in: path + description: The ID of the project pipeline to create a file for + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/PipelineFileContentSpec' + required: true + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "201": + description: The pipeline file is successfully created. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/PipelineFile' + /api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}/content: + get: + tags: + - Project Pipeline + summary: Download the contents of a pipeline file. + operationId: downloadPipelineFileContent_1 + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: pipelineId + in: path + description: The ID of the project pipeline to retrieve files for + required: true + schema: + type: string + - name: fileId + in: path + description: The ID of the pipeline file + required: true + schema: + type: string + format: uuid + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The pipeline file is successfully downloaded. + headers: + Content-Disposition: + description: Contains name of the file to be downloaded. + style: simple + schema: + type: string + content: + application/octet-stream: + schema: + type: string + format: binary + put: + tags: + - Project Pipeline + summary: Update the contents of a file for a pipeline. + operationId: updatePipelineFile + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: pipelineId + in: path + description: The ID of the project pipeline to update a file for + required: true + schema: + type: string + - name: fileId + in: path + description: The ID of the pipeline file + required: true + schema: + type: string + format: uuid + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/PipelineFileContentSpec' + required: true + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The pipeline file is successfully updated. + content: + application/vnd.illumina.v3+json: {} + /api/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}: + delete: + tags: + - Project Pipeline + summary: Delete a file for a pipeline. + operationId: deletePipelineFile + parameters: + - name: projectId + in: path + required: true + schema: + type: string + - name: pipelineId + in: path + description: The ID of the project pipeline to delete a file for + required: true + schema: + type: string + - name: fileId + in: path + description: The ID of the pipeline file + required: true + schema: + type: string + format: uuid + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "204": + description: The pipeline file is successfully deleted. + content: + application/vnd.illumina.v3+json: {} /api/projects/{projectId}/pipelines:createNextflowPipeline: post: tags: @@ -6703,6 +7213,96 @@ paths: application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/ProjectList' + /api/projects/{projectId}/samples/{sampleId}/analyses: + get: + tags: + - Project Sample + summary: Retrieve the list of analyses. + operationId: getProjectSampleAnalyses + parameters: + - name: reference + in: query + description: The reference to filter on. + schema: + type: string + - name: userreference + in: query + description: The user-reference to filter on. + schema: + type: string + - name: status + in: query + description: The status to filter on. + schema: + type: string + - name: usertag + in: query + description: The user-tags to filter on. + schema: + type: string + - name: technicaltag + in: query + description: The technical-tags to filter on. + schema: + type: string + - name: referencetag + in: query + description: The reference-data-tags to filter on. + schema: + type: string + - name: pageOffset + in: query + description: The amount of rows to skip in the result. Ideally this is a multiple + of the size parameter. Offset-based pagination has a result limit of 200K + rows and does not guarantee unique results across pages + schema: + type: string + - name: pageToken + in: query + description: The cursor to get subsequent results. The value to use is returned + in the result when using cursor-based pagination. Cursor-based pagination + guarantees complete and unique results across all pages. + schema: + type: string + - name: pageSize + in: query + description: The amount of rows to return. Use in combination with the offset + or cursor parameter to get subsequent results. + schema: + type: string + - name: sort + in: query + description: "Which field to order the results by. The default order is ascending,\ + \ suffix with ' desc' to sort descending (suffix ' asc' also works for ascending).\ + \ Multiple values should be separated with commas. An example: \"?sort=dateCreated,\ + \ lastName desc\"\n\nThe attributes for which sorting is supported:\n- reference\n\ + - userReference\n- pipeline\n- status\n- startDate\n- endDate\n- summary\n" + schema: + type: string + - name: projectId + in: path + required: true + schema: + type: string + - name: sampleId + in: path + description: The ID of the sample + required: true + schema: + type: string + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The list of project analyses is successfully retrieved. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/AnalysisPagedList' /api/projects/{projectId}/samples/{sampleId}/data: get: tags: @@ -7364,9 +7964,8 @@ paths: - name: Idempotency-Key in: header description: "The Idempotency-Key header can be used to prevent duplicate\ - \ requests and support retries. It is implemented according to the IETF spec\ - \ and is allowed to be max 255 characters long. If the header is supplied,\ + \ requests and support retries. It is implemented according to the IETF\ + \ spec and is allowed to be max 255 characters long. If the header is supplied,\ \ the response of the request will be saved for 7 days for the specific\ \ API endpoint, header value and user reference. When the same user makes\ \ a new request within 7 days to the same API endpoint with the same Idempotency-Key\ @@ -7719,12 +8318,19 @@ paths: application/vnd.illumina.v3+json: schema: $ref: '#/components/schemas/SamplePagedList' - /api/storageBundles: + /api/sequencingRuns/{sequencingRunId}: get: tags: - - Storage Bundle - summary: Retrieve a list of storage bundles. - operationId: getStorageBundles + - Sequencing Run + summary: Retrieve a sequencing run. + operationId: getSequencingRun + parameters: + - name: sequencingRunId + in: path + description: The ID of the sequencing run to retrieve + required: true + schema: + type: string responses: default: description: A problem occurred. @@ -7733,13 +8339,39 @@ paths: schema: $ref: '#/components/schemas/Problem' "200": - description: The list of storage bundles is successfully retrieved. - content: - application/vnd.illumina.v3+json: - schema: - $ref: '#/components/schemas/StorageBundleList' - /api/storageConfigurations: - get: + description: The sequencing run is successfully retrieved. + headers: + ETag: + description: The current version of the resource. Can be passed to the + corresponding PUT endpoint to enable conflict exposure (409 response). + style: simple + schema: + type: string + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/SequencingRun' + /api/storageBundles: + get: + tags: + - Storage Bundle + summary: Retrieve a list of storage bundles. + operationId: getStorageBundles + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The list of storage bundles is successfully retrieved. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/StorageBundleList' + /api/storageConfigurations: + get: tags: - Storage Configuration summary: Retrieve a list of storage configurations. @@ -8022,6 +8654,25 @@ paths: description: The storage credential secrets are successfully updated. content: application/vnd.illumina.v3+json: {} + /api/system/info: + get: + tags: + - System + summary: Retrieve system information. + operationId: getSystemInfo + responses: + default: + description: A problem occurred. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Problem' + "200": + description: The system information is successfully retrieved. + content: + application/vnd.illumina.v3+json: + schema: + $ref: '#/components/schemas/SystemInfo' /api/tokens: post: tags: @@ -8515,6 +9166,7 @@ components: type: string description: The description about the storage option nullable: true + nullable: true AnalysisStorageList: required: - items @@ -8845,6 +9497,30 @@ components: releaseVersion: type: string description: Version number of the Terms of Use. + TermsOfUseAcceptance: + required: + - accepted + - firstAcceptanceDate + - versionTermsOfUseFirstAccept + type: object + properties: + accepted: + type: boolean + description: Are the terms of use accepted + firstAcceptanceDate: + type: string + description: Date of the first time the terms of use were accepted. + format: date-time + versionTermsOfUseFirstAccept: + type: string + description: Version of the first accepted Terms of Use. + lastAcceptanceDate: + type: string + description: Date of the last time the terms of use were accepted. + format: date-time + versionTermsOfUseLastAccept: + type: string + description: Version of the last accepted Terms of Use. CreateTermsOfUse: required: - releaseVersion @@ -9757,9 +10433,9 @@ components: \ value will not change." nullable: true enum: - - Low - - Medium - - High + - LOW + - MEDIUM + - HIGH metadataModel: $ref: '#/components/schemas/MetadataModel' application: @@ -10966,11 +11642,31 @@ components: type: array items: $ref: '#/components/schemas/InputParameter' + IntegerSettings: + type: object + properties: + defaultValues: + type: array + items: + type: integer + format: int32 + OptionSettings: + type: object + properties: + options: + type: array + items: + type: string + defaultValues: + type: array + items: + type: string PipelineConfigurationParameter: required: - code - multiValue - required + - type type: object properties: code: @@ -10984,6 +11680,11 @@ components: multiValue: type: boolean description: Indicates whether multiple values are allowed for this parameter + type: + type: string + description: The type for each parameter + settings: + $ref: '#/components/schemas/Settings' PipelineConfigurationParameterList: required: - items @@ -10993,6 +11694,22 @@ components: type: array items: $ref: '#/components/schemas/PipelineConfigurationParameter' + Settings: + type: object + description: "This object contains a \"oneOf\" construct. Depending on which\ + \ type, you will receive a StringSettings-, IntegerSettings or OptionsSettings\ + \ object." + oneOf: + - $ref: '#/components/schemas/StringSettings' + - $ref: '#/components/schemas/IntegerSettings' + - $ref: '#/components/schemas/OptionSettings' + StringSettings: + type: object + properties: + defaultValues: + type: array + items: + type: string ReferenceData: required: - id @@ -11176,6 +11893,26 @@ components: content: type: string description: The content of the HTML documentation + PipelineFile: + required: + - id + - name + type: object + properties: + id: + type: string + format: uuid + name: + type: string + PipelineFileList: + required: + - items + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/PipelineFile' PipelineLanguageVersionList: required: - items @@ -11263,9 +12000,9 @@ components: description: The priority of the analysis nullable: true enum: - - Low - - Medium - - High + - LOW + - MEDIUM + - HIGH tags: $ref: '#/components/schemas/AnalysisTag' AnalysisPagedList: @@ -11547,6 +12284,10 @@ components: enum: - FILE - FOLDER + mountPath: + type: string + description: The requested location where the input file was located on + the machine that was running the pipeline. AnalysisExternalData: required: - mountPath @@ -11699,7 +12440,6 @@ components: $ref: '#/components/schemas/CreateNextflowAnalysis' CreateCwlAnalysis: required: - - activationCodeDetailId - analysisInput - pipelineId - tags @@ -11741,7 +12481,6 @@ components: $ref: '#/components/schemas/CwlAnalysisInput' CreateNextflowAnalysis: required: - - activationCodeDetailId - analysisInput - pipelineId - tags @@ -11953,13 +12692,13 @@ components: analysisPriority: type: string description: "Indicates the priority given to a project and its analyses\ - \ within a single tenant, where Medium is the default value." + \ within a single tenant, where MEDIUM is the default value." nullable: true - default: Medium + default: MEDIUM enum: - - Low - - Medium - - High + - LOW + - MEDIUM + - HIGH ProjectBundle: required: - bundle @@ -12198,7 +12937,7 @@ components: allowQuotedNewlines: type: boolean description: "Enable to include newlines contained in quoted data sections\ - \ in the cell’s value. When disabled, newlines will signal a new row" + \ in the cell’s value. When disabled, newlines will signal a new row" nullable: true default: false dataId: @@ -12898,6 +13637,125 @@ components: in offset based pagination) format: int64 nullable: true + ProjectDataUpdateBatch: + required: + - id + - job + type: object + properties: + id: + type: string + format: uuid + job: + $ref: '#/components/schemas/Job' + CreateProjectDataUpdateBatch: + required: + - dataUpdateGroups + type: object + properties: + dataUpdateGroups: + type: array + items: + $ref: '#/components/schemas/DataUpdateGroup' + DataUpdateGroup: + required: + - dataIds + type: object + properties: + dataIds: + type: array + items: + type: string + userTags: + $ref: '#/components/schemas/TagUpdate' + technicalTags: + $ref: '#/components/schemas/TagUpdate' + description: Updates to apply. + TagUpdate: + type: object + properties: + addTags: + type: array + items: + type: string + removeTags: + type: array + items: + type: string + nullable: true + ProjectDataUpdateBatchItem: + required: + - id + - processing + - request + type: object + properties: + id: + type: string + format: uuid + request: + $ref: '#/components/schemas/ProjectDataUpdateBatchItemRequest' + processing: + $ref: '#/components/schemas/ProjectDataUpdateBatchItemProcessing' + ProjectDataUpdateBatchItemPagedList: + required: + - items + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ProjectDataUpdateBatchItem' + nextPageToken: + maxLength: 2000 + minLength: 0 + type: string + description: The cursor to request the next page. For offset-based paging + the value is an empty string. + nullable: true + remainingRecords: + minimum: 0 + type: integer + description: The number of records remaining (used in cursor based pagination) + format: int64 + nullable: true + totalItemCount: + minimum: 0 + type: integer + description: The total number of records matching the search criteria (used + in offset based pagination) + format: int64 + nullable: true + ProjectDataUpdateBatchItemProcessing: + required: + - status + type: object + properties: + status: + type: string + enum: + - INITIALISED + - WAITING_RESOURCES + - UPDATING + - UPDATED + - PARTIALLY_UPDATED + - FAILED + additionalStatusInformation: + type: string + description: Additional information regarding the status of this batch item. + nullable: true + ProjectDataUpdateBatchItemRequest: + required: + - dataId + type: object + properties: + dataId: + type: string + description: "Data to apply the update to (recursively, if it's a folder)." + userTags: + $ref: '#/components/schemas/TagUpdate' + technicalTags: + $ref: '#/components/schemas/TagUpdate' NotificationSubscription: required: - enabled @@ -12978,6 +13836,109 @@ components: type: array items: $ref: '#/components/schemas/NotificationSubscription' + ProjectPermissionListV4: + required: + - items + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ProjectPermissionV4' + ProjectPermissionV4: + required: + - downloadAllowed + - id + - membershipType + - ownerId + - roleBase + - roleBench + - roleFlow + - roleProject + - tenantId + - timeCreated + - timeModified + - uploadAllowed + type: object + properties: + id: + type: string + format: uuid + timeCreated: + type: string + format: date-time + timeModified: + type: string + format: date-time + ownerId: + type: string + format: uuid + tenantId: + type: string + format: uuid + tenantName: + type: string + nullable: true + roleProject: + type: string + description: "Possible values are: NONE, VIEWER, CONTRIBUTOR, ADMINISTRATOR,\ + \ DATA_PROVIDER. More types could be added in a future release." + roleFlow: + type: string + description: "Possible values are: NONE, VIEWER, CONTRIBUTOR. More types\ + \ could be added in a future release." + roleBase: + type: string + description: "Possible values are: NONE, VIEWER, CONTRIBUTOR. More types\ + \ could be added in a future release." + roleBench: + type: string + description: "Possible values are: NONE, CONTRIBUTOR, ADMINISTRATOR. More\ + \ types could be added in a future release." + membershipType: + type: string + enum: + - USER + - EMAIL + - WORKGROUP + user: + $ref: '#/components/schemas/User' + emailAddress: + type: string + description: Only present when membershipType is EMAIL + nullable: true + workgroup: + $ref: '#/components/schemas/Workgroup' + invitationAccepted: + type: boolean + description: Only present when membershipType is EMAIL + nullable: true + invitationRejected: + type: boolean + description: Only present when user is invited by EMAIL + nullable: true + uploadAllowed: + type: boolean + downloadAllowed: + type: boolean + Workgroup: + required: + - description + - id + - name + type: object + properties: + id: + type: string + format: uuid + name: + maxLength: 100 + minLength: 1 + type: string + description: + maxLength: 1000 + minLength: 1 + type: string ProjectPermission: required: - downloadAllowed @@ -13072,24 +14033,59 @@ components: type: array items: $ref: '#/components/schemas/ProjectPermission' - Workgroup: + CreateProjectPermissionV4: required: - - description - - id - - name + - downloadAllowed + - membershipType + - roleBase + - roleBench + - roleFlow + - roleProject + - uploadAllowed type: object properties: - id: + roleProject: + pattern: NONE|VIEWER|CONTRIBUTOR|ADMINISTRATOR|DATA_PROVIDER + type: string + roleFlow: + pattern: NONE|VIEWER|CONTRIBUTOR + type: string + roleBase: + pattern: NONE|VIEWER|CONTRIBUTOR + type: string + roleBench: + pattern: NONE|CONTRIBUTOR|ADMINISTRATOR + type: string + membershipType: + type: string + description: How users are invited to the project + enum: + - USER + - EMAIL + - WORKGROUP + userId: type: string + description: "the id of the user that should be given access, required when\ + \ membershipType is USER" format: uuid - name: - maxLength: 100 - minLength: 1 + nullable: true + emailAddress: type: string - description: - maxLength: 1000 - minLength: 1 + description: "The email to invite a user on, required when membershipType\ + \ is EMAIL" + nullable: true + workgroupId: type: string + description: "the id of the workgroup to give access, required when membershipType\ + \ is WORKGROUP" + format: uuid + nullable: true + uploadAllowed: + type: boolean + description: Indicates if uploading data is allowed or not. + downloadAllowed: + type: boolean + description: Indicates if downloading data is allowed or not. CreateProjectPermission: required: - downloadAllowed @@ -13188,6 +14184,61 @@ components: type: array items: $ref: '#/components/schemas/ProjectPipeline' + PipelineFileContentSpec: + required: + - content + type: object + properties: + content: + type: string + format: binary + InputPart: + type: object + properties: + mediaType: + type: object + properties: + type: + type: string + subtype: + type: string + parameters: + type: object + additionalProperties: + type: string + wildcardType: + type: boolean + wildcardSubtype: + type: boolean + contentTypeFromMessage: + type: boolean + bodyAsString: + type: string + headers: + type: object + additionalProperties: + type: array + items: + type: string + MultipartFormDataInput: + type: object + properties: + formDataMap: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/InputPart' + formData: + type: object + additionalProperties: + $ref: '#/components/schemas/InputPart' + parts: + type: array + items: + $ref: '#/components/schemas/InputPart' + preamble: + type: string CreateNextflowPipeline: required: - analysisStorageId @@ -13256,53 +14307,6 @@ components: type: string description: The id of the storage to use for the pipeline. format: uuid - InputPart: - type: object - properties: - headers: - type: object - additionalProperties: - type: array - items: - type: string - mediaType: - type: object - properties: - type: - type: string - subtype: - type: string - parameters: - type: object - additionalProperties: - type: string - wildcardType: - type: boolean - wildcardSubtype: - type: boolean - bodyAsString: - type: string - contentTypeFromMessage: - type: boolean - MultipartFormDataInput: - type: object - properties: - formData: - type: object - additionalProperties: - $ref: '#/components/schemas/InputPart' - formDataMap: - type: object - additionalProperties: - type: array - items: - $ref: '#/components/schemas/InputPart' - parts: - type: array - items: - $ref: '#/components/schemas/InputPart' - preamble: - type: string CreateCwlPipeline: required: - analysisStorageId @@ -13539,6 +14543,12 @@ components: format: uuid job: $ref: '#/components/schemas/Job' + sequencingRunId: + type: string + description: The sequencingRunId to link to all created samples and linked + data + format: uuid + nullable: true CreateSampleCreationBatchDataItem: required: - dataId @@ -13944,6 +14954,16 @@ components: properties: awsCredentials: $ref: '#/components/schemas/AwsCredentials' + SystemInfo: + required: + - name + - version + type: object + properties: + name: + type: string + version: + type: string Token: type: object properties: @@ -14249,4 +15269,4 @@ components: in: header BasicAuth: type: http - scheme: basic + scheme: basic \ No newline at end of file diff --git a/test/test_integration/test_projects.py b/test/test_integration/test_projects.py index 9fa8a30..e2afeba 100755 --- a/test/test_integration/test_projects.py +++ b/test/test_integration/test_projects.py @@ -37,5 +37,5 @@ def test_get_projects(): projectList.append(i.get_item_oapg("id")) pprint(i.get_item_oapg("id")) - assert "test" in projectList + assert "2fab46b1-5930-476b-94c7-010f8d1fb3f3" in projectList assert api_response.response.status == 200 From 3000f8ae0e5bc018d43492ce3509e807c8034d0d Mon Sep 17 00:00:00 2001 From: kcutler0 <120067168+kcutler0@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:35:12 -0700 Subject: [PATCH 5/5] Update README.md Updated README with testing info --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2714e21..e865fe3 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ Basic authentication is only supported by the POST /tokens endpoint for generati If the API client provides request header 'Accept-Encoding' with value 'gzip', then the API applies GZIP compression on the JSON response. This significantly reduces the size and thus the download time of the response, which results in faster end-to-end API calls. In case of compression, the API also provides response header 'Content-Encoding' with value 'gzip', as indication for the client that decompression is required.

+## Testing +Tests created by Illumina are in the tests/test_integration/ folder, they are run using pytest, but modification will be required to update domain specific parameters. This is an active area of change in the repository and will be updated over time. ## Code Generation