UncountablePythonSDK 0.0.20__py3-none-any.whl → 0.0.21__py3-none-any.whl

uncountable/types/api/permissions/set_core_permissions.py

@@ -0,0 +1,89 @@
+# 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 pkgs.serialization import serial_class
+from ... import identifier as identifier_t
+from ... import permissions as permissions_t
+from ... import post_base as post_base_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+    "PermissionsScope",
+    "PermissionsScopeAllMaterialFamilies",
+    "PermissionsScopeMaterialFamily",
+    "PermissionsScopeProject",
+    "PermissionsScopeRecipe",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/permissions/external_set_core_permissions"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class PermissionsScopeProject:
+    type: typing.Literal["project"] = "project"
+    project_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class PermissionsScopeRecipe:
+    type: typing.Literal["recipe"] = "recipe"
+    recipe_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class PermissionsScopeMaterialFamily:
+    type: typing.Literal["material_family"] = "material_family"
+    material_family_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class PermissionsScopeAllMaterialFamilies:
+    type: typing.Literal["all_material_families"] = "all_material_families"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+PermissionsScope = typing.Union[PermissionsScopeProject, PermissionsScopeRecipe, PermissionsScopeMaterialFamily, PermissionsScopeAllMaterialFamilies]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    scope: PermissionsScope
+    permissions_types: list[permissions_t.CorePermissionType]
+    update_type: post_base_t.UpdateType
+    user_group_ids: typing.Optional[list[int]] = None
+    user_ids: typing.Optional[list[int]] = None
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data:
+    pass
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/associate_recipe_as_input.py

@@ -8,7 +8,7 @@ import typing  # noqa: F401
 import datetime  # noqa: F401
 from decimal import Decimal  # noqa: F401
 from dataclasses import dataclass
-from ... import base as base_t
+from ... import async_batch as async_batch_t
 from ... import identifier as identifier_t
 
 __all__: list[str] = [
@@ -26,10 +26,11 @@ ENDPOINT_PATH = "api/external/recipes/associate_recipe_as_input"
 @dataclass(kw_only=True)
 class Arguments:
     recipe_key: identifier_t.IdentifierKey
+    input_key: typing.Optional[identifier_t.IdentifierKey] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
-class Data:
-    result_id: base_t.ObjectId
+class Data(async_batch_t.AsyncBatchActionReturn):
+    pass
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/create_recipe.py

@@ -29,10 +29,10 @@ ENDPOINT_PATH = "api/external/recipes/create_recipe"
 class Arguments:
     material_family_id: base_t.ObjectId
     workflow_id: base_t.ObjectId
-    identifiers: recipe_identifiers_t.RecipeIdentifiers
     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
+    identifiers: typing.Optional[recipe_identifiers_t.RecipeIdentifiers] = None
     definition_key: typing.Optional[identifier_t.IdentifierKey] = None
 
 

uncountable/types/api/recipes/disassociate_recipe_as_input.py

@@ -0,0 +1,35 @@
+# 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 async_batch as async_batch_t
+from ... import identifier as identifier_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/recipes/disassociate_recipe_as_input"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    recipe_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data(async_batch_t.AsyncBatchActionReturn):
+    pass
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/edit_recipe_inputs.py

@@ -0,0 +1,107 @@
+# 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 pkgs.strenum_compat import StrEnum
+from dataclasses import dataclass
+from pkgs.serialization import serial_class
+from ... import base as base_t
+from ... import identifier as identifier_t
+from ... import recipe_inputs as recipe_inputs_t
+from ... import recipe_workflow_steps as recipe_workflow_steps_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+    "RecipeInputEdit",
+    "RecipeInputEditAddInput",
+    "RecipeInputEditBase",
+    "RecipeInputEditClearInputs",
+    "RecipeInputEditInputBase",
+    "RecipeInputEditType",
+    "RecipeInputEditUpsertInput",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/recipes/edit_recipe_inputs"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class RecipeInputEditType(StrEnum):
+    CLEAR_INPUTS = "clear_inputs"
+    UPSERT_INPUT = "upsert_input"
+    ADD_INPUT = "add_input"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class RecipeInputEditBase:
+    type: RecipeInputEditType
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class RecipeInputEditClearInputs(RecipeInputEditBase):
+    type: typing.Literal[RecipeInputEditType.CLEAR_INPUTS] = RecipeInputEditType.CLEAR_INPUTS
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    to_string_values={"value_numeric"},
+)
+@dataclass(kw_only=True)
+class RecipeInputEditInputBase(RecipeInputEditBase):
+    ingredient_key: identifier_t.IdentifierKey
+    quantity_basis: recipe_inputs_t.QuantityBasis = recipe_inputs_t.QuantityBasis.MASS
+    input_value_type: recipe_inputs_t.InputValueType = recipe_inputs_t.InputValueType.VALUE
+    value_numeric: typing.Optional[Decimal] = None
+    value_str: typing.Optional[str] = None
+    calculation_key: typing.Optional[identifier_t.IdentifierKey] = None
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class RecipeInputEditUpsertInput(RecipeInputEditInputBase):
+    type: typing.Literal[RecipeInputEditType.UPSERT_INPUT] = RecipeInputEditType.UPSERT_INPUT
+    clear_first: bool
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class RecipeInputEditAddInput(RecipeInputEditInputBase):
+    type: typing.Literal[RecipeInputEditType.ADD_INPUT] = RecipeInputEditType.ADD_INPUT
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+RecipeInputEdit = typing.Union[RecipeInputEditClearInputs, RecipeInputEditUpsertInput, RecipeInputEditAddInput]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    recipe_key: identifier_t.IdentifierKey
+    recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifierType
+    edits: list[RecipeInputEdit]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data:
+    result_id: base_t.ObjectId
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/get_curve.py

