UncountablePythonSDK 0.0.24__py3-none-any.whl → 0.0.131__py3-none-any.whl

type_spec/external/api/project/get_projects.yaml

@@ -1,42 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/project/external_get_projects
-    function: main.site.app.external.project.get_projects.get_projects
-    desc: "Gets either all projects created in the platform, or the projects associated with a material family ID. Projects are where experiments are placed in Uncountable, similar to folders in a directory structure"
-Arguments:
-    type: Object
-    properties:
-        all_material_families:
-            type: Boolean
-            desc: "Whether to get projects from all material families. Material families are high level groupings of data, usually separated by functional area"
-        material_family_id:
-            type: Optional<ObjectId>
-            desc: "The specific material family ID to get projects from. Only fill this in if all_material_families is set to false"
-
-Project:
-    type: Object
-    properties:
-        id:
-            type: ObjectId
-            desc: "A unique identifier for the project. Used as foreign key to reference elsewhere."
-        name:
-            type: String
-            desc: "The name of the project"
-        material_family_id:
-            type: ObjectId
-            desc: "A unique identifier for the material family. Used as foreign key to reference elsewhere."
-        project_owner_id:
-            type: Optional<ObjectId>
-            desc: "The projects owner, as a user ID within the platform"
-        phase_id:
-            type: Optional<ObjectId>
-            desc: "The phase id corresponding to a phase workflow"
-
-Data:
-    type: Object
-    properties:
-        projects:
-            type: List<Project>
-        phases:
-            type: List<phases.Phase>

type_spec/external/api/project/get_projects_data.yaml

@@ -1,50 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/project/external_get_projects_data
-    function: main.site.app.external.project.get_projects_data.get_projects_data
-    desc: "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"
-Arguments:
-    type: Object
-    properties:
-        project_ids:
-            type: List<ObjectId>
-            desc: "The projects to get the data from"
-        offset?:
-            type: Optional<Integer>
-            desc: "Used for pagination. All pagination is done in order of Project ID"
-        limit?:
-            type: Optional<Integer>
-            desc: "The number of data points to return. If not filled in, it will be set to 100, and cannot be set higher than 100"
-
-ProjectDetailed:
-    type: Object
-    properties:
-        id:
-            type: ObjectId
-            desc: "A unique identifier for the project. Used as foreign key to reference elsewhere."
-        name:
-            type: String
-            desc: "The name of the project"
-        material_family_id:
-            type: ObjectId
-            desc: "A unique identifier for the material family. Used as foreign key to reference elsewhere."
-        project_owner_id:
-            type: Optional<ObjectId>
-            desc: "The projects owner, as a user ID within the platform"
-        phase_id:
-            type: Optional<ObjectId>
-            desc: "The phase id corresponding to a phase workflow"
-        values:
-            type: List<field_values.ArgumentValueId>
-            desc: "List of fields and values associated with the project"
-
-Data:
-    type: Object
-    properties:
-        projects:
-            type: List<ProjectDetailed>
-        phases:
-            type: List<phases.Phase>
-        fields:
-            type: List<fields.Field>

type_spec/external/api/recipe_links/create_recipe_link.yaml

@@ -1,25 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/recipe_links/create_recipe_link
-    function: main.site.app.external.recipe_links.create_recipe_link.create_recipe_link
-    desc: Create a link between two recipes.  Skip if the link already exists
-
-Arguments:
-    type: Object
-    properties:
-        recipe_from_key:
-            type: identifier.IdentifierKey
-            desc: "Identifier for the recipe the link comes from"
-        recipe_to_key:
-            type: identifier.IdentifierKey
-            desc: "Identifier for the recipe the link goes to"
-        link_type:
-            type: Union<Literal<recipe_links.RecipeLinkType.child>, Literal<recipe_links.RecipeLinkType.control>, Literal<recipe_links.RecipeLinkType.user_link>>
-            desc: "The type of link being created"
-        name:
-            type: String
-            desc: "The name used for the link"
-
-Data:
-  type: async_batch.AsyncBatchActionReturn

type_spec/external/api/recipe_metadata/get_recipe_metadata_data.yaml

