cirro-api-client 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. cirro_api_client-0.0.1/PKG-INFO +264 -0
  2. cirro_api_client-0.0.1/README.md +238 -0
  3. cirro_api_client-0.0.1/cirro_api_client/__init__.py +119 -0
  4. cirro_api_client-0.0.1/cirro_api_client/api/__init__.py +17 -0
  5. cirro_api_client-0.0.1/cirro_api_client/api/billing_api.py +716 -0
  6. cirro_api_client-0.0.1/cirro_api_client/api/dashboards_api.py +772 -0
  7. cirro_api_client-0.0.1/cirro_api_client/api/datasets_api.py +1503 -0
  8. cirro_api_client-0.0.1/cirro_api_client/api/execution_api.py +956 -0
  9. cirro_api_client-0.0.1/cirro_api_client/api/file_api.py +345 -0
  10. cirro_api_client-0.0.1/cirro_api_client/api/metadata_api.py +638 -0
  11. cirro_api_client-0.0.1/cirro_api_client/api/metrics_api.py +294 -0
  12. cirro_api_client-0.0.1/cirro_api_client/api/notebooks_api.py +886 -0
  13. cirro_api_client-0.0.1/cirro_api_client/api/processes_api.py +1148 -0
  14. cirro_api_client-0.0.1/cirro_api_client/api/projects_api.py +1148 -0
  15. cirro_api_client-0.0.1/cirro_api_client/api/references_api.py +826 -0
  16. cirro_api_client-0.0.1/cirro_api_client/api/system_api.py +281 -0
  17. cirro_api_client-0.0.1/cirro_api_client/api/users_api.py +605 -0
  18. cirro_api_client-0.0.1/cirro_api_client/api_client.py +738 -0
  19. cirro_api_client-0.0.1/cirro_api_client/api_response.py +21 -0
  20. cirro_api_client-0.0.1/cirro_api_client/cirro_api_client.py +39 -0
  21. cirro_api_client-0.0.1/cirro_api_client/configuration.py +322 -0
  22. cirro_api_client-0.0.1/cirro_api_client/exceptions.py +201 -0
  23. cirro_api_client-0.0.1/cirro_api_client/models/__init__.py +90 -0
  24. cirro_api_client-0.0.1/cirro_api_client/models/access_type.py +48 -0
  25. cirro_api_client-0.0.1/cirro_api_client/models/allowed_data_type.py +102 -0
  26. cirro_api_client-0.0.1/cirro_api_client/models/aws_credentials.py +98 -0
  27. cirro_api_client-0.0.1/cirro_api_client/models/billing_account.py +118 -0
  28. cirro_api_client-0.0.1/cirro_api_client/models/billing_account_request.py +113 -0
  29. cirro_api_client-0.0.1/cirro_api_client/models/billing_method.py +47 -0
  30. cirro_api_client-0.0.1/cirro_api_client/models/budget_period.py +47 -0
  31. cirro_api_client-0.0.1/cirro_api_client/models/cloud_account.py +115 -0
  32. cirro_api_client-0.0.1/cirro_api_client/models/contact.py +95 -0
  33. cirro_api_client-0.0.1/cirro_api_client/models/create_notebook_instance_request.py +104 -0
  34. cirro_api_client-0.0.1/cirro_api_client/models/create_reference_request.py +97 -0
  35. cirro_api_client-0.0.1/cirro_api_client/models/create_response.py +91 -0
  36. cirro_api_client-0.0.1/cirro_api_client/models/custom_pipeline_settings.py +124 -0
  37. cirro_api_client-0.0.1/cirro_api_client/models/customer_type.py +47 -0
  38. cirro_api_client-0.0.1/cirro_api_client/models/dashboard.py +106 -0
  39. cirro_api_client-0.0.1/cirro_api_client/models/dashboard_request.py +99 -0
  40. cirro_api_client-0.0.1/cirro_api_client/models/dataset.py +120 -0
  41. cirro_api_client-0.0.1/cirro_api_client/models/dataset_assets_manifest.py +110 -0
  42. cirro_api_client-0.0.1/cirro_api_client/models/dataset_detail.py +127 -0
  43. cirro_api_client-0.0.1/cirro_api_client/models/dataset_viz.py +96 -0
  44. cirro_api_client-0.0.1/cirro_api_client/models/error_message.py +89 -0
  45. cirro_api_client-0.0.1/cirro_api_client/models/executor.py +47 -0
  46. cirro_api_client-0.0.1/cirro_api_client/models/file_access_request.py +105 -0
  47. cirro_api_client-0.0.1/cirro_api_client/models/file_entry.py +94 -0
  48. cirro_api_client-0.0.1/cirro_api_client/models/file_name_pattern.py +92 -0
  49. cirro_api_client-0.0.1/cirro_api_client/models/file_requirements.py +102 -0
  50. cirro_api_client-0.0.1/cirro_api_client/models/form_schema.py +92 -0
  51. cirro_api_client-0.0.1/cirro_api_client/models/generate_sftp_credentials_request.py +91 -0
  52. cirro_api_client-0.0.1/cirro_api_client/models/get_execution_logs_response.py +97 -0
  53. cirro_api_client-0.0.1/cirro_api_client/models/import_data_request.py +95 -0
  54. cirro_api_client-0.0.1/cirro_api_client/models/invite_user_request.py +95 -0
  55. cirro_api_client-0.0.1/cirro_api_client/models/invite_user_response.py +89 -0
  56. cirro_api_client-0.0.1/cirro_api_client/models/log_entry.py +92 -0
  57. cirro_api_client-0.0.1/cirro_api_client/models/metric_record.py +94 -0
  58. cirro_api_client-0.0.1/cirro_api_client/models/notebook_instance.py +107 -0
  59. cirro_api_client-0.0.1/cirro_api_client/models/notebook_instance_status_response.py +92 -0
  60. cirro_api_client-0.0.1/cirro_api_client/models/open_notebook_instance_response.py +91 -0
  61. cirro_api_client-0.0.1/cirro_api_client/models/paginated_response_dataset_list_dto.py +100 -0
  62. cirro_api_client-0.0.1/cirro_api_client/models/paginated_response_sample_dto.py +100 -0
  63. cirro_api_client-0.0.1/cirro_api_client/models/pipeline_code.py +105 -0
  64. cirro_api_client-0.0.1/cirro_api_client/models/portal_error_response.py +104 -0
  65. cirro_api_client-0.0.1/cirro_api_client/models/process.py +109 -0
  66. cirro_api_client-0.0.1/cirro_api_client/models/process_detail.py +146 -0
  67. cirro_api_client-0.0.1/cirro_api_client/models/process_detail_all_of_pipeline_code.py +105 -0
  68. cirro_api_client-0.0.1/cirro_api_client/models/project.py +109 -0
  69. cirro_api_client-0.0.1/cirro_api_client/models/project_detail.py +133 -0
  70. cirro_api_client-0.0.1/cirro_api_client/models/project_metrics.py +109 -0
  71. cirro_api_client-0.0.1/cirro_api_client/models/project_request.py +137 -0
  72. cirro_api_client-0.0.1/cirro_api_client/models/project_role.py +48 -0
  73. cirro_api_client-0.0.1/cirro_api_client/models/project_settings.py +170 -0
  74. cirro_api_client-0.0.1/cirro_api_client/models/project_user.py +100 -0
  75. cirro_api_client-0.0.1/cirro_api_client/models/reference.py +110 -0
  76. cirro_api_client-0.0.1/cirro_api_client/models/reference_type.py +95 -0
  77. cirro_api_client-0.0.1/cirro_api_client/models/repository_type.py +48 -0
  78. cirro_api_client-0.0.1/cirro_api_client/models/resources_info.py +96 -0
  79. cirro_api_client-0.0.1/cirro_api_client/models/run_analysis_request.py +103 -0
  80. cirro_api_client-0.0.1/cirro_api_client/models/sample.py +100 -0
  81. cirro_api_client-0.0.1/cirro_api_client/models/sample_request.py +93 -0
  82. cirro_api_client-0.0.1/cirro_api_client/models/service_connection.py +91 -0
  83. cirro_api_client-0.0.1/cirro_api_client/models/set_user_project_role_request.py +95 -0
  84. cirro_api_client-0.0.1/cirro_api_client/models/sftp_credentials.py +96 -0
  85. cirro_api_client-0.0.1/cirro_api_client/models/status.py +53 -0
  86. cirro_api_client-0.0.1/cirro_api_client/models/stop_execution_response.py +92 -0
  87. cirro_api_client-0.0.1/cirro_api_client/models/sync_status.py +46 -0
  88. cirro_api_client-0.0.1/cirro_api_client/models/system_info_response.py +108 -0
  89. cirro_api_client-0.0.1/cirro_api_client/models/tag.py +93 -0
  90. cirro_api_client-0.0.1/cirro_api_client/models/task.py +104 -0
  91. cirro_api_client-0.0.1/cirro_api_client/models/update_dataset_request.py +105 -0
  92. cirro_api_client-0.0.1/cirro_api_client/models/update_user_request.py +99 -0
  93. cirro_api_client-0.0.1/cirro_api_client/models/upload_dataset_create_response.py +94 -0
  94. cirro_api_client-0.0.1/cirro_api_client/models/upload_dataset_request.py +97 -0
  95. cirro_api_client-0.0.1/cirro_api_client/models/user.py +95 -0
  96. cirro_api_client-0.0.1/cirro_api_client/models/validate_file_requirements_request.py +92 -0
  97. cirro_api_client-0.0.1/cirro_api_client/py.typed +0 -0
  98. cirro_api_client-0.0.1/cirro_api_client/rest.py +268 -0
  99. cirro_api_client-0.0.1/pyproject.toml +30 -0
