nominal-api 0.915.0__py3-none-any.whl → 0.916.1__py3-none-any.whl

nominal_api/__init__.py

@@ -81,5 +81,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.915.0"
+__version__ = "0.916.1"
 

nominal_api/_impl.py

@@ -14405,27 +14405,27 @@ class module_CreateModuleRequest(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'name': ConjureFieldDefinition('name', str),
+            'api_name': ConjureFieldDefinition('apiName', str),
             'title': ConjureFieldDefinition('title', str),
             'description': ConjureFieldDefinition('description', str),
             'definition': ConjureFieldDefinition('definition', module_ModuleVersionDefinition),
             'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_rids_WorkspaceRid])
         }
 
-    __slots__: List[str] = ['_name', '_title', '_description', '_definition', '_workspace']
+    __slots__: List[str] = ['_api_name', '_title', '_description', '_definition', '_workspace']
 
-    def __init__(self, definition: "module_ModuleVersionDefinition", description: str, name: str, title: str, workspace: Optional[str] = None) -> None:
-        self._name = name
+    def __init__(self, api_name: str, definition: "module_ModuleVersionDefinition", description: str, title: str, workspace: Optional[str] = None) -> None:
+        self._api_name = api_name
         self._title = title
         self._description = description
         self._definition = definition
         self._workspace = workspace
 
     @builtins.property
-    def name(self) -> str:
-        """The name of the module. This should be unique to the module in the current workspace.
+    def api_name(self) -> str:
+        """The API name for the module. This string will uniquely identify the module within the organization.
         """
-        return self._name
+        return self._api_name
 
     @builtins.property
     def title(self) -> str:
@@ -14456,18 +14456,18 @@ class module_DerivedSeriesMetadata(ConjureBeanType):
         return {
             'function_name': ConjureFieldDefinition('functionName', str),
             'function_description': ConjureFieldDefinition('functionDescription', str),
-            'module_name': ConjureFieldDefinition('moduleName', str),
+            'module_api_name': ConjureFieldDefinition('moduleApiName', str),
             'module_application_rid': ConjureFieldDefinition('moduleApplicationRid', modules_api_ModuleApplicationRid),
             'application_resolved_parameters': ConjureFieldDefinition('applicationResolvedParameters', List[module_ModuleVariable]),
             'data_type': ConjureFieldDefinition('dataType', module_ValueType)
         }
 
-    __slots__: List[str] = ['_function_name', '_function_description', '_module_name', '_module_application_rid', '_application_resolved_parameters', '_data_type']
+    __slots__: List[str] = ['_function_name', '_function_description', '_module_api_name', '_module_application_rid', '_application_resolved_parameters', '_data_type']
 
-    def __init__(self, application_resolved_parameters: List["module_ModuleVariable"], data_type: "module_ValueType", function_description: str, function_name: str, module_application_rid: str, module_name: str) -> None:
+    def __init__(self, application_resolved_parameters: List["module_ModuleVariable"], data_type: "module_ValueType", function_description: str, function_name: str, module_api_name: str, module_application_rid: str) -> None:
         self._function_name = function_name
         self._function_description = function_description
-        self._module_name = module_name
+        self._module_api_name = module_api_name
         self._module_application_rid = module_application_rid
         self._application_resolved_parameters = application_resolved_parameters
         self._data_type = data_type
@@ -14481,8 +14481,8 @@ class module_DerivedSeriesMetadata(ConjureBeanType):
         return self._function_description
 
     @builtins.property
-    def module_name(self) -> str:
-        return self._module_name
+    def module_api_name(self) -> str:
+        return self._module_api_name
 
     @builtins.property
     def module_application_rid(self) -> str:
@@ -14875,7 +14875,7 @@ class module_ModuleMetadata(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'rid': ConjureFieldDefinition('rid', modules_api_ModuleRid),
-            'name': ConjureFieldDefinition('name', str),
+            'api_name': ConjureFieldDefinition('apiName', str),
             'title': ConjureFieldDefinition('title', str),
             'description': ConjureFieldDefinition('description', str),
             'created_by': ConjureFieldDefinition('createdBy', scout_rids_api_UserRid),
@@ -14883,11 +14883,11 @@ class module_ModuleMetadata(ConjureBeanType):
             'archived_at': ConjureFieldDefinition('archivedAt', OptionalTypeWrapper[str])
         }
 
-    __slots__: List[str] = ['_rid', '_name', '_title', '_description', '_created_by', '_created_at', '_archived_at']
+    __slots__: List[str] = ['_rid', '_api_name', '_title', '_description', '_created_by', '_created_at', '_archived_at']
 
-    def __init__(self, created_at: str, created_by: str, description: str, name: str, rid: str, title: str, archived_at: Optional[str] = None) -> None:
+    def __init__(self, api_name: str, created_at: str, created_by: str, description: str, rid: str, title: str, archived_at: Optional[str] = None) -> None:
         self._rid = rid
-        self._name = name
+        self._api_name = api_name
         self._title = title
         self._description = description
         self._created_by = created_by
@@ -14899,11 +14899,11 @@ class module_ModuleMetadata(ConjureBeanType):
         return self._rid
 
     @builtins.property
-    def name(self) -> str:
-        """The API name for the module. This uniquely identifies the module within the org.
+    def api_name(self) -> str:
+        """This uniquely identifies the module within the org.
 Note that this cannot be changed after creation.
         """
-        return self._name
+        return self._api_name
 
     @builtins.property
     def title(self) -> str:
