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

uncountable/core/client.py

@@ -6,9 +6,11 @@ from enum import StrEnum
 from urllib.parse import urljoin
 
 import requests
+from requests.exceptions import JSONDecodeError
 
 from pkgs.argument_parser import CachedParser
 from pkgs.serialization_util import serialize_for_api
+from pkgs.serialization_util.serialization_helpers import JsonValue
 from uncountable.types.client_base import APIRequest, ClientMethods
 
 from .file_upload import FileUpload, FileUploader, UploadedFile
@@ -46,16 +48,77 @@ class HTTPPostRequest(HTTPRequestBase):
 HTTPRequest = HTTPPostRequest | HTTPGetRequest
 
 
+
+@dataclass(kw_only=True)
+class ClientConfig():
+    allow_insecure_tls: bool = False
+      
+
+class APIResponseError(BaseException):
+    status_code: int
+    message: str
+    extra_details: dict[str, JsonValue] | None
+
+    def __init__(
+        self, status_code: int, message: str, extra_details: dict[str, JsonValue] | None
+    ) -> None:
+        super().__init__(status_code, message, extra_details)
+        self.status_code = status_code
+        self.message = message
+        self.extra_details = extra_details
+
+    @classmethod
+    def construct_error(
+        cls, status_code: int, extra_details: dict[str, JsonValue] | None
+    ) -> "APIResponseError":
+        message: str
+        match status_code:
+            case 403:
+                message = "unexpected: unauthorized"
+            case 410:
+                message = "unexpected: not found"
+            case 400:
+                message = "unexpected: bad arguments"
+            case 501:
+                message = "unexpected: unimplemented"
+            case 504:
+                message = "unexpected: timeout"
+            case 404:
+                message = "not found"
+            case 409:
+                message = "bad arguments"
+            case 422:
+                message = "unprocessable"
+            case _:
+                message = "unknown error"
+        return APIResponseError(
+            status_code=status_code, message=message, extra_details=extra_details
+        )
+
+
+class SDKError(BaseException):
+    message: str
+
+    def __init__(self, message: str) -> None:
+        super().__init__(message)
+        self.message = message
+
+    def __str__(self) -> str:
+        return f"internal SDK error, please contact Uncountable support: {self.message}"
+
+
 class Client(ClientMethods):
     _parser_map: dict[type, CachedParser] = {}
     _auth_details: AuthDetails
     _base_url: str
     _file_uploader: FileUploader
+    _cfg: ClientConfig
 
-    def __init__(self, *, base_url: str, auth_details: AuthDetails):
+    def __init__(self, *, base_url: str, auth_details: AuthDetails, config: ClientConfig | None = None):
         self._auth_details = auth_details
         self._base_url = base_url
         self._file_uploader = FileUploader(self._base_url, self._auth_details)
+        self._cfg = config or ClientConfig()
 
     def do_request(self, *, api_request: APIRequest, return_type: type[DT]) -> DT:
         http_request = self._build_http_request(api_request=api_request)
@@ -65,6 +128,7 @@ class Client(ClientMethods):
                     http_request.url,
                     headers=http_request.headers,
                     params=http_request.query_params,
+                    verify=not self._cfg.allow_insecure_tls
                 )
             case HTTPPostRequest():
                 response = requests.post(
@@ -72,19 +136,27 @@ class Client(ClientMethods):
                     headers=http_request.headers,
                     data=http_request.body,
                     params=http_request.query_params,
+                    verify=not self._cfg.allow_insecure_tls
                 )
             case _:
                 typing.assert_never(http_request)
         if response.status_code < 200 or response.status_code > 299:
-            # TODO: handle_error
-            pass
+            extra_details: dict[str, JsonValue] | None = None
+            try:
+                data = response.json()
+                if "error" in data:
+                    extra_details = data["error"]
+            except JSONDecodeError:
+                pass
+            raise APIResponseError.construct_error(
+                status_code=response.status_code, extra_details=extra_details
+            )
         cached_parser = self._get_cached_parser(return_type)
         try:
             data = response.json()["data"]
             return cached_parser.parse_api(data)
