nominal-api 0.539.0__py3-none-any.whl → 0.540.0__py3-none-any.whl

nominal_api/__init__.py

@@ -68,5 +68,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.539.0"
+__version__ = "0.540.0"
 

nominal_api/_impl.py

@@ -189,6 +189,8 @@ class api_SeriesDataType(ConjureEnumType):
     '''DOUBLE'''
     STRING = 'STRING'
     '''STRING'''
+    LOG = 'LOG'
+    '''LOG'''
     UNKNOWN = 'UNKNOWN'
     '''UNKNOWN'''
 
@@ -18968,23 +18970,41 @@ class scout_chartdefinition_api_RangeRawVisualisation(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'range_color': ConjureFieldDefinition('rangeColor', OptionalTypeWrapper[scout_api_HexColor]),
-            'no_range_color': ConjureFieldDefinition('noRangeColor', OptionalTypeWrapper[scout_api_HexColor])
+            'range_label': ConjureFieldDefinition('rangeLabel', OptionalTypeWrapper[str]),
+            'no_range_color': ConjureFieldDefinition('noRangeColor', OptionalTypeWrapper[scout_api_HexColor]),
+            'no_range_label': ConjureFieldDefinition('noRangeLabel', OptionalTypeWrapper[str])
         }
 
-    __slots__: List[str] = ['_range_color', '_no_range_color']
+    __slots__: List[str] = ['_range_color', '_range_label', '_no_range_color', '_no_range_label']
 
-    def __init__(self, no_range_color: Optional[str] = None, range_color: Optional[str] = None) -> None:
+    def __init__(self, no_range_color: Optional[str] = None, no_range_label: Optional[str] = None, range_color: Optional[str] = None, range_label: Optional[str] = None) -> None:
         self._range_color = range_color
+        self._range_label = range_label
         self._no_range_color = no_range_color
+        self._no_range_label = no_range_label
 
     @builtins.property
     def range_color(self) -> Optional[str]:
         return self._range_color
 
+    @builtins.property
+    def range_label(self) -> Optional[str]:
+        """
+        The string to display when the condition defined by the variable's function spec is met.
+        """
+        return self._range_label
+
     @builtins.property
     def no_range_color(self) -> Optional[str]:
         return self._no_range_color
 
+    @builtins.property
+    def no_range_label(self) -> Optional[str]:
+        """
+        The string to display when the condition defined by the variable's function spec is not met.
+        """
+        return self._no_range_label
+
 
 scout_chartdefinition_api_RangeRawVisualisation.__name__ = "RangeRawVisualisation"
 scout_chartdefinition_api_RangeRawVisualisation.__qualname__ = "RangeRawVisualisation"
@@ -63144,6 +63164,8 @@ class storage_series_api_NominalDataType(ConjureEnumType):
     '''DOUBLE'''
     STRING = 'STRING'
     '''STRING'''
+    LOG = 'LOG'
+    '''LOG'''
     UNKNOWN = 'UNKNOWN'
     '''UNKNOWN'''
 
@@ -63651,6 +63673,70 @@ storage_writer_api_DoublePoint.__qualname__ = "DoublePoint"
 storage_writer_api_DoublePoint.__module__ = "nominal_api.storage_writer_api"
 
 
