UncountablePythonSDK 0.0.29__py3-none-any.whl → 0.0.30__py3-none-any.whl

examples/recipe-import/importer.py

@@ -1,39 +0,0 @@
-from typing import Iterable, Optional
-import itertools
-from dataclasses import dataclass
-from src.client.requests_client import Client
-from src.types.api.recipes.external_create_recipes import (
-    Arguments,
-    ExternalCreateRecipeDefinition,
-)
-from src.types.api.entity.external_resolve_entity_identifiers import (
-    EntityIdentifier
-)
-from src.types.base import ObjectId
-
-
-
-@dataclass(kw_only=True)
-class RecipeIngredientData:
-    ingredient_identifier: EntityIdentifier
-    recipe_step_id: Optional[ObjectId] = None
-    value_numeric: Optional[str] = None
-    value_str: Optional[str] = None
-    set_actual_value: bool = False
-
-
-def import_recipes(
-    client: Client,
-    material_family_id: ObjectId,
-    project_id: Optional[ObjectId],
-    recipe_data: Iterable[ExternalCreateRecipeDefinition],
-    batch_size: int = 100,
-) -> None:
-    for batch in itertools.batched(recipe_data, batch_size):
-        client.external_create_recipes(
-            Arguments(
-                material_family_id=material_family_id,
-                project_id=project_id,
-                recipe_definitions=list(batch),
-            )
-        )

type_spec/external/api/batch/execute_batch.yaml

@@ -1,56 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/batch/execute_batch
-    function: main.site.app.external.batch.execute_batch.execute_batch
-    desc: Run multiple API calls via one request
-
-RequestMethod:
-    type: StringEnum
-    values:
-        get: GET
-        head: HEAD
-        post: POST
-        put: PUT
-        delete: DELETE
-        connect: CONNECT
-        options: OPTIONS
-        trace: TRACE
-        patch: PATCH
-
-BatchRequest:
-    type: Object
-    properties:
-        path:
-            type: String
-        method:
-            type: RequestMethod
-        data:
-            convert_value: no_convert
-            type: JsonValue
-            desc: JSON payload for the api call
-
-Arguments:
-    type: Object
-    properties:
-        requests:
-            type: List<BatchRequest>
-
-BatchResponse:
-    type: Object
-    properties:
-        path:
-            type: String
-        method:
-            type: RequestMethod
-        status_code:
-            type: Integer
-        response:
-            convert_value: no_convert
-            type: JsonValue
-
-Data:
-    type: Object
-    properties:
-        responses:
-            type: List<BatchResponse>

type_spec/external/api/batch/execute_batch_load_async.yaml

@@ -1,18 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/batch/execute_batch_load_async
-    function: main.site.app.external.batch.execute_batch_load_async.execute_batch_load_async
-    desc: Run multiple API calls via one request
-
-Arguments:
-    type: Object
-    properties:
-        requests:
-            type: List<async_batch.AsyncBatchRequest>
-
-Data:
-    type: Object
-    properties:
-      job_id: 
-        type: ObjectId

type_spec/external/api/chemical/convert_chemical_formats.yaml

@@ -1,33 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/chemical/convert_chemical_formats
-    function: main.site.app.external.chemical.convert_chemical_formats.convert_chemical_formats
-    desc: Converts chemical formats, into the format used by Uncountable and usable in other APIs for eg. set_input_attribute_values
-
-
-ChemicalStructureFile:
-    type: Object
-    properties:
-        struct_file:
-            type: String
-            desc: Stringified chemical structure. MOL v2000/3000, SMILES, Part of SDF.
-
-Arguments:
-    type: Object
-    properties:
-        source_chemical_structures:
-            type: List<ChemicalStructureFile>
-
-UncountableChemicalStructure:
-    type: Alias
-    alias: Dict<String, JsonValue>
-    desc: Uncountable format for chemical structures compatible with set ingredient attributes api etc.
-
-Data:
-    type: Object
-    properties:
-        chemical_structures:
-            type: List<UncountableChemicalStructure>
-            desc: The parsed chemical structures in the Uncountable format
-            convert_value: no_convert

type_spec/external/api/entity/create_entities.yaml