@@ -14968,15 +14968,15 @@ class module_ModuleRef(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'rid': ConjureFieldDefinition('rid', modules_api_ModuleRid),
-            'name': ConjureFieldDefinition('name', str),
+            'api_name': ConjureFieldDefinition('apiName', str),
             'version': ConjureFieldDefinition('version', module_ModuleVersion)
         }
 
-    __slots__: List[str] = ['_rid', '_name', '_version']
+    __slots__: List[str] = ['_rid', '_api_name', '_version']
 
-    def __init__(self, name: str, rid: str, version: str) -> None:
+    def __init__(self, api_name: str, rid: str, version: str) -> None:
         self._rid = rid
-        self._name = name
+        self._api_name = api_name
         self._version = version
 
     @builtins.property
@@ -14984,8 +14984,8 @@ class module_ModuleRef(ConjureBeanType):
         return self._rid
 
     @builtins.property
-    def name(self) -> str:
-        return self._name
+    def api_name(self) -> str:
+        return self._api_name
 
     @builtins.property
     def version(self) -> str:
@@ -14999,7 +14999,7 @@ module_ModuleRef.__module__ = "nominal_api.module"
 
 class module_ModuleService(Service):
     """Modules define collections of compute logic that can be shared and used across different contexts by applying them
-to assets. The Modules Service provides the api for managing these collections and using them.
+to assets. The Modules Service provides the API for managing these collections and using them.
     """
 
     def create_module(self, auth_header: str, request: "module_CreateModuleRequest") -> "module_Module":
@@ -15536,19 +15536,19 @@ class module_RequestModuleNameRef(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'name': ConjureFieldDefinition('name', str),
+            'api_name': ConjureFieldDefinition('apiName', str),
             'version_strategy': ConjureFieldDefinition('versionStrategy', module_VersionStrategy)
         }
 
-    __slots__: List[str] = ['_name', '_version_strategy']
+    __slots__: List[str] = ['_api_name', '_version_strategy']
 
-    def __init__(self, name: str, version_strategy: "module_VersionStrategy") -> None:
-        self._name = name
+    def __init__(self, api_name: str, version_strategy: "module_VersionStrategy") -> None:
+        self._api_name = api_name
         self._version_strategy = version_strategy
 
     @builtins.property
-    def name(self) -> str:
-        return self._name
+    def api_name(self) -> str:
+        return self._api_name
 
     @builtins.property
     def version_strategy(self) -> "module_VersionStrategy":
@@ -16544,25 +16544,25 @@ class module_internal_ModuleComputeDefinition(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'module_name': ConjureFieldDefinition('moduleName', str),
+            'module_api_name': ConjureFieldDefinition('moduleApiName', str),
             'module_rid': ConjureFieldDefinition('moduleRid', modules_api_ModuleRid),
             'version': ConjureFieldDefinition('version', module_ModuleVersion),
             'default_variables': ConjureFieldDefinition('defaultVariables', List[module_ModuleVariable]),
             'functions': ConjureFieldDefinition('functions', List[module_Function])
         }
 
-    __slots__: List[str] = ['_module_name', '_module_rid', '_version', '_default_variables', '_functions']
+    __slots__: List[str] = ['_module_api_name', '_module_rid', '_version', '_default_variables', '_functions']
 
-    def __init__(self, default_variables: List["module_ModuleVariable"], functions: List["module_Function"], module_name: str, module_rid: str, version: str) -> None:
-        self._module_name = module_name
+    def __init__(self, default_variables: List["module_ModuleVariable"], functions: List["module_Function"], module_api_name: str, module_rid: str, version: str) -> None:
+        self._module_api_name = module_api_name
         self._module_rid = module_rid
         self._version = version
         self._default_variables = default_variables
         self._functions = functions
 
     @builtins.property
-    def module_name(self) -> str:
-        return self._module_name
+    def module_api_name(self) -> str:
+        return self._module_api_name
 
     @builtins.property
     def module_rid(self) -> str:
@@ -50757,6 +50757,46 @@ scout_compute_api_OutputRangeStartVisitor.__qualname__ = "OutputRangeStartVisito
 scout_compute_api_OutputRangeStartVisitor.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_PaddedRanges(ConjureBeanType):
+    """Expands ranges durations by adding temporal padding to the start, end, or both sides. Note that if the input
+ranges contain a RangeValue, it will be dropped.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'input': ConjureFieldDefinition('input', scout_compute_api_RangeSeries),
+            'padding': ConjureFieldDefinition('padding', scout_compute_api_DurationConstant),
+            'padding_configuration': ConjureFieldDefinition('paddingConfiguration', OptionalTypeWrapper[scout_compute_api_RangePaddingConfiguration])
+        }
+
+    __slots__: List[str] = ['_input', '_padding', '_padding_configuration']
+
+    def __init__(self, input: "scout_compute_api_RangeSeries", padding: "scout_compute_api_DurationConstant", padding_configuration: Optional["scout_compute_api_RangePaddingConfiguration"] = None) -> None:
+        self._input = input
+        self._padding = padding
+        self._padding_configuration = padding_configuration
+
+    @builtins.property
+    def input(self) -> "scout_compute_api_RangeSeries":
+        return self._input
+
+    @builtins.property
+    def padding(self) -> "scout_compute_api_DurationConstant":
+        return self._padding
+
+    @builtins.property
+    def padding_configuration(self) -> Optional["scout_compute_api_RangePaddingConfiguration"]:
+        """Configuration for how to apply padding to the ranges. Defaults to PAD_START_AND_END if not specified.
+        """
+        return self._padding_configuration
+
+
+scout_compute_api_PaddedRanges.__name__ = "PaddedRanges"
+scout_compute_api_PaddedRanges.__qualname__ = "PaddedRanges"
+scout_compute_api_PaddedRanges.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_PageInfo(ConjureBeanType):
     """Specification of a page for a series. Returns raw undecimated points beginning nearest to the given page
 token, advancing pageSize points in the time direction specified by the sign of the page size.
