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

type_spec/external/api/permissions/set_core_permissions.yaml

@@ -0,0 +1,69 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/permissions/external_set_core_permissions
+    function: main.site.app.external.permissions.set_core_permissions.set_core_permissions
+    desc: "Sets recipe related permissions"
+
+
+PermissionsScopeProject:
+  type: Object
+  properties:
+      type:
+          type: Literal<'project'>
+      project_key:
+          type: identifier.IdentifierKey
+
+PermissionsScopeRecipe:
+  type: Object
+  properties:
+    type:
+        type: Literal<'recipe'>
+    recipe_key:
+        type: identifier.IdentifierKey
+
+PermissionsScopeMaterialFamily:
+  type: Object
+  properties:
+    type:
+        type: Literal<'material_family'>
+    material_family_key:
+        type: identifier.IdentifierKey
+
+PermissionsScopeAllMaterialFamilies:
+  type: Object
+  properties:
+    type:
+        type: Literal<'all_material_families'>
+
+
+PermissionsScope:
+  type: Alias
+  alias: |
+    Union<
+      PermissionsScopeProject,
+      PermissionsScopeRecipe,
+      PermissionsScopeMaterialFamily,
+      PermissionsScopeAllMaterialFamilies
+    >
+
+Arguments:
+    type: Object
+    properties:
+        scope:
+            type: PermissionsScope
+            desc: Scope of permissions to change
+        user_group_ids?:
+            type: List<Integer>
+            desc: User group ids to grant permission to
+        user_ids?:
+            type: List<Integer>
+            desc: User ids to grant permission to
+        permissions_types:
+            type: List<permissions.CorePermissionType>
+        update_type:
+            type: post_base.UpdateType
+            desc: The type of update to perform
+
+Data:
+  type: Object

type_spec/external/api/recipes/associate_recipe_as_input.yaml

@@ -11,9 +11,9 @@ Arguments:
         recipe_key:
             type: identifier.IdentifierKey
             desc: "Identifier for the recipe"
+        input_key?:
+            type: identifier.IdentifierKey
+            desc: "Identifier for an input to use for the association.  Optionally supplied.  If not supplied, one is created"
 
 Data:
-  type: Object
-  properties:
-    result_id:
-      type: ObjectId
+  type: async_batch.AsyncBatchActionReturn

type_spec/external/api/recipes/create_recipe.yaml

@@ -1,5 +1,6 @@
 $endpoint:
     is_sdk: true
+    async_batch_path: create_recipe
     method: post
     path: ${external}/recipes/create_recipe
     function: main.site.app.external.recipes.create_recipe.create_recipe
@@ -24,7 +25,7 @@ Arguments:
         recipe_metadata?:
             type: List<recipe_metadata.MetadataValue>
             desc: Metadata values to populate the recipe with
-        identifiers:
+        identifiers?:
             type: recipe_identifiers.RecipeIdentifiers
             desc: A recipe won't be created if it matches the identifier.  An identifier must be unique in the schema
         definition_key?:

type_spec/external/api/recipes/disassociate_recipe_as_input.yaml

@@ -0,0 +1,16 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/recipes/disassociate_recipe_as_input
+    function: main.site.app.external.recipes.disassociate_recipe_as_input.disassociate_recipe_as_input
+    desc: Remove any association between a recipe and ingredients
+
+Arguments:
+    type: Object
+    properties:
+        recipe_key:
+            type: identifier.IdentifierKey
+            desc: "Identifier for the recipe"
+
+Data:
+  type: async_batch.AsyncBatchActionReturn

type_spec/external/api/recipes/edit_recipe_inputs.yaml

