qi-compute-api-client 0.21.0__py3-none-any.whl → 0.31.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of qi-compute-api-client might be problematic. Click here for more details.

Files changed (60) hide show
  1. compute_api_client/__init__.py +1 -0
  2. compute_api_client/api/algorithms_api.py +25 -23
  3. compute_api_client/api/backend_api.py +19 -18
  4. compute_api_client/api/backend_types_api.py +54 -2
  5. compute_api_client/api/batch_jobs_api.py +5 -22
  6. compute_api_client/api/commits_api.py +5 -5
  7. compute_api_client/api/files_api.py +5 -5
  8. compute_api_client/api/final_results_api.py +4 -4
  9. compute_api_client/api/jobs_api.py +8 -8
  10. compute_api_client/api/languages_api.py +2 -2
  11. compute_api_client/api/members_api.py +4 -21
  12. compute_api_client/api/metadata_api.py +2 -2
  13. compute_api_client/api/permissions_api.py +4 -4
  14. compute_api_client/api/projects_api.py +28 -9
  15. compute_api_client/api/reservations_api.py +4 -4
  16. compute_api_client/api/results_api.py +566 -4
  17. compute_api_client/api/teams_api.py +2 -2
  18. compute_api_client/api/transactions_api.py +32 -32
  19. compute_api_client/api/users_api.py +21 -4
  20. compute_api_client/configuration.py +5 -7
  21. compute_api_client/docs/AlgorithmIn.md +1 -1
  22. compute_api_client/docs/AlgorithmsApi.md +20 -40
  23. compute_api_client/docs/BackendApi.md +14 -26
  24. compute_api_client/docs/BackendIn.md +32 -0
  25. compute_api_client/docs/BackendType.md +3 -0
  26. compute_api_client/docs/BackendTypesApi.md +15 -16
  27. compute_api_client/docs/BatchJobIn.md +0 -1
  28. compute_api_client/docs/BatchJobsApi.md +15 -33
  29. compute_api_client/docs/CommitsApi.md +13 -29
  30. compute_api_client/docs/FilesApi.md +13 -29
  31. compute_api_client/docs/FinalResultsApi.md +10 -22
  32. compute_api_client/docs/JobIn.md +0 -1
  33. compute_api_client/docs/JobsApi.md +18 -38
  34. compute_api_client/docs/LanguagesApi.md +6 -14
  35. compute_api_client/docs/MembersApi.md +14 -32
  36. compute_api_client/docs/MetadataApi.md +6 -14
  37. compute_api_client/docs/PermissionsApi.md +12 -28
  38. compute_api_client/docs/ProjectsApi.md +23 -45
  39. compute_api_client/docs/ReservationsApi.md +12 -28
  40. compute_api_client/docs/ResultsApi.md +115 -14
  41. compute_api_client/docs/TeamsApi.md +6 -14
  42. compute_api_client/docs/Transaction.md +1 -1
  43. compute_api_client/docs/TransactionsApi.md +12 -20
  44. compute_api_client/docs/User.md +1 -0
  45. compute_api_client/docs/UserIn.md +1 -0
  46. compute_api_client/docs/UsersApi.md +16 -30
  47. compute_api_client/models/__init__.py +1 -0
  48. compute_api_client/models/algorithm.py +1 -6
  49. compute_api_client/models/algorithm_in.py +1 -6
  50. compute_api_client/models/backend_in.py +98 -0
  51. compute_api_client/models/backend_type.py +9 -2
  52. compute_api_client/models/batch_job_in.py +1 -3
  53. compute_api_client/models/job_in.py +1 -4
  54. compute_api_client/models/transaction.py +6 -6
  55. compute_api_client/models/user.py +4 -2
  56. compute_api_client/models/user_in.py +4 -2
  57. {qi_compute_api_client-0.21.0.dist-info → qi_compute_api_client-0.31.0.dist-info}/METADATA +12 -13
  58. {qi_compute_api_client-0.21.0.dist-info → qi_compute_api_client-0.31.0.dist-info}/RECORD +60 -58
  59. {qi_compute_api_client-0.21.0.dist-info → qi_compute_api_client-0.31.0.dist-info}/LICENSE.md +0 -0
  60. {qi_compute_api_client-0.21.0.dist-info → qi_compute_api_client-0.31.0.dist-info}/WHEEL +0 -0
@@ -21,7 +21,7 @@ Create new project.
21
21
 