@@ -51904,6 +51944,26 @@ scout_compute_api_RangeMap.__qualname__ = "RangeMap"
 scout_compute_api_RangeMap.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_RangePaddingConfiguration(ConjureEnumType):
+
+    PAD_START = 'PAD_START'
+    '''PAD_START'''
+    PAD_END = 'PAD_END'
+    '''PAD_END'''
+    PAD_START_AND_END = 'PAD_START_AND_END'
+    '''PAD_START_AND_END'''
+    UNKNOWN = 'UNKNOWN'
+    '''UNKNOWN'''
+
+    def __reduce_ex__(self, proto):
+        return self.__class__, (self.name,)
+
+
+scout_compute_api_RangePaddingConfiguration.__name__ = "RangePaddingConfiguration"
+scout_compute_api_RangePaddingConfiguration.__qualname__ = "RangePaddingConfiguration"
+scout_compute_api_RangePaddingConfiguration.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_RangeSeries(ConjureUnionType):
     _approximate_threshold: Optional["scout_compute_api_ApproximateThresholdRanges"] = None
     _duration_filter: Optional["scout_compute_api_DurationFilterRanges"] = None
@@ -51925,6 +51985,7 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
     _stale_range: Optional["scout_compute_api_StaleRanges"] = None
     _threshold: Optional["scout_compute_api_ThresholdingRanges"] = None
     _union_range: Optional["scout_compute_api_UnionRanges"] = None
+    _padded_ranges: Optional["scout_compute_api_PaddedRanges"] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -51948,7 +52009,8 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
             'stability_detection': ConjureFieldDefinition('stabilityDetection', scout_compute_api_StabilityDetectionRanges),
             'stale_range': ConjureFieldDefinition('staleRange', scout_compute_api_StaleRanges),
             'threshold': ConjureFieldDefinition('threshold', scout_compute_api_ThresholdingRanges),
