nominal-api 0.855.0__tar.gz → 0.856.0__tar.gz

{nominal_api-0.855.0 → nominal_api-0.856.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nominal-api
-Version: 0.855.0
+Version: 0.856.0
 Requires-Python: >=3.8
 Requires-Dist: requests
 Requires-Dist: conjure-python-client<4,>=2.8.0

{nominal_api-0.855.0 → nominal_api-0.856.0}/nominal_api/__init__.py

@@ -80,5 +80,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.855.0"
+__version__ = "0.856.0"
 

{nominal_api-0.855.0 → nominal_api-0.856.0}/nominal_api/_impl.py

@@ -44989,41 +44989,58 @@ class scout_compute_api_DerivedSeries(ConjureUnionType):
 This is a series that is derived from a function within a module.
     """
     _module_application: Optional["scout_compute_api_ModuleApplicationDerivedSeries"] = None
+    _function: Optional["scout_compute_api_FunctionDerivedSeries"] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'module_application': ConjureFieldDefinition('moduleApplication', scout_compute_api_ModuleApplicationDerivedSeries)
+            'module_application': ConjureFieldDefinition('moduleApplication', scout_compute_api_ModuleApplicationDerivedSeries),
+            'function': ConjureFieldDefinition('function', scout_compute_api_FunctionDerivedSeries)
         }
 
     def __init__(
             self,
             module_application: Optional["scout_compute_api_ModuleApplicationDerivedSeries"] = None,
+            function: Optional["scout_compute_api_FunctionDerivedSeries"] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (module_application is not None) != 1:
+            if (module_application is not None) + (function is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if module_application is not None:
                 self._module_application = module_application
                 self._type = 'moduleApplication'
+            if function is not None:
+                self._function = function
+                self._type = 'function'
 
         elif type_of_union == 'moduleApplication':
             if module_application is None:
                 raise ValueError('a union value must not be None')
             self._module_application = module_application
             self._type = 'moduleApplication'
+        elif type_of_union == 'function':
+            if function is None:
+                raise ValueError('a union value must not be None')
+            self._function = function
+            self._type = 'function'
 
     @builtins.property
     def module_application(self) -> Optional["scout_compute_api_ModuleApplicationDerivedSeries"]:
         return self._module_application
 
+    @builtins.property
+    def function(self) -> Optional["scout_compute_api_FunctionDerivedSeries"]:
+        return self._function
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, scout_compute_api_DerivedSeriesVisitor):
             raise ValueError('{} is not an instance of scout_compute_api_DerivedSeriesVisitor'.format(visitor.__class__.__name__))
         if self._type == 'moduleApplication' and self.module_application is not None:
             return visitor._module_application(self.module_application)
+        if self._type == 'function' and self.function is not None:
+            return visitor._function(self.function)
 
 
 scout_compute_api_DerivedSeries.__name__ = "DerivedSeries"
@@ -45037,6 +45054,10 @@ class scout_compute_api_DerivedSeriesVisitor:
     def _module_application(self, module_application: "scout_compute_api_ModuleApplicationDerivedSeries") -> Any:
         pass
 
+    @abstractmethod
+    def _function(self, function: "scout_compute_api_FunctionDerivedSeries") -> Any:
+        pass
+
 
 scout_compute_api_DerivedSeriesVisitor.__name__ = "DerivedSeriesVisitor"
 scout_compute_api_DerivedSeriesVisitor.__qualname__ = "DerivedSeriesVisitor"
@@ -46605,6 +46626,129 @@ scout_compute_api_FrequencyDomainPlot.__qualname__ = "FrequencyDomainPlot"
 scout_compute_api_FrequencyDomainPlot.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_FunctionDerivedSeries(ConjureBeanType):
+    """A reference to a derived series resulting from applying a function to a set of arguments.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'module_name': ConjureFieldDefinition('moduleName', scout_compute_api_StringConstant),
+            'function_name': ConjureFieldDefinition('functionName', scout_compute_api_StringConstant),
+            'version_reference': ConjureFieldDefinition('versionReference', scout_compute_api_ModuleVersionReference),
+            'function_args': ConjureFieldDefinition('functionArgs', Dict[scout_compute_api_FunctionParameterName, scout_compute_api_FunctionParameterValue])
+        }
+
+    __slots__: List[str] = ['_module_name', '_function_name', '_version_reference', '_function_args']
+
+    def __init__(self, function_args: Dict[str, "scout_compute_api_FunctionParameterValue"], function_name: "scout_compute_api_StringConstant", module_name: "scout_compute_api_StringConstant", version_reference: "scout_compute_api_ModuleVersionReference") -> None:
+        self._module_name = module_name
+        self._function_name = function_name
+        self._version_reference = version_reference
+        self._function_args = function_args
+
+    @builtins.property
+    def module_name(self) -> "scout_compute_api_StringConstant":
+        return self._module_name
+
+    @builtins.property
+    def function_name(self) -> "scout_compute_api_StringConstant":
+        return self._function_name
+
+    @builtins.property
+    def version_reference(self) -> "scout_compute_api_ModuleVersionReference":
+        return self._version_reference
+
+    @builtins.property
+    def function_args(self) -> Dict[str, "scout_compute_api_FunctionParameterValue"]:
+        """Map of function input names to their values. The function inputs must match the function's parameter
+names and types. An input must be specified for each of the referenced function's parameters.
+        """
+        return self._function_args
+
+
+scout_compute_api_FunctionDerivedSeries.__name__ = "FunctionDerivedSeries"
+scout_compute_api_FunctionDerivedSeries.__qualname__ = "FunctionDerivedSeries"
+scout_compute_api_FunctionDerivedSeries.__module__ = "nominal_api.scout_compute_api"
+
+
+class scout_compute_api_FunctionParameterValue(ConjureUnionType):
+    _variable: Optional[str] = None
+    _value: Optional["scout_compute_api_VariableValue"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'variable': ConjureFieldDefinition('variable', scout_compute_api_VariableName),
+            'value': ConjureFieldDefinition('value', scout_compute_api_VariableValue)
+        }
+
+    def __init__(
+            self,
+            variable: Optional[str] = None,
+            value: Optional["scout_compute_api_VariableValue"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (variable is not None) + (value is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if variable is not None:
+                self._variable = variable
+                self._type = 'variable'
+            if value is not None:
+                self._value = value
+                self._type = 'value'
+
+        elif type_of_union == 'variable':
+            if variable is None:
+                raise ValueError('a union value must not be None')
+            self._variable = variable
+            self._type = 'variable'
+        elif type_of_union == 'value':
+            if value is None:
+                raise ValueError('a union value must not be None')
+            self._value = value
+            self._type = 'value'
+
+    @builtins.property
+    def variable(self) -> Optional[str]:
+        return self._variable
+
+    @builtins.property
+    def value(self) -> Optional["scout_compute_api_VariableValue"]:
+        return self._value
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_compute_api_FunctionParameterValueVisitor):
+            raise ValueError('{} is not an instance of scout_compute_api_FunctionParameterValueVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'variable' and self.variable is not None:
+            return visitor._variable(self.variable)
+        if self._type == 'value' and self.value is not None:
+            return visitor._value(self.value)
+
+
+scout_compute_api_FunctionParameterValue.__name__ = "FunctionParameterValue"
+scout_compute_api_FunctionParameterValue.__qualname__ = "FunctionParameterValue"
+scout_compute_api_FunctionParameterValue.__module__ = "nominal_api.scout_compute_api"
+
+
+class scout_compute_api_FunctionParameterValueVisitor:
+
+    @abstractmethod
+    def _variable(self, variable: str) -> Any:
+        pass
+
+    @abstractmethod
+    def _value(self, value: "scout_compute_api_VariableValue") -> Any:
+        pass
+
+
+scout_compute_api_FunctionParameterValueVisitor.__name__ = "FunctionParameterValueVisitor"
+scout_compute_api_FunctionParameterValueVisitor.__qualname__ = "FunctionParameterValueVisitor"
+scout_compute_api_FunctionParameterValueVisitor.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_FunctionVariables(ConjureBeanType):
 
     @builtins.classmethod
@@ -48289,12 +48433,12 @@ The referenced module must be applied to the referenced asset.
         return {
             'module_application_rid': ConjureFieldDefinition('moduleApplicationRid', scout_compute_api_StringConstant),
             'function_name': ConjureFieldDefinition('functionName', scout_compute_api_StringConstant),
-            'function_args': ConjureFieldDefinition('functionArgs', Dict[scout_compute_api_VariableName, scout_compute_api_VariableValue])
+            'function_args': ConjureFieldDefinition('functionArgs', Dict[scout_compute_api_FunctionParameterName, scout_compute_api_FunctionParameterValue])
         }
 
     __slots__: List[str] = ['_module_application_rid', '_function_name', '_function_args']
 
-    def __init__(self, function_args: Dict[str, "scout_compute_api_VariableValue"], function_name: "scout_compute_api_StringConstant", module_application_rid: "scout_compute_api_StringConstant") -> None:
+    def __init__(self, function_args: Dict[str, "scout_compute_api_FunctionParameterValue"], function_name: "scout_compute_api_StringConstant", module_application_rid: "scout_compute_api_StringConstant") -> None:
         self._module_application_rid = module_application_rid
         self._function_name = function_name
         self._function_args = function_args
@@ -48310,7 +48454,7 @@ The referenced module must be applied to the referenced asset.
         return self._function_name
 
     @builtins.property
-    def function_args(self) -> Dict[str, "scout_compute_api_VariableValue"]:
+    def function_args(self) -> Dict[str, "scout_compute_api_FunctionParameterValue"]:
         """Map of function input names to their values. The function inputs must match the function's parameter
 names and types. Because all function parameters have default values when the module is applied to the asset, this can be empty.
         """
@@ -48322,6 +48466,62 @@ scout_compute_api_ModuleApplicationDerivedSeries.__qualname__ = "ModuleApplicati
 scout_compute_api_ModuleApplicationDerivedSeries.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_ModuleVersionReference(ConjureUnionType):
+    _pinned: Optional["scout_compute_api_PinnedModuleVersionReference"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'pinned': ConjureFieldDefinition('pinned', scout_compute_api_PinnedModuleVersionReference)
+        }
+
+    def __init__(
+            self,
+            pinned: Optional["scout_compute_api_PinnedModuleVersionReference"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (pinned is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if pinned is not None:
+                self._pinned = pinned
+                self._type = 'pinned'
+
+        elif type_of_union == 'pinned':
+            if pinned is None:
+                raise ValueError('a union value must not be None')
+            self._pinned = pinned
+            self._type = 'pinned'
+
+    @builtins.property
+    def pinned(self) -> Optional["scout_compute_api_PinnedModuleVersionReference"]:
+        return self._pinned
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_compute_api_ModuleVersionReferenceVisitor):
+            raise ValueError('{} is not an instance of scout_compute_api_ModuleVersionReferenceVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'pinned' and self.pinned is not None:
+            return visitor._pinned(self.pinned)
+
+
+scout_compute_api_ModuleVersionReference.__name__ = "ModuleVersionReference"
+scout_compute_api_ModuleVersionReference.__qualname__ = "ModuleVersionReference"
+scout_compute_api_ModuleVersionReference.__module__ = "nominal_api.scout_compute_api"
+
+
+class scout_compute_api_ModuleVersionReferenceVisitor:
+
+    @abstractmethod
+    def _pinned(self, pinned: "scout_compute_api_PinnedModuleVersionReference") -> Any:
+        pass
+
+
+scout_compute_api_ModuleVersionReferenceVisitor.__name__ = "ModuleVersionReferenceVisitor"
+scout_compute_api_ModuleVersionReferenceVisitor.__qualname__ = "ModuleVersionReferenceVisitor"
+scout_compute_api_ModuleVersionReferenceVisitor.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_NegativeValueConfiguration(ConjureUnionType):
     _allow_negative_values: Optional["scout_compute_api_AllowNegativeValues"] = None
     _set_negative_values_to_zero: Optional["scout_compute_api_SetNegativeValuesToZero"] = None
@@ -50728,6 +50928,29 @@ scout_compute_api_PersistenceWindowConfiguration.__qualname__ = "PersistenceWind
 scout_compute_api_PersistenceWindowConfiguration.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_PinnedModuleVersionReference(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'version': ConjureFieldDefinition('version', scout_compute_api_StringConstant)
+        }
+
+    __slots__: List[str] = ['_version']
+
+    def __init__(self, version: "scout_compute_api_StringConstant") -> None:
+        self._version = version
+
+    @builtins.property
+    def version(self) -> "scout_compute_api_StringConstant":
+        return self._version
+
+
+scout_compute_api_PinnedModuleVersionReference.__name__ = "PinnedModuleVersionReference"
+scout_compute_api_PinnedModuleVersionReference.__qualname__ = "PinnedModuleVersionReference"
+scout_compute_api_PinnedModuleVersionReference.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_Point3d(ConjureBeanType):
 
     @builtins.classmethod
@@ -89208,14 +89431,16 @@ class themes_api_ChartThemeContentV1(ConjureBeanType):
             'legend_font_size': ConjureFieldDefinition('legendFontSize', int),
             'legend_font_color': ConjureFieldDefinition('legendFontColor', themes_api_HexColor),
             'legend_placement': ConjureFieldDefinition('legendPlacement', themes_api_LegendPlacement),
+            'row_gap_enabled': ConjureFieldDefinition('rowGapEnabled', bool),
+            'row_gap_size': ConjureFieldDefinition('rowGapSize', OptionalTypeWrapper[int]),
             'aspect_ratio_width': ConjureFieldDefinition('aspectRatioWidth', int),
             'aspect_ratio_height': ConjureFieldDefinition('aspectRatioHeight', int),
             'chart_type_themes': ConjureFieldDefinition('chartTypeThemes', themes_api_ChartTypeThemes)
         }
 
-    __slots__: List[str] = ['_title_enabled', '_title_alignment', '_title_font_size', '_title_font_color', '_caption_enabled', '_caption_alignment', '_caption_font_size', '_caption_font_color', '_background_enabled', '_legend_enabled', '_legend_position', '_legend_font_size', '_legend_font_color', '_legend_placement', '_aspect_ratio_width', '_aspect_ratio_height', '_chart_type_themes']
+    __slots__: List[str] = ['_title_enabled', '_title_alignment', '_title_font_size', '_title_font_color', '_caption_enabled', '_caption_alignment', '_caption_font_size', '_caption_font_color', '_background_enabled', '_legend_enabled', '_legend_position', '_legend_font_size', '_legend_font_color', '_legend_placement', '_row_gap_enabled', '_row_gap_size', '_aspect_ratio_width', '_aspect_ratio_height', '_chart_type_themes']
 
-    def __init__(self, aspect_ratio_height: int, aspect_ratio_width: int, background_enabled: bool, caption_alignment: "themes_api_TextAlignment", caption_enabled: bool, caption_font_color: str, caption_font_size: int, chart_type_themes: "themes_api_ChartTypeThemes", legend_enabled: bool, legend_font_color: str, legend_font_size: int, legend_placement: "themes_api_LegendPlacement", legend_position: "themes_api_LegendPosition", title_alignment: "themes_api_TextAlignment", title_enabled: bool, title_font_color: str, title_font_size: int) -> None:
+    def __init__(self, aspect_ratio_height: int, aspect_ratio_width: int, background_enabled: bool, caption_alignment: "themes_api_TextAlignment", caption_enabled: bool, caption_font_color: str, caption_font_size: int, chart_type_themes: "themes_api_ChartTypeThemes", legend_enabled: bool, legend_font_color: str, legend_font_size: int, legend_placement: "themes_api_LegendPlacement", legend_position: "themes_api_LegendPosition", row_gap_enabled: bool, title_alignment: "themes_api_TextAlignment", title_enabled: bool, title_font_color: str, title_font_size: int, row_gap_size: Optional[int] = None) -> None:
         self._title_enabled = title_enabled
         self._title_alignment = title_alignment
         self._title_font_size = title_font_size
@@ -89230,6 +89455,8 @@ class themes_api_ChartThemeContentV1(ConjureBeanType):
         self._legend_font_size = legend_font_size
         self._legend_font_color = legend_font_color
         self._legend_placement = legend_placement
+        self._row_gap_enabled = row_gap_enabled
+        self._row_gap_size = row_gap_size
         self._aspect_ratio_width = aspect_ratio_width
         self._aspect_ratio_height = aspect_ratio_height
         self._chart_type_themes = chart_type_themes
@@ -89319,6 +89546,18 @@ class themes_api_ChartThemeContentV1(ConjureBeanType):
         """
         return self._legend_placement
 
+    @builtins.property
+    def row_gap_enabled(self) -> bool:
+        """Whether rows will be separated.
+        """
+        return self._row_gap_enabled
+
+    @builtins.property
+    def row_gap_size(self) -> Optional[int]:
+        """The size of the row gap.
+        """
+        return self._row_gap_size
+
     @builtins.property
     def aspect_ratio_width(self) -> int:
         """The relative width of the chart export.
@@ -93838,6 +94077,8 @@ scout_compute_api_VariableName = str
 
 scout_datasource_connection_api_MeasurementName = str
 
+scout_compute_api_FunctionParameterName = str
+
 scout_compute_api_LocalVariableName = str
 
 scout_channelvariables_api_ChannelVariableName = str

{nominal_api-0.855.0 → nominal_api-0.856.0}/nominal_api/scout_compute_api/__init__.py

@@ -146,6 +146,10 @@ from .._impl import (
     scout_compute_api_FrequencyDomain as FrequencyDomain,
     scout_compute_api_FrequencyDomainPlot as FrequencyDomainPlot,
     scout_compute_api_FrequencyDomainVisitor as FrequencyDomainVisitor,
+    scout_compute_api_FunctionDerivedSeries as FunctionDerivedSeries,
+    scout_compute_api_FunctionParameterName as FunctionParameterName,
+    scout_compute_api_FunctionParameterValue as FunctionParameterValue,
+    scout_compute_api_FunctionParameterValueVisitor as FunctionParameterValueVisitor,
     scout_compute_api_FunctionReference as FunctionReference,
     scout_compute_api_FunctionVariables as FunctionVariables,
     scout_compute_api_GeoPoint as GeoPoint,
@@ -201,6 +205,8 @@ from .._impl import (
     scout_compute_api_MinSeries as MinSeries,
     scout_compute_api_Minimum as Minimum,
     scout_compute_api_ModuleApplicationDerivedSeries as ModuleApplicationDerivedSeries,
+    scout_compute_api_ModuleVersionReference as ModuleVersionReference,
+    scout_compute_api_ModuleVersionReferenceVisitor as ModuleVersionReferenceVisitor,
     scout_compute_api_NegativeValueConfiguration as NegativeValueConfiguration,
     scout_compute_api_NegativeValueConfigurationVisitor as NegativeValueConfigurationVisitor,
     scout_compute_api_NotRanges as NotRanges,
@@ -250,6 +256,7 @@ from .._impl import (
     scout_compute_api_Periodogram as Periodogram,
     scout_compute_api_PeriodogramMethod as PeriodogramMethod,
     scout_compute_api_PersistenceWindowConfiguration as PersistenceWindowConfiguration,
+    scout_compute_api_PinnedModuleVersionReference as PinnedModuleVersionReference,
     scout_compute_api_Point3d as Point3d,
     scout_compute_api_PolynomialCurve as PolynomialCurve,
     scout_compute_api_PolynomialResultDetails as PolynomialResultDetails,
@@ -500,6 +507,10 @@ __all__ = [
     'FrequencyDomain',
     'FrequencyDomainVisitor',
     'FrequencyDomainPlot',
+    'FunctionDerivedSeries',
+    'FunctionParameterName',
+    'FunctionParameterValue',
+    'FunctionParameterValueVisitor',
     'FunctionReference',
     'FunctionVariables',
     'GeoPoint',
@@ -555,6 +566,8 @@ __all__ = [
     'MinSeries',
     'Minimum',
     'ModuleApplicationDerivedSeries',
+    'ModuleVersionReference',
+    'ModuleVersionReferenceVisitor',
     'NegativeValueConfiguration',
     'NegativeValueConfigurationVisitor',
     'NotRanges',
@@ -604,6 +617,7 @@ __all__ = [
     'Periodogram',
     'PeriodogramMethod',
     'PersistenceWindowConfiguration',
+    'PinnedModuleVersionReference',
     'Point3d',
     'PolynomialCurve',
     'PolynomialResultDetails',

{nominal_api-0.855.0 → nominal_api-0.856.0}/nominal_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nominal-api
-Version: 0.855.0
+Version: 0.856.0
 Requires-Python: >=3.8
 Requires-Dist: requests
 Requires-Dist: conjure-python-client<4,>=2.8.0

{nominal_api-0.855.0 → nominal_api-0.856.0}/setup.py

@@ -6,7 +6,7 @@ from setuptools import (
 
 setup(
     name='nominal-api',
-    version='0.855.0',
+    version='0.856.0',
     python_requires='>=3.8',
     package_data={"": ["py.typed"]},
     packages=find_packages(),