@@ -0,0 +1,88 @@
+$endpoint:
+    is_sdk: true
+    is_beta: true
+    async_batch_path: edit_recipe_inputs
+    method: post
+    path: ${external}/recipes/edit_recipe_inputs
+    function: main.site.app.external.recipes.edit_recipe_inputs.edit_recipe_inputs
+    desc: Clear, update, or add inputs on a recipe
+
+RecipeInputEditType:
+    type: StringEnum
+    values:
+        - clear_inputs
+        - upsert_input
+        - add_input
+
+RecipeInputEditBase:
+    type: Object
+    properties:
+        type:
+            type: RecipeInputEditType
+
+RecipeInputEditClearInputs:
+    type: RecipeInputEditBase
+    desc: "Clears all inputs and steps from recipe workflow step to start from scratch"
+    properties:
+        type:
+            type: Literal<RecipeInputEditType.clear_inputs>
+
+RecipeInputEditInputBase:
+    type: RecipeInputEditBase
+    properties:
+        ingredient_key:
+            type: identifier.IdentifierKey
+        quantity_basis:
+            type: recipe_inputs.QuantityBasis
+            desc: "The basis to set for this edit.  Normally this should be mass for ingredients and arbitrary for process parameters"
+            default: mass
+        input_value_type:
+            type: recipe_inputs.InputValueType
+            default: value
+        value_numeric?:
+            type: Decimal
+        value_str?:
+            type: String
+        calculation_key?:
+            type: identifier.IdentifierKey
+            desc: The basis calculation to set
+
+RecipeInputEditUpsertInput:
+    type: RecipeInputEditInputBase
+    desc: "If the input is already present in the recipe, modifies it otherwise adds a new one"
+    properties:
+        type:
+            type: Literal<RecipeInputEditType.upsert_input>
+        clear_first:
+            type: Boolean
+            desc: whether to clear the current value first or modify in place
+
+RecipeInputEditAddInput:
+    type: RecipeInputEditInputBase
+    desc: "Add the input into the recipe.  If it's already present and the recipe is not a mixorder, this call will fail"
+    properties:
+        type:
+            type: Literal<RecipeInputEditType.add_input>
+
+
+RecipeInputEdit:
+    type: Alias
+    alias: Union<RecipeInputEditClearInputs, RecipeInputEditUpsertInput, RecipeInputEditAddInput>
+    discriminator: type
+
+Arguments:
+    type: Object
+    properties:
+        recipe_key:
+            type: identifier.IdentifierKey
+            desc: "Identifier for the recipe"
+        recipe_workflow_step_identifier:
+            type: recipe_workflow_steps.RecipeWorkflowStepIdentifierType
+        edits:
+            type: List<RecipeInputEdit>
+
+Data:
+  type: Object
+  properties:
+    result_id:
+      type: ObjectId

type_spec/external/api/recipes/get_curve.yaml

@@ -7,9 +7,12 @@ $endpoint:
 Arguments:
     type: Object
     properties:
-        recipe_output_id:
+        recipe_output_id?:
             type: ObjectId
             desc: "The recipe output ID to fetch the curve for. This must be a curve recipe output. Recipe Outputs can be found from external_get_recipes_data"
+        recipe_input_id?:
+            type: ObjectId
+            desc: "The recipe input ID to fetch the curve for. This must be a curve recipe input. Recipe Inputs can be found from external_get_recipes_data"
 
 Data:
     type: Object

type_spec/external/api/recipes/get_recipes_data.yaml

@@ -77,6 +77,9 @@ SimpleOutputCondition:
 RecipeInput:
     type: Object
     properties:
+        id:
+            type: ObjectId
+            desc: "The globally unique id for the recipe input"
         input_id:
             type: ObjectId
             desc: "The globally unique ID for the input, allowing for cross reference elsewhere"
@@ -92,6 +95,9 @@ RecipeInput:
         quantity_json:
             type: JsonValue
             desc: "The quantity of the input if it is not numeric or recipe type. If this is filled in, quantity_dec will not be filled in"
+        curve_id:
+            type: Optional<ObjectId>
+            desc: "The id of the curve associated with the input if the input is of curve type."
         actual_quantity_dec:
             type: Decimal
             desc: "The actual quantity of the input if it is numeric or recipe type. If this is filled in, actual_quantity_json will not be filled in"

type_spec/external/api/recipes/set_recipe_metadata.yaml

@@ -1,5 +1,6 @@
 $endpoint:
     is_sdk: true
+    async_batch_path: set_recipe_metadata
     method: post
     path: ${external}/recipes/set_recipe_metadata
     function: main.site.app.external.recipes.set_recipe_metadata.set_recipe_metadata

type_spec/external/api/recipes/set_recipe_tags.yaml