-            'union_range': ConjureFieldDefinition('unionRange', scout_compute_api_UnionRanges)
+            'union_range': ConjureFieldDefinition('unionRange', scout_compute_api_UnionRanges),
+            'padded_ranges': ConjureFieldDefinition('paddedRanges', scout_compute_api_PaddedRanges)
         }
 
     def __init__(
@@ -51973,10 +52035,11 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
             stale_range: Optional["scout_compute_api_StaleRanges"] = None,
             threshold: Optional["scout_compute_api_ThresholdingRanges"] = None,
             union_range: Optional["scout_compute_api_UnionRanges"] = None,
+            padded_ranges: Optional["scout_compute_api_PaddedRanges"] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (approximate_threshold is not None) + (duration_filter is not None) + (enum_filter is not None) + (enum_series_equality_ranges_node is not None) + (events_search is not None) + (intersect_range is not None) + (literal_ranges is not None) + (min_max_threshold is not None) + (not_ is not None) + (on_change is not None) + (peak is not None) + (range_numeric_aggregation is not None) + (raw is not None) + (derived is not None) + (series_crossover_ranges_node is not None) + (series_equality_ranges_node is not None) + (stability_detection is not None) + (stale_range is not None) + (threshold is not None) + (union_range is not None) != 1:
+            if (approximate_threshold is not None) + (duration_filter is not None) + (enum_filter is not None) + (enum_series_equality_ranges_node is not None) + (events_search is not None) + (intersect_range is not None) + (literal_ranges is not None) + (min_max_threshold is not None) + (not_ is not None) + (on_change is not None) + (peak is not None) + (range_numeric_aggregation is not None) + (raw is not None) + (derived is not None) + (series_crossover_ranges_node is not None) + (series_equality_ranges_node is not None) + (stability_detection is not None) + (stale_range is not None) + (threshold is not None) + (union_range is not None) + (padded_ranges is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if approximate_threshold is not None:
@@ -52039,6 +52102,9 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
             if union_range is not None:
                 self._union_range = union_range
                 self._type = 'unionRange'
+            if padded_ranges is not None:
+                self._padded_ranges = padded_ranges
+                self._type = 'paddedRanges'
 
         elif type_of_union == 'approximateThreshold':
             if approximate_threshold is None:
@@ -52140,6 +52206,11 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._union_range = union_range
             self._type = 'unionRange'
+        elif type_of_union == 'paddedRanges':
+            if padded_ranges is None:
+                raise ValueError('a union value must not be None')
+            self._padded_ranges = padded_ranges
+            self._type = 'paddedRanges'
 
     @builtins.property
     def approximate_threshold(self) -> Optional["scout_compute_api_ApproximateThresholdRanges"]:
@@ -52225,6 +52296,10 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
     def union_range(self) -> Optional["scout_compute_api_UnionRanges"]:
         return self._union_range
 
+    @builtins.property
+    def padded_ranges(self) -> Optional["scout_compute_api_PaddedRanges"]:
+        return self._padded_ranges
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, scout_compute_api_RangeSeriesVisitor):
             raise ValueError('{} is not an instance of scout_compute_api_RangeSeriesVisitor'.format(visitor.__class__.__name__))
@@ -52268,6 +52343,8 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
             return visitor._threshold(self.threshold)
         if self._type == 'unionRange' and self.union_range is not None:
             return visitor._union_range(self.union_range)
+        if self._type == 'paddedRanges' and self.padded_ranges is not None:
+            return visitor._padded_ranges(self.padded_ranges)
 
 
 scout_compute_api_RangeSeries.__name__ = "RangeSeries"
@@ -52357,6 +52434,10 @@ class scout_compute_api_RangeSeriesVisitor:
     def _union_range(self, union_range: "scout_compute_api_UnionRanges") -> Any:
         pass
 
+    @abstractmethod
+    def _padded_ranges(self, padded_ranges: "scout_compute_api_PaddedRanges") -> Any:
+        pass
+
 
 scout_compute_api_RangeSeriesVisitor.__name__ = "RangeSeriesVisitor"
 scout_compute_api_RangeSeriesVisitor.__qualname__ = "RangeSeriesVisitor"
@@ -53053,41 +53134,58 @@ scout_compute_api_ScatterFitOptions.__module__ = "nominal_api.scout_compute_api"
 
 class scout_compute_api_ScatterSummarizationStrategy(ConjureUnionType):
     _spatial: Optional["scout_compute_api_SpatialDecimateStrategy"] = None
+    _temporal: Optional["scout_compute_api_TemporalDecimateStrategy"] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'spatial': ConjureFieldDefinition('spatial', scout_compute_api_SpatialDecimateStrategy)
+            'spatial': ConjureFieldDefinition('spatial', scout_compute_api_SpatialDecimateStrategy),
+            'temporal': ConjureFieldDefinition('temporal', scout_compute_api_TemporalDecimateStrategy)
         }
 
     def __init__(
             self,
             spatial: Optional["scout_compute_api_SpatialDecimateStrategy"] = None,
+            temporal: Optional["scout_compute_api_TemporalDecimateStrategy"] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (spatial is not None) != 1:
+            if (spatial is not None) + (temporal is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if spatial is not None:
                 self._spatial = spatial
                 self._type = 'spatial'
+            if temporal is not None:
+                self._temporal = temporal
+                self._type = 'temporal'
 
         elif type_of_union == 'spatial':
             if spatial is None:
                 raise ValueError('a union value must not be None')
             self._spatial = spatial
             self._type = 'spatial'
+        elif type_of_union == 'temporal':
+            if temporal is None:
+                raise ValueError('a union value must not be None')
+            self._temporal = temporal
+            self._type = 'temporal'
 
     @builtins.property
     def spatial(self) -> Optional["scout_compute_api_SpatialDecimateStrategy"]:
         return self._spatial
 
+    @builtins.property
+    def temporal(self) -> Optional["scout_compute_api_TemporalDecimateStrategy"]:
+        return self._temporal
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, scout_compute_api_ScatterSummarizationStrategyVisitor):
             raise ValueError('{} is not an instance of scout_compute_api_ScatterSummarizationStrategyVisitor'.format(visitor.__class__.__name__))
         if self._type == 'spatial' and self.spatial is not None:
             return visitor._spatial(self.spatial)
+        if self._type == 'temporal' and self.temporal is not None:
+            return visitor._temporal(self.temporal)
 
 
 scout_compute_api_ScatterSummarizationStrategy.__name__ = "ScatterSummarizationStrategy"
@@ -53101,12 +53199,40 @@ class scout_compute_api_ScatterSummarizationStrategyVisitor:
     def _spatial(self, spatial: "scout_compute_api_SpatialDecimateStrategy") -> Any:
         pass
 
+    @abstractmethod
+    def _temporal(self, temporal: "scout_compute_api_TemporalDecimateStrategy") -> Any:
+        pass
+
 
 scout_compute_api_ScatterSummarizationStrategyVisitor.__name__ = "ScatterSummarizationStrategyVisitor"
 scout_compute_api_ScatterSummarizationStrategyVisitor.__qualname__ = "ScatterSummarizationStrategyVisitor"
 scout_compute_api_ScatterSummarizationStrategyVisitor.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_ScatterTemporalAggregation(ConjureEnumType):
+
+    MEAN = 'MEAN'
+    '''MEAN'''
+    MIN = 'MIN'
+    '''MIN'''
+    MAX = 'MAX'
+    '''MAX'''
+    FIRST = 'FIRST'
+    '''FIRST'''
+    LAST = 'LAST'
+    '''LAST'''
+    UNKNOWN = 'UNKNOWN'
+    '''UNKNOWN'''
+
+    def __reduce_ex__(self, proto):
+        return self.__class__, (self.name,)
+
+
+scout_compute_api_ScatterTemporalAggregation.__name__ = "ScatterTemporalAggregation"
+scout_compute_api_ScatterTemporalAggregation.__qualname__ = "ScatterTemporalAggregation"
+scout_compute_api_ScatterTemporalAggregation.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_SearchEventOriginType(ConjureEnumType):
 
     WORKBOOK = 'WORKBOOK'
@@ -54323,14 +54449,16 @@ class scout_compute_api_SummarizeCartesian(ConjureBeanType):
         return {
             'input': ConjureFieldDefinition('input', scout_compute_api_Cartesian),
             'bounds': ConjureFieldDefinition('bounds', OptionalTypeWrapper[scout_compute_api_CartesianBounds]),
+            'summarization_strategy': ConjureFieldDefinition('summarizationStrategy', OptionalTypeWrapper[scout_compute_api_ScatterSummarizationStrategy]),
             'max_points': ConjureFieldDefinition('maxPoints', OptionalTypeWrapper[int])
         }
 
-    __slots__: List[str] = ['_input', '_bounds', '_max_points']
+    __slots__: List[str] = ['_input', '_bounds', '_summarization_strategy', '_max_points']
 
-    def __init__(self, input: "scout_compute_api_Cartesian", bounds: Optional["scout_compute_api_CartesianBounds"] = None, max_points: Optional[int] = None) -> None:
+    def __init__(self, input: "scout_compute_api_Cartesian", bounds: Optional["scout_compute_api_CartesianBounds"] = None, max_points: Optional[int] = None, summarization_strategy: Optional["scout_compute_api_ScatterSummarizationStrategy"] = None) -> None:
         self._input = input
         self._bounds = bounds
+        self._summarization_strategy = summarization_strategy
         self._max_points = max_points
 
     @builtins.property
@@ -54341,6 +54469,12 @@ class scout_compute_api_SummarizeCartesian(ConjureBeanType):
     def bounds(self) -> Optional["scout_compute_api_CartesianBounds"]:
         return self._bounds
 
+    @builtins.property
+    def summarization_strategy(self) -> Optional["scout_compute_api_ScatterSummarizationStrategy"]:
+        """The summarization strategy to use when there are more than `maxPoints`. Defaults to spatial.
+        """
+        return self._summarization_strategy
+
     @builtins.property
     def max_points(self) -> Optional[int]:
         """The maximum number of points to return in the response. If more points are found, a BucketedCartesianPlot
@@ -54707,6 +54841,43 @@ scout_compute_api_TagFiltersVisitor.__qualname__ = "TagFiltersVisitor"
 scout_compute_api_TagFiltersVisitor.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_TemporalDecimateStrategy(ConjureBeanType):
+    """Buckets the input by time range into equally sized buckets.
+The number of buckets is determined by the maxPoints parameter.
+Returns a CartesianPlot.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'x_aggregation': ConjureFieldDefinition('xAggregation', scout_compute_api_ScatterTemporalAggregation),
+            'y_aggregation': ConjureFieldDefinition('yAggregation', scout_compute_api_ScatterTemporalAggregation)
+        }
+
+    __slots__: List[str] = ['_x_aggregation', '_y_aggregation']
+
+    def __init__(self, x_aggregation: "scout_compute_api_ScatterTemporalAggregation", y_aggregation: "scout_compute_api_ScatterTemporalAggregation") -> None:
+        self._x_aggregation = x_aggregation
+        self._y_aggregation = y_aggregation
+
+    @builtins.property
+    def x_aggregation(self) -> "scout_compute_api_ScatterTemporalAggregation":
+        """The strategy to use for aggregating the x values in each bucket.
+        """
+        return self._x_aggregation
+
+    @builtins.property
+    def y_aggregation(self) -> "scout_compute_api_ScatterTemporalAggregation":
+        """The strategy to use for aggregating the y values in each bucket.
+        """
+        return self._y_aggregation
+
+
+scout_compute_api_TemporalDecimateStrategy.__name__ = "TemporalDecimateStrategy"
+scout_compute_api_TemporalDecimateStrategy.__qualname__ = "TemporalDecimateStrategy"
+scout_compute_api_TemporalDecimateStrategy.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_Threshold(ConjureUnionType):
     _absolute: Optional["scout_compute_api_AbsoluteThreshold"] = None
     _percentage: Optional["scout_compute_api_PercentageThreshold"] = None
