UncountablePythonSDK 0.0.25__py3-none-any.whl → 0.0.27__py3-none-any.whl

uncountable/types/client_base.py

@@ -47,6 +47,7 @@ from uncountable.types import id_source as id_source_t
 from uncountable.types 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.entity.lock_entity as lock_entity_t
 import uncountable.types.api.id_source.match_id_source as match_id_source_t
 from uncountable.types import permissions as permissions_t
 from uncountable.types import post_base as post_base_t
@@ -59,12 +60,18 @@ import uncountable.types.api.outputs.resolve_output_conditions as resolve_output
 import uncountable.types.api.triggers.run_trigger as run_trigger_t
 import uncountable.types.api.permissions.set_core_permissions as set_core_permissions_t
 import uncountable.types.api.inputs.set_input_attribute_values as set_input_attribute_values_t
+import uncountable.types.api.inputs.set_input_category as set_input_category_t
+import uncountable.types.api.inputs.set_input_subcategories as set_input_subcategories_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
 import uncountable.types.api.recipes.set_recipe_outputs as set_recipe_outputs_t
 import uncountable.types.api.recipes.set_recipe_tags as set_recipe_tags_t
 import uncountable.types.api.entity.set_values as set_values_t
 import uncountable.types.api.entity.transition_entity_phase as transition_entity_phase_t
+import uncountable.types.api.recipes.unarchive_recipes as unarchive_recipes_t
+import uncountable.types.api.entity.unlock_entity as unlock_entity_t
+import uncountable.types.api.material_families.update_entity_material_families as update_entity_material_families_t
+import uncountable.types.api.field_options.upsert_field_options as upsert_field_options_t
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 
@@ -242,6 +249,7 @@ class ClientMethods(ABC):
         material_family_id: base_t.ObjectId,
         workflow_id: base_t.ObjectId,
         name: typing.Optional[str] = None,
+        project_id: typing.Optional[base_t.ObjectId] = 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,
@@ -251,6 +259,7 @@ class ClientMethods(ABC):
 
         :param name: The name for the recipe
         :param material_family_id: The material family for the recipe
+        :param project_id: The identifier of the project to create the recipe in
         :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