@@ -0,0 +1,62 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/recipes/set_recipe_tags
+    function: main.site.app.external.recipes.set_recipe_tags.set_recipe_tags
+    desc: Modifies recipes tags for a recipe
+
+RecipeTagUpdateType:
+    type: StringEnum
+    values:
+        - append
+        - override
+        - remove
+
+RecipeTagUpdateBase:
+    type: Object
+    properties:
+        type:
+            type: RecipeTagUpdateType
+
+RecipeTagAppend:
+    type: RecipeTagUpdateBase
+    properties:
+        type:
+            type: Literal<RecipeTagUpdateType.append>
+        recipe_tag_ids:
+            type: List<ObjectId>
+
+RecipeTagRemove:
+    type: RecipeTagUpdateBase
+    properties:
+        type:
+            type: Literal<RecipeTagUpdateType.remove>
+        recipe_tag_ids:
+            type: List<ObjectId>
+
+RecipeTagOverride:
+    type: RecipeTagUpdateBase
+    properties:
+        type:
+            type: Literal<RecipeTagUpdateType.override>
+        recipe_tag_ids:
+            type: List<ObjectId>
+
+
+RecipeTagUpdate:
+    type: Alias
+    alias: Union<RecipeTagAppend, RecipeTagRemove, RecipeTagOverride>
+
+
+Arguments:
+    type: Object
+    properties:
+        recipe_key:
+            type: identifier.IdentifierKey
+            desc: Identifier for the recipe
+        recipe_tag_update:
+            type: RecipeTagUpdate
+            desc: The update to perform on the recipe tags
+
+Data:
+  type: Object

uncountable/core/__init__.py

@@ -1,3 +1,4 @@
 from .client import AuthDetailsApiKey, Client
+from .file_upload import MediaFileUpload, UploadedFile
 
-__all__: list[str] = ["AuthDetailsApiKey", "Client"]
+__all__: list[str] = ["AuthDetailsApiKey", "Client", "MediaFileUpload", "UploadedFile"]

uncountable/core/client.py

@@ -11,6 +11,9 @@ from pkgs.argument_parser import CachedParser
 from pkgs.serialization_util import serialize_for_api
 from uncountable.types.client_base import APIRequest, ClientMethods
 
+from .file_upload import FileUpload, FileUploader, UploadedFile
+from .types import AuthDetails, AuthDetailsApiKey
+
 DT = typing.TypeVar("DT")
 
 
@@ -43,23 +46,16 @@ class HTTPPostRequest(HTTPRequestBase):
 HTTPRequest = HTTPPostRequest | HTTPGetRequest
 
 
-@dataclass(kw_only=True)
-class AuthDetailsApiKey:
-    api_id: str
-    api_secret_key: str
-
-
-AuthDetails = AuthDetailsApiKey
-
-
 class Client(ClientMethods):
     _parser_map: dict[type, CachedParser] = {}
     _auth_details: AuthDetails
     _base_url: str
+    _file_uploader: FileUploader
 
     def __init__(self, *, base_url: str, auth_details: AuthDetails):
         self._auth_details = auth_details
         self._base_url = base_url
+        self._file_uploader = FileUploader(self._base_url, self._auth_details)
 
     def do_request(self, *, api_request: APIRequest, return_type: type[DT]) -> DT:
         http_request = self._build_http_request(api_request=api_request)
@@ -125,3 +121,9 @@ class Client(ClientMethods):
                 )
             case _:
                 raise ValueError(f"unsupported request method: {method}")
+
+    def upload_files(
+        self: typing.Self, *, file_uploads: list[FileUpload]
+    ) -> list[UploadedFile]:
+        """Upload files to uncountable, returning file ids that are usable with other SDK operations."""
+        return self._file_uploader.upload_files(file_uploads=file_uploads)

uncountable/core/file_upload.py

