UncountablePythonSDK 0.0.23__tar.gz → 0.0.24__tar.gz

{uncountablepythonsdk-0.0.23/UncountablePythonSDK.egg-info → uncountablepythonsdk-0.0.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.23
+Version: 0.0.24
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git

{uncountablepythonsdk-0.0.23 → uncountablepythonsdk-0.0.24/UncountablePythonSDK.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.23
+Version: 0.0.24
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git

{uncountablepythonsdk-0.0.23 → uncountablepythonsdk-0.0.24}/UncountablePythonSDK.egg-info/SOURCES.txt

@@ -95,6 +95,7 @@ type_spec/external/api/project/get_projects.yaml
 type_spec/external/api/project/get_projects_data.yaml
 type_spec/external/api/recipe_links/create_recipe_link.yaml
 type_spec/external/api/recipe_metadata/get_recipe_metadata_data.yaml
+type_spec/external/api/recipes/archive_recipes.yaml
 type_spec/external/api/recipes/associate_recipe_as_input.yaml
 type_spec/external/api/recipes/associate_recipe_as_lot.yaml
 type_spec/external/api/recipes/create_recipe.yaml
@@ -200,6 +201,7 @@ uncountable/types/api/recipe_links/create_recipe_link.py
 uncountable/types/api/recipe_metadata/__init__.py
 uncountable/types/api/recipe_metadata/get_recipe_metadata_data.py
 uncountable/types/api/recipes/__init__.py
+uncountable/types/api/recipes/archive_recipes.py
 uncountable/types/api/recipes/associate_recipe_as_input.py
 uncountable/types/api/recipes/associate_recipe_as_lot.py
 uncountable/types/api/recipes/create_recipe.py

{uncountablepythonsdk-0.0.23 → uncountablepythonsdk-0.0.24}/pkgs/type_spec/open_api_util.py

@@ -174,6 +174,18 @@ class OpenAPIObjectType(OpenAPIType):
 
         return {"description": desc}
 
+    def _emit_property(
+        self, property_name: str, property_type: OpenAPIType
+    ) -> dict[str, object]:
+        property_info = {
+            **property_type.asdict(),
+        }
+        property_description = self._emit_property_desc(property_name)
+        if "$ref" in property_info and "description" in property_description:
+            return {"allOf": [property_info, property_description]}
+
+        return property_info | property_description
+
     def asdict(self) -> dict[str, object]:
         return self.add_addl_info({
             "type": "object",
@@ -183,10 +195,7 @@ class OpenAPIObjectType(OpenAPIType):
                 if not property_type.nullable
             ],
             "properties": {
-                property_name: {
-                    **property_type.asdict(),
-                }
-                | self._emit_property_desc(property_name)
+                property_name: self._emit_property(property_name, property_type)
                 for property_name, property_type in self.properties.items()
             },
         })

uncountablepythonsdk-0.0.24/type_spec/external/api/recipes/archive_recipes.yaml

@@ -0,0 +1,20 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/recipes/archive
+    function: main.site.app.external.recipes.archive_recipes.archive_recipes
+    desc: Archive the provided recipes and their children
+
+Arguments:
+    type: Object
+    properties:
+        recipes:
+            type: List<identifier.IdentifierKey>
+            desc: Identifier for the recipe
+        reason?:
+            type: String
+            desc: This reason will be written to the audit log archive entry
+
+
+Data:
+  type: Object

{uncountablepythonsdk-0.0.23 → uncountablepythonsdk-0.0.24}/uncountable/types/__init__.py

@@ -3,6 +3,7 @@
 # ruff: noqa: E402
 # fmt: off
 # isort: skip_file
+from .api.recipes import archive_recipes as archive_recipes_t
 from .api.recipes import associate_recipe_as_input as associate_recipe_as_input_t
 from .api.recipes import associate_recipe_as_lot as associate_recipe_as_lot_t
 from . import async_batch as async_batch_t
@@ -77,6 +78,7 @@ from . import workflows as workflows_t
 
 
 __all__: list[str] = [
+    "archive_recipes_t",
     "associate_recipe_as_input_t",
     "associate_recipe_as_lot_t",
     "async_batch_t",

uncountablepythonsdk-0.0.24/uncountable/types/api/recipes/archive_recipes.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 identifier as identifier_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/recipes/archive"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    recipes: list[identifier_t.IdentifierKey]
+    reason: typing.Optional[str] = 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

{uncountablepythonsdk-0.0.23 → uncountablepythonsdk-0.0.24}/uncountable/types/async_batch.py

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

{uncountablepythonsdk-0.0.23 → uncountablepythonsdk-0.0.24}/uncountable/types/client_base.py

@@ -9,6 +9,7 @@ import typing  # noqa: F401
 import datetime  # noqa: F401
 from decimal import Decimal  # noqa: F401
 from pkgs.serialization import OpaqueKey
+import uncountable.types.api.recipes.archive_recipes as archive_recipes_t
 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 uncountable.types import async_batch as async_batch_t
@@ -83,6 +84,28 @@ class ClientMethods(ABC):
     def do_request(self, *, api_request: APIRequest, return_type: type[DT]) -> DT:
         ...
 
+    def archive_recipes(
+        self,
+        *,
+        recipes: list[identifier_t.IdentifierKey],
+        reason: typing.Optional[str] = None,
+    ) -> archive_recipes_t.Data:
+        """Archive the provided recipes and their children
+
+        :param recipes: Identifier for the recipe
+        :param reason: This reason will be written to the audit log archive entry
+        """
+        args = archive_recipes_t.Arguments(
+            recipes=recipes,
+            reason=reason,
+        )
+        api_request = APIRequest(
+            method=archive_recipes_t.ENDPOINT_METHOD,
+            endpoint=archive_recipes_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=archive_recipes_t.Data)
+
     def associate_recipe_as_input(
         self,
         *,