@@ -260,6 +269,7 @@ class ClientMethods(ABC):
         args = create_recipe_t.Arguments(
             name=name,
             material_family_id=material_family_id,
+            project_id=project_id,
             workflow_id=workflow_id,
             workflow_variant_id=workflow_variant_id,
             recipe_metadata=recipe_metadata,
@@ -460,9 +470,9 @@ class ClientMethods(ABC):
 
         :param material_family_id: The material family ID to get the input values from.
         :param input_ids: The input IDs to get the data from. If this is not filled in, all inputs from a material family will be returned (in paginated form).
-        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the input ID
+        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the input ID. [Pagination More Info](#pagination)
         :param is_parameter: Whether to get parameters or ingredients. By default both are returned. When set to true, only parameters are returned, and when set to false, only ingredients are returned
-        :param limit: The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000
+        :param limit: The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000. [Pagination More Info](#pagination)
         """
         args = get_input_data_t.Arguments(
             material_family_id=material_family_id,
@@ -508,9 +518,9 @@ class ClientMethods(ABC):
         """Gets the name of all inputs for a material family. An input is either an ingredient or process parameter, with metadata and calculations assigned separately
 
         :param material_family_id: The material family ID to get the input values from
-        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the input ID
+        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the input ID. [Pagination More Info](#pagination)
         :param is_parameter: Whether to get parameters or ingredients. By default both are returned. When set to true, only parameters are returned, and when set to false, only ingredients are returned
-        :param limit: The maximum number of results to return. By default this is set to 20,000 and it cannot be set higher than 20,000
+        :param limit: The maximum number of results to return. By default this is set to 20,000 and it cannot be set higher than 20,000. [Pagination More Info](#pagination)
         """
         args = get_input_names_t.Arguments(
             material_family_id=material_family_id,
@@ -556,8 +566,8 @@ class ClientMethods(ABC):
 
         :param material_family_id: The material family ID to get the output values from.
         :param output_ids: The output IDs to get the data from. If this is not filled in, all outputs from a material family will be returned (in paginated form).
-        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the output ID
-        :param limit: The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000
+        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the output ID. [Pagination More Info](#pagination)
+        :param limit: The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000. [Pagination More Info](#pagination)
         """
         args = get_output_data_t.Arguments(
             material_family_id=material_family_id,
@@ -582,8 +592,8 @@ class ClientMethods(ABC):
         """Gets the name of all outputs for a material family. An output represents a measurement value of any time (numeric, text, curve, etc). This includes calculations based off of other outputs, such as a calculated change over time
 
         :param material_family_id: The material family ID to get the output values from
-        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the output ID
-        :param limit: The maximum number of results to return. By default this is set to 20,000 and it cannot be set higher than 20,000
+        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the output ID. [Pagination More Info](#pagination)
+        :param limit: The maximum number of results to return. By default this is set to 20,000 and it cannot be set higher than 20,000. [Pagination More Info](#pagination)
         """
         args = get_output_names_t.Arguments(
             material_family_id=material_family_id,
@@ -629,8 +639,8 @@ class ClientMethods(ABC):
         """Gets either all data associated with a set of projects created in the platform.  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 project_ids: The projects to get the data from
-        :param offset: Used for pagination. All pagination is done in order of Project ID
-        :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
+        :param offset: Used for pagination. All pagination is done in order of Project ID. [Pagination More Info](#pagination)
+        :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. [Pagination More Info](#pagination)
         """
         args = get_projects_data_t.Arguments(
             project_ids=project_ids,
@@ -703,8 +713,8 @@ class ClientMethods(ABC):
 
         :param material_family_id: The material family ID to get the recipe metadata values from.
         :param recipe_metadata_ids: The recipe metadata IDs to get the data from. If this is not filled in, all metadata from a material family will be returned (in paginated form).
-        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the metadata ID
-        :param limit: The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000
+        :param offset: Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the metadata ID. [Pagination More Info](#pagination)
+        :param limit: The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000. [Pagination More Info](#pagination)
         """
         args = get_recipe_metadata_data_t.Arguments(
             material_family_id=material_family_id,
@@ -769,8 +779,8 @@ class ClientMethods(ABC):
 
         :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
-        :param offset: Used for pagination. All pagination is done in order of Recipe ID
-        :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
+        :param offset: Used for pagination. All pagination is done in order of Recipe ID. [Pagination More Info](#pagination)
+        :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. [Pagination More Info](#pagination)
         """
         args = get_recipes_data_t.Arguments(
             recipe_ids=recipe_ids,
@@ -799,8 +809,8 @@ class ClientMethods(ABC):
         :param entity_type: The type of the entities requested, e.g. lab_request, recipe
         :param config_reference: The configuration reference name for the listing config
         :param attributes: Attributes to pass to the configuration for parameterizing filters
-        :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
+        :param offset: Used for pagination. Pagination is done based on the sorting of the config. [Pagination More Info](#pagination)
+        :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. [Pagination More Info](#pagination)
         """
         args = list_entities_t.Arguments(
             entity_type=entity_type,
@@ -828,8 +838,8 @@ class ClientMethods(ABC):
 
         :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
+        :param offset: Used for pagination. Pagination is done based on the sorting of the config. [Pagination More Info](#pagination)
+        :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. [Pagination More Info](#pagination)
         """
         args = list_id_source_t.Arguments(
             spec=spec,
@@ -844,6 +854,30 @@ class ClientMethods(ABC):
         )
         return self.do_request(api_request=api_request, return_type=list_id_source_t.Data)
 
+    def external_lock_entity(
+        self,
+        *,
+        entity_key: identifier_t.IdentifierKey,
+        entity_type: entity_t.EntityType,
+        globally_removable: typing.Optional[bool] = None,
+    ) -> lock_entity_t.Data:
+        """Lock an entity
+
+        :param entity_key: Identifier for the entity
+        :param globally_removable: Should the lock be removable by any user or just admins
+        """
+        args = lock_entity_t.Arguments(
+            entity_key=entity_key,
+            entity_type=entity_type,
+            globally_removable=globally_removable,
+        )
+        api_request = APIRequest(
+            method=lock_entity_t.ENDPOINT_METHOD,
+            endpoint=lock_entity_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=lock_entity_t.Data)
+
     def match_id_source(
         self,
         *,
@@ -975,6 +1009,56 @@ class ClientMethods(ABC):
         )
         return self.do_request(api_request=api_request, return_type=set_input_attribute_values_t.Data)
 
+    def external_set_input_category(
+        self,
+        *,
+        input_key: identifier_t.IdentifierKey,
+        category_id: int,
+        material_family_ids: typing.Optional[list[int]] = None,
+    ) -> set_input_category_t.Data:
+        """Sets subcategories for an input
+
+        :param input_key: Identifier for the input
+        :param category_id: The subcategory identifiers to set
+        :param material_family_ids: The material families to perform the update in
+        """
+        args = set_input_category_t.Arguments(
+            input_key=input_key,
+            category_id=category_id,
+            material_family_ids=material_family_ids,
+        )
+        api_request = APIRequest(
+            method=set_input_category_t.ENDPOINT_METHOD,
+            endpoint=set_input_category_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=set_input_category_t.Data)
+
+    def external_set_input_subcategories(
+        self,
+        *,
+        input_key: identifier_t.IdentifierKey,
+        subcategory_ids: list[int],
+        update_type: post_base_t.UpdateType,
+    ) -> set_input_subcategories_t.Data:
+        """Sets subcategories for an input
+
+        :param input_key: Identifier for the input
+        :param subcategory_ids: The subcategory identifiers to set
+        :param update_type: The type of update to perform
+        """
+        args = set_input_subcategories_t.Arguments(
+            input_key=input_key,
+            subcategory_ids=subcategory_ids,
+            update_type=update_type,
+        )
+        api_request = APIRequest(
+            method=set_input_subcategories_t.ENDPOINT_METHOD,
+            endpoint=set_input_subcategories_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=set_input_subcategories_t.Data)
+
     def set_recipe_inputs(
         self,
         *,
@@ -1096,3 +1180,93 @@ class ClientMethods(ABC):
             args=args,
         )
         return self.do_request(api_request=api_request, return_type=transition_entity_phase_t.Data)
+
+    def unarchive_recipes(
+        self,
+        *,
+        recipes: list[identifier_t.IdentifierKey],
+    ) -> unarchive_recipes_t.Data:
+        """Unarchive/restore the provided recipes
+
+        :param recipes: Identifier for the recipe
+        """
+        args = unarchive_recipes_t.Arguments(
+            recipes=recipes,
+        )
+        api_request = APIRequest(
+            method=unarchive_recipes_t.ENDPOINT_METHOD,
+            endpoint=unarchive_recipes_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=unarchive_recipes_t.Data)
+
+    def external_unlock_entity(
+        self,
+        *,
+        entity_key: identifier_t.IdentifierKey,
+        entity_type: entity_t.EntityType,
+    ) -> unlock_entity_t.Data:
+        """Unlock an entity
+
+        :param entity_key: Identifier for the entity
+        """
+        args = unlock_entity_t.Arguments(
+            entity_key=entity_key,
+            entity_type=entity_type,
+        )
+        api_request = APIRequest(
+            method=unlock_entity_t.ENDPOINT_METHOD,
+            endpoint=unlock_entity_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=unlock_entity_t.Data)
+
+    def update_entity_material_families(
+        self,
+        *,
+        entity_key: identifier_t.IdentifierKey,
+        entity_type: typing.Union[typing.Literal[entity_t.EntityType.RECIPE_METADATA], typing.Literal[entity_t.EntityType.INGREDIENT], typing.Literal[entity_t.EntityType.OUTPUT], typing.Literal[entity_t.EntityType.CONDITION_PARAMETER], typing.Literal[entity_t.EntityType.INGREDIENT_ATTRIBUTE]],
+        material_family_ids: list[base_t.ObjectId],
+        update_type: post_base_t.UpdateType,
+    ) -> update_entity_material_families_t.Data:
+        """Updates the material families that the entity is available in
+
+        :param entity_key: The identifier for the entity to update across material families
+        :param entity_type: The type of the entities requested
+        :param material_family_ids: The material families to update
+        :param update_type: The type of update to make
+        """
+        args = update_entity_material_families_t.Arguments(
+            entity_key=entity_key,
+            entity_type=entity_type,
+            material_family_ids=material_family_ids,
+            update_type=update_type,
+        )
+        api_request = APIRequest(
+            method=update_entity_material_families_t.ENDPOINT_METHOD,
+            endpoint=update_entity_material_families_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=update_entity_material_families_t.Data)
+
+    def upsert_field_options(
+        self,
+        *,
+        option_set_key: identifier_t.IdentifierKey,
+        field_options: list[upsert_field_options_t.FieldOption],
+    ) -> upsert_field_options_t.Data:
+        """Creates or updates field options for an option set
+
+        :param option_set_key: Identifier for the field option set
+        :param field_options: Field options to upsert
+        """
+        args = upsert_field_options_t.Arguments(
+            option_set_key=option_set_key,
+            field_options=field_options,
+        )
+        api_request = APIRequest(
+            method=upsert_field_options_t.ENDPOINT_METHOD,
+            endpoint=upsert_field_options_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=upsert_field_options_t.Data)