@@ -1,45 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/entity/external_create_entities
-    function: main.site.app.external.entity.create_entities.create_entities
-    desc: "Creates new Uncountable entities"
-
-
-EntityToCreate:
-    type: Object
-    properties:
-        field_values?:
-            type: Optional<List<field_values.FieldRefNameValue>>
-
-Arguments:
-    type: Object
-    properties:
-        definition_id:
-            type: ObjectId
-            desc: "Definition id for the entities to create"
-        entity_type:
-            type: |
-                Union<
-                    Literal<entity.EntityType.lab_request>,
-                    Literal<entity.EntityType.approval>,
-                    Literal<entity.EntityType.custom_entity>,
-                    Literal<entity.EntityType.inventory_amount>,
-                    Literal<entity.EntityType.task>,
-                    Literal<entity.EntityType.project>,
-                    Literal<entity.EntityType.equipment>,
-                    Literal<entity.EntityType.inv_local_locations>,
-                    Literal<entity.EntityType.field_option_set>,
-                    Literal<entity.EntityType.webhook>
-                >
-            desc: "The type of the entities to create"
-        entities_to_create:
-            type: List<EntityToCreate>
-            desc: "A list of the entities to create"
-
-Data:
-    type: Object
-    properties:
-        entities:
-            type: List<entity.Entity>
-            desc: The entities created

type_spec/external/api/entity/create_entity.yaml

@@ -1,51 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/entity/external_create_entity
-    function: main.site.app.external.entity.create_entity.create_entity
-    desc: "Creates a new Uncountable entity"
-    is_sdk: true
-
-EntityFieldInitialValue:
-    type: Object
-    properties:
-        field_ref_name:
-            type: String
-            desc: "A unique identifer string for the field"
-        row_index?:
-            type: Optional<Integer>
-            desc: "The index in the table for the field"
-        value:
-            type: JsonValue
-            desc: "The value for the field"
-
-Arguments:
-    type: Object
-    properties:
-        definition_id:
-            type: ObjectId
-            desc: "Definition id of the entity to create"
-        entity_type:
-            type: |
-                Union<
-                    Literal<entity.EntityType.lab_request>,
-                    Literal<entity.EntityType.approval>,
-                    Literal<entity.EntityType.custom_entity>,
-                    Literal<entity.EntityType.inventory_amount>,
-                    Literal<entity.EntityType.task>,
-                    Literal<entity.EntityType.project>,
-                    Literal<entity.EntityType.equipment>,
-                    Literal<entity.EntityType.inv_local_locations>,
-                    Literal<entity.EntityType.field_option_set>,
-                    Literal<entity.EntityType.webhook>
-                >
-            desc: "The type of the entities requested"
-        field_values?:
-            type: Optional<List<field_values.FieldRefNameValue>>
-
-Data:
-    type: Object
-    properties:
-        entity:
-            type: entity.Entity
-            desc: The entity created

type_spec/external/api/entity/get_entities_data.yaml

@@ -1,29 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/entity/external_get_entities_data
-    function: main.site.app.external.entity.get_entities_data.get_entities_data
-    desc: "Gets the details for a passed entity"
-Arguments:
-    type: Object
-    properties:
-        entity_ids:
-            type: List<ObjectId>
-            desc: "Ids of the entity to retrieve"
-        entity_type:
-            type: entity.EntityType
-            desc: "The type of the entities requested, e.g. lab_request or approval"
-
-EntityDetails:
-    type: Object
-    properties:
-        entity:
-            type: entity.Entity
-        field_values:
-            type: List<field_values.FieldRefIdNameValue>
-
-Data:
-    type: Object
-    properties:
-        entity_details:
-            type: List<EntityDetails>

type_spec/external/api/entity/list_entities.yaml