-        except ValueError as err:
-            # TODO: handle parse error
-            raise err
+        except ValueError | JSONDecodeError:
+            raise SDKError("unable to process response")
 
     def _get_cached_parser(self, data_type: type[DT]) -> CachedParser[DT]:
         if data_type not in self._parser_map:

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], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK]]
+    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.INVENTORY_AMOUNT], 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], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK]]
+    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.INVENTORY_AMOUNT], 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/recipes/edit_recipe_inputs.py

@@ -10,7 +10,6 @@ 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
@@ -96,12 +95,12 @@ RecipeInputEdit = typing.Union[RecipeInputEditClearInputs, RecipeInputEditUpsert
 @dataclass(kw_only=True)
 class Arguments:
     recipe_key: identifier_t.IdentifierKey
-    recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifierType
+    recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifier
     edits: list[RecipeInputEdit]
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Data:
-    result_id: base_t.ObjectId
+    pass
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/async_batch.py

@@ -25,6 +25,7 @@ class AsyncBatchRequestPath(StrEnum):
     CREATE_RECIPE = "recipes/create_recipe"
     SET_RECIPE_METADATA = "recipes/set_recipe_metadata"
     SET_RECIPE_TAGS = "recipes/set_recipe_tags"
+    EDIT_RECIPE_INPUTS = "recipes/edit_recipe_inputs"
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/async_batch_processor.py

@@ -43,7 +43,7 @@ class AsyncBatchProcessorBase(ABC):
         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:
+    ) -> async_batch_t.QueuedAsyncBatchRequest:
         """Returns the id of the recipe being created.
 
         :param name: The name for the recipe
@@ -77,7 +77,7 @@ class AsyncBatchProcessorBase(ABC):
 
         self._enqueue(req)
 
-        return async_batch_t.QueuedBatchRequest(
+        return async_batch_t.QueuedAsyncBatchRequest(
             path=req.path,
             batch_reference=req.batch_reference,
         )
@@ -86,10 +86,10 @@ class AsyncBatchProcessorBase(ABC):
         self,
         *,
         recipe_key: identifier_t.IdentifierKey,
-        recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifierType,
+        recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifier,
         edits: list[edit_recipe_inputs_t.RecipeInputEdit],
         depends_on: typing.Optional[list[str]] = None,
-    ) -> async_batch_t.QueuedBatchRequest:
+    ) -> async_batch_t.QueuedAsyncBatchRequest:
         """Clear, update, or add inputs on a recipe
 
         :param recipe_key: Identifier for the recipe
@@ -113,7 +113,7 @@ class AsyncBatchProcessorBase(ABC):
 
         self._enqueue(req)
 
-        return async_batch_t.QueuedBatchRequest(
+        return async_batch_t.QueuedAsyncBatchRequest(
             path=req.path,
             batch_reference=req.batch_reference,
         )
@@ -124,7 +124,7 @@ class AsyncBatchProcessorBase(ABC):
         recipe_key: identifier_t.IdentifierKey,
         recipe_metadata: list[recipe_metadata_t.MetadataValue],
         depends_on: typing.Optional[list[str]] = None,
-    ) -> async_batch_t.QueuedBatchRequest:
+    ) -> async_batch_t.QueuedAsyncBatchRequest:
         """Set metadata values on a recipe
 
         :param recipe_key: Identifier for the recipe
@@ -148,7 +148,7 @@ class AsyncBatchProcessorBase(ABC):
 
         self._enqueue(req)
 
-        return async_batch_t.QueuedBatchRequest(
+        return async_batch_t.QueuedAsyncBatchRequest(
             path=req.path,
             batch_reference=req.batch_reference,
         )

uncountable/types/client_base.py

@@ -21,6 +21,7 @@ import uncountable.types.api.recipes.create_recipe as create_recipe_t
 import uncountable.types.api.recipe_links.create_recipe_link as create_recipe_link_t
 import uncountable.types.api.recipes.create_recipes as create_recipes_t
 import uncountable.types.api.recipes.disassociate_recipe_as_input as disassociate_recipe_as_input_t
+import uncountable.types.api.recipes.edit_recipe_inputs as edit_recipe_inputs_t
 from uncountable.types 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
@@ -51,6 +52,7 @@ from uncountable.types import post_base as post_base_t
 from uncountable.types import recipe_identifiers as recipe_identifiers_t
 from uncountable.types import recipe_links as recipe_links_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.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
@@ -147,7 +149,7 @@ class ClientMethods(ABC):
         self,
         *,
         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], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK]],
+        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.INVENTORY_AMOUNT], 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[create_entities_t.EntityToCreate],
     ) -> create_entities_t.Data:
         """Creates new Uncountable entities
