qi-compute-api-client 0.46.0__tar.gz → 0.47.0__tar.gz

qi_compute_api_client-0.47.0/LICENSE.md

@@ -0,0 +1,142 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1
+    through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or
+    are under common control with that entity. For the purposes of this definition, "control" means (i) the power,
+    direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii)
+    ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications, including but not limited to software source
+    code, documentation source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form,
+    including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as
+    indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix
+    below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the
+    Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole,
+    an original work of authorship. For the purposes of this License, Derivative Works shall not include works that
+    remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications
+    or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in
+    the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright
+    owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written
+    communication sent to the Licensor or its representatives, including but not limited to communication on electronic
+    mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously
+    marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been
+    received by Licensor and subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to
+    You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce,
+    prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such
+    Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You
+    a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section)
+    patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such
+    license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was
+    submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a
+    lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory
+    patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of
+    the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
+    or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+    (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent,
+    trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to
+    any part of the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You
+    distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding
+    those notices that do not pertain to any part of the Derivative Works, in at least one of the following places:
+    within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if
+    provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever
+    such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do
+    not modify the License. You may add Your own attribution notices within Derivative Works that You distribute,
+    alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices
+    cannot be construed as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and may provide additional or different license terms
+    and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a
+    whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated
+    in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for
+    inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any
+    additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any
+    separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product
+    names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and
+    reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and
+    each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+    either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
+    MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness
+    of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this
+    License.
+
+8.  Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or
+    otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in
+    writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or
+    consequential damages of any character arising as a result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+    any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of
+    such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may
+    choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations
+    and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own
+    behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such
+    Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
+License. You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
+language governing permissions and limitations under the License.

qi_compute_api_client-0.47.0/PKG-INFO

@@ -0,0 +1,268 @@
+Metadata-Version: 2.3
+Name: qi-compute-api-client
+Version: 0.47.0
+Summary: An API client for the Compute Job Manager of Quantum Inspire.
+License: Apache-2.0
+Author: Quantum Inspire
+Author-email: support@quantum-inspire.eu
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: aiohttp (>=3.10.5,<4.0.0)
+Requires-Dist: pydantic (>=2.10.4,<3.0.0)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
+Requires-Dist: urllib3 (>=2.0.0,<3.0.0)
+Project-URL: Repository, https://github.com/QuTech-Delft/compute-api-client
+Description-Content-Type: text/markdown
+
+# compute-api-client
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The `compute_api_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)
+project:
+
+- API version: 0.1.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.7+
+
+## Installation & Usage
+
+This python library package is generated without supporting files like setup.py or requirements files
+
+To be able to use it, you will need these dependencies in your own package that uses this library:
+
+- urllib3 >= 1.25.3
+- python-dateutil
+- aiohttp
+- pydantic
+
+## Getting Started
+
+In your own code, to use this library to connect and interact with compute-api-client, you can run the following:
+
+```python
+
+import time
+import compute_api_client
+from compute_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = compute_api_client.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+
+# Enter a context with an instance of the API client
+async with compute_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = compute_api_client.AlgorithmsApi(api_client)
+    algorithm_in = compute_api_client.AlgorithmIn() # AlgorithmIn |
+
+    try:
+        # Create algorithm
+        api_response = await api_instance.create_algorithm_algorithms_post(algorithm_in)
+        print("The response of AlgorithmsApi->create_algorithm_algorithms_post:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AlgorithmsApi->create_algorithm_algorithms_post: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to _http://localhost_
+
+| Class             | Method                                                                                                                                                                       | HTTP request                              | Description                                |
+| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------ |
+| _AlgorithmsApi_   | [**create_algorithm_algorithms_post**](compute_api_client/docs/AlgorithmsApi.md#create_algorithm_algorithms_post)                                                            | **POST** /algorithms                      | Create algorithm                           |
+| _AlgorithmsApi_   | [**delete_algorithm_algorithms_id_delete**](compute_api_client/docs/AlgorithmsApi.md#delete_algorithm_algorithms_id_delete)                                                  | **DELETE** /algorithms/{id}               | Destroy algorithm                          |
+| _AlgorithmsApi_   | [**read_algorithm_algorithms_id_get**](compute_api_client/docs/AlgorithmsApi.md#read_algorithm_algorithms_id_get)                                                            | **GET** /algorithms/{id}                  | Retrieve algorithm                         |
+| _AlgorithmsApi_   | [**read_algorithms_algorithms_get**](compute_api_client/docs/AlgorithmsApi.md#read_algorithms_algorithms_get)                                                                | **GET** /algorithms                       | List algorithms                            |
+| _AlgorithmsApi_   | [**update_algorithm_algorithms_id_put**](compute_api_client/docs/AlgorithmsApi.md#update_algorithm_algorithms_id_put)                                                        | **PUT** /algorithms/{id}                  | Update algorithm                           |
+| _AuthConfigApi_   | [**auth_config_auth_config_get**](compute_api_client/docs/AuthConfigApi.md#auth_config_auth_config_get)                                                                      | **GET** /auth_config                      | Get suggested authentication configuration |
+| _BackendApi_      | [**create_backend_backends_post**](compute_api_client/docs/BackendApi.md#create_backend_backends_post)                                                                       | **POST** /backends                        | Create backend                             |
+| _BackendApi_      | [**read_backend_backends_id_get**](compute_api_client/docs/BackendApi.md#read_backend_backends_id_get)                                                                       | **GET** /backends/{id}                    | Retrieve backend                           |
+| _BackendApi_      | [**read_backend_self_backends_me_get**](compute_api_client/docs/BackendApi.md#read_backend_self_backends_me_get)                                                             | **GET** /backends/me                      | Retrieve backend                           |
+| _BackendApi_      | [**read_backends_backends_get**](compute_api_client/docs/BackendApi.md#read_backends_backends_get)                                                                           | **GET** /backends                         | List backends                              |
+| _BackendApi_      | [**update_backend_self_backends_me_patch**](compute_api_client/docs/BackendApi.md#update_backend_self_backends_me_patch)                                                     | **PATCH** /backends/me                    | Update backend                             |
+| _BackendTypesApi_ | [**read_backend_type_backend_types_id_get**](compute_api_client/docs/BackendTypesApi.md#read_backend_type_backend_types_id_get)                                              | **GET** /backend_types/{id}               | Retrieve backend type                      |
+| _BackendTypesApi_ | [**read_backend_types_backend_types_get**](compute_api_client/docs/BackendTypesApi.md#read_backend_types_backend_types_get)                                                  | **GET** /backend_types/                   | List backend types                         |
+| _BatchJobsApi_    | [**create_batch_job_batch_jobs_post**](compute_api_client/docs/BatchJobsApi.md#create_batch_job_batch_jobs_post)                                                             | **POST** /batch_jobs                      | Create batch job                           |
+| _BatchJobsApi_    | [**enqueue_batch_job_batch_jobs_id_enqueue_patch**](compute_api_client/docs/BatchJobsApi.md#enqueue_batch_job_batch_jobs_id_enqueue_patch)                                   | **PATCH** /batch_jobs/{id}/enqueue        | Enqueue batch job for execution            |
+| _BatchJobsApi_    | [**finish_batch_job_batch_jobs_id_finish_patch**](compute_api_client/docs/BatchJobsApi.md#finish_batch_job_batch_jobs_id_finish_patch)                                       | **PATCH** /batch_jobs/{id}/finish         | Finish batch job                           |
+| _BatchJobsApi_    | [**peek_batch_job_batch_jobs_peek_patch**](compute_api_client/docs/BatchJobsApi.md#peek_batch_job_batch_jobs_peek_patch)                                                     | **PATCH** /batch_jobs/peek                | Peek batch job                             |
+| _BatchJobsApi_    | [**pop_batch_job_batch_jobs_pop_patch**](compute_api_client/docs/BatchJobsApi.md#pop_batch_job_batch_jobs_pop_patch)                                                         | **PATCH** /batch_jobs/pop                 | Take batch job                             |
+| _BatchJobsApi_    | [**read_batch_jobs_batch_jobs_get**](compute_api_client/docs/BatchJobsApi.md#read_batch_jobs_batch_jobs_get)                                                                 | **GET** /batch_jobs                       | List batch jobs                            |
+| _BatchJobsApi_    | [**unpop_batch_job_batch_jobs_unpop_patch**](compute_api_client/docs/BatchJobsApi.md#unpop_batch_job_batch_jobs_unpop_patch)                                                 | **PATCH** /batch_jobs/unpop               | Take batch job                             |
+| _CommitsApi_      | [**compile_commit_commits_id_compile_post**](compute_api_client/docs/CommitsApi.md#compile_commit_commits_id_compile_post)                                                   | **POST** /commits/{id}/compile            | Compile file in a commit                   |
+| _CommitsApi_      | [**create_commit_commits_post**](compute_api_client/docs/CommitsApi.md#create_commit_commits_post)                                                                           | **POST** /commits                         | Create commit                              |
+| _CommitsApi_      | [**delete_commit_commits_id_delete**](compute_api_client/docs/CommitsApi.md#delete_commit_commits_id_delete)                                                                 | **DELETE** /commits/{id}                  | Destroy commit                             |
+| _CommitsApi_      | [**read_commit_commits_id_get**](compute_api_client/docs/CommitsApi.md#read_commit_commits_id_get)                                                                           | **GET** /commits/{id}                     | Get commit by ID                           |
+| _CommitsApi_      | [**read_commits_commits_get**](compute_api_client/docs/CommitsApi.md#read_commits_commits_get)                                                                               | **GET** /commits                          | List commits                               |
+| _FilesApi_        | [**create_file_files_post**](compute_api_client/docs/FilesApi.md#create_file_files_post)                                                                                     | **POST** /files                           | Create file                                |
+| _FilesApi_        | [**delete_file_files_id_delete**](compute_api_client/docs/FilesApi.md#delete_file_files_id_delete)                                                                           | **DELETE** /files/{id}                    | Destroy file                               |
+| _FilesApi_        | [**read_file_files_id_get**](compute_api_client/docs/FilesApi.md#read_file_files_id_get)                                                                                     | **GET** /files/{id}                       | Retrieve file                              |
+| _FilesApi_        | [**read_files_files_get**](compute_api_client/docs/FilesApi.md#read_files_files_get)                                                                                         | **GET** /files                            | List files                                 |
+| _FinalResultsApi_ | [**create_final_result_final_results_post**](compute_api_client/docs/FinalResultsApi.md#create_final_result_final_results_post)                                              | **POST** /final_results                   | Create final result                        |
+| _FinalResultsApi_ | [**read_final_result_by_job_id_final_results_job_job_id_get**](compute_api_client/docs/FinalResultsApi.md#read_final_result_by_job_id_final_results_job_job_id_get)          | **GET** /final_results/job/{job_id}       | Retrieve final result by job ID            |
+| _FinalResultsApi_ | [**read_final_result_final_results_id_get**](compute_api_client/docs/FinalResultsApi.md#read_final_result_final_results_id_get)                                              | **GET** /final_results/{id}               | Retrieve final result                      |
+| _HealthApi_       | [**healthz_healthz_get**](compute_api_client/docs/HealthApi.md#healthz_healthz_get)                                                                                          | **GET** /healthz                          | Report health                              |
+| _JobsApi_         | [**create_job_jobs_post**](compute_api_client/docs/JobsApi.md#create_job_jobs_post)                                                                                          | **POST** /jobs                            | Create job                                 |
+| _JobsApi_         | [**delete_job_jobs_id_delete**](compute_api_client/docs/JobsApi.md#delete_job_jobs_id_delete)                                                                                | **DELETE** /jobs/{id}                     | Destroy job                                |
+| _JobsApi_         | [**read_job_jobs_id_get**](compute_api_client/docs/JobsApi.md#read_job_jobs_id_get)                                                                                          | **GET** /jobs/{id}                        | Retrieve job                               |
+| _JobsApi_         | [**read_jobs_jobs_get**](compute_api_client/docs/JobsApi.md#read_jobs_jobs_get)                                                                                              | **GET** /jobs                             | List jobs                                  |
+| _JobsApi_         | [**update_job_status_jobs_id_patch**](compute_api_client/docs/JobsApi.md#update_job_status_jobs_id_patch)                                                                    | **PATCH** /jobs/{id}                      | Update Job Status                          |
+| _LanguagesApi_    | [**read_language_languages_id_get**](compute_api_client/docs/LanguagesApi.md#read_language_languages_id_get)                                                                 | **GET** /languages/{id}                   | Retrieve language                          |
+| _LanguagesApi_    | [**read_languages_languages_get**](compute_api_client/docs/LanguagesApi.md#read_languages_languages_get)                                                                     | **GET** /languages                        | List languages                             |
+| _MembersApi_      | [**create_member_members_post**](compute_api_client/docs/MembersApi.md#create_member_members_post)                                                                           | **POST** /members                         | Create member                              |
+| _MembersApi_      | [**delete_member_members_id_delete**](compute_api_client/docs/MembersApi.md#delete_member_members_id_delete)                                                                 | **DELETE** /members/{id}                  | Destroy member                             |
+| _MembersApi_      | [**read_member_members_id_get**](compute_api_client/docs/MembersApi.md#read_member_members_id_get)                                                                           | **GET** /members/{id}                     | Retrieve member                            |
+| _MembersApi_      | [**read_members_members_get**](compute_api_client/docs/MembersApi.md#read_members_members_get)                                                                               | **GET** /members                          | List members                               |
+| _MetadataApi_     | [**create_metadata_self_metadata_post**](compute_api_client/docs/MetadataApi.md#create_metadata_self_metadata_post)                                                          | **POST** /metadata                        | Create metadata                            |
+| _MetadataApi_     | [**read_metadata_by_backend_id_metadata_backend_backend_id_get**](compute_api_client/docs/MetadataApi.md#read_metadata_by_backend_id_metadata_backend_backend_id_get)        | **GET** /metadata/backend/{backend_id}    | Retrieve metadata by backend ID            |
+| _MetadataApi_     | [**read_metadata_metadata_id_get**](compute_api_client/docs/MetadataApi.md#read_metadata_metadata_id_get)                                                                    | **GET** /metadata/{id}                    | Get metadata by ID                         |
+| _PermissionsApi_  | [**read_permission_group_permission_groups_id_get**](compute_api_client/docs/PermissionsApi.md#read_permission_group_permission_groups_id_get)                               | **GET** /permission_groups/{id}           | Retrieve permission groups                 |
+| _PermissionsApi_  | [**read_permission_groups_permission_groups_get**](compute_api_client/docs/PermissionsApi.md#read_permission_groups_permission_groups_get)                                   | **GET** /permission_groups/               | List permission groups                     |
+| _PermissionsApi_  | [**read_permission_permissions_id_get**](compute_api_client/docs/PermissionsApi.md#read_permission_permissions_id_get)                                                       | **GET** /permissions/{id}                 | Retrieve permissions                       |
+| _PermissionsApi_  | [**read_permissions_permissions_get**](compute_api_client/docs/PermissionsApi.md#read_permissions_permissions_get)                                                           | **GET** /permissions/                     | List permissions                           |
+| _ProjectsApi_     | [**create_project_projects_post**](compute_api_client/docs/ProjectsApi.md#create_project_projects_post)                                                                      | **POST** /projects                        | Create project                             |
+| _ProjectsApi_     | [**delete_project_projects_id_delete**](compute_api_client/docs/ProjectsApi.md#delete_project_projects_id_delete)                                                            | **DELETE** /projects/{id}                 | Destroy project                            |
+| _ProjectsApi_     | [**partial_update_project_projects_id_patch**](compute_api_client/docs/ProjectsApi.md#partial_update_project_projects_id_patch)                                              | **PATCH** /projects/{id}                  | Partially update project                   |
+| _ProjectsApi_     | [**read_project_projects_id_get**](compute_api_client/docs/ProjectsApi.md#read_project_projects_id_get)                                                                      | **GET** /projects/{id}                    | Retrieve project                           |
+| _ProjectsApi_     | [**read_projects_projects_get**](compute_api_client/docs/ProjectsApi.md#read_projects_projects_get)                                                                          | **GET** /projects                         | List projects                              |
+| _ProjectsApi_     | [**update_project_projects_id_put**](compute_api_client/docs/ProjectsApi.md#update_project_projects_id_put)                                                                  | **PUT** /projects/{id}                    | Update project                             |
+| _ReservationsApi_ | [**create_reservation_reservations_post**](compute_api_client/docs/ReservationsApi.md#create_reservation_reservations_post)                                                  | **POST** /reservations                    | Create reservation                         |
+| _ReservationsApi_ | [**read_reservation_reservations_id_get**](compute_api_client/docs/ReservationsApi.md#read_reservation_reservations_id_get)                                                  | **GET** /reservations/{id}                | Retrieve reservation                       |
+| _ReservationsApi_ | [**read_reservations_reservations_get**](compute_api_client/docs/ReservationsApi.md#read_reservations_reservations_get)                                                      | **GET** /reservations                     | List reservations                          |
+| _ReservationsApi_ | [**terminate_reservation_reservations_id_terminate_patch**](compute_api_client/docs/ReservationsApi.md#terminate_reservation_reservations_id_terminate_patch)                | **PATCH** /reservations/{id}/terminate    | Terminate reservation                      |
+| _ResultsApi_      | [**create_result_results_post**](compute_api_client/docs/ResultsApi.md#create_result_results_post)                                                                           | **POST** /results                         | Create result                              |
+| _ResultsApi_      | [**delete_results_by_job_id_results_job_job_id_delete**](compute_api_client/docs/ResultsApi.md#delete_results_by_job_id_results_job_job_id_delete)                           | **DELETE** /results/job/{job_id}          | Delete results by job ID                   |
+| _ResultsApi_      | [**read_result_results_id_get**](compute_api_client/docs/ResultsApi.md#read_result_results_id_get)                                                                           | **GET** /results/{id}                     | Retrieve result                            |
+| _ResultsApi_      | [**read_results_by_algorithm_id_results_algorithm_algorithm_id_get**](compute_api_client/docs/ResultsApi.md#read_results_by_algorithm_id_results_algorithm_algorithm_id_get) | **GET** /results/algorithm/{algorithm_id} | Retrieve results by algorithm ID           |
+| _ResultsApi_      | [**read_results_by_job_id_results_job_job_id_get**](compute_api_client/docs/ResultsApi.md#read_results_by_job_id_results_job_job_id_get)                                     | **GET** /results/job/{job_id}             | Retrieve results by job ID                 |
+| _TeamsApi_        | [**read_team_teams_id_get**](compute_api_client/docs/TeamsApi.md#read_team_teams_id_get)                                                                                     | **GET** /teams/{id}                       | Retrieve teams                             |
+| _TeamsApi_        | [**read_teams_teams_get**](compute_api_client/docs/TeamsApi.md#read_teams_teams_get)                                                                                         | **GET** /teams/                           | List teams                                 |
+| _TransactionsApi_ | [**read_transaction_transactions_id_get**](compute_api_client/docs/TransactionsApi.md#read_transaction_transactions_id_get)                                                  | **GET** /transactions/{id}                | Retrieve transactions                      |
+| _TransactionsApi_ | [**read_transactions_transactions_get**](compute_api_client/docs/TransactionsApi.md#read_transactions_transactions_get)                                                      | **GET** /transactions/                    | List transactions                          |
+| _UsersApi_        | [**create_user_users_post**](compute_api_client/docs/UsersApi.md#create_user_users_post)                                                                                     | **POST** /users                           | Create user                                |
+| _UsersApi_        | [**delete_user_users_id_delete**](compute_api_client/docs/UsersApi.md#delete_user_users_id_delete)                                                                           | **DELETE** /users/{id}                    | Destroy user                               |
+| _UsersApi_        | [**read_user_users_id_get**](compute_api_client/docs/UsersApi.md#read_user_users_id_get)                                                                                     | **GET** /users/{id}                       | Retrieve user                              |
+| _UsersApi_        | [**read_users_users_get**](compute_api_client/docs/UsersApi.md#read_users_users_get)                                                                                         | **GET** /users                            | List users                                 |
+
+## Documentation For Models
+
+- [Algorithm](compute_api_client/docs/Algorithm.md)
+- [AlgorithmIn](compute_api_client/docs/AlgorithmIn.md)
+- [AlgorithmType](compute_api_client/docs/AlgorithmType.md)
+- [AuthConfig](compute_api_client/docs/AuthConfig.md)
+- [Backend](compute_api_client/docs/Backend.md)
+- [BackendIn](compute_api_client/docs/BackendIn.md)
+- [BackendPatch](compute_api_client/docs/BackendPatch.md)
+- [BackendStatus](compute_api_client/docs/BackendStatus.md)
+- [BackendType](compute_api_client/docs/BackendType.md)
+- [BackendWithAuthentication](compute_api_client/docs/BackendWithAuthentication.md)
+- [BatchJob](compute_api_client/docs/BatchJob.md)
+- [BatchJobIn](compute_api_client/docs/BatchJobIn.md)
+- [BatchJobStatus](compute_api_client/docs/BatchJobStatus.md)
+- [Commit](compute_api_client/docs/Commit.md)
+- [CommitIn](compute_api_client/docs/CommitIn.md)
+- [CompilePayload](compute_api_client/docs/CompilePayload.md)
+- [CompileStage](compute_api_client/docs/CompileStage.md)
+- [Domain](compute_api_client/docs/Domain.md)
+- [File](compute_api_client/docs/File.md)
+- [FileIn](compute_api_client/docs/FileIn.md)
+- [FinalResult](compute_api_client/docs/FinalResult.md)
+- [FinalResultIn](compute_api_client/docs/FinalResultIn.md)
+- [HTTPBadRequestError](compute_api_client/docs/HTTPBadRequestError.md)
+- [HTTPNotFoundError](compute_api_client/docs/HTTPNotFoundError.md)
+- [HTTPValidationError](compute_api_client/docs/HTTPValidationError.md)
+- [Job](compute_api_client/docs/Job.md)
+- [JobIn](compute_api_client/docs/JobIn.md)
+- [JobPatch](compute_api_client/docs/JobPatch.md)
+- [JobStatus](compute_api_client/docs/JobStatus.md)
+- [Language](compute_api_client/docs/Language.md)
+- [LocationInner](compute_api_client/docs/LocationInner.md)
+- [Member](compute_api_client/docs/Member.md)
+- [MemberIn](compute_api_client/docs/MemberIn.md)
+- [Metadata](compute_api_client/docs/Metadata.md)
+- [MetadataIn](compute_api_client/docs/MetadataIn.md)
+- [PageAlgorithm](compute_api_client/docs/PageAlgorithm.md)
+- [PageBackend](compute_api_client/docs/PageBackend.md)
+- [PageBackendType](compute_api_client/docs/PageBackendType.md)
+- [PageBatchJob](compute_api_client/docs/PageBatchJob.md)
+- [PageCommit](compute_api_client/docs/PageCommit.md)
+- [PageFile](compute_api_client/docs/PageFile.md)
+- [PageJob](compute_api_client/docs/PageJob.md)
+- [PageLanguage](compute_api_client/docs/PageLanguage.md)
+- [PageMember](compute_api_client/docs/PageMember.md)
+- [PageMetadata](compute_api_client/docs/PageMetadata.md)
+- [PagePermission](compute_api_client/docs/PagePermission.md)
+- [PagePermissionGroup](compute_api_client/docs/PagePermissionGroup.md)
+- [PageProject](compute_api_client/docs/PageProject.md)
+- [PageReservation](compute_api_client/docs/PageReservation.md)
+- [PageResult](compute_api_client/docs/PageResult.md)
+- [PageTeam](compute_api_client/docs/PageTeam.md)
+- [PageTransaction](compute_api_client/docs/PageTransaction.md)
+- [PageUser](compute_api_client/docs/PageUser.md)
+- [Permission](compute_api_client/docs/Permission.md)
+- [PermissionGroup](compute_api_client/docs/PermissionGroup.md)
+- [Project](compute_api_client/docs/Project.md)
+- [ProjectIn](compute_api_client/docs/ProjectIn.md)
+- [ProjectPatch](compute_api_client/docs/ProjectPatch.md)
+- [Reservation](compute_api_client/docs/Reservation.md)
+- [ReservationIn](compute_api_client/docs/ReservationIn.md)
+- [Result](compute_api_client/docs/Result.md)
+- [ResultIn](compute_api_client/docs/ResultIn.md)
+- [Role](compute_api_client/docs/Role.md)
+- [ShareType](compute_api_client/docs/ShareType.md)
+- [Team](compute_api_client/docs/Team.md)
+- [Transaction](compute_api_client/docs/Transaction.md)
+- [User](compute_api_client/docs/User.md)
+- [UserIn](compute_api_client/docs/UserIn.md)
+- [ValidationError](compute_api_client/docs/ValidationError.md)
+
+<a id="documentation-for-authorization"></a>
+
+## Documentation For Authorization
+
+Authentication schemes defined for the API: <a id="user_bearer"></a>
+
+### user_bearer
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://quantum-inspire-staging.eu.auth0.com/authorize
+- **Scopes**: N/A
+
+<a id="backend"></a>
+
+### backend
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+## Author
+