UncountablePythonSDK 0.0.7__py3-none-any.whl → 0.0.92__py3-none-any.whl

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: Integer
-            desc: "Required: The Material Family ID to get the input groups from."
-
-SimpleInputGroup:
-    type: Object
-    properties:
-        input_group_id:
-            type: Integer
-            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,61 +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<Integer>
-            desc: "The list of material families to add the ingredient to.  This must be non-empty"
-        quantity_type:
-            type: Union<Literal<'numeric'>, Literal<'text'>>
-            desc: "The quantity type of the input.  Always numeric for standard inputs"
-        type:
-            type: Union<Literal<'ingredient'>, Literal<'process_parameter'>>
-            desc: "The type of the input, E.g. ingredient, process parameter"
-        attributes?:
-            type: List<InputAttributeValue>
-            desc: "The attributes of the input"
-        category_id?:
-            type: Integer
-            desc: The unique identifier for the category to set for the input
-
-InputAttributeValue:
-    type: Object
-    properties:
-        attribute_id:
-            type: Integer
-            desc: "A unique identifier for the attribute."
-        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"
-
-InputSimple:
-    type: Object
-    properties:
-        input_id:
-            type: Integer
-            desc: "A unique identifier for the id"
-
-Data:
-    type: Object
-    properties:
-        inputs:
-            type: List<InputSimple>

type_spec/external/api/inputs/get_input_data.yaml

@@ -1,108 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/inputs/external_get_input_data
-    function: main.site.app.external.inputs.get_input_data.get_input_data
-    desc: "Gets the attribute, categorization and other metadata associated with a set of inputs. An input is either an ingredient or process parameter, with metadata and calculations assigned separately"
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: Integer
-            desc: "The material family ID to get the input values from."
-        input_ids:
-            type: Optional<List<Integer>>
-            desc: "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)."
-        offset:
-            type: Optional<Integer>
-            desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the input ID"
-        is_parameter:
-            type: Optional<Boolean>
-            desc: "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"
-        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"
-
-InputAttrVal:
-    type: Object
-    properties:
-        attribute_id:
-            type: Integer
-            desc: "The unique integer ID for the input attribute value. Used for joining and identification elsewhere."
-        quantity_dec:
-            type: Decimal
-            desc: "The value for the attribute, if it is of numeric type"
-        quantity_json:
-            type: JsonValue
-            desc: "The value for the attribute, if it is not of numeric type"
-
-SimpleInputAttr:
-    type: Object
-    properties:
-        attribute_id:
-            type: Integer
-            desc: "The unique integer ID for the input attribute value. Used for joining and identification elsewhere."
-        name:
-            type: String
-            desc: "The name of the input attribute"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the input attribute, such as numeric, categorical or text"
-
-SimpleInputGlobalCategory:
-    type: Object
-    properties:
-        category_id:
-            type: Integer
-            desc: "The unique integer ID for the global category. Used for joining and identification elsewhere."
-        name:
-            type: String
-            desc: "The name of the input global category"
-
-SimpleInputSubcategory:
-    type: Object
-    properties:
-        subcategory_id:
-            type: Integer
-            desc: "The unique integer ID for the subcategory. Used for joining and identification elsewhere."
-        name:
-            type: String
-            desc: "The name of the input subcategory"
-
-FullInput:
-    type: Object
-    properties:
-        input_id:
-            type: Integer
-            desc: "The unique integer ID of the input value. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the input"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the input, such as numeric, categorical or text"
-        is_parameter:
-            type: Boolean
-            desc: "Whether the input is a process parameter (true) or an ingredient (false)"
-        attributes:
-            type: List<InputAttrVal>
-            desc: "Attributes associated with an input, such as CAS number, density, etc."
-        global_category_id:
-            type: Integer
-            desc: "The global category ID associated with the input"
-        subcategory_ids:
-            type: List<Integer>
-            desc: "The subcategory IDs associated with an input. Inputs can be placed into an unlimited number of subcategories"
-
-Data:
-    type: Object
-    properties:
-        inputs:
-            type: List<FullInput>
-        attrs:
-            type: List<SimpleInputAttr>
-        global_categories:
-            type: List<SimpleInputGlobalCategory>
-        subcategories:
-            type: List<SimpleInputSubcategory>

type_spec/external/api/inputs/get_input_names.yaml