@@ -61946,6 +62117,41 @@ scout_compute_resolved_api_OnChangeRangesNode.__qualname__ = "OnChangeRangesNode
 scout_compute_resolved_api_OnChangeRangesNode.__module__ = "nominal_api.scout_compute_resolved_api"
 
 
+class scout_compute_resolved_api_PaddedRangesNode(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'input': ConjureFieldDefinition('input', scout_compute_resolved_api_RangesNode),
+            'padding': ConjureFieldDefinition('padding', scout_run_api_Duration),
+            'padding_configuration': ConjureFieldDefinition('paddingConfiguration', scout_compute_api_RangePaddingConfiguration)
+        }
+
+    __slots__: List[str] = ['_input', '_padding', '_padding_configuration']
+
+    def __init__(self, input: "scout_compute_resolved_api_RangesNode", padding: "scout_run_api_Duration", padding_configuration: "scout_compute_api_RangePaddingConfiguration") -> None:
+        self._input = input
+        self._padding = padding
+        self._padding_configuration = padding_configuration
+
+    @builtins.property
+    def input(self) -> "scout_compute_resolved_api_RangesNode":
+        return self._input
+
+    @builtins.property
+    def padding(self) -> "scout_run_api_Duration":
+        return self._padding
+
+    @builtins.property
+    def padding_configuration(self) -> "scout_compute_api_RangePaddingConfiguration":
+        return self._padding_configuration
+
+
+scout_compute_resolved_api_PaddedRangesNode.__name__ = "PaddedRangesNode"
+scout_compute_resolved_api_PaddedRangesNode.__qualname__ = "PaddedRangesNode"
+scout_compute_resolved_api_PaddedRangesNode.__module__ = "nominal_api.scout_compute_resolved_api"
+
+
 class scout_compute_resolved_api_PercentageThreshold(ConjureBeanType):
 
     @builtins.classmethod
@@ -62159,6 +62365,7 @@ class scout_compute_resolved_api_RangesNode(ConjureUnionType):
     _threshold: Optional["scout_compute_resolved_api_ThresholdingRangesNode"] = None
     _union_range: Optional["scout_compute_resolved_api_UnionRangesNode"] = None
     _event_search: Optional["scout_compute_resolved_api_EventSearchNode"] = None