@@ -0,0 +1,95 @@
+import asyncio
+from contextlib import contextmanager
+from dataclasses import dataclass
+from enum import StrEnum
+from io import BytesIO
+from pathlib import Path
+from typing import Generator, Literal, Self
+
+import aiohttp
+import aiotus
+
+from .types import AuthDetails
+
+_CHUNK_SIZE = 5 * 1024 * 1024  # s3 requires 5MiB minimum
+
+
+class FileUploadType(StrEnum):
+    MEDIA_FILE_UPLOAD = "MEDIA_FILE_UPLOAD"
+
+
+@dataclass(kw_only=True)
+class MediaFileUpload:
+    """Upload file from a path on disk"""
+
+    path: str
+    type: FileUploadType.MEDIA_FILE_UPLOAD = FileUploadType.MEDIA_FILE_UPLOAD
+
+
+FileUpload = MediaFileUpload
+
+
+@dataclass(kw_only=True)
+class FileBytes:
+    name: str
+    bytes_data: BytesIO
+
+
+@contextmanager
+def file_upload_data(file_upload: FileUpload) -> Generator[FileBytes, None, None]:
+    match file_upload.type:
+        case FileUploadType.MEDIA_FILE_UPLOAD:
+            with open(file_upload.path, "rb") as f:
+                yield FileBytes(
+                    name=Path(file_upload.path).name, bytes_data=BytesIO(f.read())
+                )
+
+
+@dataclass(kw_only=True)
+class UploadedFile:
+    name: str
+    file_id: int
+
+
+class UploadFailed(Exception):
+    pass
+
+
+class FileUploader:
+    _auth_details: AuthDetails
+    _base_url: str
+
+    def __init__(self: Self, base_url: str, auth_details: AuthDetails) -> None:
+        self._base_url = base_url
+        self._auth_details = auth_details
+
+    async def _upload_file(self: Self, file_upload: FileUpload) -> UploadedFile:
+        creation_url = f"{self._base_url}/api/external/file_upload/files"
+        auth = aiohttp.BasicAuth(
+            self._auth_details.api_id, self._auth_details.api_secret_key
+        )
+        async with (
+            aiohttp.ClientSession(
+                auth=auth, headers={"Origin": self._base_url}
+            ) as session,
+        ):
+            with file_upload_data(file_upload) as file_bytes:
+                location = await aiotus.upload(
+                    creation_url,
+                    file_bytes.bytes_data,
+                    {"filename": file_bytes.name.encode()},
+                    client_session=session,
+                    chunksize=_CHUNK_SIZE,
+                )
+                if location is None:
+                    raise UploadFailed(f"Failed to upload: {file_bytes.name}")
+                return UploadedFile(
+                    name=file_bytes.name, file_id=int(location.path.split("/")[-1])
+                )
+
+    def upload_files(
+        self: Self, *, file_uploads: list[FileUpload]
+    ) -> list[UploadedFile]:
+        return [
+            asyncio.run(self._upload_file(file_upload)) for file_upload in file_uploads
+        ]

uncountable/core/types.py

@@ -0,0 +1,22 @@
+import base64
+import json
+import typing
+from dataclasses import dataclass
+from enum import StrEnum
+from urllib.parse import urljoin
+
+import aiohttp
+import requests
+
+from pkgs.argument_parser import CachedParser
+from pkgs.serialization_util import serialize_for_api
+from uncountable.types.client_base import APIRequest, ClientMethods
+
+
+@dataclass(kw_only=True)
+class AuthDetailsApiKey:
+    api_id: str
+    api_secret_key: str
+
+
+AuthDetails = AuthDetailsApiKey

uncountable/types/__init__.py

@@ -17,6 +17,8 @@ from .api.recipes import create_recipe as create_recipe_t
 from .api.recipe_links import create_recipe_link as create_recipe_link_t
 from .api.recipes import create_recipes as create_recipes_t
 from . import curves as curves_t
+from .api.recipes import disassociate_recipe_as_input as disassociate_recipe_as_input_t
+from .api.recipes import edit_recipe_inputs as edit_recipe_inputs_t
 from . import entity as entity_t
 from .api.batch import execute_batch as execute_batch_t
 from .api.batch import execute_batch_load_async as execute_batch_load_async_t
@@ -47,21 +49,28 @@ from .api.entity import list_entities as list_entities_t
 from .api.id_source import list_id_source as list_id_source_t
 from .api.id_source import match_id_source as match_id_source_t
 from . import outputs as outputs_t
+from . import permissions as permissions_t
 from . import phases as phases_t
