UncountablePythonSDK 0.0.128__py3-none-any.whl → 0.0.129__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 UncountablePythonSDK might be problematic. Click here for more details.
- examples/integration-server/jobs/materials_auto/example_instrument.py +4 -3
- examples/integration-server/jobs/materials_auto/example_parse.py +45 -2
- examples/integration-server/jobs/materials_auto/example_predictions.py +2 -2
- examples/integration-server/pyproject.toml +1 -1
- pkgs/serialization_util/serialization_helpers.py +3 -1
- pkgs/type_spec/builder.py +9 -3
- pkgs/type_spec/builder_types.py +9 -0
- pkgs/type_spec/cross_output_links.py +2 -10
- pkgs/type_spec/emit_open_api.py +0 -12
- pkgs/type_spec/emit_python.py +72 -11
- pkgs/type_spec/emit_typescript_util.py +28 -6
- pkgs/type_spec/load_types.py +1 -1
- pkgs/type_spec/type_info/emit_type_info.py +13 -2
- uncountable/core/client.py +10 -3
- uncountable/integration/queue_runner/command_server/command_server.py +8 -7
- uncountable/integration/webhook_server/entrypoint.py +2 -0
- uncountable/types/__init__.py +2 -0
- uncountable/types/api/entity/list_aggregate.py +79 -0
- uncountable/types/api/entity/list_entities.py +25 -0
- uncountable/types/api/recipes/get_recipes_data.py +13 -0
- uncountable/types/async_batch_processor.py +20 -0
- uncountable/types/client_base.py +194 -0
- uncountable/types/client_config.py +1 -0
- uncountable/types/client_config_t.py +10 -0
- uncountable/types/entity_t.py +2 -0
- {uncountablepythonsdk-0.0.128.dist-info → uncountablepythonsdk-0.0.129.dist-info}/METADATA +1 -1
- {uncountablepythonsdk-0.0.128.dist-info → uncountablepythonsdk-0.0.129.dist-info}/RECORD +29 -27
- {uncountablepythonsdk-0.0.128.dist-info → uncountablepythonsdk-0.0.129.dist-info}/WHEEL +0 -0
- {uncountablepythonsdk-0.0.128.dist-info → uncountablepythonsdk-0.0.129.dist-info}/top_level.txt +0 -0
uncountable/types/client_base.py
CHANGED
|
@@ -17,6 +17,7 @@ import uncountable.types.api.recipes.associate_recipe_as_lot as associate_recipe
|
|
|
17
17
|
from uncountable.types import async_batch_t
|
|
18
18
|
from uncountable.types import base_t
|
|
19
19
|
import uncountable.types.api.recipes.clear_recipe_outputs as clear_recipe_outputs_t
|
|
20
|
+
from uncountable.types import client_config_t
|
|
20
21
|
import uncountable.types.api.uploader.complete_async_parse as complete_async_parse_t
|
|
21
22
|
import uncountable.types.api.runsheet.complete_async_upload as complete_async_upload_t
|
|
22
23
|
import uncountable.types.api.chemical.convert_chemical_formats as convert_chemical_formats_t
|
|
@@ -59,6 +60,7 @@ import uncountable.types.api.entity.grant_entity_permissions as grant_entity_per
|
|
|
59
60
|
from uncountable.types import id_source_t
|
|
60
61
|
from uncountable.types import identifier_t
|
|
61
62
|
import uncountable.types.api.uploader.invoke_uploader as invoke_uploader_t
|
|
63
|
+
import uncountable.types.api.entity.list_aggregate as list_aggregate_t
|
|
62
64
|
import uncountable.types.api.entity.list_entities as list_entities_t
|
|
63
65
|
import uncountable.types.api.id_source.list_id_source as list_id_source_t
|
|
64
66
|
import uncountable.types.api.entity.lock_entity as lock_entity_t
|
|
@@ -113,6 +115,7 @@ class APIRequest:
|
|
|
113
115
|
method: str
|
|
114
116
|
endpoint: str
|
|
115
117
|
args: typing.Any
|
|
118
|
+
request_options: client_config_t.RequestOptions | None = None
|
|
116
119
|
|
|
117
120
|
|
|
118
121
|
class ClientMethods(ABC):
|
|
@@ -126,6 +129,7 @@ class ClientMethods(ABC):
|
|
|
126
129
|
*,
|
|
127
130
|
recipe_key: identifier_t.IdentifierKey,
|
|
128
131
|
project_key: identifier_t.IdentifierKey,
|
|
132
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
129
133
|
) -> add_recipe_to_project_t.Data:
|
|
130
134
|
"""Adds a recipe to a project
|
|
131
135
|
|
|
@@ -140,6 +144,7 @@ class ClientMethods(ABC):
|
|
|
140
144
|
method=add_recipe_to_project_t.ENDPOINT_METHOD,
|
|
141
145
|
endpoint=add_recipe_to_project_t.ENDPOINT_PATH,
|
|
142
146
|
args=args,
|
|
147
|
+
request_options=_request_options,
|
|
143
148
|
)
|
|
144
149
|
return self.do_request(api_request=api_request, return_type=add_recipe_to_project_t.Data)
|
|
145
150
|
|
|
@@ -149,6 +154,7 @@ class ClientMethods(ABC):
|
|
|
149
154
|
time_series_segment_key: identifier_t.IdentifierKey,
|
|
150
155
|
time_series_data: list[add_time_series_data_t.TimeSeriesDatum],
|
|
151
156
|
on_conflict: add_time_series_data_t.OnTimepointConflict = add_time_series_data_t.OnTimepointConflict.ERROR,
|
|
157
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
152
158
|
) -> add_time_series_data_t.Data:
|
|
153
159
|
"""Add timepoint data to a time series segment.
|
|
154
160
|
|
|
@@ -165,6 +171,7 @@ class ClientMethods(ABC):
|
|
|
165
171
|
method=add_time_series_data_t.ENDPOINT_METHOD,
|
|
166
172
|
endpoint=add_time_series_data_t.ENDPOINT_PATH,
|
|
167
173
|
args=args,
|
|
174
|
+
request_options=_request_options,
|
|
168
175
|
)
|
|
169
176
|
return self.do_request(api_request=api_request, return_type=add_time_series_data_t.Data)
|
|
170
177
|
|
|
@@ -173,6 +180,7 @@ class ClientMethods(ABC):
|
|
|
173
180
|
*,
|
|
174
181
|
recipes: list[identifier_t.IdentifierKey],
|
|
175
182
|
reason: str | None = None,
|
|
183
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
176
184
|
) -> archive_recipes_t.Data:
|
|
177
185
|
"""Archive the provided recipes and their children
|
|
178
186
|
|
|
@@ -187,6 +195,7 @@ class ClientMethods(ABC):
|
|
|
187
195
|
method=archive_recipes_t.ENDPOINT_METHOD,
|
|
188
196
|
endpoint=archive_recipes_t.ENDPOINT_PATH,
|
|
189
197
|
args=args,
|
|
198
|
+
request_options=_request_options,
|
|
190
199
|
)
|
|
191
200
|
return self.do_request(api_request=api_request, return_type=archive_recipes_t.Data)
|
|
192
201
|
|
|
@@ -195,6 +204,7 @@ class ClientMethods(ABC):
|
|
|
195
204
|
*,
|
|
196
205
|
equipment_key: identifier_t.IdentifierKey,
|
|
197
206
|
material_family_ids: list[base_t.ObjectId],
|
|
207
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
198
208
|
) -> associate_equipment_input_t.Data:
|
|
199
209
|
"""Create or return the input association for equipment
|
|
200
210
|
|
|
@@ -209,6 +219,7 @@ class ClientMethods(ABC):
|
|
|
209
219
|
method=associate_equipment_input_t.ENDPOINT_METHOD,
|
|
210
220
|
endpoint=associate_equipment_input_t.ENDPOINT_PATH,
|
|
211
221
|
args=args,
|
|
222
|
+
request_options=_request_options,
|
|
212
223
|
)
|
|
213
224
|
return self.do_request(api_request=api_request, return_type=associate_equipment_input_t.Data)
|
|
214
225
|
|
|
@@ -218,6 +229,7 @@ class ClientMethods(ABC):
|
|
|
218
229
|
recipe_key: identifier_t.IdentifierKey,
|
|
219
230
|
input_key: identifier_t.IdentifierKey | None = None,
|
|
220
231
|
show_in_listings: bool | None = None,
|
|
232
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
221
233
|
) -> associate_recipe_as_input_t.Data:
|
|
222
234
|
"""Create or return the input association for a recipe
|
|
223
235
|
|
|
@@ -234,6 +246,7 @@ class ClientMethods(ABC):
|
|
|
234
246
|
method=associate_recipe_as_input_t.ENDPOINT_METHOD,
|
|
235
247
|
endpoint=associate_recipe_as_input_t.ENDPOINT_PATH,
|
|
236
248
|
args=args,
|
|
249
|
+
request_options=_request_options,
|
|
237
250
|
)
|
|
238
251
|
return self.do_request(api_request=api_request, return_type=associate_recipe_as_input_t.Data)
|
|
239
252
|
|
|
@@ -242,6 +255,7 @@ class ClientMethods(ABC):
|
|
|
242
255
|
*,
|
|
243
256
|
recipe_key: identifier_t.IdentifierKey,
|
|
244
257
|
ingredient_key: identifier_t.IdentifierKey,
|
|
258
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
245
259
|
) -> associate_recipe_as_lot_t.Data:
|
|
246
260
|
"""Create a new lot association for the provided recipe with the provided ingredient
|
|
247
261
|
|
|
@@ -256,6 +270,7 @@ class ClientMethods(ABC):
|
|
|
256
270
|
method=associate_recipe_as_lot_t.ENDPOINT_METHOD,
|
|
257
271
|
endpoint=associate_recipe_as_lot_t.ENDPOINT_PATH,
|
|
258
272
|
args=args,
|
|
273
|
+
request_options=_request_options,
|
|
259
274
|
)
|
|
260
275
|
return self.do_request(api_request=api_request, return_type=associate_recipe_as_lot_t.Data)
|
|
261
276
|
|
|
@@ -263,6 +278,7 @@ class ClientMethods(ABC):
|
|
|
263
278
|
self,
|
|
264
279
|
*,
|
|
265
280
|
recipe_key: identifier_t.IdentifierKey,
|
|
281
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
266
282
|
) -> clear_recipe_outputs_t.Data:
|
|
267
283
|
"""Clears all output values & output metadata for a given recipe
|
|
268
284
|
|
|
@@ -275,6 +291,7 @@ class ClientMethods(ABC):
|
|
|
275
291
|
method=clear_recipe_outputs_t.ENDPOINT_METHOD,
|
|
276
292
|
endpoint=clear_recipe_outputs_t.ENDPOINT_PATH,
|
|
277
293
|
args=args,
|
|
294
|
+
request_options=_request_options,
|
|
278
295
|
)
|
|
279
296
|
return self.do_request(api_request=api_request, return_type=clear_recipe_outputs_t.Data)
|
|
280
297
|
|
|
@@ -284,6 +301,7 @@ class ClientMethods(ABC):
|
|
|
284
301
|
parsed_file_data: list[uploader_t.ParsedFileData],
|
|
285
302
|
async_job_key: identifier_t.IdentifierKey,
|
|
286
303
|
upload_destination: generic_upload_t.UploadDestinationRecipe,
|
|
304
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
287
305
|
) -> complete_async_parse_t.Data:
|
|
288
306
|
"""Parses uploaded files asynchronously
|
|
289
307
|
|
|
@@ -297,6 +315,7 @@ class ClientMethods(ABC):
|
|
|
297
315
|
method=complete_async_parse_t.ENDPOINT_METHOD,
|
|
298
316
|
endpoint=complete_async_parse_t.ENDPOINT_PATH,
|
|
299
317
|
args=args,
|
|
318
|
+
request_options=_request_options,
|
|
300
319
|
)
|
|
301
320
|
return self.do_request(api_request=api_request, return_type=complete_async_parse_t.Data)
|
|
302
321
|
|
|
@@ -305,6 +324,7 @@ class ClientMethods(ABC):
|
|
|
305
324
|
*,
|
|
306
325
|
async_job_id: base_t.ObjectId,
|
|
307
326
|
file_id: base_t.ObjectId,
|
|
327
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
308
328
|
) -> complete_async_upload_t.Data:
|
|
309
329
|
"""Processes an file id with a given async job id to be uploaded asynchronously
|
|
310
330
|
|
|
@@ -317,6 +337,7 @@ class ClientMethods(ABC):
|
|
|
317
337
|
method=complete_async_upload_t.ENDPOINT_METHOD,
|
|
318
338
|
endpoint=complete_async_upload_t.ENDPOINT_PATH,
|
|
319
339
|
args=args,
|
|
340
|
+
request_options=_request_options,
|
|
320
341
|
)
|
|
321
342
|
return self.do_request(api_request=api_request, return_type=complete_async_upload_t.Data)
|
|
322
343
|
|
|
@@ -324,6 +345,7 @@ class ClientMethods(ABC):
|
|
|
324
345
|
self,
|
|
325
346
|
*,
|
|
326
347
|
source_chemical_structures: list[convert_chemical_formats_t.ChemicalStructureFile],
|
|
348
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
327
349
|
) -> convert_chemical_formats_t.Data:
|
|
328
350
|
"""Converts chemical formats, into the format used by Uncountable and usable in other APIs for eg. set_input_attribute_values
|
|
329
351
|
|
|
@@ -335,6 +357,7 @@ class ClientMethods(ABC):
|
|
|
335
357
|
method=convert_chemical_formats_t.ENDPOINT_METHOD,
|
|
336
358
|
endpoint=convert_chemical_formats_t.ENDPOINT_PATH,
|
|
337
359
|
args=args,
|
|
360
|
+
request_options=_request_options,
|
|
338
361
|
)
|
|
339
362
|
return self.do_request(api_request=api_request, return_type=convert_chemical_formats_t.Data)
|
|
340
363
|
|
|
@@ -345,6 +368,7 @@ class ClientMethods(ABC):
|
|
|
345
368
|
entities_to_create: list[create_entities_t.EntityToCreate],
|
|
346
369
|
definition_id: base_t.ObjectId | None = None,
|
|
347
370
|
definition_key: identifier_t.IdentifierKey | None = None,
|
|
371
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
348
372
|
) -> create_entities_t.Data:
|
|
349
373
|
"""Creates new Uncountable entities
|
|
350
374
|
|
|
@@ -363,6 +387,7 @@ class ClientMethods(ABC):
|
|
|
363
387
|
method=create_entities_t.ENDPOINT_METHOD,
|
|
364
388
|
endpoint=create_entities_t.ENDPOINT_PATH,
|
|
365
389
|
args=args,
|
|
390
|
+
request_options=_request_options,
|
|
366
391
|
)
|
|
367
392
|
return self.do_request(api_request=api_request, return_type=create_entities_t.Data)
|
|
368
393
|
|
|
@@ -374,6 +399,7 @@ class ClientMethods(ABC):
|
|
|
374
399
|
definition_key: identifier_t.IdentifierKey | None = None,
|
|
375
400
|
field_values: list[field_values_t.FieldRefNameValue] | None = None,
|
|
376
401
|
parent_entity: entity_t.Entity | None = None,
|
|
402
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
377
403
|
) -> create_entity_t.Data:
|
|
378
404
|
"""Creates a new Uncountable entity
|
|
379
405
|
|
|
@@ -393,6 +419,7 @@ class ClientMethods(ABC):
|
|
|
393
419
|
method=create_entity_t.ENDPOINT_METHOD,
|
|
394
420
|
endpoint=create_entity_t.ENDPOINT_PATH,
|
|
395
421
|
args=args,
|
|
422
|
+
request_options=_request_options,
|
|
396
423
|
)
|
|
397
424
|
return self.do_request(api_request=api_request, return_type=create_entity_t.Data)
|
|
398
425
|
|
|
@@ -400,6 +427,7 @@ class ClientMethods(ABC):
|
|
|
400
427
|
self,
|
|
401
428
|
*,
|
|
402
429
|
inputs_to_create: list[create_inputs_t.InputToCreate],
|
|
430
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
403
431
|
) -> create_inputs_t.Data:
|
|
404
432
|
"""Creates new inputs
|
|
405
433
|
|
|
@@ -412,6 +440,7 @@ class ClientMethods(ABC):
|
|
|
412
440
|
method=create_inputs_t.ENDPOINT_METHOD,
|
|
413
441
|
endpoint=create_inputs_t.ENDPOINT_PATH,
|
|
414
442
|
args=args,
|
|
443
|
+
request_options=_request_options,
|
|
415
444
|
)
|
|
416
445
|
return self.do_request(api_request=api_request, return_type=create_inputs_t.Data)
|
|
417
446
|
|
|
@@ -420,6 +449,7 @@ class ClientMethods(ABC):
|
|
|
420
449
|
*,
|
|
421
450
|
recipe_key: identifier_t.IdentifierKey,
|
|
422
451
|
recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifier,
|
|
452
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
423
453
|
) -> create_mix_order_t.Data:
|
|
424
454
|
"""Creates mix order on a recipe workflow step
|
|
425
455
|
|
|
@@ -432,6 +462,7 @@ class ClientMethods(ABC):
|
|
|
432
462
|
method=create_mix_order_t.ENDPOINT_METHOD,
|
|
433
463
|
endpoint=create_mix_order_t.ENDPOINT_PATH,
|
|
434
464
|
args=args,
|
|
465
|
+
request_options=_request_options,
|
|
435
466
|
)
|
|
436
467
|
return self.do_request(api_request=api_request, return_type=create_mix_order_t.Data)
|
|
437
468
|
|
|
@@ -443,6 +474,7 @@ class ClientMethods(ABC):
|
|
|
443
474
|
field_values: list[field_values_t.FieldArgumentValue],
|
|
444
475
|
entity_key: identifier_t.IdentifierKey | None = None,
|
|
445
476
|
on_create_init_field_values: list[field_values_t.FieldArgumentValue] | None = None,
|
|
477
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
446
478
|
) -> create_or_update_entity_t.Data:
|
|
447
479
|
"""Creates or updates field values for an entity
|
|
448
480
|
|
|
@@ -459,6 +491,7 @@ class ClientMethods(ABC):
|
|
|
459
491
|
method=create_or_update_entity_t.ENDPOINT_METHOD,
|
|
460
492
|
endpoint=create_or_update_entity_t.ENDPOINT_PATH,
|
|
461
493
|
args=args,
|
|
494
|
+
request_options=_request_options,
|
|
462
495
|
)
|
|
463
496
|
return self.do_request(api_request=api_request, return_type=create_or_update_entity_t.Data)
|
|
464
497
|
|
|
@@ -473,6 +506,7 @@ class ClientMethods(ABC):
|
|
|
473
506
|
recipe_metadata: list[recipe_metadata_t.MetadataValue] | None = None,
|
|
474
507
|
identifiers: recipe_identifiers_t.RecipeIdentifiers | None = None,
|
|
475
508
|
definition_key: identifier_t.IdentifierKey | None = None,
|
|
509
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
476
510
|
) -> create_recipe_t.Data:
|
|
477
511
|
"""Returns the id of the recipe being created.
|
|
478
512
|
|
|
@@ -499,6 +533,7 @@ class ClientMethods(ABC):
|
|
|
499
533
|
method=create_recipe_t.ENDPOINT_METHOD,
|
|
500
534
|
endpoint=create_recipe_t.ENDPOINT_PATH,
|
|
501
535
|
args=args,
|
|
536
|
+
request_options=_request_options,
|
|
502
537
|
)
|
|
503
538
|
return self.do_request(api_request=api_request, return_type=create_recipe_t.Data)
|
|
504
539
|
|
|
@@ -509,6 +544,7 @@ class ClientMethods(ABC):
|
|
|
509
544
|
recipe_to_key: identifier_t.IdentifierKey,
|
|
510
545
|
link_type: typing.Literal[recipe_links_t.RecipeLinkType.CHILD] | typing.Literal[recipe_links_t.RecipeLinkType.CONTROL] | typing.Literal[recipe_links_t.RecipeLinkType.USER_LINK] | typing.Literal[recipe_links_t.RecipeLinkType.PREVIOUS_EXPERIMENT],
|
|
511
546
|
name: str | None = None,
|
|
547
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
512
548
|
) -> create_recipe_link_t.Data:
|
|
513
549
|
"""Create a link between two recipes. Skip if the link already exists
|
|
514
550
|
|
|
@@ -527,6 +563,7 @@ class ClientMethods(ABC):
|
|
|
527
563
|
method=create_recipe_link_t.ENDPOINT_METHOD,
|
|
528
564
|
endpoint=create_recipe_link_t.ENDPOINT_PATH,
|
|
529
565
|
args=args,
|
|
566
|
+
request_options=_request_options,
|
|
530
567
|
)
|
|
531
568
|
return self.do_request(api_request=api_request, return_type=create_recipe_link_t.Data)
|
|
532
569
|
|
|
@@ -536,6 +573,7 @@ class ClientMethods(ABC):
|
|
|
536
573
|
material_family_id: base_t.ObjectId,
|
|
537
574
|
recipe_definitions: list[create_recipes_t.CreateRecipeDefinition],
|
|
538
575
|
project_id: base_t.ObjectId | None = None,
|
|
576
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
539
577
|
) -> create_recipes_t.Data:
|
|
540
578
|
"""Creates recipes in Uncountable, optionally with metadata values, and returns the resulting ids in corresponding order
|
|
541
579
|
|
|
@@ -551,6 +589,7 @@ class ClientMethods(ABC):
|
|
|
551
589
|
method=create_recipes_t.ENDPOINT_METHOD,
|
|
552
590
|
endpoint=create_recipes_t.ENDPOINT_PATH,
|
|
553
591
|
args=args,
|
|
592
|
+
request_options=_request_options,
|
|
554
593
|
)
|
|
555
594
|
return self.do_request(api_request=api_request, return_type=create_recipes_t.Data)
|
|
556
595
|
|
|
@@ -558,6 +597,7 @@ class ClientMethods(ABC):
|
|
|
558
597
|
self,
|
|
559
598
|
*,
|
|
560
599
|
recipe_key: identifier_t.IdentifierKey,
|
|
600
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
561
601
|
) -> disassociate_recipe_as_input_t.Data:
|
|
562
602
|
"""Remove any association between a recipe and ingredients
|
|
563
603
|
|
|
@@ -570,6 +610,7 @@ class ClientMethods(ABC):
|
|
|
570
610
|
method=disassociate_recipe_as_input_t.ENDPOINT_METHOD,
|
|
571
611
|
endpoint=disassociate_recipe_as_input_t.ENDPOINT_PATH,
|
|
572
612
|
args=args,
|
|
613
|
+
request_options=_request_options,
|
|
573
614
|
)
|
|
574
615
|
return self.do_request(api_request=api_request, return_type=disassociate_recipe_as_input_t.Data)
|
|
575
616
|
|
|
@@ -579,6 +620,7 @@ class ClientMethods(ABC):
|
|
|
579
620
|
recipe_key: identifier_t.IdentifierKey,
|
|
580
621
|
recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifier,
|
|
581
622
|
edits: list[edit_recipe_inputs_t.RecipeInputEdit],
|
|
623
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
582
624
|
) -> edit_recipe_inputs_t.Data:
|
|
583
625
|
"""Clear, update, or add inputs on a recipe
|
|
584
626
|
|
|
@@ -593,6 +635,7 @@ class ClientMethods(ABC):
|
|
|
593
635
|
method=edit_recipe_inputs_t.ENDPOINT_METHOD,
|
|
594
636
|
endpoint=edit_recipe_inputs_t.ENDPOINT_PATH,
|
|
595
637
|
args=args,
|
|
638
|
+
request_options=_request_options,
|
|
596
639
|
)
|
|
597
640
|
return self.do_request(api_request=api_request, return_type=edit_recipe_inputs_t.Data)
|
|
598
641
|
|
|
@@ -600,6 +643,7 @@ class ClientMethods(ABC):
|
|
|
600
643
|
self,
|
|
601
644
|
*,
|
|
602
645
|
requests: list[execute_batch_t.BatchRequest],
|
|
646
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
603
647
|
) -> execute_batch_t.Data:
|
|
604
648
|
"""Run multiple API calls via one request
|
|
605
649
|
|
|
@@ -611,6 +655,7 @@ class ClientMethods(ABC):
|
|
|
611
655
|
method=execute_batch_t.ENDPOINT_METHOD,
|
|
612
656
|
endpoint=execute_batch_t.ENDPOINT_PATH,
|
|
613
657
|
args=args,
|
|
658
|
+
request_options=_request_options,
|
|
614
659
|
)
|
|
615
660
|
return self.do_request(api_request=api_request, return_type=execute_batch_t.Data)
|
|
616
661
|
|
|
@@ -618,6 +663,7 @@ class ClientMethods(ABC):
|
|
|
618
663
|
self,
|
|
619
664
|
*,
|
|
620
665
|
requests: list[async_batch_t.AsyncBatchRequest],
|
|
666
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
621
667
|
) -> execute_batch_load_async_t.Data:
|
|
622
668
|
"""Run multiple API calls via one request
|
|
623
669
|
|
|
@@ -629,6 +675,7 @@ class ClientMethods(ABC):
|
|
|
629
675
|
method=execute_batch_load_async_t.ENDPOINT_METHOD,
|
|
630
676
|
endpoint=execute_batch_load_async_t.ENDPOINT_PATH,
|
|
631
677
|
args=args,
|
|
678
|
+
request_options=_request_options,
|
|
632
679
|
)
|
|
633
680
|
return self.do_request(api_request=api_request, return_type=execute_batch_load_async_t.Data)
|
|
634
681
|
|
|
@@ -640,6 +687,7 @@ class ClientMethods(ABC):
|
|
|
640
687
|
client_timezone: exports_t.ListingExportUserTimezone | None = None,
|
|
641
688
|
limit: int | None = None,
|
|
642
689
|
attributes: list[export_entities_t.ListingAttribute] | None = None,
|
|
690
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
643
691
|
) -> export_entities_t.Data:
|
|
644
692
|
"""Uses a structured loading configuration to export entities in the system. This endpoint is asynchronous, and returns the job ID that can be used to query the status of the export.
|
|
645
693
|
|
|
@@ -657,6 +705,7 @@ class ClientMethods(ABC):
|
|
|
657
705
|
method=export_entities_t.ENDPOINT_METHOD,
|
|
658
706
|
endpoint=export_entities_t.ENDPOINT_PATH,
|
|
659
707
|
args=args,
|
|
708
|
+
request_options=_request_options,
|
|
660
709
|
)
|
|
661
710
|
return self.do_request(api_request=api_request, return_type=export_entities_t.Data)
|
|
662
711
|
|
|
@@ -665,6 +714,7 @@ class ClientMethods(ABC):
|
|
|
665
714
|
*,
|
|
666
715
|
recipe_keys: list[identifier_t.IdentifierKey],
|
|
667
716
|
calculation_key: identifier_t.IdentifierKey,
|
|
717
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
668
718
|
) -> get_column_calculation_values_t.Data:
|
|
669
719
|
"""Get the values for a column calculations for recipes
|
|
670
720
|
|
|
@@ -679,17 +729,24 @@ class ClientMethods(ABC):
|
|
|
679
729
|
method=get_column_calculation_values_t.ENDPOINT_METHOD,
|
|
680
730
|
endpoint=get_column_calculation_values_t.ENDPOINT_PATH,
|
|
681
731
|
args=args,
|
|
732
|
+
request_options=_request_options,
|
|
682
733
|
)
|
|
683
734
|
return self.do_request(api_request=api_request, return_type=get_column_calculation_values_t.Data)
|
|
684
735
|
|
|
685
736
|
def get_current_user_info(
|
|
686
737
|
self,
|
|
738
|
+
*,
|
|
739
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
687
740
|
) -> get_current_user_info_t.Data:
|
|
741
|
+
"""Return information about the current user
|
|
742
|
+
|
|
743
|
+
"""
|
|
688
744
|
args = get_current_user_info_t.Arguments()
|
|
689
745
|
api_request = APIRequest(
|
|
690
746
|
method=get_current_user_info_t.ENDPOINT_METHOD,
|
|
691
747
|
endpoint=get_current_user_info_t.ENDPOINT_PATH,
|
|
692
748
|
args=args,
|
|
749
|
+
request_options=_request_options,
|
|
693
750
|
)
|
|
694
751
|
return self.do_request(api_request=api_request, return_type=get_current_user_info_t.Data)
|
|
695
752
|
|
|
@@ -698,6 +755,7 @@ class ClientMethods(ABC):
|
|
|
698
755
|
*,
|
|
699
756
|
recipe_output_id: base_t.ObjectId | None = None,
|
|
700
757
|
recipe_input_id: base_t.ObjectId | None = None,
|
|
758
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
701
759
|
) -> get_curve_t.Data:
|
|
702
760
|
"""Returns an array of values for the specified curve id.
|
|
703
761
|
|
|
@@ -712,6 +770,7 @@ class ClientMethods(ABC):
|
|
|
712
770
|
method=get_curve_t.ENDPOINT_METHOD,
|
|
713
771
|
endpoint=get_curve_t.ENDPOINT_PATH,
|
|
714
772
|
args=args,
|
|
773
|
+
request_options=_request_options,
|
|
715
774
|
)
|
|
716
775
|
return self.do_request(api_request=api_request, return_type=get_curve_t.Data)
|
|
717
776
|
|
|
@@ -720,6 +779,7 @@ class ClientMethods(ABC):
|
|
|
720
779
|
*,
|
|
721
780
|
entity_ids: list[base_t.ObjectId],
|
|
722
781
|
entity_type: entity_t.EntityType,
|
|
782
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
723
783
|
) -> get_entities_data_t.Data:
|
|
724
784
|
"""Gets the details for a passed entity
|
|
725
785
|
|
|
@@ -734,6 +794,7 @@ class ClientMethods(ABC):
|
|
|
734
794
|
method=get_entities_data_t.ENDPOINT_METHOD,
|
|
735
795
|
endpoint=get_entities_data_t.ENDPOINT_PATH,
|
|
736
796
|
args=args,
|
|
797
|
+
request_options=_request_options,
|
|
737
798
|
)
|
|
738
799
|
return self.do_request(api_request=api_request, return_type=get_entities_data_t.Data)
|
|
739
800
|
|
|
@@ -745,6 +806,7 @@ class ClientMethods(ABC):
|
|
|
745
806
|
is_parameter: bool | None,
|
|
746
807
|
offset: int | None = None,
|
|
747
808
|
limit: int | None = None,
|
|
809
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
748
810
|
) -> get_input_data_t.Data:
|
|
749
811
|
"""Gets the attribute, categorization and other metadata associated with a set of inputs. An input is either an ingredient or process parameter, with metadata and calculations assigned separately
|
|
750
812
|
|
|
@@ -765,6 +827,7 @@ class ClientMethods(ABC):
|
|
|
765
827
|
method=get_input_data_t.ENDPOINT_METHOD,
|
|
766
828
|
endpoint=get_input_data_t.ENDPOINT_PATH,
|
|
767
829
|
args=args,
|
|
830
|
+
request_options=_request_options,
|
|
768
831
|
)
|
|
769
832
|
return self.do_request(api_request=api_request, return_type=get_input_data_t.Data)
|
|
770
833
|
|
|
@@ -772,6 +835,7 @@ class ClientMethods(ABC):
|
|
|
772
835
|
self,
|
|
773
836
|
*,
|
|
774
837
|
material_family_id: base_t.ObjectId,
|
|
838
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
775
839
|
) -> get_input_group_names_t.Data:
|
|
776
840
|
"""Gets the name of all input groups in a material family that either the user created, or are shared to all users.
|
|
777
841
|
|
|
@@ -784,6 +848,7 @@ class ClientMethods(ABC):
|
|
|
784
848
|
method=get_input_group_names_t.ENDPOINT_METHOD,
|
|
785
849
|
endpoint=get_input_group_names_t.ENDPOINT_PATH,
|
|
786
850
|
args=args,
|
|
851
|
+
request_options=_request_options,
|
|
787
852
|
)
|
|
788
853
|
return self.do_request(api_request=api_request, return_type=get_input_group_names_t.Data)
|
|
789
854
|
|
|
@@ -794,6 +859,7 @@ class ClientMethods(ABC):
|
|
|
794
859
|
is_parameter: bool | None,
|
|
795
860
|
offset: int | None = None,
|
|
796
861
|
limit: int | None = None,
|
|
862
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
797
863
|
) -> get_input_names_t.Data:
|
|
798
864
|
"""Gets the name of all inputs for a material family. An input is either an ingredient or process parameter, with metadata and calculations assigned separately
|
|
799
865
|
|
|
@@ -812,6 +878,7 @@ class ClientMethods(ABC):
|
|
|
812
878
|
method=get_input_names_t.ENDPOINT_METHOD,
|
|
813
879
|
endpoint=get_input_names_t.ENDPOINT_PATH,
|
|
814
880
|
args=args,
|
|
881
|
+
request_options=_request_options,
|
|
815
882
|
)
|
|
816
883
|
return self.do_request(api_request=api_request, return_type=get_input_names_t.Data)
|
|
817
884
|
|
|
@@ -819,6 +886,7 @@ class ClientMethods(ABC):
|
|
|
819
886
|
self,
|
|
820
887
|
*,
|
|
821
888
|
input_ids: list[base_t.ObjectId],
|
|
889
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
822
890
|
) -> get_inputs_data_t.Data:
|
|
823
891
|
"""Gets the details for passed input ids
|
|
824
892
|
|
|
@@ -831,6 +899,7 @@ class ClientMethods(ABC):
|
|
|
831
899
|
method=get_inputs_data_t.ENDPOINT_METHOD,
|
|
832
900
|
endpoint=get_inputs_data_t.ENDPOINT_PATH,
|
|
833
901
|
args=args,
|
|
902
|
+
request_options=_request_options,
|
|
834
903
|
)
|
|
835
904
|
return self.do_request(api_request=api_request, return_type=get_inputs_data_t.Data)
|
|
836
905
|
|
|
@@ -841,6 +910,7 @@ class ClientMethods(ABC):
|
|
|
841
910
|
output_ids: list[base_t.ObjectId] | None = None,
|
|
842
911
|
offset: int | None = None,
|
|
843
912
|
limit: int | None = None,
|
|
913
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
844
914
|
) -> get_output_data_t.Data:
|
|
845
915
|
"""Gets the attribute, categorization and other metadata associated with a set of outputs
|
|
846
916
|
|
|
@@ -859,6 +929,7 @@ class ClientMethods(ABC):
|
|
|
859
929
|
method=get_output_data_t.ENDPOINT_METHOD,
|
|
860
930
|
endpoint=get_output_data_t.ENDPOINT_PATH,
|
|
861
931
|
args=args,
|
|
932
|
+
request_options=_request_options,
|
|
862
933
|
)
|
|
863
934
|
return self.do_request(api_request=api_request, return_type=get_output_data_t.Data)
|
|
864
935
|
|
|
@@ -868,6 +939,7 @@ class ClientMethods(ABC):
|
|
|
868
939
|
material_family_id: base_t.ObjectId,
|
|
869
940
|
offset: int | None = None,
|
|
870
941
|
limit: int | None = None,
|
|
942
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
871
943
|
) -> get_output_names_t.Data:
|
|
872
944
|
"""Gets the name of all outputs for a material family. An output represents a measurement value of any time (numeric, text, curve, etc). This includes calculations based off of other outputs, such as a calculated change over time
|
|
873
945
|
|
|
@@ -884,6 +956,7 @@ class ClientMethods(ABC):
|
|
|
884
956
|
method=get_output_names_t.ENDPOINT_METHOD,
|
|
885
957
|
endpoint=get_output_names_t.ENDPOINT_PATH,
|
|
886
958
|
args=args,
|
|
959
|
+
request_options=_request_options,
|
|
887
960
|
)
|
|
888
961
|
return self.do_request(api_request=api_request, return_type=get_output_names_t.Data)
|
|
889
962
|
|
|
@@ -892,6 +965,7 @@ class ClientMethods(ABC):
|
|
|
892
965
|
*,
|
|
893
966
|
all_material_families: bool,
|
|
894
967
|
material_family_id: base_t.ObjectId | None,
|
|
968
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
895
969
|
) -> get_projects_t.Data:
|
|
896
970
|
"""Gets either all projects created in the platform, or the projects associated with a material family ID. Projects are where experiments are placed in Uncountable, similar to folders in a directory structure
|
|
897
971
|
|
|
@@ -906,6 +980,7 @@ class ClientMethods(ABC):
|
|
|
906
980
|
method=get_projects_t.ENDPOINT_METHOD,
|
|
907
981
|
endpoint=get_projects_t.ENDPOINT_PATH,
|
|
908
982
|
args=args,
|
|
983
|
+
request_options=_request_options,
|
|
909
984
|
)
|
|
910
985
|
return self.do_request(api_request=api_request, return_type=get_projects_t.Data)
|
|
911
986
|
|
|
@@ -915,6 +990,7 @@ class ClientMethods(ABC):
|
|
|
915
990
|
project_ids: list[base_t.ObjectId],
|
|
916
991
|
offset: int | None = None,
|
|
917
992
|
limit: int | None = None,
|
|
993
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
918
994
|
) -> get_projects_data_t.Data:
|
|
919
995
|
"""Gets either all data associated with a set of projects created in the platform. Because Uncountables recipe structure is complex, various data values are exploded out to increase efficiency in parsing, and this page is paginated to prevent too large of return values
|
|
920
996
|
|
|
@@ -931,6 +1007,7 @@ class ClientMethods(ABC):
|
|
|
931
1007
|
method=get_projects_data_t.ENDPOINT_METHOD,
|
|
932
1008
|
endpoint=get_projects_data_t.ENDPOINT_PATH,
|
|
933
1009
|
args=args,
|
|
1010
|
+
request_options=_request_options,
|
|
934
1011
|
)
|
|
935
1012
|
return self.do_request(api_request=api_request, return_type=get_projects_data_t.Data)
|
|
936
1013
|
|
|
@@ -939,6 +1016,7 @@ class ClientMethods(ABC):
|
|
|
939
1016
|
*,
|
|
940
1017
|
recipe_ids: list[base_t.ObjectId],
|
|
941
1018
|
calculation_ids: list[base_t.ObjectId] | None = None,
|
|
1019
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
942
1020
|
) -> get_recipe_calculations_t.Data:
|
|
943
1021
|
"""Gets the calculations for the passed recipes
|
|
944
1022
|
|
|
@@ -953,6 +1031,7 @@ class ClientMethods(ABC):
|
|
|
953
1031
|
method=get_recipe_calculations_t.ENDPOINT_METHOD,
|
|
954
1032
|
endpoint=get_recipe_calculations_t.ENDPOINT_PATH,
|
|
955
1033
|
args=args,
|
|
1034
|
+
request_options=_request_options,
|
|
956
1035
|
)
|
|
957
1036
|
return self.do_request(api_request=api_request, return_type=get_recipe_calculations_t.Data)
|
|
958
1037
|
|
|
@@ -962,6 +1041,7 @@ class ClientMethods(ABC):
|
|
|
962
1041
|
recipe_ids: list[base_t.ObjectId],
|
|
963
1042
|
depth: int = 1,
|
|
964
1043
|
link_types: list[recipe_links_t.RecipeLinkType] | None,
|
|
1044
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
965
1045
|
) -> get_recipe_links_t.Data:
|
|
966
1046
|
"""Gets the links for the passed recipes
|
|
967
1047
|
|
|
@@ -978,6 +1058,7 @@ class ClientMethods(ABC):
|
|
|
978
1058
|
method=get_recipe_links_t.ENDPOINT_METHOD,
|
|
979
1059
|
endpoint=get_recipe_links_t.ENDPOINT_PATH,
|
|
980
1060
|
args=args,
|
|
1061
|
+
request_options=_request_options,
|
|
981
1062
|
)
|
|
982
1063
|
return self.do_request(api_request=api_request, return_type=get_recipe_links_t.Data)
|
|
983
1064
|
|
|
@@ -988,6 +1069,7 @@ class ClientMethods(ABC):
|
|
|
988
1069
|
recipe_metadata_ids: list[base_t.ObjectId] | None,
|
|
989
1070
|
offset: int | None = None,
|
|
990
1071
|
limit: int | None = None,
|
|
1072
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
991
1073
|
) -> get_recipe_metadata_data_t.Data:
|
|
992
1074
|
"""Gets the recipe metadata. Recipe metadata is data associated with experiments that is not an input, output or calculation, such as a sample ID.
|
|
993
1075
|
|
|
@@ -1006,6 +1088,7 @@ class ClientMethods(ABC):
|
|
|
1006
1088
|
method=get_recipe_metadata_data_t.ENDPOINT_METHOD,
|
|
1007
1089
|
endpoint=get_recipe_metadata_data_t.ENDPOINT_PATH,
|
|
1008
1090
|
args=args,
|
|
1091
|
+
request_options=_request_options,
|
|
1009
1092
|
)
|
|
1010
1093
|
return self.do_request(api_request=api_request, return_type=get_recipe_metadata_data_t.Data)
|
|
1011
1094
|
|
|
@@ -1013,6 +1096,7 @@ class ClientMethods(ABC):
|
|
|
1013
1096
|
self,
|
|
1014
1097
|
*,
|
|
1015
1098
|
project_id: base_t.ObjectId,
|
|
1099
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1016
1100
|
) -> get_recipe_names_t.Data:
|
|
1017
1101
|
"""Gets the name of all recipes (or experiments, used as synonyms by Uncountable) for a project. The call external_get_projects can be used to find projects
|
|
1018
1102
|
|
|
@@ -1025,6 +1109,7 @@ class ClientMethods(ABC):
|
|
|
1025
1109
|
method=get_recipe_names_t.ENDPOINT_METHOD,
|
|
1026
1110
|
endpoint=get_recipe_names_t.ENDPOINT_PATH,
|
|
1027
1111
|
args=args,
|
|
1112
|
+
request_options=_request_options,
|
|
1028
1113
|
)
|
|
1029
1114
|
return self.do_request(api_request=api_request, return_type=get_recipe_names_t.Data)
|
|
1030
1115
|
|
|
@@ -1032,6 +1117,7 @@ class ClientMethods(ABC):
|
|
|
1032
1117
|
self,
|
|
1033
1118
|
*,
|
|
1034
1119
|
recipe_output_ids: list[base_t.ObjectId],
|
|
1120
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1035
1121
|
) -> get_recipe_output_metadata_t.Data:
|
|
1036
1122
|
"""Gets the metadata values for the passed recipe outputs
|
|
1037
1123
|
|
|
@@ -1044,6 +1130,7 @@ class ClientMethods(ABC):
|
|
|
1044
1130
|
method=get_recipe_output_metadata_t.ENDPOINT_METHOD,
|
|
1045
1131
|
endpoint=get_recipe_output_metadata_t.ENDPOINT_PATH,
|
|
1046
1132
|
args=args,
|
|
1133
|
+
request_options=_request_options,
|
|
1047
1134
|
)
|
|
1048
1135
|
return self.do_request(api_request=api_request, return_type=get_recipe_output_metadata_t.Data)
|
|
1049
1136
|
|
|
@@ -1055,6 +1142,7 @@ class ClientMethods(ABC):
|
|
|
1055
1142
|
offset: int | None = None,
|
|
1056
1143
|
limit: int | None = None,
|
|
1057
1144
|
empty_output_behavior: get_recipes_data_t.RecipeOutputInclusion | None = None,
|
|
1145
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1058
1146
|
) -> get_recipes_data_t.Data:
|
|
1059
1147
|
"""Gets all data associated with a set of recipes. Because Uncountables recipe structure is complex, various data values are exploded out to increase efficiency in parsing, and this page is paginated to prevent too large of return values
|
|
1060
1148
|
|
|
@@ -1075,6 +1163,7 @@ class ClientMethods(ABC):
|
|
|
1075
1163
|
method=get_recipes_data_t.ENDPOINT_METHOD,
|
|
1076
1164
|
endpoint=get_recipes_data_t.ENDPOINT_PATH,
|
|
1077
1165
|
args=args,
|
|
1166
|
+
request_options=_request_options,
|
|
1078
1167
|
)
|
|
1079
1168
|
return self.do_request(api_request=api_request, return_type=get_recipes_data_t.Data)
|
|
1080
1169
|
|
|
@@ -1087,6 +1176,7 @@ class ClientMethods(ABC):
|
|
|
1087
1176
|
user_keys: list[identifier_t.IdentifierKey] | None = None,
|
|
1088
1177
|
user_group_keys: list[identifier_t.IdentifierKey] | None = None,
|
|
1089
1178
|
all_users: bool | None = None,
|
|
1179
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1090
1180
|
) -> grant_entity_permissions_t.Data:
|
|
1091
1181
|
"""Grant entity permissions to a list of users or user groups or to all users.
|
|
1092
1182
|
|
|
@@ -1103,6 +1193,7 @@ class ClientMethods(ABC):
|
|
|
1103
1193
|
method=grant_entity_permissions_t.ENDPOINT_METHOD,
|
|
1104
1194
|
endpoint=grant_entity_permissions_t.ENDPOINT_PATH,
|
|
1105
1195
|
args=args,
|
|
1196
|
+
request_options=_request_options,
|
|
1106
1197
|
)
|
|
1107
1198
|
return self.do_request(api_request=api_request, return_type=grant_entity_permissions_t.Data)
|
|
1108
1199
|
|
|
@@ -1113,6 +1204,7 @@ class ClientMethods(ABC):
|
|
|
1113
1204
|
destination: generic_upload_t.UploadDestination,
|
|
1114
1205
|
file_id: base_t.ObjectId | None = None,
|
|
1115
1206
|
file_ids: list[base_t.ObjectId] | None = None,
|
|
1207
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1116
1208
|
) -> invoke_uploader_t.Data:
|
|
1117
1209
|
"""Runs a file through an uploader.
|
|
1118
1210
|
|
|
@@ -1128,9 +1220,40 @@ class ClientMethods(ABC):
|
|
|
1128
1220
|
method=invoke_uploader_t.ENDPOINT_METHOD,
|
|
1129
1221
|
endpoint=invoke_uploader_t.ENDPOINT_PATH,
|
|
1130
1222
|
args=args,
|
|
1223
|
+
request_options=_request_options,
|
|
1131
1224
|
)
|
|
1132
1225
|
return self.do_request(api_request=api_request, return_type=invoke_uploader_t.Data)
|
|
1133
1226
|
|
|
1227
|
+
def list_aggregate(
|
|
1228
|
+
self,
|
|
1229
|
+
*,
|
|
1230
|
+
config_reference: str,
|
|
1231
|
+
attribute_values: list[list_aggregate_t.AttributeValue] | None = None,
|
|
1232
|
+
offset: int | None = None,
|
|
1233
|
+
limit: int | None = None,
|
|
1234
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1235
|
+
) -> list_aggregate_t.Data:
|
|
1236
|
+
"""Uses a structured loading configuration to list aggregated data from the platform
|
|
1237
|
+
|
|
1238
|
+
:param config_reference: The configuration reference name for the listing config
|
|
1239
|
+
:param attribute_values: Attributes to pass to the configuration for parameterizing filters
|
|
1240
|
+
:param offset: Used for pagination. Pagination is done based on the sorting of the config. [Pagination More Info](#pagination)
|
|
1241
|
+
:param limit: The number of data points to return. If not filled in, it will be set to 100, and cannot be set higher than 100. [Pagination More Info](#pagination)
|
|
1242
|
+
"""
|
|
1243
|
+
args = list_aggregate_t.Arguments(
|
|
1244
|
+
config_reference=config_reference,
|
|
1245
|
+
attribute_values=attribute_values,
|
|
1246
|
+
offset=offset,
|
|
1247
|
+
limit=limit,
|
|
1248
|
+
)
|
|
1249
|
+
api_request = APIRequest(
|
|
1250
|
+
method=list_aggregate_t.ENDPOINT_METHOD,
|
|
1251
|
+
endpoint=list_aggregate_t.ENDPOINT_PATH,
|
|
1252
|
+
args=args,
|
|
1253
|
+
request_options=_request_options,
|
|
1254
|
+
)
|
|
1255
|
+
return self.do_request(api_request=api_request, return_type=list_aggregate_t.Data)
|
|
1256
|
+
|
|
1134
1257
|
def list_entities(
|
|
1135
1258
|
self,
|
|
1136
1259
|
*,
|
|
@@ -1139,6 +1262,8 @@ class ClientMethods(ABC):
|
|
|
1139
1262
|
attributes: dict[OpaqueKey, base_t.JsonValue] | None = None,
|
|
1140
1263
|
offset: int | None = None,
|
|
1141
1264
|
limit: int | None = None,
|
|
1265
|
+
additional_filter_configs: list[list_entities_t.AdditionalFilterConfig] | None = None,
|
|
1266
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1142
1267
|
) -> list_entities_t.Data:
|
|
1143
1268
|
"""Uses a structured loading configuration to list entities in the system
|
|
1144
1269
|
|
|
@@ -1147,6 +1272,7 @@ class ClientMethods(ABC):
|
|
|
1147
1272
|
:param attributes: Attributes to pass to the configuration for parameterizing filters
|
|
1148
1273
|
:param offset: Used for pagination. Pagination is done based on the sorting of the config. [Pagination More Info](#pagination)
|
|
1149
1274
|
:param limit: The number of data points to return. If not filled in, it will be set to 100, and cannot be set higher than 100. [Pagination More Info](#pagination)
|
|
1275
|
+
:param additional_filter_configs: Advanced property: Additional filter configurations to apply to the listing. A maximum of 10 additional filter configs are supported.
|
|
1150
1276
|
"""
|
|
1151
1277
|
args = list_entities_t.Arguments(
|
|
1152
1278
|
entity_type=entity_type,
|
|
@@ -1154,11 +1280,13 @@ class ClientMethods(ABC):
|
|
|
1154
1280
|
attributes=attributes,
|
|
1155
1281
|
offset=offset,
|
|
1156
1282
|
limit=limit,
|
|
1283
|
+
additional_filter_configs=additional_filter_configs,
|
|
1157
1284
|
)
|
|
1158
1285
|
api_request = APIRequest(
|
|
1159
1286
|
method=list_entities_t.ENDPOINT_METHOD,
|
|
1160
1287
|
endpoint=list_entities_t.ENDPOINT_PATH,
|
|
1161
1288
|
args=args,
|
|
1289
|
+
request_options=_request_options,
|
|
1162
1290
|
)
|
|
1163
1291
|
return self.do_request(api_request=api_request, return_type=list_entities_t.Data)
|
|
1164
1292
|
|
|
@@ -1169,6 +1297,7 @@ class ClientMethods(ABC):
|
|
|
1169
1297
|
search_label: str,
|
|
1170
1298
|
offset: int | None = None,
|
|
1171
1299
|
limit: int | None = None,
|
|
1300
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1172
1301
|
) -> list_id_source_t.Data:
|
|
1173
1302
|
"""Lists id and label pairs
|
|
1174
1303
|
|
|
@@ -1187,6 +1316,7 @@ class ClientMethods(ABC):
|
|
|
1187
1316
|
method=list_id_source_t.ENDPOINT_METHOD,
|
|
1188
1317
|
endpoint=list_id_source_t.ENDPOINT_PATH,
|
|
1189
1318
|
args=args,
|
|
1319
|
+
request_options=_request_options,
|
|
1190
1320
|
)
|
|
1191
1321
|
return self.do_request(api_request=api_request, return_type=list_id_source_t.Data)
|
|
1192
1322
|
|
|
@@ -1196,6 +1326,7 @@ class ClientMethods(ABC):
|
|
|
1196
1326
|
entity_key: identifier_t.IdentifierKey,
|
|
1197
1327
|
entity_type: entity_t.EntityType,
|
|
1198
1328
|
globally_removable: bool | None = None,
|
|
1329
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1199
1330
|
) -> lock_entity_t.Data:
|
|
1200
1331
|
"""Lock an entity
|
|
1201
1332
|
|
|
@@ -1211,6 +1342,7 @@ class ClientMethods(ABC):
|
|
|
1211
1342
|
method=lock_entity_t.ENDPOINT_METHOD,
|
|
1212
1343
|
endpoint=lock_entity_t.ENDPOINT_PATH,
|
|
1213
1344
|
args=args,
|
|
1345
|
+
request_options=_request_options,
|
|
1214
1346
|
)
|
|
1215
1347
|
return self.do_request(api_request=api_request, return_type=lock_entity_t.Data)
|
|
1216
1348
|
|
|
@@ -1222,6 +1354,7 @@ class ClientMethods(ABC):
|
|
|
1222
1354
|
globally_removable: bool,
|
|
1223
1355
|
lock_samples: bool | None = None,
|
|
1224
1356
|
comments: str | None = None,
|
|
1357
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1225
1358
|
) -> lock_recipes_t.Data:
|
|
1226
1359
|
"""Lock experiments. Experiments will require unlocking to be editable. Edits to the experiments are blocked while they are locked.
|
|
1227
1360
|
|
|
@@ -1245,6 +1378,7 @@ class ClientMethods(ABC):
|
|
|
1245
1378
|
method=lock_recipes_t.ENDPOINT_METHOD,
|
|
1246
1379
|
endpoint=lock_recipes_t.ENDPOINT_PATH,
|
|
1247
1380
|
args=args,
|
|
1381
|
+
request_options=_request_options,
|
|
1248
1382
|
)
|
|
1249
1383
|
return self.do_request(api_request=api_request, return_type=lock_recipes_t.Data)
|
|
1250
1384
|
|
|
@@ -1253,6 +1387,7 @@ class ClientMethods(ABC):
|
|
|
1253
1387
|
*,
|
|
1254
1388
|
entity_type: entity_t.EntityType,
|
|
1255
1389
|
query: lookup_entity_t.LookupEntityQuery,
|
|
1390
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1256
1391
|
) -> lookup_entity_t.Data:
|
|
1257
1392
|
"""Look up an entity based on an identifier or field values
|
|
1258
1393
|
|
|
@@ -1265,6 +1400,7 @@ class ClientMethods(ABC):
|
|
|
1265
1400
|
method=lookup_entity_t.ENDPOINT_METHOD,
|
|
1266
1401
|
endpoint=lookup_entity_t.ENDPOINT_PATH,
|
|
1267
1402
|
args=args,
|
|
1403
|
+
request_options=_request_options,
|
|
1268
1404
|
)
|
|
1269
1405
|
return self.do_request(api_request=api_request, return_type=lookup_entity_t.Data)
|
|
1270
1406
|
|
|
@@ -1273,6 +1409,7 @@ class ClientMethods(ABC):
|
|
|
1273
1409
|
*,
|
|
1274
1410
|
spec: id_source_t.IdSourceSpec,
|
|
1275
1411
|
names: list[str],
|
|
1412
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1276
1413
|
) -> match_id_source_t.Data:
|
|
1277
1414
|
"""Lists id and label pairs
|
|
1278
1415
|
|
|
@@ -1287,6 +1424,7 @@ class ClientMethods(ABC):
|
|
|
1287
1424
|
method=match_id_source_t.ENDPOINT_METHOD,
|
|
1288
1425
|
endpoint=match_id_source_t.ENDPOINT_PATH,
|
|
1289
1426
|
args=args,
|
|
1427
|
+
request_options=_request_options,
|
|
1290
1428
|
)
|
|
1291
1429
|
return self.do_request(api_request=api_request, return_type=match_id_source_t.Data)
|
|
1292
1430
|
|
|
@@ -1298,6 +1436,7 @@ class ClientMethods(ABC):
|
|
|
1298
1436
|
message: str,
|
|
1299
1437
|
display_notice: bool = False,
|
|
1300
1438
|
entity: entity_t.EntityIdentifier | None = None,
|
|
1439
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1301
1440
|
) -> push_notification_t.Data:
|
|
1302
1441
|
"""Push a notification to a user or user group
|
|
1303
1442
|
|
|
@@ -1313,6 +1452,7 @@ class ClientMethods(ABC):
|
|
|
1313
1452
|
method=push_notification_t.ENDPOINT_METHOD,
|
|
1314
1453
|
endpoint=push_notification_t.ENDPOINT_PATH,
|
|
1315
1454
|
args=args,
|
|
1455
|
+
request_options=_request_options,
|
|
1316
1456
|
)
|
|
1317
1457
|
return self.do_request(api_request=api_request, return_type=push_notification_t.Data)
|
|
1318
1458
|
|
|
@@ -1320,6 +1460,7 @@ class ClientMethods(ABC):
|
|
|
1320
1460
|
self,
|
|
1321
1461
|
*,
|
|
1322
1462
|
socket_request: sockets_t.SocketTokenRequest,
|
|
1463
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1323
1464
|
) -> register_sockets_token_t.Data:
|
|
1324
1465
|
"""Request token for connecting to sockets server
|
|
1325
1466
|
|
|
@@ -1331,6 +1472,7 @@ class ClientMethods(ABC):
|
|
|
1331
1472
|
method=register_sockets_token_t.ENDPOINT_METHOD,
|
|
1332
1473
|
endpoint=register_sockets_token_t.ENDPOINT_PATH,
|
|
1333
1474
|
args=args,
|
|
1475
|
+
request_options=_request_options,
|
|
1334
1476
|
)
|
|
1335
1477
|
return self.do_request(api_request=api_request, return_type=register_sockets_token_t.Data)
|
|
1336
1478
|
|
|
@@ -1339,6 +1481,7 @@ class ClientMethods(ABC):
|
|
|
1339
1481
|
*,
|
|
1340
1482
|
recipe_key: identifier_t.IdentifierKey,
|
|
1341
1483
|
project_key: identifier_t.IdentifierKey,
|
|
1484
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1342
1485
|
) -> remove_recipe_from_project_t.Data:
|
|
1343
1486
|
"""Removes a recipe from a project
|
|
1344
1487
|
|
|
@@ -1353,6 +1496,7 @@ class ClientMethods(ABC):
|
|
|
1353
1496
|
method=remove_recipe_from_project_t.ENDPOINT_METHOD,
|
|
1354
1497
|
endpoint=remove_recipe_from_project_t.ENDPOINT_PATH,
|
|
1355
1498
|
args=args,
|
|
1499
|
+
request_options=_request_options,
|
|
1356
1500
|
)
|
|
1357
1501
|
return self.do_request(api_request=api_request, return_type=remove_recipe_from_project_t.Data)
|
|
1358
1502
|
|
|
@@ -1362,6 +1506,7 @@ class ClientMethods(ABC):
|
|
|
1362
1506
|
recipe_from_key: identifier_t.IdentifierKey,
|
|
1363
1507
|
recipe_to_key: identifier_t.IdentifierKey,
|
|
1364
1508
|
link_type: typing.Literal[recipe_links_t.RecipeLinkType.CHILD] | typing.Literal[recipe_links_t.RecipeLinkType.CONTROL] | typing.Literal[recipe_links_t.RecipeLinkType.USER_LINK] | typing.Literal[recipe_links_t.RecipeLinkType.PREVIOUS_EXPERIMENT],
|
|
1509
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1365
1510
|
) -> remove_recipe_link_t.Data:
|
|
1366
1511
|
"""Remove a link between two recipes. Skip if the link doesn't already exist
|
|
1367
1512
|
|
|
@@ -1378,6 +1523,7 @@ class ClientMethods(ABC):
|
|
|
1378
1523
|
method=remove_recipe_link_t.ENDPOINT_METHOD,
|
|
1379
1524
|
endpoint=remove_recipe_link_t.ENDPOINT_PATH,
|
|
1380
1525
|
args=args,
|
|
1526
|
+
request_options=_request_options,
|
|
1381
1527
|
)
|
|
1382
1528
|
return self.do_request(api_request=api_request, return_type=remove_recipe_link_t.Data)
|
|
1383
1529
|
|
|
@@ -1386,6 +1532,7 @@ class ClientMethods(ABC):
|
|
|
1386
1532
|
*,
|
|
1387
1533
|
entity_ids: list[str | base_t.ObjectId],
|
|
1388
1534
|
entity_type: entity_t.EntityType,
|
|
1535
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1389
1536
|
) -> resolve_entity_ids_t.Data:
|
|
1390
1537
|
"""Gets the names for passed in ids
|
|
1391
1538
|
|
|
@@ -1400,6 +1547,7 @@ class ClientMethods(ABC):
|
|
|
1400
1547
|
method=resolve_entity_ids_t.ENDPOINT_METHOD,
|
|
1401
1548
|
endpoint=resolve_entity_ids_t.ENDPOINT_PATH,
|
|
1402
1549
|
args=args,
|
|
1550
|
+
request_options=_request_options,
|
|
1403
1551
|
)
|
|
1404
1552
|
return self.do_request(api_request=api_request, return_type=resolve_entity_ids_t.Data)
|
|
1405
1553
|
|
|
@@ -1407,6 +1555,7 @@ class ClientMethods(ABC):
|
|
|
1407
1555
|
self,
|
|
1408
1556
|
*,
|
|
1409
1557
|
requested_conditions: list[resolve_output_conditions_t.ConditionRequest],
|
|
1558
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1410
1559
|
) -> resolve_output_conditions_t.Data:
|
|
1411
1560
|
"""For the provided set of condition parameter id and values, returns the existing or newly created output condition id for that value and id pair.
|
|
1412
1561
|
|
|
@@ -1418,6 +1567,7 @@ class ClientMethods(ABC):
|
|
|
1418
1567
|
method=resolve_output_conditions_t.ENDPOINT_METHOD,
|
|
1419
1568
|
endpoint=resolve_output_conditions_t.ENDPOINT_PATH,
|
|
1420
1569
|
args=args,
|
|
1570
|
+
request_options=_request_options,
|
|
1421
1571
|
)
|
|
1422
1572
|
return self.do_request(api_request=api_request, return_type=resolve_output_conditions_t.Data)
|
|
1423
1573
|
|
|
@@ -1426,6 +1576,7 @@ class ClientMethods(ABC):
|
|
|
1426
1576
|
*,
|
|
1427
1577
|
trigger_ref_name: str,
|
|
1428
1578
|
entity: entity_t.Entity | None = None,
|
|
1579
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1429
1580
|
) -> run_trigger_t.Data:
|
|
1430
1581
|
"""Runs a trigger. Requires admin access
|
|
1431
1582
|
|
|
@@ -1438,6 +1589,7 @@ class ClientMethods(ABC):
|
|
|
1438
1589
|
method=run_trigger_t.ENDPOINT_METHOD,
|
|
1439
1590
|
endpoint=run_trigger_t.ENDPOINT_PATH,
|
|
1440
1591
|
args=args,
|
|
1592
|
+
request_options=_request_options,
|
|
1441
1593
|
)
|
|
1442
1594
|
return self.do_request(api_request=api_request, return_type=run_trigger_t.Data)
|
|
1443
1595
|
|
|
@@ -1449,6 +1601,7 @@ class ClientMethods(ABC):
|
|
|
1449
1601
|
update_type: post_base_t.UpdateType,
|
|
1450
1602
|
user_group_ids: list[int] | None = None,
|
|
1451
1603
|
user_ids: list[int] | None = None,
|
|
1604
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1452
1605
|
) -> set_core_permissions_t.Data:
|
|
1453
1606
|
"""Sets recipe related permissions
|
|
1454
1607
|
|
|
@@ -1468,6 +1621,7 @@ class ClientMethods(ABC):
|
|
|
1468
1621
|
method=set_core_permissions_t.ENDPOINT_METHOD,
|
|
1469
1622
|
endpoint=set_core_permissions_t.ENDPOINT_PATH,
|
|
1470
1623
|
args=args,
|
|
1624
|
+
request_options=_request_options,
|
|
1471
1625
|
)
|
|
1472
1626
|
return self.do_request(api_request=api_request, return_type=set_core_permissions_t.Data)
|
|
1473
1627
|
|
|
@@ -1476,6 +1630,7 @@ class ClientMethods(ABC):
|
|
|
1476
1630
|
*,
|
|
1477
1631
|
entity_identifier: entity_t.EntityIdentifier,
|
|
1478
1632
|
field_values: list[field_values_t.FieldArgumentValue],
|
|
1633
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1479
1634
|
) -> set_entity_field_values_t.Data:
|
|
1480
1635
|
"""Sets field values for an entity
|
|
1481
1636
|
|
|
@@ -1490,6 +1645,7 @@ class ClientMethods(ABC):
|
|
|
1490
1645
|
method=set_entity_field_values_t.ENDPOINT_METHOD,
|
|
1491
1646
|
endpoint=set_entity_field_values_t.ENDPOINT_PATH,
|
|
1492
1647
|
args=args,
|
|
1648
|
+
request_options=_request_options,
|
|
1493
1649
|
)
|
|
1494
1650
|
return self.do_request(api_request=api_request, return_type=set_entity_field_values_t.Data)
|
|
1495
1651
|
|
|
@@ -1497,6 +1653,7 @@ class ClientMethods(ABC):
|
|
|
1497
1653
|
self,
|
|
1498
1654
|
*,
|
|
1499
1655
|
attribute_values: list[set_input_attribute_values_t.InputAttributeValue],
|
|
1656
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1500
1657
|
) -> set_input_attribute_values_t.Data:
|
|
1501
1658
|
"""Sets attribute values for an input
|
|
1502
1659
|
|
|
@@ -1509,6 +1666,7 @@ class ClientMethods(ABC):
|
|
|
1509
1666
|
method=set_input_attribute_values_t.ENDPOINT_METHOD,
|
|
1510
1667
|
endpoint=set_input_attribute_values_t.ENDPOINT_PATH,
|
|
1511
1668
|
args=args,
|
|
1669
|
+
request_options=_request_options,
|
|
1512
1670
|
)
|
|
1513
1671
|
return self.do_request(api_request=api_request, return_type=set_input_attribute_values_t.Data)
|
|
1514
1672
|
|
|
@@ -1518,6 +1676,7 @@ class ClientMethods(ABC):
|
|
|
1518
1676
|
input_key: identifier_t.IdentifierKey,
|
|
1519
1677
|
category_id: int | None,
|
|
1520
1678
|
material_family_ids: list[int] | None = None,
|
|
1679
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1521
1680
|
) -> set_input_category_t.Data:
|
|
1522
1681
|
"""Sets subcategories for an input
|
|
1523
1682
|
|
|
@@ -1534,6 +1693,7 @@ class ClientMethods(ABC):
|
|
|
1534
1693
|
method=set_input_category_t.ENDPOINT_METHOD,
|
|
1535
1694
|
endpoint=set_input_category_t.ENDPOINT_PATH,
|
|
1536
1695
|
args=args,
|
|
1696
|
+
request_options=_request_options,
|
|
1537
1697
|
)
|
|
1538
1698
|
return self.do_request(api_request=api_request, return_type=set_input_category_t.Data)
|
|
1539
1699
|
|
|
@@ -1543,6 +1703,7 @@ class ClientMethods(ABC):
|
|
|
1543
1703
|
input_key: identifier_t.IdentifierKey,
|
|
1544
1704
|
subcategory_ids: list[int],
|
|
1545
1705
|
update_type: post_base_t.UpdateType,
|
|
1706
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1546
1707
|
) -> set_input_subcategories_t.Data:
|
|
1547
1708
|
"""Sets subcategories for an input
|
|
1548
1709
|
|
|
@@ -1559,6 +1720,7 @@ class ClientMethods(ABC):
|
|
|
1559
1720
|
method=set_input_subcategories_t.ENDPOINT_METHOD,
|
|
1560
1721
|
endpoint=set_input_subcategories_t.ENDPOINT_PATH,
|
|
1561
1722
|
args=args,
|
|
1723
|
+
request_options=_request_options,
|
|
1562
1724
|
)
|
|
1563
1725
|
return self.do_request(api_request=api_request, return_type=set_input_subcategories_t.Data)
|
|
1564
1726
|
|
|
@@ -1567,6 +1729,7 @@ class ClientMethods(ABC):
|
|
|
1567
1729
|
*,
|
|
1568
1730
|
input_key: identifier_t.IdentifierKey,
|
|
1569
1731
|
intermediate_type: set_intermediate_type_t.IntermediateType,
|
|
1732
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1570
1733
|
) -> set_intermediate_type_t.Data:
|
|
1571
1734
|
"""Sets the type of an intermediate ingredient.
|
|
1572
1735
|
|
|
@@ -1581,6 +1744,7 @@ class ClientMethods(ABC):
|
|
|
1581
1744
|
method=set_intermediate_type_t.ENDPOINT_METHOD,
|
|
1582
1745
|
endpoint=set_intermediate_type_t.ENDPOINT_PATH,
|
|
1583
1746
|
args=args,
|
|
1747
|
+
request_options=_request_options,
|
|
1584
1748
|
)
|
|
1585
1749
|
return self.do_request(api_request=api_request, return_type=set_intermediate_type_t.Data)
|
|
1586
1750
|
|
|
@@ -1588,6 +1752,7 @@ class ClientMethods(ABC):
|
|
|
1588
1752
|
self,
|
|
1589
1753
|
*,
|
|
1590
1754
|
input_data: list[set_recipe_inputs_t.RecipeInputValue],
|
|
1755
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1591
1756
|
) -> set_recipe_inputs_t.Data:
|
|
1592
1757
|
"""Sets inputs values for an experiment. Values set can be numeric, text or categorical types in the Uncountable system
|
|
1593
1758
|
|
|
@@ -1600,6 +1765,7 @@ class ClientMethods(ABC):
|
|
|
1600
1765
|
method=set_recipe_inputs_t.ENDPOINT_METHOD,
|
|
1601
1766
|
endpoint=set_recipe_inputs_t.ENDPOINT_PATH,
|
|
1602
1767
|
args=args,
|
|
1768
|
+
request_options=_request_options,
|
|
1603
1769
|
)
|
|
1604
1770
|
return self.do_request(api_request=api_request, return_type=set_recipe_inputs_t.Data)
|
|
1605
1771
|
|
|
@@ -1608,6 +1774,7 @@ class ClientMethods(ABC):
|
|
|
1608
1774
|
*,
|
|
1609
1775
|
recipe_key: identifier_t.IdentifierKey,
|
|
1610
1776
|
recipe_metadata: list[recipe_metadata_t.MetadataValue],
|
|
1777
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1611
1778
|
) -> set_recipe_metadata_t.Data:
|
|
1612
1779
|
"""Set metadata values on a recipe
|
|
1613
1780
|
|
|
@@ -1622,6 +1789,7 @@ class ClientMethods(ABC):
|
|
|
1622
1789
|
method=set_recipe_metadata_t.ENDPOINT_METHOD,
|
|
1623
1790
|
endpoint=set_recipe_metadata_t.ENDPOINT_PATH,
|
|
1624
1791
|
args=args,
|
|
1792
|
+
request_options=_request_options,
|
|
1625
1793
|
)
|
|
1626
1794
|
return self.do_request(api_request=api_request, return_type=set_recipe_metadata_t.Data)
|
|
1627
1795
|
|
|
@@ -1629,6 +1797,7 @@ class ClientMethods(ABC):
|
|
|
1629
1797
|
self,
|
|
1630
1798
|
*,
|
|
1631
1799
|
updates: list[set_recipe_output_annotations_t.RecipeOutputUpdateAnnotations],
|
|
1800
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1632
1801
|
) -> set_recipe_output_annotations_t.Data:
|
|
1633
1802
|
"""Update annotations for an experiments outputs
|
|
1634
1803
|
|
|
@@ -1641,6 +1810,7 @@ class ClientMethods(ABC):
|
|
|
1641
1810
|
method=set_recipe_output_annotations_t.ENDPOINT_METHOD,
|
|
1642
1811
|
endpoint=set_recipe_output_annotations_t.ENDPOINT_PATH,
|
|
1643
1812
|
args=args,
|
|
1813
|
+
request_options=_request_options,
|
|
1644
1814
|
)
|
|
1645
1815
|
return self.do_request(api_request=api_request, return_type=set_recipe_output_annotations_t.Data)
|
|
1646
1816
|
|
|
@@ -1648,6 +1818,7 @@ class ClientMethods(ABC):
|
|
|
1648
1818
|
self,
|
|
1649
1819
|
*,
|
|
1650
1820
|
output_file_data: set_recipe_output_file_t.RecipeOutputFileValue,
|
|
1821
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1651
1822
|
) -> set_recipe_output_file_t.Data:
|
|
1652
1823
|
"""Sets output file value for an experiment. Include a single file as part of the FormData of the request with the filename as the key
|
|
1653
1824
|
|
|
@@ -1660,6 +1831,7 @@ class ClientMethods(ABC):
|
|
|
1660
1831
|
method=set_recipe_output_file_t.ENDPOINT_METHOD,
|
|
1661
1832
|
endpoint=set_recipe_output_file_t.ENDPOINT_PATH,
|
|
1662
1833
|
args=args,
|
|
1834
|
+
request_options=_request_options,
|
|
1663
1835
|
)
|
|
1664
1836
|
return self.do_request(api_request=api_request, return_type=set_recipe_output_file_t.Data)
|
|
1665
1837
|
|
|
@@ -1667,6 +1839,7 @@ class ClientMethods(ABC):
|
|
|
1667
1839
|
self,
|
|
1668
1840
|
*,
|
|
1669
1841
|
output_data: list[set_recipe_outputs_t.RecipeOutputValue],
|
|
1842
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1670
1843
|
) -> set_recipe_outputs_t.Data:
|
|
1671
1844
|
"""Sets output values for an experiment. Values set can be numeric, text or categorical types in the Uncountable system
|
|
1672
1845
|
|
|
@@ -1679,6 +1852,7 @@ class ClientMethods(ABC):
|
|
|
1679
1852
|
method=set_recipe_outputs_t.ENDPOINT_METHOD,
|
|
1680
1853
|
endpoint=set_recipe_outputs_t.ENDPOINT_PATH,
|
|
1681
1854
|
args=args,
|
|
1855
|
+
request_options=_request_options,
|
|
1682
1856
|
)
|
|
1683
1857
|
return self.do_request(api_request=api_request, return_type=set_recipe_outputs_t.Data)
|
|
1684
1858
|
|
|
@@ -1687,6 +1861,7 @@ class ClientMethods(ABC):
|
|
|
1687
1861
|
*,
|
|
1688
1862
|
recipe_key: identifier_t.IdentifierKey,
|
|
1689
1863
|
recipe_tag_update: set_recipe_tags_t.RecipeTagUpdate,
|
|
1864
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1690
1865
|
) -> set_recipe_tags_t.Data:
|
|
1691
1866
|
"""Modifies recipes tags for a recipe
|
|
1692
1867
|
|
|
@@ -1701,6 +1876,7 @@ class ClientMethods(ABC):
|
|
|
1701
1876
|
method=set_recipe_tags_t.ENDPOINT_METHOD,
|
|
1702
1877
|
endpoint=set_recipe_tags_t.ENDPOINT_PATH,
|
|
1703
1878
|
args=args,
|
|
1879
|
+
request_options=_request_options,
|
|
1704
1880
|
)
|
|
1705
1881
|
return self.do_request(api_request=api_request, return_type=set_recipe_tags_t.Data)
|
|
1706
1882
|
|
|
@@ -1711,6 +1887,7 @@ class ClientMethods(ABC):
|
|
|
1711
1887
|
value: set_recipe_total_t.ValueNumeric,
|
|
1712
1888
|
recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifier | None = None,
|
|
1713
1889
|
calculation_key: identifier_t.IdentifierKey | None = None,
|
|
1890
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1714
1891
|
) -> set_recipe_total_t.Data:
|
|
1715
1892
|
"""Updates the Set Total value for a recipe or one of its workflow steps
|
|
1716
1893
|
|
|
@@ -1729,6 +1906,7 @@ class ClientMethods(ABC):
|
|
|
1729
1906
|
method=set_recipe_total_t.ENDPOINT_METHOD,
|
|
1730
1907
|
endpoint=set_recipe_total_t.ENDPOINT_PATH,
|
|
1731
1908
|
args=args,
|
|
1909
|
+
request_options=_request_options,
|
|
1732
1910
|
)
|
|
1733
1911
|
return self.do_request(api_request=api_request, return_type=set_recipe_total_t.Data)
|
|
1734
1912
|
|
|
@@ -1737,6 +1915,7 @@ class ClientMethods(ABC):
|
|
|
1737
1915
|
*,
|
|
1738
1916
|
entity: entity_t.Entity,
|
|
1739
1917
|
values: list[field_values_t.ArgumentValueRefName],
|
|
1918
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1740
1919
|
) -> set_values_t.Data:
|
|
1741
1920
|
"""Sets field values for an entity
|
|
1742
1921
|
|
|
@@ -1749,6 +1928,7 @@ class ClientMethods(ABC):
|
|
|
1749
1928
|
method=set_values_t.ENDPOINT_METHOD,
|
|
1750
1929
|
endpoint=set_values_t.ENDPOINT_PATH,
|
|
1751
1930
|
args=args,
|
|
1931
|
+
request_options=_request_options,
|
|
1752
1932
|
)
|
|
1753
1933
|
return self.do_request(api_request=api_request, return_type=set_values_t.Data)
|
|
1754
1934
|
|
|
@@ -1757,6 +1937,7 @@ class ClientMethods(ABC):
|
|
|
1757
1937
|
*,
|
|
1758
1938
|
entity: entity_t.Entity,
|
|
1759
1939
|
transition: transition_entity_phase_t.TransitionIdentifier,
|
|
1940
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1760
1941
|
) -> transition_entity_phase_t.Data:
|
|
1761
1942
|
"""Transitions an entity from one phase to another
|
|
1762
1943
|
|
|
@@ -1769,6 +1950,7 @@ class ClientMethods(ABC):
|
|
|
1769
1950
|
method=transition_entity_phase_t.ENDPOINT_METHOD,
|
|
1770
1951
|
endpoint=transition_entity_phase_t.ENDPOINT_PATH,
|
|
1771
1952
|
args=args,
|
|
1953
|
+
request_options=_request_options,
|
|
1772
1954
|
)
|
|
1773
1955
|
return self.do_request(api_request=api_request, return_type=transition_entity_phase_t.Data)
|
|
1774
1956
|
|
|
@@ -1776,6 +1958,7 @@ class ClientMethods(ABC):
|
|
|
1776
1958
|
self,
|
|
1777
1959
|
*,
|
|
1778
1960
|
recipes: list[identifier_t.IdentifierKey],
|
|
1961
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1779
1962
|
) -> unarchive_recipes_t.Data:
|
|
1780
1963
|
"""Unarchive/restore the provided recipes
|
|
1781
1964
|
|
|
@@ -1788,6 +1971,7 @@ class ClientMethods(ABC):
|
|
|
1788
1971
|
method=unarchive_recipes_t.ENDPOINT_METHOD,
|
|
1789
1972
|
endpoint=unarchive_recipes_t.ENDPOINT_PATH,
|
|
1790
1973
|
args=args,
|
|
1974
|
+
request_options=_request_options,
|
|
1791
1975
|
)
|
|
1792
1976
|
return self.do_request(api_request=api_request, return_type=unarchive_recipes_t.Data)
|
|
1793
1977
|
|
|
@@ -1796,6 +1980,7 @@ class ClientMethods(ABC):
|
|
|
1796
1980
|
*,
|
|
1797
1981
|
entity_key: identifier_t.IdentifierKey,
|
|
1798
1982
|
entity_type: entity_t.EntityType,
|
|
1983
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1799
1984
|
) -> unlock_entity_t.Data:
|
|
1800
1985
|
"""Unlock an entity
|
|
1801
1986
|
|
|
@@ -1809,6 +1994,7 @@ class ClientMethods(ABC):
|
|
|
1809
1994
|
method=unlock_entity_t.ENDPOINT_METHOD,
|
|
1810
1995
|
endpoint=unlock_entity_t.ENDPOINT_PATH,
|
|
1811
1996
|
args=args,
|
|
1997
|
+
request_options=_request_options,
|
|
1812
1998
|
)
|
|
1813
1999
|
return self.do_request(api_request=api_request, return_type=unlock_entity_t.Data)
|
|
1814
2000
|
|
|
@@ -1818,6 +2004,7 @@ class ClientMethods(ABC):
|
|
|
1818
2004
|
type: unlock_recipes_t.RecipeUnlockType = unlock_recipes_t.RecipeUnlockType.STANDARD,
|
|
1819
2005
|
recipes: list[identifier_t.IdentifierKey],
|
|
1820
2006
|
unlock_samples: bool | None = None,
|
|
2007
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1821
2008
|
) -> unlock_recipes_t.Data:
|
|
1822
2009
|
"""Unlock experiments. Experiments will edtiable after unlocking if they are currently locked.
|
|
1823
2010
|
|
|
@@ -1834,6 +2021,7 @@ class ClientMethods(ABC):
|
|
|
1834
2021
|
method=unlock_recipes_t.ENDPOINT_METHOD,
|
|
1835
2022
|
endpoint=unlock_recipes_t.ENDPOINT_PATH,
|
|
1836
2023
|
args=args,
|
|
2024
|
+
request_options=_request_options,
|
|
1837
2025
|
)
|
|
1838
2026
|
return self.do_request(api_request=api_request, return_type=unlock_recipes_t.Data)
|
|
1839
2027
|
|
|
@@ -1844,6 +2032,7 @@ class ClientMethods(ABC):
|
|
|
1844
2032
|
entity_type: typing.Literal[entity_t.EntityType.RECIPE_METADATA] | typing.Literal[entity_t.EntityType.INGREDIENT] | typing.Literal[entity_t.EntityType.OUTPUT] | typing.Literal[entity_t.EntityType.CONDITION_PARAMETER] | typing.Literal[entity_t.EntityType.INGREDIENT_ATTRIBUTE] | typing.Literal[entity_t.EntityType.INGREDIENT_CATEGORY_ALL],
|
|
1845
2033
|
material_family_ids: list[base_t.ObjectId],
|
|
1846
2034
|
update_type: post_base_t.UpdateType,
|
|
2035
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1847
2036
|
) -> update_entity_material_families_t.Data:
|
|
1848
2037
|
"""Updates the material families that the entity is available in
|
|
1849
2038
|
|
|
@@ -1862,6 +2051,7 @@ class ClientMethods(ABC):
|
|
|
1862
2051
|
method=update_entity_material_families_t.ENDPOINT_METHOD,
|
|
1863
2052
|
endpoint=update_entity_material_families_t.ENDPOINT_PATH,
|
|
1864
2053
|
args=args,
|
|
2054
|
+
request_options=_request_options,
|
|
1865
2055
|
)
|
|
1866
2056
|
return self.do_request(api_request=api_request, return_type=update_entity_material_families_t.Data)
|
|
1867
2057
|
|
|
@@ -1873,6 +2063,7 @@ class ClientMethods(ABC):
|
|
|
1873
2063
|
condition_parameters: list[upsert_condition_match_t.ConditionParameter] | None = None,
|
|
1874
2064
|
output_conditions: list[identifier_t.IdentifierKey] | None = None,
|
|
1875
2065
|
existing_condition_match: identifier_t.IdentifierKey | None = None,
|
|
2066
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1876
2067
|
) -> upsert_condition_match_t.Data:
|
|
1877
2068
|
"""Creates or updates condition match
|
|
1878
2069
|
|
|
@@ -1888,6 +2079,7 @@ class ClientMethods(ABC):
|
|
|
1888
2079
|
method=upsert_condition_match_t.ENDPOINT_METHOD,
|
|
1889
2080
|
endpoint=upsert_condition_match_t.ENDPOINT_PATH,
|
|
1890
2081
|
args=args,
|
|
2082
|
+
request_options=_request_options,
|
|
1891
2083
|
)
|
|
1892
2084
|
return self.do_request(api_request=api_request, return_type=upsert_condition_match_t.Data)
|
|
1893
2085
|
|
|
@@ -1896,6 +2088,7 @@ class ClientMethods(ABC):
|
|
|
1896
2088
|
*,
|
|
1897
2089
|
option_set_key: identifier_t.IdentifierKey,
|
|
1898
2090
|
field_options: list[upsert_field_options_t.FieldOption],
|
|
2091
|
+
_request_options: client_config_t.RequestOptions | None = None,
|
|
1899
2092
|
) -> upsert_field_options_t.Data:
|
|
1900
2093
|
"""Creates or updates field options for an option set
|
|
1901
2094
|
|
|
@@ -1910,5 +2103,6 @@ class ClientMethods(ABC):
|
|
|
1910
2103
|
method=upsert_field_options_t.ENDPOINT_METHOD,
|
|
1911
2104
|
endpoint=upsert_field_options_t.ENDPOINT_PATH,
|
|
1912
2105
|
args=args,
|
|
2106
|
+
request_options=_request_options,
|
|
1913
2107
|
)
|
|
1914
2108
|
return self.do_request(api_request=api_request, return_type=upsert_field_options_t.Data)
|