cirro_api_client-0.0.1/PKG-INFO ADDED
@@ -0,0 +1,264 @@
1
+ Metadata-Version: 2.1
2
+ Name: cirro_api_client
3
+ Version: 0.0.1
4
+ Summary: Cirro Data
5
+ Home-page: https://github.com/CirroBio/Cirro-client-python
6
+ License: MIT
7
+ Keywords: OpenAPI,OpenAPI-Generator,Cirro Data
8
+ Author: Cirro
9
+ Author-email: support@cirro.bio
10
+ Requires-Python: >=3.7,<4.0
11
+ Classifier: License :: OSI Approved :: MIT License
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.7
14
+ Classifier: Programming Language :: Python :: 3.8
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Requires-Dist: pydantic (>=2)
20
+ Requires-Dist: python-dateutil (>=2.8.2)
21
+ Requires-Dist: typing-extensions (>=4.7.1)
22
+ Requires-Dist: urllib3 (>=1.25.3)
23
+ Project-URL: Repository, https://github.com/CirroBio/Cirro-client-python
24
+ Description-Content-Type: text/markdown
25
+
26
+ # Cirro API Client
27
+ Cirro Data Platform service API
28
+
29
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
30
+
31
+ ## Requirements.
32
+
33
+ Python 3.7+
34
+
35
+ ## Installation & Usage
36
+ ### pip install
37
+
38
+ Via PyPI:
39
+ ```sh
40
+ pip install cirro-api-client
41
+ ```
42
+
43
+ If the python package is hosted on a repository, you can install directly using:
44
+
45
+ ```sh
46
+ pip install git+https://github.com/CirroBio/Cirro-client-python.git
47
+ ```
48
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/CirroBio/Cirro-client-python.git`)
49
+
50
+ ### Setuptools
51
+
52
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
53
+
54
+ ```sh
55
+ python setup.py install --user
56
+ ```
57
+ (or `sudo python setup.py install` to install the package for all users)
58
+
59
+ ### Tests
60
+
61
+ Execute `pytest` to run the tests.
62
+
63
+ ## Getting Started
64
+
65
+ Please follow the [installation procedure](#installation--usage) and then run the following:
66
+
67
+ ```python
68
+
69
+ import os
70
+ from cirro_api_client import Configuration, CirroApiClient
71
+ from cirro_api_client.rest import ApiException
72
+ from pprint import pprint
73
+
74
+ # Defining the host is optional and defaults to https://api.cirro.bio
75
+ # See configuration.py for a list of all supported configuration parameters.
76
+ # The access_token param can be either a string, or a function that returns a string.
77
+ configuration = Configuration(
78
+ host = "https://api.cirro.bio",
79
+ access_token = os.environ["BEARER_TOKEN"]
80
+ )
81
+
82
+ # Create instance of the API client
83
+ api_client = CirroApiClient(configuration)
84
+
85
+ try:
86
+ # Get list of projects
87
+ projects = api_client.projects.get_projects()
88
+ print("The response of Projects->get_projects:\n")
89
+ pprint(projects)
90
+ except ApiException as e:
91
+ print("Exception when calling Projects->get_projects: %s\n" % e)
92
+
93
+ ```
94
+
95
+ ## Documentation for API Endpoints
96
+
97
+ All URIs are relative to *https://api.cirro.bio*
98
+
99
+ Class | Method | HTTP request | Description
100
+ ------------ | ------------- | ------------- | -------------
101
+ *BillingApi* | [**create_billing_account**](docs/BillingApi.md#create_billing_account) | **POST** /billing | Create billing account
102
+ *BillingApi* | [**delete_billing_account**](docs/BillingApi.md#delete_billing_account) | **DELETE** /billing/{billingAccountId} | Delete billing account
103
+ *BillingApi* | [**generate_billing_report**](docs/BillingApi.md#generate_billing_report) | **GET** /billing-report | Generate billing report
104
+ *BillingApi* | [**get_billing_accounts**](docs/BillingApi.md#get_billing_accounts) | **GET** /billing | List billing accounts
105
+ *BillingApi* | [**update_billing_account**](docs/BillingApi.md#update_billing_account) | **PUT** /billing/{billingAccountId} | Update billing account
106
+ *DashboardsApi* | [**create_dashboard**](docs/DashboardsApi.md#create_dashboard) | **POST** /projects/{projectId}/dashboards | Create dashboard
107
+ *DashboardsApi* | [**delete_dashboard**](docs/DashboardsApi.md#delete_dashboard) | **DELETE** /projects/{projectId}/dashboards/{dashboardId} | Delete dashboard
108
+ *DashboardsApi* | [**get_dashboard**](docs/DashboardsApi.md#get_dashboard) | **GET** /projects/{projectId}/dashboards/{dashboardId} | Get dashboard
109
+ *DashboardsApi* | [**get_dashboards**](docs/DashboardsApi.md#get_dashboards) | **GET** /projects/{projectId}/dashboards | List dashboards
110
+ *DashboardsApi* | [**update_dashboard**](docs/DashboardsApi.md#update_dashboard) | **PUT** /projects/{projectId}/dashboards/{dashboardId} | Update dashboard
111
+ *DatasetsApi* | [**delete_dataset**](docs/DatasetsApi.md#delete_dataset) | **DELETE** /projects/{projectId}/datasets/{datasetId} | Delete a dataset
112
+ *DatasetsApi* | [**get_dataset**](docs/DatasetsApi.md#get_dataset) | **GET** /projects/{projectId}/datasets/{datasetId} | Get dataset
113
+ *DatasetsApi* | [**get_dataset_manifest**](docs/DatasetsApi.md#get_dataset_manifest) | **GET** /projects/{projectId}/datasets/{datasetId}/files | Get dataset manifest
114
+ *DatasetsApi* | [**get_datasets**](docs/DatasetsApi.md#get_datasets) | **GET** /projects/{projectId}/datasets | List datasets
115
+ *DatasetsApi* | [**import_public_dataset**](docs/DatasetsApi.md#import_public_dataset) | **POST** /projects/{projectId}/datasets/import | Import public dataset
116
+ *DatasetsApi* | [**ingest_samples**](docs/DatasetsApi.md#ingest_samples) | **PUT** /projects/{projectId}/datasets/{datasetId}/ingest-samples | Rerun sample ingest
117
+ *DatasetsApi* | [**regenerate_manifest**](docs/DatasetsApi.md#regenerate_manifest) | **PUT** /projects/{projectId}/datasets/{datasetId}/regenerate-manifest | Regenerate dataset manifest
118
+ *DatasetsApi* | [**rerun_transform**](docs/DatasetsApi.md#rerun_transform) | **PUT** /projects/{projectId}/datasets/{datasetId}/rerun-transform | Rerun data transforms
119
+ *DatasetsApi* | [**update_dataset**](docs/DatasetsApi.md#update_dataset) | **PUT** /projects/{projectId}/datasets/{datasetId} | Update dataset
120
+ *DatasetsApi* | [**upload_dataset**](docs/DatasetsApi.md#upload_dataset) | **POST** /projects/{projectId}/datasets/upload | Upload private dataset
121
+ *ExecutionApi* | [**get_execution_logs**](docs/ExecutionApi.md#get_execution_logs) | **GET** /projects/{projectId}/execution/{datasetId}/logs | Get execution logs
122
+ *ExecutionApi* | [**get_project_summary**](docs/ExecutionApi.md#get_project_summary) | **GET** /projects/{projectId}/execution | Get execution summary
123
+ *ExecutionApi* | [**get_task_logs**](docs/ExecutionApi.md#get_task_logs) | **GET** /projects/{projectId}/execution/{datasetId}/tasks/{taskId}/logs | Get task logs
124
+ *ExecutionApi* | [**get_tasks_for_execution**](docs/ExecutionApi.md#get_tasks_for_execution) | **GET** /projects/{projectId}/execution/{datasetId}/tasks | Get execution tasks
125
+ *ExecutionApi* | [**run_analysis**](docs/ExecutionApi.md#run_analysis) | **POST** /projects/{projectId}/execution | Run analysis
126
+ *ExecutionApi* | [**stop_analysis**](docs/ExecutionApi.md#stop_analysis) | **PUT** /projects/{projectId}/execution/{datasetId}/stop | Stop execution
127
+ *FileApi* | [**generate_project_file_access_token**](docs/FileApi.md#generate_project_file_access_token) | **POST** /projects/{projectId}/s3-token | Create project file access token
128
+ *FileApi* | [**generate_project_sftp_token**](docs/FileApi.md#generate_project_sftp_token) | **POST** /projects/{projectId}/sftp-token | Create project SFTP Token
129
+ *MetadataApi* | [**get_project_samples**](docs/MetadataApi.md#get_project_samples) | **GET** /projects/{projectId}/samples | Get project samples
130
+ *MetadataApi* | [**get_project_schema**](docs/MetadataApi.md#get_project_schema) | **GET** /projects/{projectId}/schema | Get project metadata schema
131
+ *MetadataApi* | [**update_project_schema**](docs/MetadataApi.md#update_project_schema) | **PUT** /projects/{projectId}/schema | Update project metadata schema
132
+ *MetadataApi* | [**update_sample**](docs/MetadataApi.md#update_sample) | **PUT** /projects/{projectId}/samples/{sampleId} | Update sample
133
+ *MetricsApi* | [**get_all_metrics**](docs/MetricsApi.md#get_all_metrics) | **GET** /metrics | Get all project metrics
134
+ *MetricsApi* | [**get_project_metrics**](docs/MetricsApi.md#get_project_metrics) | **GET** /projects/{projectId}/metrics | Get project metrics
135
+ *NotebooksApi* | [**create_notebook_instance**](docs/NotebooksApi.md#create_notebook_instance) | **POST** /projects/{projectId}/notebook-instances | Create notebook instance
136
+ *NotebooksApi* | [**delete_notebook_instance**](docs/NotebooksApi.md#delete_notebook_instance) | **DELETE** /projects/{projectId}/notebook-instances/{notebookInstanceId} | Delete notebook instance
137
+ *NotebooksApi* | [**generate_notebook_instance_url**](docs/NotebooksApi.md#generate_notebook_instance_url) | **GET** /projects/{projectId}/notebook-instances/{notebookInstanceId}:generate-url | Generate notebook instance URL
138
+ *NotebooksApi* | [**get_notebook_instance_status**](docs/NotebooksApi.md#get_notebook_instance_status) | **GET** /projects/{projectId}/notebook-instances/{notebookInstanceId}:status | Get notebook instance status
139
+ *NotebooksApi* | [**get_notebook_instances**](docs/NotebooksApi.md#get_notebook_instances) | **GET** /projects/{projectId}/notebook-instances | Get notebook instances
140
+ *NotebooksApi* | [**stop_notebook_instance**](docs/NotebooksApi.md#stop_notebook_instance) | **POST** /projects/{projectId}/notebook-instances/{notebookInstanceId}:stop | Stop notebook instance
141
+ *ProcessesApi* | [**archive_custom_process**](docs/ProcessesApi.md#archive_custom_process) | **DELETE** /processes/{processId} | Archive custom process
142
+ *ProcessesApi* | [**create_custom_process**](docs/ProcessesApi.md#create_custom_process) | **POST** /processes | Create custom process
143
+ *ProcessesApi* | [**get_process**](docs/ProcessesApi.md#get_process) | **GET** /processes/{processId} | Get process
144
+ *ProcessesApi* | [**get_process_parameters**](docs/ProcessesApi.md#get_process_parameters) | **GET** /processes/{processId}/parameters | Get process parameters
145
+ *ProcessesApi* | [**get_processes**](docs/ProcessesApi.md#get_processes) | **GET** /processes | List processes
146
+ *ProcessesApi* | [**sync_custom_process**](docs/ProcessesApi.md#sync_custom_process) | **PUT** /processes/{processId}:sync | Sync custom process
147
+ *ProcessesApi* | [**update_custom_process**](docs/ProcessesApi.md#update_custom_process) | **PUT** /processes/{processId} | Update custom process
148
+ *ProcessesApi* | [**validate_file_requirements**](docs/ProcessesApi.md#validate_file_requirements) | **POST** /processes/{processId}/validate-files | Validate file requirements
149
+ *ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /projects | Create project
150
+ *ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /projects/{projectId} | Get project
151
+ *ProjectsApi* | [**get_project_users**](docs/ProjectsApi.md#get_project_users) | **GET** /projects/{projectId}/permissions | Get project permissions
152
+ *ProjectsApi* | [**get_projects**](docs/ProjectsApi.md#get_projects) | **GET** /projects | Get projects
153
+ *ProjectsApi* | [**redeploy_project**](docs/ProjectsApi.md#redeploy_project) | **PUT** /projects/{projectId}:re-deploy | Redeploy project
154
+ *ProjectsApi* | [**set_user_project_role**](docs/ProjectsApi.md#set_user_project_role) | **PUT** /projects/{projectId}/permissions | Set role
155
+ *ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PUT** /projects/{projectId} | Update project
156
+ *ProjectsApi* | [**update_project_tags**](docs/ProjectsApi.md#update_project_tags) | **PUT** /projects/{projectId}:tags | Set project tags
157
+ *ReferencesApi* | [**create_project_reference**](docs/ReferencesApi.md#create_project_reference) | **POST** /projects/{projectId}/references | Create project reference
158
+ *ReferencesApi* | [**delete_project_reference**](docs/ReferencesApi.md#delete_project_reference) | **DELETE** /projects/{projectId}/references | Delete project reference
159
+ *ReferencesApi* | [**get_reference_types**](docs/ReferencesApi.md#get_reference_types) | **GET** /reference-types | Get reference types
160
+ *ReferencesApi* | [**get_references**](docs/ReferencesApi.md#get_references) | **GET** /references | Get global references
161
+ *ReferencesApi* | [**get_references_for_project**](docs/ReferencesApi.md#get_references_for_project) | **GET** /projects/{projectId}/references | Get project references
162
+ *ReferencesApi* | [**refresh_project_references**](docs/ReferencesApi.md#refresh_project_references) | **PUT** /projects/{projectId}/references | Refresh project references
163
+ *SystemApi* | [**get_service_connections**](docs/SystemApi.md#get_service_connections) | **GET** /service-connections | Get service connections
164
+ *SystemApi* | [**info**](docs/SystemApi.md#info) | **GET** /info | Get system info
165
+ *UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /users/{username} | Get user
166
+ *UsersApi* | [**get_users**](docs/UsersApi.md#get_users) | **GET** /users | List users
167
+ *UsersApi* | [**invite_user**](docs/UsersApi.md#invite_user) | **POST** /users | Invite user
168
+ *UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /users/{username} | Update user
169
+
170
+
171
+ ## Documentation For Models
172
+
173
+ - [AWSCredentials](docs/AWSCredentials.md)
174
+ - [AccessType](docs/AccessType.md)
175
+ - [AllowedDataType](docs/AllowedDataType.md)
176
+ - [BillingAccount](docs/BillingAccount.md)
177
+ - [BillingAccountRequest](docs/BillingAccountRequest.md)
178
+ - [BillingMethod](docs/BillingMethod.md)
179
+ - [BudgetPeriod](docs/BudgetPeriod.md)
180
+ - [CloudAccount](docs/CloudAccount.md)
181
+ - [Contact](docs/Contact.md)
182
+ - [CreateNotebookInstanceRequest](docs/CreateNotebookInstanceRequest.md)
183
+ - [CreateReferenceRequest](docs/CreateReferenceRequest.md)
184
+ - [CreateResponse](docs/CreateResponse.md)
185
+ - [CustomPipelineSettings](docs/CustomPipelineSettings.md)
186
+ - [CustomerType](docs/CustomerType.md)
187
+ - [Dashboard](docs/Dashboard.md)
188
+ - [DashboardRequest](docs/DashboardRequest.md)
189
+ - [Dataset](docs/Dataset.md)
190
+ - [DatasetAssetsManifest](docs/DatasetAssetsManifest.md)
191
+ - [DatasetDetail](docs/DatasetDetail.md)
192
+ - [DatasetViz](docs/DatasetViz.md)
193
+ - [ErrorMessage](docs/ErrorMessage.md)
194
+ - [Executor](docs/Executor.md)
195
+ - [FileAccessRequest](docs/FileAccessRequest.md)
196
+ - [FileEntry](docs/FileEntry.md)
197
+ - [FileNamePattern](docs/FileNamePattern.md)
198
+ - [FileRequirements](docs/FileRequirements.md)
199
+ - [FormSchema](docs/FormSchema.md)
200
+ - [GenerateSftpCredentialsRequest](docs/GenerateSftpCredentialsRequest.md)
201
+ - [GetExecutionLogsResponse](docs/GetExecutionLogsResponse.md)
202
+ - [ImportDataRequest](docs/ImportDataRequest.md)
203
+ - [InviteUserRequest](docs/InviteUserRequest.md)
204
+ - [InviteUserResponse](docs/InviteUserResponse.md)
205
+ - [LogEntry](docs/LogEntry.md)
206
+ - [MetricRecord](docs/MetricRecord.md)
207
+ - [NotebookInstance](docs/NotebookInstance.md)
208
+ - [NotebookInstanceStatusResponse](docs/NotebookInstanceStatusResponse.md)
209
+ - [OpenNotebookInstanceResponse](docs/OpenNotebookInstanceResponse.md)
210
+ - [PaginatedResponseDatasetListDto](docs/PaginatedResponseDatasetListDto.md)
211
+ - [PaginatedResponseSampleDto](docs/PaginatedResponseSampleDto.md)
212
+ - [PipelineCode](docs/PipelineCode.md)
213
+ - [PortalErrorResponse](docs/PortalErrorResponse.md)
214
+ - [Process](docs/Process.md)
215
+ - [ProcessDetail](docs/ProcessDetail.md)
216
+ - [ProcessDetailAllOfPipelineCode](docs/ProcessDetailAllOfPipelineCode.md)
217
+ - [Project](docs/Project.md)
218
+ - [ProjectDetail](docs/ProjectDetail.md)
219
+ - [ProjectMetrics](docs/ProjectMetrics.md)
220
+ - [ProjectRequest](docs/ProjectRequest.md)
221
+ - [ProjectRole](docs/ProjectRole.md)
222
+ - [ProjectSettings](docs/ProjectSettings.md)
223
+ - [ProjectUser](docs/ProjectUser.md)
224
+ - [Reference](docs/Reference.md)
225
+ - [ReferenceType](docs/ReferenceType.md)
226
+ - [RepositoryType](docs/RepositoryType.md)
227
+ - [ResourcesInfo](docs/ResourcesInfo.md)
228
+ - [RunAnalysisRequest](docs/RunAnalysisRequest.md)
229
+ - [Sample](docs/Sample.md)
230
+ - [SampleRequest](docs/SampleRequest.md)
231
+ - [ServiceConnection](docs/ServiceConnection.md)
232
+ - [SetUserProjectRoleRequest](docs/SetUserProjectRoleRequest.md)
233
+ - [SftpCredentials](docs/SftpCredentials.md)
234
+ - [Status](docs/Status.md)
235
+ - [StopExecutionResponse](docs/StopExecutionResponse.md)
236
+ - [SyncStatus](docs/SyncStatus.md)
237
+ - [SystemInfoResponse](docs/SystemInfoResponse.md)
238
+ - [Tag](docs/Tag.md)
239
+ - [Task](docs/Task.md)
240
+ - [UpdateDatasetRequest](docs/UpdateDatasetRequest.md)
241
+ - [UpdateUserRequest](docs/UpdateUserRequest.md)
242
+ - [UploadDatasetCreateResponse](docs/UploadDatasetCreateResponse.md)
243
+ - [UploadDatasetRequest](docs/UploadDatasetRequest.md)
244
+ - [User](docs/User.md)
245
+ - [ValidateFileRequirementsRequest](docs/ValidateFileRequirementsRequest.md)
246
+
247
+
248
+ <a id="documentation-for-authorization"></a>
249
+ ## Documentation For Authorization
250
+
251
+
252
+ Authentication schemes defined for the API:
253
+ <a id="accessToken"></a>
254
+ ### accessToken
255
+
256
+ - **Type**: Bearer authentication (JWT)
257
+
258
+
259
+ ## Author
260
+
261
+ support@cirro.bio
262
+
263
+
264
+
cirro_api_client-0.0.1/README.md ADDED
@@ -0,0 +1,238 @@
1
+ # Cirro API Client
2
+ Cirro Data Platform service API
3
+
4
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
5
+
6
+ ## Requirements.
7
+
8
+ Python 3.7+
9
+
10
+ ## Installation & Usage
11
+ ### pip install
12
+
13
+ Via PyPI:
14
+ ```sh
15
+ pip install cirro-api-client
16
+ ```
17
+
18
+ If the python package is hosted on a repository, you can install directly using:
19
+
20
+ ```sh
21
+ pip install git+https://github.com/CirroBio/Cirro-client-python.git
22
+ ```
23
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/CirroBio/Cirro-client-python.git`)
24
+
25
+ ### Setuptools
26
+
27
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
28
+
29
+ ```sh
30
+ python setup.py install --user
31
+ ```
32
+ (or `sudo python setup.py install` to install the package for all users)
33
+
34
+ ### Tests
35
+
36
+ Execute `pytest` to run the tests.
37
+
38
+ ## Getting Started
39
+
40
+ Please follow the [installation procedure](#installation--usage) and then run the following:
41
+
42
+ ```python
43
+
44
+ import os
45
+ from cirro_api_client import Configuration, CirroApiClient
46
+ from cirro_api_client.rest import ApiException
47
+ from pprint import pprint
48
+
49
+ # Defining the host is optional and defaults to https://api.cirro.bio
50
+ # See configuration.py for a list of all supported configuration parameters.
51
+ # The access_token param can be either a string, or a function that returns a string.
52
+ configuration = Configuration(
53
+ host = "https://api.cirro.bio",
54
+ access_token = os.environ["BEARER_TOKEN"]
55
+ )
56
+
57
+ # Create instance of the API client
58
+ api_client = CirroApiClient(configuration)
59
+
60
+ try:
61
+ # Get list of projects
62
+ projects = api_client.projects.get_projects()
63
+ print("The response of Projects->get_projects:\n")
64
+ pprint(projects)
65
+ except ApiException as e:
66
+ print("Exception when calling Projects->get_projects: %s\n" % e)
67
+
68
+ ```
69
+
70
+ ## Documentation for API Endpoints
71
+
72
+ All URIs are relative to *https://api.cirro.bio*
73
+
74
+ Class | Method | HTTP request | Description
75
+ ------------ | ------------- | ------------- | -------------
76
+ *BillingApi* | [**create_billing_account**](docs/BillingApi.md#create_billing_account) | **POST** /billing | Create billing account
77
+ *BillingApi* | [**delete_billing_account**](docs/BillingApi.md#delete_billing_account) | **DELETE** /billing/{billingAccountId} | Delete billing account
78
+ *BillingApi* | [**generate_billing_report**](docs/BillingApi.md#generate_billing_report) | **GET** /billing-report | Generate billing report
79
+ *BillingApi* | [**get_billing_accounts**](docs/BillingApi.md#get_billing_accounts) | **GET** /billing | List billing accounts
80
+ *BillingApi* | [**update_billing_account**](docs/BillingApi.md#update_billing_account) | **PUT** /billing/{billingAccountId} | Update billing account
81
+ *DashboardsApi* | [**create_dashboard**](docs/DashboardsApi.md#create_dashboard) | **POST** /projects/{projectId}/dashboards | Create dashboard
82
+ *DashboardsApi* | [**delete_dashboard**](docs/DashboardsApi.md#delete_dashboard) | **DELETE** /projects/{projectId}/dashboards/{dashboardId} | Delete dashboard
83
+ *DashboardsApi* | [**get_dashboard**](docs/DashboardsApi.md#get_dashboard) | **GET** /projects/{projectId}/dashboards/{dashboardId} | Get dashboard
84
+ *DashboardsApi* | [**get_dashboards**](docs/DashboardsApi.md#get_dashboards) | **GET** /projects/{projectId}/dashboards | List dashboards
85
+ *DashboardsApi* | [**update_dashboard**](docs/DashboardsApi.md#update_dashboard) | **PUT** /projects/{projectId}/dashboards/{dashboardId} | Update dashboard
86
+ *DatasetsApi* | [**delete_dataset**](docs/DatasetsApi.md#delete_dataset) | **DELETE** /projects/{projectId}/datasets/{datasetId} | Delete a dataset
87
+ *DatasetsApi* | [**get_dataset**](docs/DatasetsApi.md#get_dataset) | **GET** /projects/{projectId}/datasets/{datasetId} | Get dataset
88
+ *DatasetsApi* | [**get_dataset_manifest**](docs/DatasetsApi.md#get_dataset_manifest) | **GET** /projects/{projectId}/datasets/{datasetId}/files | Get dataset manifest
89
+ *DatasetsApi* | [**get_datasets**](docs/DatasetsApi.md#get_datasets) | **GET** /projects/{projectId}/datasets | List datasets
90
+ *DatasetsApi* | [**import_public_dataset**](docs/DatasetsApi.md#import_public_dataset) | **POST** /projects/{projectId}/datasets/import | Import public dataset
91
+ *DatasetsApi* | [**ingest_samples**](docs/DatasetsApi.md#ingest_samples) | **PUT** /projects/{projectId}/datasets/{datasetId}/ingest-samples | Rerun sample ingest
92
+ *DatasetsApi* | [**regenerate_manifest**](docs/DatasetsApi.md#regenerate_manifest) | **PUT** /projects/{projectId}/datasets/{datasetId}/regenerate-manifest | Regenerate dataset manifest
93
+ *DatasetsApi* | [**rerun_transform**](docs/DatasetsApi.md#rerun_transform) | **PUT** /projects/{projectId}/datasets/{datasetId}/rerun-transform | Rerun data transforms
94
+ *DatasetsApi* | [**update_dataset**](docs/DatasetsApi.md#update_dataset) | **PUT** /projects/{projectId}/datasets/{datasetId} | Update dataset
95
+ *DatasetsApi* | [**upload_dataset**](docs/DatasetsApi.md#upload_dataset) | **POST** /projects/{projectId}/datasets/upload | Upload private dataset
96
+ *ExecutionApi* | [**get_execution_logs**](docs/ExecutionApi.md#get_execution_logs) | **GET** /projects/{projectId}/execution/{datasetId}/logs | Get execution logs
97
+ *ExecutionApi* | [**get_project_summary**](docs/ExecutionApi.md#get_project_summary) | **GET** /projects/{projectId}/execution | Get execution summary
98
+ *ExecutionApi* | [**get_task_logs**](docs/ExecutionApi.md#get_task_logs) | **GET** /projects/{projectId}/execution/{datasetId}/tasks/{taskId}/logs | Get task logs
99
+ *ExecutionApi* | [**get_tasks_for_execution**](docs/ExecutionApi.md#get_tasks_for_execution) | **GET** /projects/{projectId}/execution/{datasetId}/tasks | Get execution tasks
100
+ *ExecutionApi* | [**run_analysis**](docs/ExecutionApi.md#run_analysis) | **POST** /projects/{projectId}/execution | Run analysis
101
+ *ExecutionApi* | [**stop_analysis**](docs/ExecutionApi.md#stop_analysis) | **PUT** /projects/{projectId}/execution/{datasetId}/stop | Stop execution
102
+ *FileApi* | [**generate_project_file_access_token**](docs/FileApi.md#generate_project_file_access_token) | **POST** /projects/{projectId}/s3-token | Create project file access token
103
+ *FileApi* | [**generate_project_sftp_token**](docs/FileApi.md#generate_project_sftp_token) | **POST** /projects/{projectId}/sftp-token | Create project SFTP Token
104
+ *MetadataApi* | [**get_project_samples**](docs/MetadataApi.md#get_project_samples) | **GET** /projects/{projectId}/samples | Get project samples
105
+ *MetadataApi* | [**get_project_schema**](docs/MetadataApi.md#get_project_schema) | **GET** /projects/{projectId}/schema | Get project metadata schema
106
+ *MetadataApi* | [**update_project_schema**](docs/MetadataApi.md#update_project_schema) | **PUT** /projects/{projectId}/schema | Update project metadata schema
107
+ *MetadataApi* | [**update_sample**](docs/MetadataApi.md#update_sample) | **PUT** /projects/{projectId}/samples/{sampleId} | Update sample
108
+ *MetricsApi* | [**get_all_metrics**](docs/MetricsApi.md#get_all_metrics) | **GET** /metrics | Get all project metrics
109
+ *MetricsApi* | [**get_project_metrics**](docs/MetricsApi.md#get_project_metrics) | **GET** /projects/{projectId}/metrics | Get project metrics
110
+ *NotebooksApi* | [**create_notebook_instance**](docs/NotebooksApi.md#create_notebook_instance) | **POST** /projects/{projectId}/notebook-instances | Create notebook instance
111
+ *NotebooksApi* | [**delete_notebook_instance**](docs/NotebooksApi.md#delete_notebook_instance) | **DELETE** /projects/{projectId}/notebook-instances/{notebookInstanceId} | Delete notebook instance
112
+ *NotebooksApi* | [**generate_notebook_instance_url**](docs/NotebooksApi.md#generate_notebook_instance_url) | **GET** /projects/{projectId}/notebook-instances/{notebookInstanceId}:generate-url | Generate notebook instance URL
113
+ *NotebooksApi* | [**get_notebook_instance_status**](docs/NotebooksApi.md#get_notebook_instance_status) | **GET** /projects/{projectId}/notebook-instances/{notebookInstanceId}:status | Get notebook instance status
114
+ *NotebooksApi* | [**get_notebook_instances**](docs/NotebooksApi.md#get_notebook_instances) | **GET** /projects/{projectId}/notebook-instances | Get notebook instances
115
+ *NotebooksApi* | [**stop_notebook_instance**](docs/NotebooksApi.md#stop_notebook_instance) | **POST** /projects/{projectId}/notebook-instances/{notebookInstanceId}:stop | Stop notebook instance
116
+ *ProcessesApi* | [**archive_custom_process**](docs/ProcessesApi.md#archive_custom_process) | **DELETE** /processes/{processId} | Archive custom process
117
+ *ProcessesApi* | [**create_custom_process**](docs/ProcessesApi.md#create_custom_process) | **POST** /processes | Create custom process
118
+ *ProcessesApi* | [**get_process**](docs/ProcessesApi.md#get_process) | **GET** /processes/{processId} | Get process
119
+ *ProcessesApi* | [**get_process_parameters**](docs/ProcessesApi.md#get_process_parameters) | **GET** /processes/{processId}/parameters | Get process parameters
120
+ *ProcessesApi* | [**get_processes**](docs/ProcessesApi.md#get_processes) | **GET** /processes | List processes
121
+ *ProcessesApi* | [**sync_custom_process**](docs/ProcessesApi.md#sync_custom_process) | **PUT** /processes/{processId}:sync | Sync custom process
122
+ *ProcessesApi* | [**update_custom_process**](docs/ProcessesApi.md#update_custom_process) | **PUT** /processes/{processId} | Update custom process
123
+ *ProcessesApi* | [**validate_file_requirements**](docs/ProcessesApi.md#validate_file_requirements) | **POST** /processes/{processId}/validate-files | Validate file requirements
124
+ *ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /projects | Create project
125
+ *ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /projects/{projectId} | Get project
126
+ *ProjectsApi* | [**get_project_users**](docs/ProjectsApi.md#get_project_users) | **GET** /projects/{projectId}/permissions | Get project permissions
127
+ *ProjectsApi* | [**get_projects**](docs/ProjectsApi.md#get_projects) | **GET** /projects | Get projects
128
+ *ProjectsApi* | [**redeploy_project**](docs/ProjectsApi.md#redeploy_project) | **PUT** /projects/{projectId}:re-deploy | Redeploy project
129
+ *ProjectsApi* | [**set_user_project_role**](docs/ProjectsApi.md#set_user_project_role) | **PUT** /projects/{projectId}/permissions | Set role
130
+ *ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PUT** /projects/{projectId} | Update project
131
+ *ProjectsApi* | [**update_project_tags**](docs/ProjectsApi.md#update_project_tags) | **PUT** /projects/{projectId}:tags | Set project tags
132
+ *ReferencesApi* | [**create_project_reference**](docs/ReferencesApi.md#create_project_reference) | **POST** /projects/{projectId}/references | Create project reference
133
+ *ReferencesApi* | [**delete_project_reference**](docs/ReferencesApi.md#delete_project_reference) | **DELETE** /projects/{projectId}/references | Delete project reference
134
+ *ReferencesApi* | [**get_reference_types**](docs/ReferencesApi.md#get_reference_types) | **GET** /reference-types | Get reference types
135
+ *ReferencesApi* | [**get_references**](docs/ReferencesApi.md#get_references) | **GET** /references | Get global references
136
+ *ReferencesApi* | [**get_references_for_project**](docs/ReferencesApi.md#get_references_for_project) | **GET** /projects/{projectId}/references | Get project references
137
+ *ReferencesApi* | [**refresh_project_references**](docs/ReferencesApi.md#refresh_project_references) | **PUT** /projects/{projectId}/references | Refresh project references
138
+ *SystemApi* | [**get_service_connections**](docs/SystemApi.md#get_service_connections) | **GET** /service-connections | Get service connections
139
+ *SystemApi* | [**info**](docs/SystemApi.md#info) | **GET** /info | Get system info
140
+ *UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /users/{username} | Get user
141
+ *UsersApi* | [**get_users**](docs/UsersApi.md#get_users) | **GET** /users | List users
142
+ *UsersApi* | [**invite_user**](docs/UsersApi.md#invite_user) | **POST** /users | Invite user
143
+ *UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /users/{username} | Update user
144
+
145
+
146
+ ## Documentation For Models
147
+
148
+ - [AWSCredentials](docs/AWSCredentials.md)
149
+ - [AccessType](docs/AccessType.md)
150
+ - [AllowedDataType](docs/AllowedDataType.md)
151
+ - [BillingAccount](docs/BillingAccount.md)
152
+ - [BillingAccountRequest](docs/BillingAccountRequest.md)
153
+ - [BillingMethod](docs/BillingMethod.md)
154
+ - [BudgetPeriod](docs/BudgetPeriod.md)
155
+ - [CloudAccount](docs/CloudAccount.md)
156
+ - [Contact](docs/Contact.md)
157
+ - [CreateNotebookInstanceRequest](docs/CreateNotebookInstanceRequest.md)
158
+ - [CreateReferenceRequest](docs/CreateReferenceRequest.md)
159
+ - [CreateResponse](docs/CreateResponse.md)
160
+ - [CustomPipelineSettings](docs/CustomPipelineSettings.md)
161
+ - [CustomerType](docs/CustomerType.md)
162
+ - [Dashboard](docs/Dashboard.md)
163
+ - [DashboardRequest](docs/DashboardRequest.md)
164
+ - [Dataset](docs/Dataset.md)
165
+ - [DatasetAssetsManifest](docs/DatasetAssetsManifest.md)
166
+ - [DatasetDetail](docs/DatasetDetail.md)
167
+ - [DatasetViz](docs/DatasetViz.md)
168
+ - [ErrorMessage](docs/ErrorMessage.md)
169
+ - [Executor](docs/Executor.md)
170
+ - [FileAccessRequest](docs/FileAccessRequest.md)
171
+ - [FileEntry](docs/FileEntry.md)
172
+ - [FileNamePattern](docs/FileNamePattern.md)
173
+ - [FileRequirements](docs/FileRequirements.md)
174
+ - [FormSchema](docs/FormSchema.md)
175
+ - [GenerateSftpCredentialsRequest](docs/GenerateSftpCredentialsRequest.md)
176
+ - [GetExecutionLogsResponse](docs/GetExecutionLogsResponse.md)
177
+ - [ImportDataRequest](docs/ImportDataRequest.md)
178
+ - [InviteUserRequest](docs/InviteUserRequest.md)
179
+ - [InviteUserResponse](docs/InviteUserResponse.md)
180
+ - [LogEntry](docs/LogEntry.md)
181
+ - [MetricRecord](docs/MetricRecord.md)
182
+ - [NotebookInstance](docs/NotebookInstance.md)
183
+ - [NotebookInstanceStatusResponse](docs/NotebookInstanceStatusResponse.md)
184
+ - [OpenNotebookInstanceResponse](docs/OpenNotebookInstanceResponse.md)
185
+ - [PaginatedResponseDatasetListDto](docs/PaginatedResponseDatasetListDto.md)
186
+ - [PaginatedResponseSampleDto](docs/PaginatedResponseSampleDto.md)
187
+ - [PipelineCode](docs/PipelineCode.md)
188
+ - [PortalErrorResponse](docs/PortalErrorResponse.md)
189
+ - [Process](docs/Process.md)
190
+ - [ProcessDetail](docs/ProcessDetail.md)
191
+ - [ProcessDetailAllOfPipelineCode](docs/ProcessDetailAllOfPipelineCode.md)
192
+ - [Project](docs/Project.md)
193
+ - [ProjectDetail](docs/ProjectDetail.md)
194
+ - [ProjectMetrics](docs/ProjectMetrics.md)
195
+ - [ProjectRequest](docs/ProjectRequest.md)
196
+ - [ProjectRole](docs/ProjectRole.md)
197
+ - [ProjectSettings](docs/ProjectSettings.md)
198
+ - [ProjectUser](docs/ProjectUser.md)
199
+ - [Reference](docs/Reference.md)
200
+ - [ReferenceType](docs/ReferenceType.md)
201
+ - [RepositoryType](docs/RepositoryType.md)
202
+ - [ResourcesInfo](docs/ResourcesInfo.md)
203
+ - [RunAnalysisRequest](docs/RunAnalysisRequest.md)
204
+ - [Sample](docs/Sample.md)
205
+ - [SampleRequest](docs/SampleRequest.md)
206
+ - [ServiceConnection](docs/ServiceConnection.md)
207
+ - [SetUserProjectRoleRequest](docs/SetUserProjectRoleRequest.md)
208
+ - [SftpCredentials](docs/SftpCredentials.md)
209
+ - [Status](docs/Status.md)
210
+ - [StopExecutionResponse](docs/StopExecutionResponse.md)
211
+ - [SyncStatus](docs/SyncStatus.md)
212
+ - [SystemInfoResponse](docs/SystemInfoResponse.md)
213
+ - [Tag](docs/Tag.md)
214
+ - [Task](docs/Task.md)
215
+ - [UpdateDatasetRequest](docs/UpdateDatasetRequest.md)
216
+ - [UpdateUserRequest](docs/UpdateUserRequest.md)
217
+ - [UploadDatasetCreateResponse](docs/UploadDatasetCreateResponse.md)
218
+ - [UploadDatasetRequest](docs/UploadDatasetRequest.md)
219
+ - [User](docs/User.md)
220
+ - [ValidateFileRequirementsRequest](docs/ValidateFileRequirementsRequest.md)
221
+
222
+
223
+ <a id="documentation-for-authorization"></a>
224
+ ## Documentation For Authorization
225
+
226
+
227
+ Authentication schemes defined for the API:
228
+ <a id="accessToken"></a>
229
+ ### accessToken
230
+
231
+ - **Type**: Bearer authentication (JWT)
232
+
233
+
234
+ ## Author
235
+
236
+ support@cirro.bio
237
+
238
+
cirro_api_client-0.0.1/cirro_api_client/__init__.py ADDED
@@ -0,0 +1,119 @@
1
+ # coding: utf-8
2
+
3
+ # flake8: noqa
4
+
5
+ """
6
+ Cirro Data
7
+
8
+ Cirro Data Platform service API
9
+
10
+ The version of the OpenAPI document: latest
11
+ Contact: support@cirro.bio
12
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
13
+
14
+ Do not edit the class manually.
15
+ """ # noqa: E501
16
+
17
+
18
+ __version__ = "0.0.1"
19
+
20
+ # import apis into sdk package
21
+ from cirro_api_client.api.billing_api import BillingApi
22
+ from cirro_api_client.api.dashboards_api import DashboardsApi
23
+ from cirro_api_client.api.datasets_api import DatasetsApi
24
+ from cirro_api_client.api.execution_api import ExecutionApi
25
+ from cirro_api_client.api.file_api import FileApi
26
+ from cirro_api_client.api.metadata_api import MetadataApi
27
+ from cirro_api_client.api.metrics_api import MetricsApi
28
+ from cirro_api_client.api.notebooks_api import NotebooksApi
29
+ from cirro_api_client.api.processes_api import ProcessesApi
30
+ from cirro_api_client.api.projects_api import ProjectsApi
31
+ from cirro_api_client.api.references_api import ReferencesApi
32
+ from cirro_api_client.api.system_api import SystemApi
33
+ from cirro_api_client.api.users_api import UsersApi
34
+
35
+ # import ApiClient
36
+ from cirro_api_client.api_response import ApiResponse
37
+ from cirro_api_client.cirro_api_client import CirroApiClient
38
+ from cirro_api_client.configuration import Configuration
39
+ from cirro_api_client.exceptions import OpenApiException
40
+ from cirro_api_client.exceptions import ApiTypeError
41
+ from cirro_api_client.exceptions import ApiValueError
42
+ from cirro_api_client.exceptions import ApiKeyError
43
+ from cirro_api_client.exceptions import ApiAttributeError
44
+ from cirro_api_client.exceptions import ApiException
45
+
46
+ # import models into sdk package
47
+ from cirro_api_client.models.aws_credentials import AWSCredentials
48
+ from cirro_api_client.models.access_type import AccessType
49
+ from cirro_api_client.models.allowed_data_type import AllowedDataType
50
+ from cirro_api_client.models.billing_account import BillingAccount
51
+ from cirro_api_client.models.billing_account_request import BillingAccountRequest
52
+ from cirro_api_client.models.billing_method import BillingMethod
53
+ from cirro_api_client.models.budget_period import BudgetPeriod
54
+ from cirro_api_client.models.cloud_account import CloudAccount
55
+ from cirro_api_client.models.contact import Contact
56
+ from cirro_api_client.models.create_notebook_instance_request import CreateNotebookInstanceRequest
57
+ from cirro_api_client.models.create_reference_request import CreateReferenceRequest
58
+ from cirro_api_client.models.create_response import CreateResponse
59
+ from cirro_api_client.models.custom_pipeline_settings import CustomPipelineSettings
60
+ from cirro_api_client.models.customer_type import CustomerType
61
+ from cirro_api_client.models.dashboard import Dashboard
62
+ from cirro_api_client.models.dashboard_request import DashboardRequest
63
+ from cirro_api_client.models.dataset import Dataset
64
+ from cirro_api_client.models.dataset_assets_manifest import DatasetAssetsManifest
65
+ from cirro_api_client.models.dataset_detail import DatasetDetail
66
+ from cirro_api_client.models.dataset_viz import DatasetViz
67
+ from cirro_api_client.models.error_message import ErrorMessage
68
+ from cirro_api_client.models.executor import Executor
69
+ from cirro_api_client.models.file_access_request import FileAccessRequest
70
+ from cirro_api_client.models.file_entry import FileEntry
71
+ from cirro_api_client.models.file_name_pattern import FileNamePattern
72
+ from cirro_api_client.models.file_requirements import FileRequirements
73
+ from cirro_api_client.models.form_schema import FormSchema
74
+ from cirro_api_client.models.generate_sftp_credentials_request import GenerateSftpCredentialsRequest
75
+ from cirro_api_client.models.get_execution_logs_response import GetExecutionLogsResponse
76
+ from cirro_api_client.models.import_data_request import ImportDataRequest
77
+ from cirro_api_client.models.invite_user_request import InviteUserRequest
78
+ from cirro_api_client.models.invite_user_response import InviteUserResponse
79
+ from cirro_api_client.models.log_entry import LogEntry
80
+ from cirro_api_client.models.metric_record import MetricRecord
81
+ from cirro_api_client.models.notebook_instance import NotebookInstance
82
+ from cirro_api_client.models.notebook_instance_status_response import NotebookInstanceStatusResponse
83
+ from cirro_api_client.models.open_notebook_instance_response import OpenNotebookInstanceResponse
84
+ from cirro_api_client.models.paginated_response_dataset_list_dto import PaginatedResponseDatasetListDto
85
+ from cirro_api_client.models.paginated_response_sample_dto import PaginatedResponseSampleDto
86
+ from cirro_api_client.models.pipeline_code import PipelineCode
87
+ from cirro_api_client.models.portal_error_response import PortalErrorResponse
88
+ from cirro_api_client.models.process import Process
89
+ from cirro_api_client.models.process_detail import ProcessDetail
90
+ from cirro_api_client.models.process_detail_all_of_pipeline_code import ProcessDetailAllOfPipelineCode
91
+ from cirro_api_client.models.project import Project
92
+ from cirro_api_client.models.project_detail import ProjectDetail
93
+ from cirro_api_client.models.project_metrics import ProjectMetrics
94
+ from cirro_api_client.models.project_request import ProjectRequest
95
+ from cirro_api_client.models.project_role import ProjectRole
96
+ from cirro_api_client.models.project_settings import ProjectSettings
97
+ from cirro_api_client.models.project_user import ProjectUser
98
+ from cirro_api_client.models.reference import Reference
99
+ from cirro_api_client.models.reference_type import ReferenceType
100
+ from cirro_api_client.models.repository_type import RepositoryType
101
+ from cirro_api_client.models.resources_info import ResourcesInfo
102
+ from cirro_api_client.models.run_analysis_request import RunAnalysisRequest
103
+ from cirro_api_client.models.sample import Sample
104
+ from cirro_api_client.models.sample_request import SampleRequest
105
+ from cirro_api_client.models.service_connection import ServiceConnection
106
+ from cirro_api_client.models.set_user_project_role_request import SetUserProjectRoleRequest
107
+ from cirro_api_client.models.sftp_credentials import SftpCredentials
108
+ from cirro_api_client.models.status import Status
109
+ from cirro_api_client.models.stop_execution_response import StopExecutionResponse
110
+ from cirro_api_client.models.sync_status import SyncStatus
111
+ from cirro_api_client.models.system_info_response import SystemInfoResponse
112
+ from cirro_api_client.models.tag import Tag
113
+ from cirro_api_client.models.task import Task
114
+ from cirro_api_client.models.update_dataset_request import UpdateDatasetRequest
115
+ from cirro_api_client.models.update_user_request import UpdateUserRequest
116
+ from cirro_api_client.models.upload_dataset_create_response import UploadDatasetCreateResponse
117
+ from cirro_api_client.models.upload_dataset_request import UploadDatasetRequest
118
+ from cirro_api_client.models.user import User
119
+ from cirro_api_client.models.validate_file_requirements_request import ValidateFileRequirementsRequest
cirro_api_client-0.0.1/cirro_api_client/api/__init__.py ADDED
@@ -0,0 +1,17 @@
1
+ # flake8: noqa
2
+
3
+ # import apis into api package
4
+ from cirro_api_client.api.billing_api import BillingApi
5
+ from cirro_api_client.api.dashboards_api import DashboardsApi
6
+ from cirro_api_client.api.datasets_api import DatasetsApi
7
+ from cirro_api_client.api.execution_api import ExecutionApi
8
+ from cirro_api_client.api.file_api import FileApi
9
+ from cirro_api_client.api.metadata_api import MetadataApi
10
+ from cirro_api_client.api.metrics_api import MetricsApi
11
+ from cirro_api_client.api.notebooks_api import NotebooksApi
12
+ from cirro_api_client.api.processes_api import ProcessesApi
13
+ from cirro_api_client.api.projects_api import ProjectsApi
14
+ from cirro_api_client.api.references_api import ReferencesApi
15
+ from cirro_api_client.api.system_api import SystemApi
16
+ from cirro_api_client.api.users_api import UsersApi
17
+