@@ -1,41 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipe_metadata/external_get_recipe_metadata_data
-    function: main.site.app.external.recipe_metadata.get_recipe_metadata_data.get_recipe_metadata_data
-    desc: "Gets the recipe metadata. Recipe metadata is data associated with experiments that is not an input, output or calculation, such as a sample ID."
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: ObjectId
-            desc: "The material family ID to get the recipe metadata values from."
-        recipe_metadata_ids:
-            type: Optional<List<ObjectId>>
-            desc: "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)."
-        offset?:
-            type: Optional<Integer>
-            desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the metadata ID"
-        limit?:
-            type: Optional<Integer>
-            desc: "The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000"
-
-FullRecipeMetadataField:
-    type: Object
-    properties:
-        recipe_metadata_id:
-            type: ObjectId
-            desc: "The unique integer ID of the recipe metadata value. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the recipe metadata"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the recipe metadata, such as numeric, categorical or text"
-
-Data:
-    type: Object
-    properties:
-        recipe_metadata:
-            type: List<FullRecipeMetadataField>

type_spec/external/api/recipes/archive_recipes.yaml

@@ -1,20 +0,0 @@
-$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

type_spec/external/api/recipes/associate_recipe_as_input.yaml

@@ -1,19 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/recipes/associate_recipe_as_input
-    function: main.site.app.external.recipes.associate_recipe_as_input.associate_recipe_as_input
-    desc: Create or return the input association for a recipe
-
-Arguments:
-    type: Object
-    properties:
-        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: async_batch.AsyncBatchActionReturn

type_spec/external/api/recipes/associate_recipe_as_lot.yaml

@@ -1,19 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/recipes/associate_recipe_as_lot
-    function: main.site.app.external.recipes.associate_recipe_as_lot.associate_recipe_as_lot
-    desc: Create a new lot association for the provided recipe with the provided ingredient
-
-Arguments:
-    type: Object
-    properties:
-        recipe_key:
-            type: identifier.IdentifierKey
-            desc: "Identifier for the recipe"
-        ingredient_key:
-            type: identifier.IdentifierKey
-            desc: "Identifier for the ingredient"
-
-Data:
-  type: async_batch.AsyncBatchActionReturn

type_spec/external/api/recipes/create_recipe.yaml

@@ -1,39 +0,0 @@
-$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
-    desc: Returns the id of the recipe being created.
-
-
-Arguments:
-    type: Object
-    properties:
-        name?:
-            type: String
-            desc: The name for the recipe
-        material_family_id:
-            type: ObjectId
-            desc: The material family for the recipe
-        workflow_id:
-            type: ObjectId
-            desc: The identifier of the workflow to create the recipe with
-        workflow_variant_id?:
-            type: Optional<ObjectId>
-            desc: The identifier of the workflow variant to create the recipe with
-        recipe_metadata?:
-            type: List<recipe_metadata.MetadataValue>
-            desc: Metadata values to populate the recipe with
-        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: identifier.IdentifierKey
-            desc: The entity definition identifier, default is used if not supplied
-
-Data:
-  type: Object
-  properties:
-    result_id:
-      type: ObjectId

type_spec/external/api/recipes/create_recipes.yaml

@@ -1,47 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/recipes/external_create_recipes
-    function: main.site.app.external.recipes.create_recipes.create_recipes
-    desc: "Sets inputs values for an experiment. Values set can be numeric, text or categorical types in the Uncountable system"
-
-CreateRecipeDefinition:
-    type: Object
-    properties:
-        name?:
-            type: String
-            desc: "The name for the recipe"
-        workflow_id:
-            type: ObjectId
-            desc: "The identifier of the workflow to create the recipe with"
-        workflow_variant_id?:
-            type: Optional<ObjectId>
-            desc: "The identifier of the workflow variant to create the recipe with"
-        recipe_metadata?:
-            type: List<recipe_metadata.MetadataValue>
-            desc: "Metadata values to populate the recipe with"
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: ObjectId
-            desc: "The identifier of the material family to create the recipes in"
-        project_id?:
-            type: ObjectId
-            desc: "The identifier of the project to create the recipes in"
-        recipe_definitions:
-            type: List<CreateRecipeDefinition>
-
-CreateRecipeResult:
-    type: Object
-    properties:
-        recipe_id:
-            type: ObjectId
-            desc: The identifier for the created recipe
-
-Data:
-    type: Object
-    properties:
-        recipes:
-            type: List<CreateRecipeResult>

type_spec/external/api/recipes/disassociate_recipe_as_input.yaml

@@ -1,16 +0,0 @@
-$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