+class storage_writer_api_LogPoint(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'timestamp': ConjureFieldDefinition('timestamp', api_Timestamp),
+            'value': ConjureFieldDefinition('value', storage_writer_api_LogValue)
+        }
+
+    __slots__: List[str] = ['_timestamp', '_value']
+
+    def __init__(self, timestamp: "api_Timestamp", value: "storage_writer_api_LogValue") -> None:
+        self._timestamp = timestamp
+        self._value = value
+
+    @builtins.property
+    def timestamp(self) -> "api_Timestamp":
+        return self._timestamp
+
+    @builtins.property
+    def value(self) -> "storage_writer_api_LogValue":
+        return self._value
+
+
+storage_writer_api_LogPoint.__name__ = "LogPoint"
+storage_writer_api_LogPoint.__qualname__ = "LogPoint"
+storage_writer_api_LogPoint.__module__ = "nominal_api.storage_writer_api"
+
+
+class storage_writer_api_LogValue(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'raw': ConjureFieldDefinition('raw', str),
+            'message': ConjureFieldDefinition('message', OptionalTypeWrapper[str]),
+            'args': ConjureFieldDefinition('args', Dict[str, str])
+        }
+
+    __slots__: List[str] = ['_raw', '_message', '_args']
+
+    def __init__(self, args: Dict[str, str], raw: str, message: Optional[str] = None) -> None:
+        self._raw = raw
+        self._message = message
+        self._args = args
+
+    @builtins.property
+    def raw(self) -> str:
+        return self._raw
+
+    @builtins.property
+    def message(self) -> Optional[str]:
+        return self._message
+
+    @builtins.property
+    def args(self) -> Dict[str, str]:
+        return self._args
+
+
+storage_writer_api_LogValue.__name__ = "LogValue"
+storage_writer_api_LogValue.__qualname__ = "LogValue"
+storage_writer_api_LogValue.__module__ = "nominal_api.storage_writer_api"
+
+
 class storage_writer_api_NominalChannelWriterService(Service):
     """
     Write data points to Nominal data sources.
@@ -63887,22 +63973,25 @@ storage_writer_api_NominalChannelWriterService.__module__ = "nominal_api.storage
 class storage_writer_api_Points(ConjureUnionType):
     _string: Optional[List["storage_writer_api_StringPoint"]] = None
     _double: Optional[List["storage_writer_api_DoublePoint"]] = None
+    _log: Optional[List["storage_writer_api_LogPoint"]] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'string': ConjureFieldDefinition('string', List[storage_writer_api_StringPoint]),
-            'double': ConjureFieldDefinition('double', List[storage_writer_api_DoublePoint])
+            'double': ConjureFieldDefinition('double', List[storage_writer_api_DoublePoint]),
+            'log': ConjureFieldDefinition('log', List[storage_writer_api_LogPoint])
         }
 
     def __init__(
             self,
             string: Optional[List["storage_writer_api_StringPoint"]] = None,
             double: Optional[List["storage_writer_api_DoublePoint"]] = None,
+            log: Optional[List["storage_writer_api_LogPoint"]] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (string is not None) + (double is not None) != 1:
+            if (string is not None) + (double is not None) + (log is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if string is not None:
@@ -63911,6 +64000,9 @@ class storage_writer_api_Points(ConjureUnionType):
             if double is not None:
                 self._double = double
                 self._type = 'double'
+            if log is not None:
+                self._log = log
+                self._type = 'log'
 
         elif type_of_union == 'string':
             if string is None:
@@ -63922,6 +64014,11 @@ class storage_writer_api_Points(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._double = double
             self._type = 'double'
+        elif type_of_union == 'log':
+            if log is None:
+                raise ValueError('a union value must not be None')
+            self._log = log
+            self._type = 'log'
 
     @builtins.property
     def string(self) -> Optional[List["storage_writer_api_StringPoint"]]:
@@ -63931,6 +64028,13 @@ class storage_writer_api_Points(ConjureUnionType):
     def double(self) -> Optional[List["storage_writer_api_DoublePoint"]]:
         return self._double
 
+    @builtins.property
+    def log(self) -> Optional[List["storage_writer_api_LogPoint"]]:
+        """
+        Log points are not yet supported. Sending log points will result in an error.
+        """
+        return self._log
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, storage_writer_api_PointsVisitor):
             raise ValueError('{} is not an instance of storage_writer_api_PointsVisitor'.format(visitor.__class__.__name__))
@@ -63938,6 +64042,8 @@ class storage_writer_api_Points(ConjureUnionType):
             return visitor._string(self.string)
         if self._type == 'double' and self.double is not None:
             return visitor._double(self.double)
+        if self._type == 'log' and self.log is not None:
+            return visitor._log(self.log)
 
 
 storage_writer_api_Points.__name__ = "Points"
@@ -63955,6 +64061,10 @@ class storage_writer_api_PointsVisitor:
     def _double(self, double: List["storage_writer_api_DoublePoint"]) -> Any:
         pass
 
+    @abstractmethod
+    def _log(self, log: List["storage_writer_api_LogPoint"]) -> Any:
+        pass
+
 
 storage_writer_api_PointsVisitor.__name__ = "PointsVisitor"
 storage_writer_api_PointsVisitor.__qualname__ = "PointsVisitor"
@@ -66932,6 +67042,8 @@ class timeseries_logicalseries_api_NominalType(ConjureEnumType):
     '''DOUBLE'''
     STRING = 'STRING'
     '''STRING'''
+    LOG = 'LOG'
+    '''LOG'''
     UNKNOWN = 'UNKNOWN'
     '''UNKNOWN'''
 

nominal_api/storage_writer_api/__init__.py

@@ -3,6 +3,8 @@ from .._impl import (
     storage_writer_api_DirectNominalChannelWriterService as DirectNominalChannelWriterService,
     storage_writer_api_DoublePoint as DoublePoint,
     storage_writer_api_Field as Field,
+    storage_writer_api_LogPoint as LogPoint,
+    storage_writer_api_LogValue as LogValue,
     storage_writer_api_MeasurementName as MeasurementName,
     storage_writer_api_NominalChannelWriterService as NominalChannelWriterService,
     storage_writer_api_Points as Points,

{nominal_api-0.539.0.dist-info → nominal_api-0.540.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: nominal-api
-Version: 0.539.0
+Version: 0.540.0
 Requires-Python: >=3.8
 Requires-Dist: requests
 Requires-Dist: conjure-python-client<3,>=2.8.0

{nominal_api-0.539.0.dist-info → nominal_api-0.540.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=2ATPwb0_50YuMB7OQEW_Tp23VPSDHS8GHaZgl1sVmtE,1762
-nominal_api/_impl.py,sha256=vS8ltkft8U8jpRSfKmMQCBRERVgyV2usv3o2MwwUJB0,2643996
+nominal_api/__init__.py,sha256=PgTMWZrSjdtP3Ira9hG2bMy7Qdz6N5XzwHZSc3xDXuc,1762
+nominal_api/_impl.py,sha256=6DO_xexkB3gQLyqfog5kXBFedWdBdddSQkC7H1cI8fE,2647850
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=CaUmWhW0zcP8jVWFQEgj-lpoBi-Unm0wBd2s9dPeWmo,656
 nominal_api/api_rids/__init__.py,sha256=p7dKiMV692oGtYStr5FZJEJNg3YbF7scJK1WFMpBiW0,298
@@ -56,7 +56,7 @@ nominal_api/scout_workbookcommon_api/__init__.py,sha256=yXWeUKKqU_e08ZfkMZ4gKNUV
 nominal_api/secrets_api/__init__.py,sha256=cHYclGHqwCiu42M3grXjeoxLG4FLC0pIqZfx_ZsiB40,950
 nominal_api/storage_datasource_api/__init__.py,sha256=rPs4MPAqfdzQVatoTmebjBLvsFfpl2eKW0oLvXmkkOc,352
 nominal_api/storage_series_api/__init__.py,sha256=HapfYMCap8kDYXh7_kjsdywLqwterOB0OdVUyU3QZz8,829
-nominal_api/storage_writer_api/__init__.py,sha256=cvrJv-Vjmt9HfdXKIBGRPBdmlbwsLiWfn8tydflIvJY,774
+nominal_api/storage_writer_api/__init__.py,sha256=_yiTu5SKCx7VQBRMDmF_K8O3a4Pp_sgD1wZQeRtg_Zg,864
 nominal_api/themes_api/__init__.py,sha256=w-G93T5f6_2zSSUi-ffyUHxH8QA_2oI9jM7YBSMFpwY,924
 nominal_api/timeseries_archetype/__init__.py,sha256=eKdgdZoOcZg_9pmec6J86NlgQdhxhi1282WUAFxghJ8,115
 nominal_api/timeseries_archetype_api/__init__.py,sha256=IREibRlChT9ugCAkeMKm7RiAChsKV4KJZ-DcKkVLC_U,1396
@@ -65,7 +65,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=wr83ByQTVVPOGvbB_KWL
 nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=YLixotb-W-adYR6t_RBsJDwoHttppkOBesoaXERwhVs,1240
 nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
-nominal_api-0.539.0.dist-info/METADATA,sha256=elpzay81eGjW2ZvW9hZHBMbQwcOmqoDKFM54MU0SulA,199
-nominal_api-0.539.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-nominal_api-0.539.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.539.0.dist-info/RECORD,,
+nominal_api-0.540.0.dist-info/METADATA,sha256=BuGm9tNrGHFj_0__l8Igv8Mplwf6qeoMx2GNETWLX38,199
+nominal_api-0.540.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+nominal_api-0.540.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.540.0.dist-info/RECORD,,