@@ -25,7 +25,8 @@ ENDPOINT_PATH = "api/external/recipes/external_get_curve"
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    recipe_output_id: base_t.ObjectId
+    recipe_output_id: typing.Optional[base_t.ObjectId] = None
+    recipe_input_id: typing.Optional[base_t.ObjectId] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/get_recipes_data.py

@@ -90,11 +90,13 @@ class SimpleOutputCondition:
 )
 @dataclass(kw_only=True)
 class RecipeInput:
+    id: base_t.ObjectId
     input_id: base_t.ObjectId
     input_lot_recipe_id: typing.Optional[base_t.ObjectId]
     recipe_step_id: base_t.ObjectId
     quantity_dec: Decimal
     quantity_json: base_t.JsonValue
+    curve_id: typing.Optional[base_t.ObjectId]
     actual_quantity_dec: Decimal
     actual_quantity_json: base_t.JsonValue
     input_type: str

uncountable/types/api/recipes/set_recipe_tags.py

@@ -0,0 +1,91 @@
+# 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 pkgs.strenum_compat import StrEnum
+from dataclasses import dataclass
+from pkgs.serialization import serial_class
+from ... import base as base_t
+from ... import identifier as identifier_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+    "RecipeTagAppend",
+    "RecipeTagOverride",
+    "RecipeTagRemove",
+    "RecipeTagUpdate",
+    "RecipeTagUpdateBase",
+    "RecipeTagUpdateType",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/recipes/set_recipe_tags"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class RecipeTagUpdateType(StrEnum):
+    APPEND = "append"
+    OVERRIDE = "override"
+    REMOVE = "remove"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class RecipeTagUpdateBase:
+    type: RecipeTagUpdateType
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class RecipeTagAppend(RecipeTagUpdateBase):
+    type: typing.Literal[RecipeTagUpdateType.APPEND] = RecipeTagUpdateType.APPEND
+    recipe_tag_ids: list[base_t.ObjectId]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class RecipeTagRemove(RecipeTagUpdateBase):
+    type: typing.Literal[RecipeTagUpdateType.REMOVE] = RecipeTagUpdateType.REMOVE
+    recipe_tag_ids: list[base_t.ObjectId]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class RecipeTagOverride(RecipeTagUpdateBase):
+    type: typing.Literal[RecipeTagUpdateType.OVERRIDE] = RecipeTagUpdateType.OVERRIDE
+    recipe_tag_ids: list[base_t.ObjectId]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+RecipeTagUpdate = typing.Union[RecipeTagAppend, RecipeTagRemove, RecipeTagOverride]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    recipe_key: identifier_t.IdentifierKey
+    recipe_tag_update: RecipeTagUpdate
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data:
+    pass
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/async_batch.py

@@ -16,6 +16,7 @@ __all__: list[str] = [
     "AsyncBatchActionReturn",
     "AsyncBatchRequest",
     "AsyncBatchRequestPath",
+    "QueuedAsyncBatchRequest",
 ]
 
 
@@ -23,6 +24,7 @@ __all__: list[str] = [
 class AsyncBatchRequestPath(StrEnum):
     CREATE_RECIPE = "recipes/create_recipe"
     SET_RECIPE_METADATA = "recipes/set_recipe_metadata"
+    SET_RECIPE_TAGS = "recipes/set_recipe_tags"
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
@@ -42,4 +44,11 @@ class AsyncBatchRequest:
 class AsyncBatchActionReturn:
     modification_made: bool
     result_id: typing.Optional[base_t.ObjectId] = None
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True, frozen=True, eq=True)
+class QueuedAsyncBatchRequest:
+    path: AsyncBatchRequestPath
+    batch_reference: str
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/async_batch_processor.py