22
22
  ### Example
23
23
 
24
- * Api Key Authentication (user):
24
+ * OAuth Authentication (user_bearer):
25
25
  ```python
26
26
  import time
27
27
  import os
@@ -42,11 +42,7 @@ configuration = compute_api_client.Configuration(
42
42
  # Examples for each auth method are provided below, use the example that
43
43
  # satisfies your auth use case.
44
44
 
45
- # Configure API key authorization: user
46
- configuration.api_key['user'] = os.environ["API_KEY"]
47
-
48
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
49
- # configuration.api_key_prefix['user'] = 'Bearer'
45
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
50
46
 
51
47
  # Enter a context with an instance of the API client
52
48
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -77,7 +73,7 @@ Name | Type | Description | Notes
77
73
 
78
74
  ### Authorization
79
75
 
80
- [user](../README.md#user)
76
+ [user_bearer](../README.md#user_bearer)
81
77
 
82
78
  ### HTTP request headers
83
79
 
@@ -101,7 +97,7 @@ Delete a project.
101
97
 
102
98
  ### Example
103
99
 
104
- * Api Key Authentication (user):
100
+ * OAuth Authentication (user_bearer):
105
101
  ```python
106
102
  import time
107
103
  import os
@@ -120,11 +116,7 @@ configuration = compute_api_client.Configuration(
120
116
  # Examples for each auth method are provided below, use the example that
121
117
  # satisfies your auth use case.
122
118
 
123
- # Configure API key authorization: user
124
- configuration.api_key['user'] = os.environ["API_KEY"]
125
-
126
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
127
- # configuration.api_key_prefix['user'] = 'Bearer'
119
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
128
120
 
129
121
  # Enter a context with an instance of the API client
130
122
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -153,7 +145,7 @@ void (empty response body)
153
145
 
154
146
  ### Authorization
155
147
 
156
- [user](../README.md#user)
148
+ [user_bearer](../README.md#user_bearer)
157
149
 
158
150
  ### HTTP request headers
159
151
 
@@ -178,7 +170,7 @@ Partially update a project.
178
170
 
179
171
  ### Example
180
172
 
181
- * Api Key Authentication (user):
173
+ * OAuth Authentication (user_bearer):
182
174
  ```python
183
175
  import time
184
176
  import os
@@ -199,11 +191,7 @@ configuration = compute_api_client.Configuration(
199
191
  # Examples for each auth method are provided below, use the example that
200
192
  # satisfies your auth use case.
201
193
 
202
- # Configure API key authorization: user
203
- configuration.api_key['user'] = os.environ["API_KEY"]
204
-
205
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
206
- # configuration.api_key_prefix['user'] = 'Bearer'
194
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
207
195
 
208
196
  # Enter a context with an instance of the API client
209
197
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -236,7 +224,7 @@ Name | Type | Description | Notes
236
224
 
237
225
  ### Authorization
238
226
 
239
- [user](../README.md#user)
227
+ [user_bearer](../README.md#user_bearer)
240
228
 
241
229
  ### HTTP request headers
242
230
 
@@ -261,7 +249,7 @@ Get project by ID.
261
249
 
262
250
  ### Example
263
251
 
264
- * Api Key Authentication (user):
252
+ * OAuth Authentication (user_bearer):
265
253
  ```python
266
254
  import time
267
255
  import os
@@ -281,11 +269,7 @@ configuration = compute_api_client.Configuration(
281
269
  # Examples for each auth method are provided below, use the example that
282
270
  # satisfies your auth use case.
283
271
 
284
- # Configure API key authorization: user
285
- configuration.api_key['user'] = os.environ["API_KEY"]
286
-
287
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
288
- # configuration.api_key_prefix['user'] = 'Bearer'
272
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
289
273
 
290
274
  # Enter a context with an instance of the API client
291
275
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -316,7 +300,7 @@ Name | Type | Description | Notes
316
300
 
317
301
  ### Authorization
318
302
 
319
- [user](../README.md#user)
303
+ [user_bearer](../README.md#user_bearer)
320
304
 
321
305
  ### HTTP request headers
322
306
 
@@ -333,15 +317,15 @@ Name | Type | Description | Notes
333
317
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
334
318
 
335
319
  # **read_projects_projects_get**
336
- > List[Project] read_projects_projects_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred)
320
+ > List[Project] read_projects_projects_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred)
337
321
 
338
322
  List projects
339
323
 
340
- List projects.
324
+ List projects. If the search parameter is provided, the list is filtered based on the condition that either the project name OR description contains the specified substring. The filter considers exact matches for other parameters provided. The final result is the logical AND of the substring match condition and any other provided exact match conditions.
341
325
 
342
326
  ### Example
343
327
 
344
- * Api Key Authentication (user):
328
+ * OAuth Authentication (user_bearer):
345
329
  ```python
346
330
  import time
347
331
  import os
@@ -361,16 +345,13 @@ configuration = compute_api_client.Configuration(
361
345
  # Examples for each auth method are provided below, use the example that
362
346
  # satisfies your auth use case.
363
347
 
364
- # Configure API key authorization: user
365
- configuration.api_key['user'] = os.environ["API_KEY"]
366
-
367
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
368
- # configuration.api_key_prefix['user'] = 'Bearer'
348
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
369
349
 
370
350
  # Enter a context with an instance of the API client
371
351
  async with compute_api_client.ApiClient(configuration) as api_client:
372
352
  # Create an instance of the API class
373
353
  api_instance = compute_api_client.ProjectsApi(api_client)
354
+ search = 'search_example' # str | Substring search for project names or description (optional)
374
355
  latest = True # bool | (optional)
375
356
  sort_by = 'sort_by_example' # str | (optional)
376
357
  page_number = 56 # int | (optional)
@@ -384,7 +365,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
384
365
 
385
366
  try:
386
367
  # List projects
387
- api_response = await api_instance.read_projects_projects_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred)
368
+ api_response = await api_instance.read_projects_projects_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred)
388
369
  print("The response of ProjectsApi->read_projects_projects_get:\n")
389
370
  pprint(api_response)
390
371
  except Exception as e:
@@ -397,6 +378,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
397
378
 
398
379
  Name | Type | Description | Notes
399
380
  ------------- | ------------- | ------------- | -------------
381
+ **search** | **str**| Substring search for project names or description | [optional]
400
382
  **latest** | **bool**| | [optional]
401
383
  **sort_by** | **str**| | [optional]
402
384
  **page_number** | **int**| | [optional]
@@ -414,7 +396,7 @@ Name | Type | Description | Notes
414
396
 
415
397
  ### Authorization
416
398
 
417
- [user](../README.md#user)
399
+ [user_bearer](../README.md#user_bearer)
418
400
 
419
401
  ### HTTP request headers
420
402
 
@@ -438,7 +420,7 @@ Update a project.
438
420
 
439
421
  ### Example
440
422
 
441
- * Api Key Authentication (user):
423
+ * OAuth Authentication (user_bearer):
442
424
  ```python
443
425
  import time
444
426
  import os
@@ -459,11 +441,7 @@ configuration = compute_api_client.Configuration(
459
441
  # Examples for each auth method are provided below, use the example that
460
442
  # satisfies your auth use case.
461
443
 
462
- # Configure API key authorization: user
463
- configuration.api_key['user'] = os.environ["API_KEY"]
464
-
465
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
466
- # configuration.api_key_prefix['user'] = 'Bearer'
444
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
467
445
 
468
446
  # Enter a context with an instance of the API client
469
447
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -496,7 +474,7 @@ Name | Type | Description | Notes
496
474
 
497
475
  ### Authorization
498
476
 
499
- [user](../README.md#user)
477
+ [user_bearer](../README.md#user_bearer)
500
478
 
501
479
  ### HTTP request headers
502
480
 
@@ -19,7 +19,7 @@ Create new reservation.
19
19
 
20
20
  ### Example
21
21
 
22
- * Api Key Authentication (user):
22
+ * OAuth Authentication (user_bearer):
23
23
  ```python
24
24
  import time
25
25
  import os
@@ -40,11 +40,7 @@ configuration = compute_api_client.Configuration(
40
40
  # Examples for each auth method are provided below, use the example that
41
41
  # satisfies your auth use case.
42
42
 
43
- # Configure API key authorization: user
44
- configuration.api_key['user'] = os.environ["API_KEY"]
45
-
46
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
47
- # configuration.api_key_prefix['user'] = 'Bearer'
43
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
48
44
 
49
45
  # Enter a context with an instance of the API client
50
46
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -75,7 +71,7 @@ Name | Type | Description | Notes
75
71
 
76
72
  ### Authorization
77
73
 
78
- [user](../README.md#user)
74
+ [user_bearer](../README.md#user_bearer)
79
75
 
80
76
  ### HTTP request headers
81
77
 
@@ -99,7 +95,7 @@ Get reservation by ID.
99
95
 
100
96
  ### Example
101
97
 
102
- * Api Key Authentication (user):
98
+ * OAuth Authentication (user_bearer):
103
99
  ```python
104
100
  import time
105
101
  import os
@@ -119,11 +115,7 @@ configuration = compute_api_client.Configuration(
119
115
  # Examples for each auth method are provided below, use the example that
120
116
  # satisfies your auth use case.
121
117
 
122
- # Configure API key authorization: user
123
- configuration.api_key['user'] = os.environ["API_KEY"]
124
-
125
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
126
- # configuration.api_key_prefix['user'] = 'Bearer'
118
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
127
119
 
128
120
  # Enter a context with an instance of the API client
129
121
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -154,7 +146,7 @@ Name | Type | Description | Notes
154
146
 
155
147
  ### Authorization
156
148
 
157
- [user](../README.md#user)
149
+ [user_bearer](../README.md#user_bearer)
158
150
 
159
151
  ### HTTP request headers
160
152
 
@@ -179,7 +171,7 @@ Read reservations.
179
171
 
180
172
  ### Example
181
173
 
182
- * Api Key Authentication (user):
174
+ * OAuth Authentication (user_bearer):
183
175
  ```python
184
176
  import time
185
177
  import os
@@ -199,11 +191,7 @@ configuration = compute_api_client.Configuration(
199
191
  # Examples for each auth method are provided below, use the example that
200
192
  # satisfies your auth use case.
201
193
 
202
- # Configure API key authorization: user
203
- configuration.api_key['user'] = os.environ["API_KEY"]
204
-
205
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
206
- # configuration.api_key_prefix['user'] = 'Bearer'
194
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
207
195
 
208
196
  # Enter a context with an instance of the API client
209
197
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -256,7 +244,7 @@ Name | Type | Description | Notes
256
244
 
257
245
  ### Authorization
258
246
 
259
- [user](../README.md#user)
247
+ [user_bearer](../README.md#user_bearer)
260
248
 
261
249
  ### HTTP request headers
262
250
 
@@ -280,7 +268,7 @@ Terminate reservation by ID.
280
268
 
281
269
  ### Example
282
270
 
283
- * Api Key Authentication (user):
271
+ * OAuth Authentication (user_bearer):
284
272
  ```python
285
273
  import time
286
274
  import os
@@ -300,11 +288,7 @@ configuration = compute_api_client.Configuration(
300
288
  # Examples for each auth method are provided below, use the example that
301
289
  # satisfies your auth use case.
302
290
 
303
- # Configure API key authorization: user
304
- configuration.api_key['user'] = os.environ["API_KEY"]
305
-
306
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
307
- # configuration.api_key_prefix['user'] = 'Bearer'
291
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
308
292
 
309
293
  # Enter a context with an instance of the API client
310
294
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -335,7 +319,7 @@ Name | Type | Description | Notes
335
319
 
336
320
  ### Authorization
337
321
 
338
- [user](../README.md#user)
322
+ [user_bearer](../README.md#user_bearer)
339
323
 
340
324
  ### HTTP request headers
341
325
 
@@ -7,6 +7,7 @@ Method | HTTP request | Description
7
7
  [**create_result_results_post**](ResultsApi.md#create_result_results_post) | **POST** /results | Create result
8
8
  [**delete_results_by_job_id_results_job_job_id_delete**](ResultsApi.md#delete_results_by_job_id_results_job_job_id_delete) | **DELETE** /results/job/{job_id} | Delete results by job ID
9
9
  [**read_result_results_id_get**](ResultsApi.md#read_result_results_id_get) | **GET** /results/{id} | Retrieve result
10
+ [**read_results_by_algorithm_id_results_algorithm_algorithm_id_get**](ResultsApi.md#read_results_by_algorithm_id_results_algorithm_algorithm_id_get) | **GET** /results/algorithm/{algorithm_id} | Retrieve results by algorithm ID
10
11
  [**read_results_by_job_id_results_job_job_id_get**](ResultsApi.md#read_results_by_job_id_results_job_job_id_get) | **GET** /results/job/{job_id} | Retrieve results by job ID
11
12
 
12
13
 
@@ -176,7 +177,7 @@ Get result by ID.
176
177
 
177
178
  ### Example
178
179
 
179
- * Api Key Authentication (user):
180
+ * OAuth Authentication (user_bearer):
180
181
  ```python
181
182
  import time
182
183
  import os
@@ -196,11 +197,7 @@ configuration = compute_api_client.Configuration(
196
197
  # Examples for each auth method are provided below, use the example that
197
198
  # satisfies your auth use case.
198
199
 
199
- # Configure API key authorization: user
200
- configuration.api_key['user'] = os.environ["API_KEY"]
201
-
202
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
203
- # configuration.api_key_prefix['user'] = 'Bearer'
200
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
204
201
 
205
202
  # Enter a context with an instance of the API client
206
203
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -231,7 +228,7 @@ Name | Type | Description | Notes
231
228
 
232
229
  ### Authorization
233
230
 
234
- [user](../README.md#user)
231
+ [user_bearer](../README.md#user_bearer)
235
232
 
236
233
  ### HTTP request headers
237
234
 
@@ -247,6 +244,114 @@ Name | Type | Description | Notes
247
244
 
248
245
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
249
246
 
247
+ # **read_results_by_algorithm_id_results_algorithm_algorithm_id_get**
248
+ > List[Result] read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, number_of_qubits=number_of_qubits, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, body=body)
249
+
250
+ Retrieve results by algorithm ID
251
+
252
+ Get results by algorithm ID.
253
+
254
+ ### Example
255
+
256
+ * OAuth Authentication (user_bearer):
257
+ ```python
258
+ import time
259
+ import os
260
+ import compute_api_client
261
+ from compute_api_client.models.result import Result
262
+ from compute_api_client.rest import ApiException
263
+ from pprint import pprint
264
+
265
+ # Defining the host is optional and defaults to http://localhost
266
+ # See configuration.py for a list of all supported configuration parameters.
267
+ configuration = compute_api_client.Configuration(
268
+ host = "http://localhost"
269
+ )
270
+
271
+ # The client must configure the authentication and authorization parameters
272
+ # in accordance with the API server security policy.
273
+ # Examples for each auth method are provided below, use the example that
274
+ # satisfies your auth use case.
275
+
276
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
277
+
278
+ # Enter a context with an instance of the API client
279
+ async with compute_api_client.ApiClient(configuration) as api_client:
280
+ # Create an instance of the API class
281
+ api_instance = compute_api_client.ResultsApi(api_client)
282
+ algorithm_id = 56 # int |
283
+ latest = True # bool | (optional)
284
+ sort_by = 'sort_by_example' # str | (optional)
285
+ page_number = 56 # int | (optional)
286
+ items_per_page = 56 # int | (optional)
287
+ id = 56 # int | (optional)
288
+ created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional)
289
+ job_id = 56 # int | (optional)
290
+ metadata_id = 56 # int | (optional)
291
+ number_of_qubits = 56 # int | (optional)
292
+ execution_time_in_seconds = 3.4 # float | (optional)
293
+ shots_requested__isnull = True # bool | (optional)
294
+ shots_requested = 56 # int | (optional)
295
+ shots_done__isnull = True # bool | (optional)
296
+ shots_done = 56 # int | (optional)
297
+ results__isnull = True # bool | (optional)
298
+ body = None # object | (optional)
299
+
300
+ try:
301
+ # Retrieve results by algorithm ID
302
+ api_response = await api_instance.read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, number_of_qubits=number_of_qubits, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, body=body)
303
+ print("The response of ResultsApi->read_results_by_algorithm_id_results_algorithm_algorithm_id_get:\n")
304
+ pprint(api_response)
305
+ except Exception as e:
306
+ print("Exception when calling ResultsApi->read_results_by_algorithm_id_results_algorithm_algorithm_id_get: %s\n" % e)
307
+ ```
308
+
309
+
310
+
311
+ ### Parameters
312
+
313
+ Name | Type | Description | Notes
314
+ ------------- | ------------- | ------------- | -------------
315
+ **algorithm_id** | **int**| |
316
+ **latest** | **bool**| | [optional]
317
+ **sort_by** | **str**| | [optional]
318
+ **page_number** | **int**| | [optional]
319
+ **items_per_page** | **int**| | [optional]
320
+ **id** | **int**| | [optional]
321
+ **created_on** | **datetime**| | [optional]
322
+ **job_id** | **int**| | [optional]
323
+ **metadata_id** | **int**| | [optional]
324
+ **number_of_qubits** | **int**| | [optional]
325
+ **execution_time_in_seconds** | **float**| | [optional]
326
+ **shots_requested__isnull** | **bool**| | [optional]
327
+ **shots_requested** | **int**| | [optional]
328
+ **shots_done__isnull** | **bool**| | [optional]
329
+ **shots_done** | **int**| | [optional]
330
+ **results__isnull** | **bool**| | [optional]
331
+ **body** | **object**| | [optional]
332
+
333
+ ### Return type
334
+
335
+ [**List[Result]**](Result.md)
336
+
337
+ ### Authorization
338
+
339
+ [user_bearer](../README.md#user_bearer)
340
+
341
+ ### HTTP request headers
342
+
343
+ - **Content-Type**: application/json
344
+ - **Accept**: application/json
345
+
346
+ ### HTTP response details
347
+ | Status code | Description | Response headers |
348
+ |-------------|-------------|------------------|
349
+ **200** | Successful Response | - |
350
+ **404** | Not Found | - |
351
+ **422** | Validation Error | - |
352
+
353
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
354
+
250
355
  # **read_results_by_job_id_results_job_job_id_get**
251
356
  > List[Result] read_results_by_job_id_results_job_job_id_get(job_id)
252
357
 
@@ -256,7 +361,7 @@ Get results by job ID.
256
361
 
257
362
  ### Example
258
363
 
259
- * Api Key Authentication (user):
364
+ * OAuth Authentication (user_bearer):
260
365
  ```python
261
366
  import time
262
367
  import os
@@ -276,11 +381,7 @@ configuration = compute_api_client.Configuration(
276
381
  # Examples for each auth method are provided below, use the example that
277
382
  # satisfies your auth use case.
278
383
 
279
- # Configure API key authorization: user
280
- configuration.api_key['user'] = os.environ["API_KEY"]
281
-
282
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
283
- # configuration.api_key_prefix['user'] = 'Bearer'
384
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
284
385
 
285
386
  # Enter a context with an instance of the API client
286
387
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -311,7 +412,7 @@ Name | Type | Description | Notes
311
412
 
312
413
  ### Authorization
313
414
 
314
- [user](../README.md#user)
415
+ [user_bearer](../README.md#user_bearer)
315
416
 
316
417
  ### HTTP request headers
317
418
 
@@ -17,7 +17,7 @@ Get team by ID.
17
17
 
18
18
  ### Example
19
19
 
20
- * Api Key Authentication (user):
20
+ * OAuth Authentication (user_bearer):
21
21
  ```python
22
22
  import time
23
23
  import os
@@ -37,11 +37,7 @@ configuration = compute_api_client.Configuration(
37
37
  # Examples for each auth method are provided below, use the example that
38
38
  # satisfies your auth use case.
39
39
 
40
- # Configure API key authorization: user
41
- configuration.api_key['user'] = os.environ["API_KEY"]
42
-
43
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
44
- # configuration.api_key_prefix['user'] = 'Bearer'
40
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
45
41
 
46
42
  # Enter a context with an instance of the API client
47
43
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -72,7 +68,7 @@ Name | Type | Description | Notes
72
68
 
73
69
  ### Authorization
74
70
 
75
- [user](../README.md#user)
71
+ [user_bearer](../README.md#user_bearer)
76
72
 
77
73
  ### HTTP request headers
78
74
 
@@ -97,7 +93,7 @@ Read teams.
97
93
 
98
94
  ### Example
99
95
 
100
- * Api Key Authentication (user):
96
+ * OAuth Authentication (user_bearer):
101
97
  ```python
102
98
  import time
103
99
  import os
@@ -117,11 +113,7 @@ configuration = compute_api_client.Configuration(
117
113
  # Examples for each auth method are provided below, use the example that
118
114
  # satisfies your auth use case.
119
115
 
120
- # Configure API key authorization: user
121
- configuration.api_key['user'] = os.environ["API_KEY"]
122
-
123
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
124
- # configuration.api_key_prefix['user'] = 'Bearer'
116
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
125
117
 
126
118
  # Enter a context with an instance of the API client
127
119
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -166,7 +158,7 @@ Name | Type | Description | Notes
166
158
 
167
159
  ### Authorization
168
160
 
169
- [user](../README.md#user)
161
+ [user_bearer](../README.md#user_bearer)
170
162
 
171
163
  ### HTTP request headers
172
164
 
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **domain** | [**Domain**](Domain.md) | |
9
9
  **job** | **int** | |
10
10
  **team_id** | **int** | |
11
- **user_id** | **int** | |
11
+ **member_id** | **int** | |
12
12
  **change** | **int** | |
13
13
  **timestamp** | **datetime** | |
14
14
 
@@ -17,7 +17,7 @@ Get transaction by ID.
17
17
 
18
18
  ### Example
19
19
 
20
- * Api Key Authentication (user):
20
+ * OAuth Authentication (user_bearer):
21
21
  ```python
22
22
  import time
23
23
  import os
@@ -37,11 +37,7 @@ configuration = compute_api_client.Configuration(
37
37
  # Examples for each auth method are provided below, use the example that
38
38
  # satisfies your auth use case.
39
39
 
40
- # Configure API key authorization: user
41
- configuration.api_key['user'] = os.environ["API_KEY"]
42
-
43
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
44
- # configuration.api_key_prefix['user'] = 'Bearer'
40
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
45
41
 
46
42
  # Enter a context with an instance of the API client
47
43
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -72,7 +68,7 @@ Name | Type | Description | Notes
72
68
 
73
69
  ### Authorization
74
70
 
75
- [user](../README.md#user)
71
+ [user_bearer](../README.md#user_bearer)
76
72
 
77
73
  ### HTTP request headers
78
74
 
@@ -89,7 +85,7 @@ Name | Type | Description | Notes
89
85
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
90
86
 
91
87
  # **read_transactions_transactions_get**
92
- > List[Transaction] read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, user_id__isnull=user_id__isnull, user_id=user_id, change=change, timestamp=timestamp)
88
+ > List[Transaction] read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp)
93
89
 
94
90
  List transactions
95
91
 
@@ -97,7 +93,7 @@ Read transactions.
97
93
 
98
94
  ### Example
99
95
 
100
- * Api Key Authentication (user):
96
+ * OAuth Authentication (user_bearer):
101
97
  ```python
102
98
  import time
103
99
  import os
@@ -118,11 +114,7 @@ configuration = compute_api_client.Configuration(
118
114
  # Examples for each auth method are provided below, use the example that
119
115
  # satisfies your auth use case.
120
116
 
121
- # Configure API key authorization: user
122
- configuration.api_key['user'] = os.environ["API_KEY"]
123
-
124
- # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
125
- # configuration.api_key_prefix['user'] = 'Bearer'
117
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
126
118
 
127
119
  # Enter a context with an instance of the API client
128
120
  async with compute_api_client.ApiClient(configuration) as api_client:
@@ -138,14 +130,14 @@ async with compute_api_client.ApiClient(configuration) as api_client:
138
130
  job__isnull = True # bool | (optional)
139
131
  job = 56 # int | (optional)
140
132
  team_id = 56 # int | (optional)
141
- user_id__isnull = True # bool | (optional)
142
- user_id = 56 # int | (optional)
133
+ member_id__isnull = True # bool | (optional)
134
+ member_id = 56 # int | (optional)
143
135
  change = 56 # int | (optional)
144
136
  timestamp = '2013-10-20T19:20:30+01:00' # datetime | (optional)
145
137
 
146
138
  try:
147
139
  # List transactions
148
- api_response = await api_instance.read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, user_id__isnull=user_id__isnull, user_id=user_id, change=change, timestamp=timestamp)
140
+ api_response = await api_instance.read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp)
149
141
  print("The response of TransactionsApi->read_transactions_transactions_get:\n")
150
142
  pprint(api_response)
151
143
  except Exception as e:
@@ -168,8 +160,8 @@ Name | Type | Description | Notes
168
160
  **job__isnull** | **bool**| | [optional]
169
161
  **job** | **int**| | [optional]
170
162
  **team_id** | **int**| | [optional]
171
- **user_id__isnull** | **bool**| | [optional]
172
- **user_id** | **int**| | [optional]
163
+ **member_id__isnull** | **bool**| | [optional]
164
+ **member_id** | **int**| | [optional]
173
165
  **change** | **int**| | [optional]
174
166
  **timestamp** | **datetime**| | [optional]
175
167
 
@@ -179,7 +171,7 @@ Name | Type | Description | Notes
179
171
 
180
172
  ### Authorization
181
173
 
182
- [user](../README.md#user)
174
+ [user_bearer](../README.md#user_bearer)
183
175
 
184
176
  ### HTTP request headers
185
177