@@ -1,52 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/entity/external_list_entities
-    function: main.site.app.external.entity.list_entities.list_entities
-    desc: "Uses a structured loading configuration to list entities in the system"
-Arguments:
-    type: Object
-    properties:
-        entity_type:
-            type: entity.EntityType
-            desc: "The type of the entities requested, e.g. lab_request, recipe"
-        config_reference:
-            type: String
-            desc: "The configuration reference name for the listing config"
-        attributes?:
-            type: Dict<OpaqueKey, JsonValue>
-            desc: "Attributes to pass to the configuration for parameterizing filters"
-        offset?:
-            type: Optional<Integer>
-            desc: Used for pagination. Pagination is done based on the sorting of the config. [Pagination More Info](#pagination)
-        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. [Pagination More Info](#pagination)
-
-EntityResult:
-    type: Object
-    properties:
-        entity:
-            type: entity.Entity
-            desc: "The entity represented by the record"
-        column_values:
-            type: List<JsonValue>
-            desc: "The column values loaded from the configuration"
-
-ColumnAccess:
-    type: Object
-    properties:
-        name:
-            type: String
-            desc: "The name for the identifier for this column.  Note that this will be replaced with the label in the future"
-        table_label:
-            type: Optional<String>
-            desc: "The name manually set for the column"
-
-Data:
-    type: Object
-    properties:
-        columns:
-            type: List<ColumnAccess>
-        results:
-            type: List<EntityResult>

type_spec/external/api/entity/lock_entity.yaml

@@ -1,21 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/entity/external_lock_entity
-    function: main.site.app.external.entity.external_lock_entity.external_lock_entity
-    desc: Lock an entity
-
-Arguments:
-    type: Object
-    properties:
-        entity_key:
-            type: identifier.IdentifierKey
-            desc: "Identifier for the entity"
-        entity_type:
-            type: entity.EntityType
-        globally_removable?:
-            type: Boolean
-            desc: "Should the lock be removable by any user or just admins"
-
-Data:
-  type: async_batch.AsyncBatchActionReturn

type_spec/external/api/entity/resolve_entity_ids.yaml

@@ -1,29 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/entity/external_resolve_entity_ids
-    function: main.site.app.external.entity.resolve_entity_ids.resolve_entity_ids
-    desc: "Gets the names for passed in ids"
-Arguments:
-    type: Object
-    properties:
-        entity_ids:
-            type: List<Union<String, ObjectId>>
-            desc: "Ids of the entity to retrieve"
-        entity_type:
-            type: entity.EntityType
-            desc: "The type of the entities requested"
-
-EntityNames:
-    type: Object
-    properties:
-        id:
-            type: Union<String, Integer>
-        name:
-            type: String
-
-Data:
-    type: Object
-    properties:
-        items:
-            type: List<EntityNames>

type_spec/external/api/entity/set_values.yaml

@@ -1,18 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/entity/external_set_values
-    function: main.site.app.external.entity.set_values.set_values
-    desc: "Sets field values for an entity"
-
-Arguments:
-    type: Object
-    properties:
-        entity:
-            type: entity.Entity
-        values:
-            type: List<field_values.ArgumentValueRefName>
-
-Data:
-    type: response.Response
-    properties:

type_spec/external/api/entity/transition_entity_phase.yaml

@@ -1,44 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/entity/transition_entity_phase
-    function: main.site.app.external.entity.transition_entity_phase.transition_entity_phase
-    desc: "Transitions an entity from one phase to another"
-
-
-TransitionIdentifierPhases:
-    type: Object
-    properties:
-        type:
-            type: Literal<'phases'>
-        phase_from_key:
-            type: identifier.IdentifierKey
-        phase_to_key:
-            type: identifier.IdentifierKey
-
-TransitionIdentifierTransition:
-    type: Object
-    properties:
-        type:
-            type: Literal<'transition'>
-        transition_key:
-            type: identifier.IdentifierKey
-
-
-TransitionIdentifier:
-    type: Alias
-    alias: |
-        Union<TransitionIdentifierPhases, TransitionIdentifierTransition>
-
-
-Arguments:
-    type: Object
-    properties:
-        entity:
-            type: entity.Entity
-        transition:
-            type: TransitionIdentifier
-
-Data:
-    type: response.Response
-    properties:

type_spec/external/api/entity/unlock_entity.yaml

@@ -1,18 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/entity/external_unlock_entity
-    function: main.site.app.external.entity.external_unlock_entity.external_unlock_entity
-    desc: Unlock an entity
-
-Arguments:
-    type: Object
-    properties:
-        entity_key:
-            type: identifier.IdentifierKey
-            desc: "Identifier for the entity"
-        entity_type:
-            type: entity.EntityType
-
-Data:
-  type: async_batch.AsyncBatchActionReturn

type_spec/external/api/field_options/upsert_field_options.yaml

@@ -1,37 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/field_options/upsert_field_options
-    function: main.site.app.external.field_options.upsert_field_options.upsert_field_options
-    desc: "Creates or updates field options for an option set"
-    is_sdk: true
-
-FieldOption:
-    type: Object
-    properties:
-        option_id:
-            type: String
-            desc: "A unique identifer for the option.  This is required to be a string with no symbols"
-        option_value?:
-            type: String
-            desc: "The label for the option.  If none is set, then the existing value will be used.  If there is no existing value, then the option id will be used."
-        archived?:
-            type: Boolean
-            desc: "If included, whether to set the option to be archived or unarchived"
-        subsets?:
-            type: List<String>
-            desc: "If included, what subsets to include the option in"
-
-Arguments:
-    type: Object
-    properties:
-        option_set_key:
-            type: identifier.IdentifierKey
-            desc: "Identifier for the field option set"
-        field_options:
-            type: List<FieldOption>
-            desc: Field options to upsert
-
-Data:
-    type: Object
-    properties:

type_spec/external/api/id_source/list_id_source.yaml

@@ -1,35 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/id_source/list_id_source
-    function: main.site.app.external.id_source.list_id_source.list_id_source
-    desc: "Lists id and label pairs"
-Arguments:
-    type: Object
-    properties:
-        spec:
-            type: id_source.IdSourceSpec
-            desc: "The id source spec to use"
-        search_label:
-            type: String
-            desc: Text to search within the labels to search matches
-        offset?:
-            type: Optional<Integer>
-            desc: Used for pagination. Pagination is done based on the sorting of the config. [Pagination More Info](#pagination)
-        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. [Pagination More Info](#pagination)
-
-IdName:
-    type: Object
-    properties:
-        id:
-            type: Union<ObjectId,String>
-        name:
-            type: String
-
-Data:
-    type: Object
-    properties:
-        results:
-            type: List<IdName>

type_spec/external/api/id_source/match_id_source.yaml

@@ -1,32 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/id_source/match_id_source
-    function: main.site.app.external.id_source.match_id_source.match_id_source
-    desc: "Lists id and label pairs"
-Arguments:
-    type: Object
-    properties:
-        spec:
-            type: id_source.IdSourceSpec
-            desc: "The id source spec to use"
-        names:
-            type: List<String>
-            desc: "The names to match with the id source.  At most 10 are allowed at a time"
-
-Match:
-    type: Object
-    properties:
-        name:
-            type: String
-            desc: The name used to match
-        ids:
-            type: List<Union<ObjectId, String>>
-            desc: The list of matches
-
-Data:
-    type: Object
-    properties:
-        results:
-            type: List<Match>
-            convert_value: no_convert

type_spec/external/api/input_groups/get_input_group_names.yaml

@@ -1,29 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/input_groups/external_get_input_group_names
-    function: main.site.app.external.input_groups.get_input_group_names.get_input_group_names
-    desc: "Gets the name of all input groups in a material family that either the user created, or are shared to all users."
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: ObjectId
-            desc: "Required: The Material Family ID to get the input groups from."
-
-SimpleInputGroup:
-    type: Object
-    properties:
-        input_group_id:
-            type: ObjectId
-            desc: "The unique integer ID of the input group. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the input group"
-
-Data:
-    type: Object
-    properties:
-        input_groups:
-            type: List<SimpleInputGroup>

type_spec/external/api/inputs/create_inputs.yaml

@@ -1,48 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/inputs/external_create_inputs
-    function: main.site.app.external.inputs.create_inputs.external_create_inputs
-    desc: "Creates new inputs"
-    is_sdk: true
-
-Arguments:
-    type: Object
-    properties:
-        inputs_to_create:
-            type: List<InputToCreate>
-            desc: "A list of inputs to create"
-
-InputToCreate:
-    type: Object
-    properties:
-        name:
-            type: String
-        material_family_ids:
-            type: List<ObjectId>
-            desc: "The list of material families to add the ingredient to.  This must be non-empty"
-        quantity_type:
-            type: Union<Literal<inputs.IngredientQuantityType.numeric>, Literal<inputs.IngredientQuantityType.text>>
-            desc: "The quantity type of the input.  Always numeric for standard inputs"
-        type:
-            type: Union<Literal<inputs.IngredientType.ingredient>, Literal<inputs.IngredientType.process_parameter>>
-            desc: "The type of the input, E.g. ingredient, process parameter"
-        attributes?:
-            type: List<input_attributes.InputAttributeValue>
-            desc: "The attributes of the input"
-        category_id?:
-            type: ObjectId
-            desc: The unique identifier for the category to set for the input
-
-InputSimple:
-    type: Object
-    properties:
-        input_id:
-            type: ObjectId
-            desc: "A unique identifier for the id"
-
-Data:
-    type: Object
-    properties:
-        inputs:
-            type: List<InputSimple>