UncountablePythonSDK 0.0.17__py3-none-any.whl → 0.0.18__py3-none-any.whl

uncountable/types/async_batch.py

@@ -7,14 +7,36 @@ from __future__ import annotations
 import typing  # noqa: F401
 import datetime  # noqa: F401
 from decimal import Decimal  # noqa: F401
+from pkgs.strenum_compat import StrEnum
 from dataclasses import dataclass
+from pkgs.serialization import serial_class
 from . import base as base_t
 
 __all__: list[str] = [
     "AsyncBatchActionReturn",
+    "AsyncBatchRequest",
+    "AsyncBatchRequestPath",
 ]
 
 
+# DO NOT MODIFY -- This file is generated by type_spec
+class AsyncBatchRequestPath(StrEnum):
+    CREATE_RECIPE = "recipes/create_recipe"
+    SET_RECIPE_METADATA = "recipes/set_recipe_metadata"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    unconverted_values={"data"},
+)
+@dataclass(kw_only=True)
+class AsyncBatchRequest:
+    path: AsyncBatchRequestPath
+    data: base_t.JsonValue
+    batch_reference: str
+    depends_on: typing.Optional[list[str]] = None
+
+
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class AsyncBatchActionReturn:

uncountable/types/base.py

@@ -18,7 +18,8 @@ __all__: list[str] = [
 """
     Types that type_spec will use in the emitted files.
 """
-from typing import Union, Mapping, Sequence, Any, TYPE_CHECKING
+from typing import Union, Any, TYPE_CHECKING
+from collections.abc import Mapping, Sequence
 
 # These two are part of the core output, thus don't duplicate here
 # from decimal import Decimal

uncountable/types/client_base.py

@@ -11,6 +11,7 @@ from decimal import Decimal  # noqa: F401
 from pkgs.serialization import OpaqueKey
 import uncountable.types.api.recipes.associate_recipe_as_input as associate_recipe_as_input_t
 import uncountable.types.api.recipes.associate_recipe_as_lot as associate_recipe_as_lot_t
+from . import async_batch as async_batch_t
 from . import base as base_t
 import uncountable.types.api.chemical.convert_chemical_formats as convert_chemical_formats_t
 import uncountable.types.api.entity.create_entities as create_entities_t
@@ -21,6 +22,7 @@ import uncountable.types.api.recipe_links.create_recipe_link as create_recipe_li
 import uncountable.types.api.recipes.create_recipes as create_recipes_t
 from . import entity as entity_t
 import uncountable.types.api.batch.execute_batch as execute_batch_t
+import uncountable.types.api.batch.execute_batch_load_async as execute_batch_load_async_t
 from . import field_values as field_values_t
 import uncountable.types.api.recipes.get_curve as get_curve_t
 import uncountable.types.api.entity.get_entities_data as get_entities_data_t
@@ -38,13 +40,17 @@ import uncountable.types.api.recipe_metadata.get_recipe_metadata_data as get_rec
 import uncountable.types.api.recipes.get_recipe_names as get_recipe_names_t
 import uncountable.types.api.recipes.get_recipe_output_metadata as get_recipe_output_metadata_t
 import uncountable.types.api.recipes.get_recipes_data as get_recipes_data_t
+from . import id_source as id_source_t
 from . import identifier as identifier_t
 import uncountable.types.api.entity.list_entities as list_entities_t
+import uncountable.types.api.id_source.list_id_source as list_id_source_t
+import uncountable.types.api.id_source.match_id_source as match_id_source_t
 from . import recipe_identifiers as recipe_identifiers_t
 from . import recipe_links as recipe_links_t
 from . import recipe_metadata as recipe_metadata_t
 import uncountable.types.api.entity.resolve_entity_ids as resolve_entity_ids_t
 import uncountable.types.api.outputs.resolve_output_conditions as resolve_output_conditions_t
+import uncountable.types.api.triggers.run_trigger as run_trigger_t
 import uncountable.types.api.inputs.set_input_attribute_values as set_input_attribute_values_t
 import uncountable.types.api.recipes.set_recipe_inputs as set_recipe_inputs_t
 import uncountable.types.api.recipes.set_recipe_metadata as set_recipe_metadata_t
@@ -212,6 +218,7 @@ class ClientMethods(ABC):
         name: typing.Optional[str] = None,
         workflow_variant_id: typing.Optional[typing.Optional[base_t.ObjectId]] = None,
         recipe_metadata: typing.Optional[list[recipe_metadata_t.MetadataValue]] = None,
+        definition_key: typing.Optional[identifier_t.IdentifierKey] = None,
     ) -> create_recipe_t.Data:
         """Returns the id of the recipe being created.
 
@@ -221,6 +228,7 @@ class ClientMethods(ABC):
         :param workflow_variant_id: The identifier of the workflow variant to create the recipe with
         :param recipe_metadata: Metadata values to populate the recipe with
         :param identifiers: A recipe won't be created if it matches the identifier.  An identifier must be unique in the schema
+        :param definition_key: The entity definition identifier, default is used if not supplied
         """
         args = create_recipe_t.Arguments(
             name=name,
@@ -229,6 +237,7 @@ class ClientMethods(ABC):
             workflow_variant_id=workflow_variant_id,
             recipe_metadata=recipe_metadata,
             identifiers=identifiers,
+            definition_key=definition_key,
         )
         api_request = APIRequest(
             method=create_recipe_t.ENDPOINT_METHOD,
@@ -311,6 +320,25 @@ class ClientMethods(ABC):
         return self.do_request(api_request=api_request, return_type=execute_batch_t.Data)
 
 
+    def execute_batch_load_async(
+        self,
+        *,
+        requests: list[async_batch_t.AsyncBatchRequest],
+    ) -> execute_batch_load_async_t.Data:
+        """Run multiple API calls via one request
+
+        """
+        args = execute_batch_load_async_t.Arguments(
+            requests=requests,
+        )
+        api_request = APIRequest(
+            method=execute_batch_load_async_t.ENDPOINT_METHOD,
+            endpoint=execute_batch_load_async_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=execute_batch_load_async_t.Data)
+
+
     def get_curve(
         self,
         *,
@@ -685,7 +713,7 @@ class ClientMethods(ABC):
         offset: typing.Optional[typing.Optional[int]] = None,
         limit: typing.Optional[typing.Optional[int]] = None,
     ) -> get_recipes_data_t.Data:
-        """Gets all data associated with a set of recipes / experiments. 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
+        """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
 
         :param recipe_ids: The recipes to get the data from. Either these or project_id must be filled in
         :param project_id: The projects to get the data from. Either these or recipe_ids must be filled in
@@ -738,6 +766,58 @@ class ClientMethods(ABC):
         return self.do_request(api_request=api_request, return_type=list_entities_t.Data)
 
 
+    def list_id_source(
+        self,
+        *,
+        spec: id_source_t.IdSourceSpec,
+        search_label: str,
+        offset: typing.Optional[typing.Optional[int]] = None,
+        limit: typing.Optional[typing.Optional[int]] = None,
+    ) -> list_id_source_t.Data:
+        """Lists id and label pairs
+
+        :param spec: The id source spec to use
+        :param search_label: Text to search within the labels to search matches
+        :param offset: Used for pagination. Pagination is done based on the sorting of the config
+        :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
+        """
+        args = list_id_source_t.Arguments(
+            spec=spec,
+            search_label=search_label,
+            offset=offset,
+            limit=limit,
+        )
+        api_request = APIRequest(
+            method=list_id_source_t.ENDPOINT_METHOD,
+            endpoint=list_id_source_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=list_id_source_t.Data)
+
+
+    def match_id_source(
+        self,
+        *,
+        spec: id_source_t.IdSourceSpec,
+        names: list[str],
+    ) -> match_id_source_t.Data:
+        """Lists id and label pairs
+
+        :param spec: The id source spec to use
+        :param names: The names to match with the id source.  At most 10 are allowed at a time
+        """
+        args = match_id_source_t.Arguments(
+            spec=spec,
+            names=names,
+        )
+        api_request = APIRequest(
+            method=match_id_source_t.ENDPOINT_METHOD,
+            endpoint=match_id_source_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=match_id_source_t.Data)
+
+
     def resolve_entity_ids(
         self,
         *,
@@ -780,6 +860,27 @@ class ClientMethods(ABC):
         return self.do_request(api_request=api_request, return_type=resolve_output_conditions_t.Data)
 
 
+    def run_trigger(
+        self,
+        *,
+        trigger_ref_name: str,
+        entity: typing.Optional[entity_t.Entity] = None,
+    ) -> run_trigger_t.Data:
+        """Runs a trigger.  Requires admin access
+
+        """
+        args = run_trigger_t.Arguments(
+            entity=entity,
+            trigger_ref_name=trigger_ref_name,
+        )
+        api_request = APIRequest(
+            method=run_trigger_t.ENDPOINT_METHOD,
+            endpoint=run_trigger_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=run_trigger_t.Data)
+
+
     def set_input_attribute_values(
         self,
         *,

uncountable/types/id_source.py

@@ -0,0 +1,49 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from dataclasses import dataclass
+from . import entity as entity_t
+
+__all__: list[str] = [
+    "IdSourceSpec",
+    "IdSourceSpecBase",
+    "IdSourceSpecCustomEntity",
+    "IdSourceSpecEntity",
+    "IdSourceSpecFieldOptions",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class IdSourceSpecBase:
+    pass
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class IdSourceSpecEntity(IdSourceSpecBase):
+    entity_type: entity_t.EntityType
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class IdSourceSpecCustomEntity(IdSourceSpecBase):
+    definition_ref_name: str
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class IdSourceSpecFieldOptions(IdSourceSpecBase):
+    set_ref_name: str
+    subset_ref_name: typing.Optional[str] = None
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+IdSourceSpec = typing.Union[IdSourceSpecEntity, IdSourceSpecCustomEntity, IdSourceSpecFieldOptions]
+# DO NOT MODIFY -- This file is generated by type_spec