@@ -1,38 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/inputs/external_get_input_names
-    function: main.site.app.external.inputs.get_input_names.get_input_names
-    desc: "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"
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: Integer
-            desc: "The material family ID to get the input values from"
-        offset:
-            type: Optional<Integer>
-            desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the input ID"
-        is_parameter:
-            type: Optional<Boolean>
-            desc: "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"
-        limit:
-            type: Optional<Integer>
-            desc: "The maximum number of results to return. By default this is set to 20,000 and it cannot be set higher than 20,000"
-
-InputWithName:
-    type: Object
-    properties:
-        input_id:
-            type: Integer
-            desc: "The unique integer ID of the input value. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the input"
-
-Data:
-    type: Object
-    properties:
-        inputs:
-            type: List<InputWithName>

type_spec/external/api/inputs/get_inputs_data.yaml

@@ -1,95 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/inputs/external_get_inputs_data
-    function: main.site.app.external.inputs.get_inputs_data.get_inputs_data
-    desc: "Gets the details for passed input ids"
-
-Arguments:
-    type: Object
-    properties:
-        input_ids:
-            type: List<Integer>
-            desc: "Ids of the inputs to retrieve"
-
-AttributeDetails:
-    type: Object
-    properties:
-        attribute_id:
-            type: Integer
-            desc: "A unique identifier for the attribute."
-        name:
-            type: String
-            desc: "The name of the attribute"
-        quantity_type:
-            type: String
-            desc: "The value type of the attribute"
-
-InputAttributeValue:
-    type: Object
-    properties:
-        attribute_id:
-            type: Integer
-            desc: "A unique identifier for the attribute."
-        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"
-
-InputTag:
-    type: Object
-    properties:
-        tag_id:
-            type: Integer
-            desc: "A unique identifier for the tag."
-        tag_name:
-            type: String
-            desc: "A name for the tag"
-
-InputCategory:
-    type: Object
-    properties:
-        material_family_id:
-            type: Integer
-            desc: "A unique identifier for the material family id where the category assignment is made."
-        category_id:
-            type: Integer
-            desc: "A unique identifer for the category"
-        category_name:
-            type: String
-            desc: "A name for the category"
-
-InputDetails:
-    type: Object
-    properties:
-        input_id:
-            type: Integer
-            desc: "A unique identifier for the input."
-        name:
-            type: String
-            desc: "The name of the input."
-        quantity_type:
-            type: String
-            desc: "The quantity type of the input.  Always numeric for standard inputs"
-        type:
-            type: String
-            desc: "The type of the input.  E.g. input, process parameter, equipment"
-        attributes:
-            type: List<InputAttributeValue>
-            desc: "The attributes of the input"
-        categories:
-            type: List<InputCategory>
-            desc: "The categories for the input for each material family"
-        tags:
-            type: List<InputTag>
-            desc: "The tags (subcategories) for the input"
-
-Data:
-    type: Object
-    properties:
-        input_details:
-            type: List<InputDetails>
-        input_attributes:
-            type: List<AttributeDetails>

type_spec/external/api/inputs/set_input_attribute_values.yaml

@@ -1,37 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/inputs/external_set_input_attribute_values
-    function: main.site.app.external.inputs.set_input_attribute_values.set_input_attribute_values
-    desc: "Sets attribute values for an input"
-
-Arguments:
-    type: Object
-    properties:
-        attribute_values:
-            type: List<InputAttributeValue>
-            desc: "The attributes of the input to set"
-
-InputAttributeValue:
-    type: Object
-    properties:
-        input_id:
-            type: Integer
-            desc: "A unique identifier for the input to set the attribute value on"
-        attribute_id:
-            type: Integer
-            desc: "A unique identifier for the attribute."
-        quantity_dec?:
-            type: Decimal
-            desc: "The value for the attribute, if it is of numeric type"
-        quantity_json?:
-            type: JsonValue
-            desc: "The value for the attribute, if it is not of numeric type"
-
-Data:
-    type: Object
-    properties:
-        status:
-            type: Literal<'ok'>
-            default: "ok"
-            desc: "'ok' indicates the post request was successful"

type_spec/external/api/outputs/get_output_data.yaml