+    _padded_ranges: Optional["scout_compute_resolved_api_PaddedRangesNode"] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -62178,7 +62385,8 @@ class scout_compute_resolved_api_RangesNode(ConjureUnionType):
             'stability_detection': ConjureFieldDefinition('stabilityDetection', scout_compute_resolved_api_StabilityDetectionRangesNode),
             'threshold': ConjureFieldDefinition('threshold', scout_compute_resolved_api_ThresholdingRangesNode),
             'union_range': ConjureFieldDefinition('unionRange', scout_compute_resolved_api_UnionRangesNode),
-            'event_search': ConjureFieldDefinition('eventSearch', scout_compute_resolved_api_EventSearchNode)
+            'event_search': ConjureFieldDefinition('eventSearch', scout_compute_resolved_api_EventSearchNode),
+            'padded_ranges': ConjureFieldDefinition('paddedRanges', scout_compute_resolved_api_PaddedRangesNode)
         }
 
     def __init__(
@@ -62199,10 +62407,11 @@ class scout_compute_resolved_api_RangesNode(ConjureUnionType):
             threshold: Optional["scout_compute_resolved_api_ThresholdingRangesNode"] = None,
             union_range: Optional["scout_compute_resolved_api_UnionRangesNode"] = None,
             event_search: Optional["scout_compute_resolved_api_EventSearchNode"] = None,
+            padded_ranges: Optional["scout_compute_resolved_api_PaddedRangesNode"] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (duration_filter is not None) + (enum_equality is not None) + (enum_filter is not None) + (extrema is not None) + (intersect_range is not None) + (literal_ranges is not None) + (min_max_threshold is not None) + (not_ is not None) + (on_change is not None) + (range_numeric_aggregation is not None) + (series_crossover_ranges_node is not None) + (stale_range is not None) + (stability_detection is not None) + (threshold is not None) + (union_range is not None) + (event_search is not None) != 1:
+            if (duration_filter is not None) + (enum_equality is not None) + (enum_filter is not None) + (extrema is not None) + (intersect_range is not None) + (literal_ranges is not None) + (min_max_threshold is not None) + (not_ is not None) + (on_change is not None) + (range_numeric_aggregation is not None) + (series_crossover_ranges_node is not None) + (stale_range is not None) + (stability_detection is not None) + (threshold is not None) + (union_range is not None) + (event_search is not None) + (padded_ranges is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if duration_filter is not None:
@@ -62253,6 +62462,9 @@ class scout_compute_resolved_api_RangesNode(ConjureUnionType):
             if event_search is not None:
                 self._event_search = event_search
                 self._type = 'eventSearch'
+            if padded_ranges is not None:
+                self._padded_ranges = padded_ranges
+                self._type = 'paddedRanges'
 
         elif type_of_union == 'durationFilter':
             if duration_filter is None:
@@ -62334,6 +62546,11 @@ class scout_compute_resolved_api_RangesNode(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._event_search = event_search
             self._type = 'eventSearch'
+        elif type_of_union == 'paddedRanges':
+            if padded_ranges is None:
+                raise ValueError('a union value must not be None')
+            self._padded_ranges = padded_ranges
+            self._type = 'paddedRanges'
 
     @builtins.property
     def duration_filter(self) -> Optional["scout_compute_resolved_api_DurationFilterRangesNode"]:
@@ -62399,6 +62616,10 @@ class scout_compute_resolved_api_RangesNode(ConjureUnionType):
     def event_search(self) -> Optional["scout_compute_resolved_api_EventSearchNode"]:
         return self._event_search
 
+    @builtins.property
+    def padded_ranges(self) -> Optional["scout_compute_resolved_api_PaddedRangesNode"]:
+        return self._padded_ranges
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, scout_compute_resolved_api_RangesNodeVisitor):
             raise ValueError('{} is not an instance of scout_compute_resolved_api_RangesNodeVisitor'.format(visitor.__class__.__name__))
@@ -62434,6 +62655,8 @@ class scout_compute_resolved_api_RangesNode(ConjureUnionType):
             return visitor._union_range(self.union_range)
         if self._type == 'eventSearch' and self.event_search is not None:
             return visitor._event_search(self.event_search)
+        if self._type == 'paddedRanges' and self.padded_ranges is not None:
+            return visitor._padded_ranges(self.padded_ranges)
 
 
 scout_compute_resolved_api_RangesNode.__name__ = "RangesNode"
@@ -62507,6 +62730,10 @@ class scout_compute_resolved_api_RangesNodeVisitor:
     def _event_search(self, event_search: "scout_compute_resolved_api_EventSearchNode") -> Any:
         pass
 
+    @abstractmethod
+    def _padded_ranges(self, padded_ranges: "scout_compute_resolved_api_PaddedRangesNode") -> Any:
+        pass
+
 
 scout_compute_resolved_api_RangesNodeVisitor.__name__ = "RangesNodeVisitor"
 scout_compute_resolved_api_RangesNodeVisitor.__qualname__ = "RangesNodeVisitor"
@@ -64157,15 +64384,17 @@ class scout_compute_resolved_api_SummarizeCartesianNode(ConjureBeanType):
         return {
             'input': ConjureFieldDefinition('input', scout_compute_resolved_api_CartesianNode),
             'bounds': ConjureFieldDefinition('bounds', OptionalTypeWrapper[scout_compute_resolved_api_CartesianBounds]),
-            'max_points': ConjureFieldDefinition('maxPoints', OptionalTypeWrapper[int])
+            'max_points': ConjureFieldDefinition('maxPoints', OptionalTypeWrapper[int]),
+            'summarization_strategy': ConjureFieldDefinition('summarizationStrategy', scout_compute_api_ScatterSummarizationStrategy)
         }
 
-    __slots__: List[str] = ['_input', '_bounds', '_max_points']
+    __slots__: List[str] = ['_input', '_bounds', '_max_points', '_summarization_strategy']
 
-    def __init__(self, input: "scout_compute_resolved_api_CartesianNode", bounds: Optional["scout_compute_resolved_api_CartesianBounds"] = None, max_points: Optional[int] = None) -> None:
+    def __init__(self, input: "scout_compute_resolved_api_CartesianNode", summarization_strategy: "scout_compute_api_ScatterSummarizationStrategy", bounds: Optional["scout_compute_resolved_api_CartesianBounds"] = None, max_points: Optional[int] = None) -> None:
         self._input = input
         self._bounds = bounds
         self._max_points = max_points
+        self._summarization_strategy = summarization_strategy
 
     @builtins.property
     def input(self) -> "scout_compute_resolved_api_CartesianNode":
@@ -64179,6 +64408,10 @@ class scout_compute_resolved_api_SummarizeCartesianNode(ConjureBeanType):
     def max_points(self) -> Optional[int]:
         return self._max_points
 
+    @builtins.property
+    def summarization_strategy(self) -> "scout_compute_api_ScatterSummarizationStrategy":
+        return self._summarization_strategy
+
 
 scout_compute_resolved_api_SummarizeCartesianNode.__name__ = "SummarizeCartesianNode"
 scout_compute_resolved_api_SummarizeCartesianNode.__qualname__ = "SummarizeCartesianNode"

nominal_api/scout_compute_api/__init__.py

@@ -248,6 +248,7 @@ from .._impl import (
     scout_compute_api_OutputFormat as OutputFormat,
     scout_compute_api_OutputRangeStart as OutputRangeStart,
     scout_compute_api_OutputRangeStartVisitor as OutputRangeStartVisitor,
+    scout_compute_api_PaddedRanges as PaddedRanges,
     scout_compute_api_PageInfo as PageInfo,
     scout_compute_api_PageStrategy as PageStrategy,
     scout_compute_api_PageStrategyVisitor as PageStrategyVisitor,
@@ -279,6 +280,7 @@ from .._impl import (
     scout_compute_api_RangeAggregationOperation as RangeAggregationOperation,
     scout_compute_api_RangeAggregationOperationVisitor as RangeAggregationOperationVisitor,
     scout_compute_api_RangeMap as RangeMap,
+    scout_compute_api_RangePaddingConfiguration as RangePaddingConfiguration,
     scout_compute_api_RangeSeries as RangeSeries,
     scout_compute_api_RangeSeriesVisitor as RangeSeriesVisitor,
     scout_compute_api_RangeSummary as RangeSummary,
@@ -298,6 +300,7 @@ from .._impl import (
     scout_compute_api_ScatterFitOptions as ScatterFitOptions,
     scout_compute_api_ScatterSummarizationStrategy as ScatterSummarizationStrategy,
     scout_compute_api_ScatterSummarizationStrategyVisitor as ScatterSummarizationStrategyVisitor,
+    scout_compute_api_ScatterTemporalAggregation as ScatterTemporalAggregation,
     scout_compute_api_SearchEventOriginType as SearchEventOriginType,
     scout_compute_api_SelectIndexFrom1dEnumArraySeries as SelectIndexFrom1dEnumArraySeries,
     scout_compute_api_SelectIndexFrom1dNumericArraySeries as SelectIndexFrom1dNumericArraySeries,
@@ -339,6 +342,7 @@ from .._impl import (
     scout_compute_api_TagFilterValidationErrorType as TagFilterValidationErrorType,
     scout_compute_api_TagFilters as TagFilters,
     scout_compute_api_TagFiltersVisitor as TagFiltersVisitor,
+    scout_compute_api_TemporalDecimateStrategy as TemporalDecimateStrategy,
     scout_compute_api_Threshold as Threshold,
     scout_compute_api_ThresholdOperator as ThresholdOperator,
     scout_compute_api_ThresholdVisitor as ThresholdVisitor,
@@ -621,6 +625,7 @@ __all__ = [
     'OutputFormat',
     'OutputRangeStart',
     'OutputRangeStartVisitor',
+    'PaddedRanges',
     'PageInfo',
     'PageStrategy',
     'PageStrategyVisitor',
@@ -652,6 +657,7 @@ __all__ = [
     'RangeAggregationOperation',
     'RangeAggregationOperationVisitor',
     'RangeMap',
+    'RangePaddingConfiguration',
     'RangeSeries',
     'RangeSeriesVisitor',
     'RangeSummary',
@@ -671,6 +677,7 @@ __all__ = [
     'ScatterFitOptions',
     'ScatterSummarizationStrategy',
     'ScatterSummarizationStrategyVisitor',
+    'ScatterTemporalAggregation',
     'SearchEventOriginType',
     'SelectIndexFrom1dEnumArraySeries',
     'SelectIndexFrom1dNumericArraySeries',
@@ -712,6 +719,7 @@ __all__ = [
     'TagFilterValidationErrorType',
     'TagFilters',
     'TagFiltersVisitor',
+    'TemporalDecimateStrategy',
     'Threshold',
     'ThresholdVisitor',
     'ThresholdOperator',

nominal_api/scout_compute_resolved_api/__init__.py

@@ -96,6 +96,7 @@ from .._impl import (
     scout_compute_resolved_api_NumericUnionSeriesNode as NumericUnionSeriesNode,
     scout_compute_resolved_api_OffsetSeriesNode as OffsetSeriesNode,
     scout_compute_resolved_api_OnChangeRangesNode as OnChangeRangesNode,
+    scout_compute_resolved_api_PaddedRangesNode as PaddedRangesNode,
     scout_compute_resolved_api_PercentageThreshold as PercentageThreshold,
     scout_compute_resolved_api_PeriodogramNode as PeriodogramNode,
     scout_compute_resolved_api_PersistenceWindowConfiguration as PersistenceWindowConfiguration,
@@ -261,6 +262,7 @@ __all__ = [
     'NumericUnionSeriesNode',
     'OffsetSeriesNode',
     'OnChangeRangesNode',
+    'PaddedRangesNode',
     'PercentageThreshold',
     'PeriodogramNode',
     'PersistenceWindowConfiguration',

{nominal_api-0.915.0.dist-info → nominal_api-0.916.1.dist-info}/METADATA

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

{nominal_api-0.915.0.dist-info → nominal_api-0.916.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=ysCOamUljXcrhet2G1MilSf6b7E57vnE3_0xVOyek_8,2088
-nominal_api/_impl.py,sha256=5a8KpwO455KkARLA1znwmAO1yhyBH7vZ6AZDG5NWcy4,3797445
+nominal_api/__init__.py,sha256=Yl06g57Lr6RswRXLfT2tUc2TuDmyI90oJmPEwegrJHQ,2088
+nominal_api/_impl.py,sha256=_Rwp5_n1RfizdyUrTyeclxV-TSGMl8zdPzWupc9OFv4,3807968
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=GqRLE9wwPPQgALVHFJViG8E4JJ2t3yfHedeXRLu1L70,2226
 nominal_api/api_ids/__init__.py,sha256=sxqN5dMk6bOx0SKOd0ANG3_kmx1VtdSVotzEGn_q6sE,114
@@ -33,9 +33,9 @@ nominal_api/scout_checklistexecution_api/__init__.py,sha256=iVeUjPTlbpQ3vlQkQjHr
 nominal_api/scout_checks_api/__init__.py,sha256=uCmiNrVwLDlkg8YnpP-uZr9nFFFN52sM644Qo6YNy3k,6972
 nominal_api/scout_comparisonnotebook_api/__init__.py,sha256=F5cQo_KqeTpFwqKBDV-iEjrND7xQgkycC1yocpxq1Qk,6277
 nominal_api/scout_comparisonrun_api/__init__.py,sha256=y5SlDoXvskyTKjg2O8o3cBhGSN-KA7iVlVjyy3vb3Co,652
-nominal_api/scout_compute_api/__init__.py,sha256=XlI7QZ655C_z6rytjS0bmY_noHDNRrr-YQ7SHp8zfFo,34018
+nominal_api/scout_compute_api/__init__.py,sha256=j2VBWPlPUGikx7uzDBo5vQ_kh7J9UPcS3hAZjCjBrtc,34423
 nominal_api/scout_compute_api_deprecated/__init__.py,sha256=JrZKbt1ulYECTdUSkXn6On22Alu_cPUBjCRWTN3ctxk,5041
-nominal_api/scout_compute_resolved_api/__init__.py,sha256=hPqFEk6hpnBiD8FYg-bxzFIeQtdhMOD__Ars5xcqtUo,17608
+nominal_api/scout_compute_resolved_api/__init__.py,sha256=cnh00fuFDRDg5aH3R1_iBomncmzGv0lM7-evSNvNIOk,17701
 nominal_api/scout_dataexport_api/__init__.py,sha256=E5hE8rqLbdCH1n877yLh_NjpP1RkJOWgqesH-ObhK1o,2122
 nominal_api/scout_datareview_api/__init__.py,sha256=ITQR6pdPseU9vS2bKDeleafiBhurtHmcHeKz_6J8Ab8,12229
 nominal_api/scout_datasource/__init__.py,sha256=Z1Msu1Daf8GlLuM3w5imyB-6DhTNZojxI6xpH1sSvhM,141
@@ -78,7 +78,7 @@ nominal_api/timeseries_seriescache/__init__.py,sha256=hL5hN8jKLEGE_fDiZzdASmWIrR
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=USBxFmNnVFdnhTPLvWi3UgsvBZ4Iz4ycNgBTi10F-zI,1603
 nominal_api/upload_api/__init__.py,sha256=7-XXuZUqKPV4AMWvxNpZPZ5vBun4x-AomXj3Vol_BN4,123
 nominal_api/usercreation_api/__init__.py,sha256=Q6M70SlKFVfIxZqRohD4XYmBz5t2DP1DB0a0Q6glqGA,171
-nominal_api-0.915.0.dist-info/METADATA,sha256=stzsTGPaKrzcO_l7LKq5BxnCrYX3Z93wo4D2bBGixZw,199
-nominal_api-0.915.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nominal_api-0.915.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.915.0.dist-info/RECORD,,
+nominal_api-0.916.1.dist-info/METADATA,sha256=Ri4kZGIVLdr_FazP8yQ_mX-FUbbhHPSuvpaLWsmwGsM,199
+nominal_api-0.916.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nominal_api-0.916.1.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.916.1.dist-info/RECORD,,