@@ -1,85 +0,0 @@
-$endpoint:
-    is_sdk: 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.RecipeWorkflowStepIdentifier
-        edits:
-            type: List<RecipeInputEdit>
-
-Data:
-  type: Object
-  properties:

type_spec/external/api/recipes/get_curve.yaml

@@ -1,21 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_curve
-    function: main.site.app.external.recipes.get_curve.get_curve
-    desc: "Returns an array of values for the specified curve id."
-Arguments:
-    type: Object
-    properties:
-        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
-    properties:
-        curve:
-            type: curves.Curve

type_spec/external/api/recipes/get_recipe_calculations.yaml

@@ -1,39 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_calculations
-    function: main.site.app.external.recipes.get_recipe_calculations.get_recipe_calculations
-    desc: "Gets the calculations for the passed recipes"
-Arguments:
-    type: Object
-    properties:
-        recipe_ids:
-            type: List<ObjectId>
-            desc: "Ids of the Recipes to retrieve calculations for"
-        calculation_ids?:
-            type: List<ObjectId>
-            desc: "Optionally a list of ids of calculations to retrieve"
-
-RecipeCalculation:
-    type: Object
-    properties:
-        recipe_id:
-            type: ObjectId
-            desc: "Identifier for the recipe"
-        calculation_id:
-            type: ObjectId
-            desc: "Identifier for the calculation"
-        quantity_dec?:
-            type: Decimal
-            desc: "The value for the calculation, if it is of numeric type"
-        quantity_json?:
-            type: JsonValue
-            desc: "The value for the calculation, if it is not of numeric type"
-
-Data:
-    type: Object
-    properties:
-        recipe_calculations:
-            type: List<RecipeCalculation>
-        calculations:
-            type: List<calculations.Calculation>

type_spec/external/api/recipes/get_recipe_links.yaml

@@ -1,26 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_links
-    function: main.site.app.external.recipes.get_recipe_links.get_recipe_links
-    desc: "Gets the links for the passed recipes"
-
-Arguments:
-    type: Object
-    properties:
-        recipe_ids:
-            type: List<ObjectId>
-            desc: "Ids of the Recipes to retrieve links for"
-        depth:
-            type: Integer
-            desc: "How many layers deep to look for links"
-            default: 1
-        link_types:
-            type: Optional<List<recipe_links.RecipeLinkType>>
-            desc: "Optional filter to only desired link types"
-
-Data:
-    type: Object
-    properties:
-        recipe_links:
-            type: List<recipe_links.RecipeLink>

type_spec/external/api/recipes/get_recipe_names.yaml

@@ -1,29 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_names
-    function: main.site.app.external.recipes.get_recipe_names.get_recipe_names
-    desc: "Gets the name of all recipes (or experiments, used as synonyms by Uncountable) for a project. The call external_get_projects can be used to find projects"
-
-Arguments:
-    type: Object
-    properties:
-        project_id:
-            type: ObjectId
-            desc: "Required: The project ID to get the recipes/experiments from."
-
-SimpleRecipe:
-    type: Object
-    properties:
-        id:
-            type: ObjectId
-            desc: "The unique integer ID of the recipe/experiment. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the recipe"
-
-Data:
-    type: Object
-    properties:
-        recipes:
-            type: List<SimpleRecipe>

type_spec/external/api/recipes/get_recipe_output_metadata.yaml

@@ -1,36 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_output_metadata
-    function: main.site.app.external.recipes.get_recipe_output_metadata.get_recipe_output_metadata
-    desc: "Gets the metadata values for the passed recipe outputs"
-Arguments:
-    type: Object
-    properties:
-        recipe_output_ids:
-            type: List<ObjectId>
-            desc: "Ids of the Recipe Outputs to retrieve metadata for"
-
-RecipeOutputMetadata:
-    type: Object
-    properties:
-        recipe_output_id:
-            type: ObjectId
-            desc: "Identifier for the recipe output"
-        recipe_output_metadata_field_id:
-            type: ObjectId
-            desc: "Identifier for the metadata field id"
-        quantity_dec:
-            type: Decimal
-            desc: "The value for the metadata, if it is of numeric type"
-        quantity_json:
-            type: JsonValue
-            desc: "The value for the metadata, if it is not of numeric type"
-
-Data:
-    type: Object
-    properties:
-        recipe_output_metadata:
-            type: List<RecipeOutputMetadata>
-        recipe_output_metadata_fields:
-            type: List<recipe_output_metadata.RecipeOutputMetadataField>