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