@@ -1,103 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/outputs/external_get_output_data
-    function: main.site.app.external.outputs.get_output_data.get_output_data
-    desc: "Gets the attribute, categorization and other metadata associated with a set of outputs"
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: Integer
-            desc: "The material family ID to get the output values from."
-        output_ids?:
-            type: List<Integer>
-            desc: "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)."
-        offset?:
-            type: Integer
-            desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the output ID"
-        limit?:
-            type: 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"
-
-OutputAttrVal:
-    type: Object
-    properties:
-        attribute_id:
-            type: Integer
-            desc: "The unique integer ID for the output attribute value. Used for joining and identification elsewhere."
-        quantity_dec:
-            type: Decimal
-            desc: "The value for the attribute, if it is of numeric type"
-        quantity_json:
-            type: JsonValue
-            desc: "The value for the attribute, if it is not of numeric type"
-
-SimpleOutputAttr:
-    type: Object
-    properties:
-        attribute_id:
-            type: Integer
-            desc: "The unique integer ID for the output attribute value. Used for joining and identification elsewhere."
-        name:
-            type: String
-            desc: "The name of the output attribute"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the output attribute, such as numeric, categorical or text"
-
-SimpleOutputGlobalCategory:
-    type: Object
-    properties:
-        category_id:
-            type: Integer
-            desc: "The unique integer ID for the global category. Used for joining and identification elsewhere."
-        name:
-            type: String
-            desc: "The name of the output global category"
-
-SimpleUnit:
-    type: Object
-    desc: "A representation of units within Uncountable system"
-    properties:
-        unit_id:
-            type: Integer
-            desc: "A unique ID for the unit, referenceable elsewhere"
-        name:
-            type: String
-            desc: "The name of the unit"
-
-FullOutput:
-    type: Object
-    properties:
-        output_id:
-            type: Integer
-            desc: "The unique integer ID of the output value. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the output"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the output, such as numeric, categorical, text, curve, or calculation"
-        attributes:
-            type: List<OutputAttrVal>
-            desc: "Attributes associated with an output, such as a test documentation"
-        global_category_id:
-            type: Integer
-            desc: "The global category ID associated with the output"
-        unit_id:
-            type: Integer
-            desc: "The unit for the output, which all data is stored in. This may be different than the users default displayed information for the output"
-
-Data:
-    type: Object
-    properties:
-        outputs:
-            type: List<FullOutput>
-        attrs:
-            type: List<SimpleOutputAttr>
-        global_categories:
-            type: List<SimpleOutputGlobalCategory>
-        units:
-            type: List<SimpleUnit>

type_spec/external/api/outputs/get_output_names.yaml

@@ -1,35 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/outputs/external_get_output_names
-    function: main.site.app.external.outputs.get_output_names.get_output_names
-    desc: "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"
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: Integer
-            desc: "The material family ID to get the output values from"
-        offset?:
-            type: Integer
-            desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the output ID"
-        limit?:
-            type: Integer
-            desc: "The maximum number of results to return. By default this is set to 20,000 and it cannot be set higher than 20,000"
-
-OutputWithName:
-    type: Object
-    properties:
-        output_id:
-            type: Integer
-            desc: "The unique integer ID of the output value. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the output"
-
-Data:
-    type: Object
-    properties:
-        outputs:
-            type: List<OutputWithName>

type_spec/external/api/outputs/resolve_output_conditions.yaml

@@ -1,50 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/outputs/external_resolve_output_conditions
-    function: main.site.app.external.outputs.resolve_output_conditions.resolve_output_conditions
-    desc: For the provided set of condition parameter id and values, returns the existing or newly created output condition id for that value and id pair.
-
-ConditionParameterValueRecord:
-    type: Object
-    properties:
-        condition_parameter_id:
-            type: ObjectId
-        value_numeric?:
-            type: Decimal
-            desc: The numeric value for the condition parameter. Should be none if condition parameter is not of type numeric
-        value_string?:
-            type: String
-            desc: The string value for the condition parameter if applicable for this condition parameter
-
-ConditionRequest:
-    type: Object
-    properties:
-        conditions:
-            type: List<ConditionParameterValueRecord>
-
-Arguments:
-    type: Object
-    properties:
-        requested_conditions:
-            type: List<ConditionRequest>
-
-ConditionResponse:
-    type: Object
-    properties:
-        conditions:
-            type: List<ConditionParameterValueRecord>
-        output_condition_id:
-            type: ObjectId
-            desc: The resolved output condition id for this condition parameter id and value pair
-
-Data:
-    type: Object
-    properties:
-        resolved_conditions:
-            type: List<ConditionResponse>
-            desc: Retains the same order as the request and includes the resolve output condition id for each condition request
-
-max_num_condition_requests:
-    type: Integer
-    value: 100

type_spec/external/api/project/get_projects.yaml

@@ -1,52 +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<Integer>
-            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: Integer
-            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: Integer
-            desc: "A unique identifier for the material family. Used as foreign key to reference elsewhere."
-        project_owner_id:
-            type: Optional<Integer>
-            desc: "The projects owner, as a user ID within the platform"
-        phase_id:
-            type: Optional<Integer>
-            desc: "The phase id corresponding to a phase workflow"
-
-Phase:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "A unique identifier for the phase. Used as foreign key to reference elsewhere."
-        name:
-            type: String
-            desc: "The name of the phase"
-
-Data:
-    type: Object
-    properties:
-        projects:
-            type: List<Project>
-        phases:
-            type: List<Phase>