+from . import post_base as post_base_t
 from . import recipe_identifiers as recipe_identifiers_t
+from . import recipe_inputs as recipe_inputs_t
 from . import recipe_links as recipe_links_t
 from . import recipe_metadata as recipe_metadata_t
 from . import recipe_output_metadata as recipe_output_metadata_t
 from . import recipe_tags as recipe_tags_t
+from . import recipe_workflow_steps as recipe_workflow_steps_t
 from .api.entity import resolve_entity_ids as resolve_entity_ids_t
 from .api.outputs import resolve_output_conditions as resolve_output_conditions_t
 from . import response as response_t
 from .api.triggers import run_trigger as run_trigger_t
+from .api.permissions import set_core_permissions as set_core_permissions_t
 from .api.inputs import set_input_attribute_values as set_input_attribute_values_t
 from .api.recipes import set_recipe_inputs as set_recipe_inputs_t
 from .api.recipes import set_recipe_metadata as set_recipe_metadata_t
 from .api.recipes import set_recipe_outputs as set_recipe_outputs_t
+from .api.recipes import set_recipe_tags as set_recipe_tags_t
 from .api.entity import set_values as set_values_t
+from .api.entity import transition_entity_phase as transition_entity_phase_t
 from . import units as units_t
 from . import users as users_t
 from . import workflows as workflows_t
@@ -82,6 +91,8 @@ __all__: list[str] = [
     "create_recipe_link_t",
     "create_recipes_t",
     "curves_t",
+    "disassociate_recipe_as_input_t",
+    "edit_recipe_inputs_t",
     "entity_t",
     "execute_batch_t",
     "execute_batch_load_async_t",
@@ -112,21 +123,28 @@ __all__: list[str] = [
     "list_id_source_t",
     "match_id_source_t",
     "outputs_t",
+    "permissions_t",
     "phases_t",
+    "post_base_t",
     "recipe_identifiers_t",
+    "recipe_inputs_t",
     "recipe_links_t",
     "recipe_metadata_t",
     "recipe_output_metadata_t",
     "recipe_tags_t",
+    "recipe_workflow_steps_t",
     "resolve_entity_ids_t",
     "resolve_output_conditions_t",
     "response_t",
     "run_trigger_t",
+    "set_core_permissions_t",
     "set_input_attribute_values_t",
     "set_recipe_inputs_t",
     "set_recipe_metadata_t",
     "set_recipe_outputs_t",
+    "set_recipe_tags_t",
     "set_values_t",
+    "transition_entity_phase_t",
     "units_t",
     "users_t",
     "workflows_t",

uncountable/types/api/entity/create_entities.py

@@ -34,7 +34,7 @@ class EntityToCreate:
 @dataclass(kw_only=True)
 class Arguments:
     definition_id: base_t.ObjectId
-    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS]]
+    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK]]
     entities_to_create: list[EntityToCreate]
 
 

uncountable/types/api/entity/create_entity.py

@@ -40,7 +40,7 @@ class EntityFieldInitialValue:
 @dataclass(kw_only=True)
 class Arguments:
     definition_id: base_t.ObjectId
-    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS]]
+    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK]]
     field_values: typing.Optional[typing.Optional[list[field_values_t.FieldRefNameValue]]] = None
 
 

uncountable/types/api/entity/transition_entity_phase.py

@@ -0,0 +1,66 @@
+# 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 entity as entity_t
+from ... import identifier as identifier_t
+from ... import response as response_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+    "TransitionIdentifier",
+    "TransitionIdentifierPhases",
+    "TransitionIdentifierTransition",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/entity/transition_entity_phase"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class TransitionIdentifierPhases:
+    type: typing.Literal["phases"] = "phases"
+    phase_from_key: identifier_t.IdentifierKey
+    phase_to_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class TransitionIdentifierTransition:
+    type: typing.Literal["transition"] = "transition"
+    transition_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+TransitionIdentifier = typing.Union[TransitionIdentifierPhases, TransitionIdentifierTransition]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    entity: entity_t.Entity
+    transition: TransitionIdentifier
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data(response_t.Response):
+    pass
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/permissions/__init__.py

@@ -0,0 +1 @@
+# DO NOT MODIFY -- This file is generated by type_spec