@@ -0,0 +1,154 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402
+# fmt: off
+# isort: skip_file
+# ruff: noqa: PLR0904
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from uncountable.types import async_batch as async_batch_t
+from uncountable.types import base as base_t
+import uncountable.types.api.recipes.create_recipe as create_recipe_t
+import uncountable.types.api.recipes.edit_recipe_inputs as edit_recipe_inputs_t
+from uncountable.types import identifier as identifier_t
+from uncountable.types import recipe_identifiers as recipe_identifiers_t
+from uncountable.types import recipe_metadata as recipe_metadata_t
+from uncountable.types import recipe_workflow_steps as recipe_workflow_steps_t
+import uncountable.types.api.recipes.set_recipe_metadata as set_recipe_metadata_t
+import uuid
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from pkgs.serialization_util.serialization_helpers import serialize_for_api
+
+
+class AsyncBatchProcessorBase(ABC):
+    @abstractmethod
+    def _enqueue(self, req: async_batch_t.AsyncBatchRequest) -> None:
+        ...
+
+    @abstractmethod
+    def send(self) -> base_t.ObjectId:
+        ...
+
+    def create_recipe(
+        self,
+        *,
+        material_family_id: base_t.ObjectId,
+        workflow_id: base_t.ObjectId,
+        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,
+        identifiers: typing.Optional[recipe_identifiers_t.RecipeIdentifiers] = None,
+        definition_key: typing.Optional[identifier_t.IdentifierKey] = None,
+        depends_on: typing.Optional[list[str]] = None,
+    ) -> async_batch_t.QueuedBatchRequest:
+        """Returns the id of the recipe being created.
+
+        :param name: The name for the recipe
+        :param material_family_id: The material family for the recipe
+        :param workflow_id: The identifier of the workflow to create the recipe with
+        :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
+        :param depends_on: A list of batch reference keys to process before processing this request
+        """
+        args = create_recipe_t.Arguments(
+            name=name,
+            material_family_id=material_family_id,
+            workflow_id=workflow_id,
+            workflow_variant_id=workflow_variant_id,
+            recipe_metadata=recipe_metadata,
+            identifiers=identifiers,
+            definition_key=definition_key,
+        )
+        json_data = serialize_for_api(args)
+
+        batch_reference = str(uuid.uuid4())
+
+        req = async_batch_t.AsyncBatchRequest(
+            path=async_batch_t.AsyncBatchRequestPath.CREATE_RECIPE,
+            data=json_data,
+            depends_on=depends_on,
+            batch_reference=batch_reference,
+        )
+
+        self._enqueue(req)
+
+        return async_batch_t.QueuedBatchRequest(
+            path=req.path,
+            batch_reference=req.batch_reference,
+        )
+
+    def edit_recipe_inputs(
+        self,
+        *,
+        recipe_key: identifier_t.IdentifierKey,
+        recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifierType,
+        edits: list[edit_recipe_inputs_t.RecipeInputEdit],
+        depends_on: typing.Optional[list[str]] = None,
+    ) -> async_batch_t.QueuedBatchRequest:
+        """Clear, update, or add inputs on a recipe
+
+        :param recipe_key: Identifier for the recipe
+        :param depends_on: A list of batch reference keys to process before processing this request
+        """
+        args = edit_recipe_inputs_t.Arguments(
+            recipe_key=recipe_key,
+            recipe_workflow_step_identifier=recipe_workflow_step_identifier,
+            edits=edits,
+        )
+        json_data = serialize_for_api(args)
+
+        batch_reference = str(uuid.uuid4())
+
+        req = async_batch_t.AsyncBatchRequest(
+            path=async_batch_t.AsyncBatchRequestPath.EDIT_RECIPE_INPUTS,
+            data=json_data,
+            depends_on=depends_on,
+            batch_reference=batch_reference,
+        )
+
+        self._enqueue(req)
+
+        return async_batch_t.QueuedBatchRequest(
+            path=req.path,
+            batch_reference=req.batch_reference,
+        )
+
+    def set_recipe_metadata(
+        self,
+        *,
+        recipe_key: identifier_t.IdentifierKey,
+        recipe_metadata: list[recipe_metadata_t.MetadataValue],
+        depends_on: typing.Optional[list[str]] = None,
+    ) -> async_batch_t.QueuedBatchRequest:
+        """Set metadata values on a recipe
+
+        :param recipe_key: Identifier for the recipe
+        :param recipe_metadata: Metadata values to populate the recipe with
+        :param depends_on: A list of batch reference keys to process before processing this request
+        """
+        args = set_recipe_metadata_t.Arguments(
+            recipe_key=recipe_key,
+            recipe_metadata=recipe_metadata,
+        )
+        json_data = serialize_for_api(args)
+
+        batch_reference = str(uuid.uuid4())
+
+        req = async_batch_t.AsyncBatchRequest(
+            path=async_batch_t.AsyncBatchRequestPath.SET_RECIPE_METADATA,
+            data=json_data,
+            depends_on=depends_on,
+            batch_reference=batch_reference,
+        )
+
+        self._enqueue(req)
+
+        return async_batch_t.QueuedBatchRequest(
+            path=req.path,
+            batch_reference=req.batch_reference,
+        )