@@ -172,7 +174,7 @@ class ClientMethods(ABC):
         self,
         *,
         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], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK]],
+        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.INVENTORY_AMOUNT], 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,
     ) -> create_entity_t.Data:
         """Creates a new Uncountable entity
@@ -319,6 +321,29 @@ class ClientMethods(ABC):
         )
         return self.do_request(api_request=api_request, return_type=disassociate_recipe_as_input_t.Data)
 
+    def edit_recipe_inputs(
+        self,
+        *,
+        recipe_key: identifier_t.IdentifierKey,
+        recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifier,
+        edits: list[edit_recipe_inputs_t.RecipeInputEdit],
+    ) -> edit_recipe_inputs_t.Data:
+        """Clear, update, or add inputs on a recipe
+
+        :param recipe_key: Identifier for the recipe
+        """
+        args = edit_recipe_inputs_t.Arguments(
+            recipe_key=recipe_key,
+            recipe_workflow_step_identifier=recipe_workflow_step_identifier,
+            edits=edits,
+        )
+        api_request = APIRequest(
+            method=edit_recipe_inputs_t.ENDPOINT_METHOD,
+            endpoint=edit_recipe_inputs_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=edit_recipe_inputs_t.Data)
+
     def execute_batch(
         self,
         *,

uncountable/types/identifier.py

@@ -23,7 +23,7 @@ __all__: list[str] = [
 @serial_class(
     parse_require={"type"},
 )
-@dataclass(kw_only=True)
+@dataclass(kw_only=True, frozen=True, eq=True)
 class IdentifierKeyId:
     type: typing.Literal["id"] = "id"
     id: base_t.ObjectId
@@ -33,7 +33,7 @@ class IdentifierKeyId:
 @serial_class(
     parse_require={"type"},
 )
-@dataclass(kw_only=True)
+@dataclass(kw_only=True, frozen=True, eq=True)
 class IdentifierKeyRefName:
     type: typing.Literal["ref_name"] = "ref_name"
     ref_name: str
@@ -43,7 +43,7 @@ class IdentifierKeyRefName:
 @serial_class(
     parse_require={"type"},
 )
-@dataclass(kw_only=True)
+@dataclass(kw_only=True, frozen=True, eq=True)
 class IdentifierKeyBatchReference:
     type: typing.Literal["batch_reference"] = "batch_reference"
     reference: str

uncountable/types/recipe_workflow_steps.py

@@ -59,7 +59,7 @@ class RecipeWorkflowStepPosition(StrEnum):
 class RecipeWorkflowStepIdentifierWorkflowStep(RecipeWorkflowStepIdentifierBase):
     type: typing.Literal[RecipeWorkflowStepIdentifierType.WORKFLOW_STEP] = RecipeWorkflowStepIdentifierType.WORKFLOW_STEP
     workflow_step_key: identifier_t.IdentifierKey
-    position: typing.Optional[RecipeWorkflowStepPosition] = None
+    position: RecipeWorkflowStepPosition = RecipeWorkflowStepPosition.FIRST
 
 
 # DO NOT MODIFY -- This file is generated by type_spec