nominal-api 0.672.0__py3-none-any.whl → 0.673.0__py3-none-any.whl

nominal_api/__init__.py

@@ -75,5 +75,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.672.0"
+__version__ = "0.673.0"
 

nominal_api/_impl.py

@@ -16954,6 +16954,45 @@ scout_asset_api_AssetDataScope.__qualname__ = "AssetDataScope"
 scout_asset_api_AssetDataScope.__module__ = "nominal_api.scout_asset_api"
 
 
+class scout_asset_api_AssetSortOptions(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'is_descending': ConjureFieldDefinition('isDescending', bool),
+            'field': ConjureFieldDefinition('field', OptionalTypeWrapper[scout_asset_api_SortField]),
+            'sort_key': ConjureFieldDefinition('sortKey', OptionalTypeWrapper[scout_asset_api_SortKey])
+        }
+
+    __slots__: List[str] = ['_is_descending', '_field', '_sort_key']
+
+    def __init__(self, is_descending: bool, field: Optional["scout_asset_api_SortField"] = None, sort_key: Optional["scout_asset_api_SortKey"] = None) -> None:
+        self._is_descending = is_descending
+        self._field = field
+        self._sort_key = sort_key
+
+    @builtins.property
+    def is_descending(self) -> bool:
+        return self._is_descending
+
+    @builtins.property
+    def field(self) -> Optional["scout_asset_api_SortField"]:
+        return self._field
+
+    @builtins.property
+    def sort_key(self) -> Optional["scout_asset_api_SortKey"]:
+        """
+        Field to sort by. Includes both field and property-based sorting.
+Must be supplied if field is not provided separately.
+        """
+        return self._sort_key
+
+
+scout_asset_api_AssetSortOptions.__name__ = "AssetSortOptions"
+scout_asset_api_AssetSortOptions.__qualname__ = "AssetSortOptions"
+scout_asset_api_AssetSortOptions.__module__ = "nominal_api.scout_asset_api"
+
+
 class scout_asset_api_AssetTypeDataScopeConfig(ConjureBeanType):
 
     @builtins.classmethod
@@ -17556,7 +17595,7 @@ class scout_asset_api_SearchAssetsRequest(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'sort': ConjureFieldDefinition('sort', scout_asset_api_SortOptions),
+            'sort': ConjureFieldDefinition('sort', scout_asset_api_AssetSortOptions),
             'page_size': ConjureFieldDefinition('pageSize', OptionalTypeWrapper[int]),
             'next_page_token': ConjureFieldDefinition('nextPageToken', OptionalTypeWrapper[api_Token]),
             'query': ConjureFieldDefinition('query', scout_asset_api_SearchAssetsQuery),
@@ -17565,7 +17604,7 @@ class scout_asset_api_SearchAssetsRequest(ConjureBeanType):
 
     __slots__: List[str] = ['_sort', '_page_size', '_next_page_token', '_query', '_archived_statuses']
 
-    def __init__(self, query: "scout_asset_api_SearchAssetsQuery", sort: "scout_asset_api_SortOptions", archived_statuses: Optional[List["api_ArchivedStatus"]] = None, next_page_token: Optional[str] = None, page_size: Optional[int] = None) -> None:
+    def __init__(self, query: "scout_asset_api_SearchAssetsQuery", sort: "scout_asset_api_AssetSortOptions", archived_statuses: Optional[List["api_ArchivedStatus"]] = None, next_page_token: Optional[str] = None, page_size: Optional[int] = None) -> None:
         self._sort = sort
         self._page_size = page_size
         self._next_page_token = next_page_token
@@ -17573,7 +17612,7 @@ class scout_asset_api_SearchAssetsRequest(ConjureBeanType):
         self._archived_statuses = archived_statuses
 
     @builtins.property
-    def sort(self) -> "scout_asset_api_SortOptions":
+    def sort(self) -> "scout_asset_api_AssetSortOptions":
         return self._sort
 
     @builtins.property
@@ -17799,7 +17838,7 @@ class scout_asset_api_SearchTypesRequest(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'sort': ConjureFieldDefinition('sort', scout_asset_api_SortOptions),
+            'sort': ConjureFieldDefinition('sort', scout_asset_api_TypeSortOptions),
             'page_size': ConjureFieldDefinition('pageSize', OptionalTypeWrapper[int]),
             'next_page_token': ConjureFieldDefinition('nextPageToken', OptionalTypeWrapper[api_Token]),
             'query': ConjureFieldDefinition('query', scout_asset_api_SearchTypesQuery),
@@ -17808,7 +17847,7 @@ class scout_asset_api_SearchTypesRequest(ConjureBeanType):
 
     __slots__: List[str] = ['_sort', '_page_size', '_next_page_token', '_query', '_archived_statuses']
 
-    def __init__(self, query: "scout_asset_api_SearchTypesQuery", sort: "scout_asset_api_SortOptions", archived_statuses: Optional[List["api_ArchivedStatus"]] = None, next_page_token: Optional[str] = None, page_size: Optional[int] = None) -> None:
+    def __init__(self, query: "scout_asset_api_SearchTypesQuery", sort: "scout_asset_api_TypeSortOptions", archived_statuses: Optional[List["api_ArchivedStatus"]] = None, next_page_token: Optional[str] = None, page_size: Optional[int] = None) -> None:
         self._sort = sort
         self._page_size = page_size
         self._next_page_token = next_page_token
@@ -17816,7 +17855,7 @@ class scout_asset_api_SearchTypesRequest(ConjureBeanType):
         self._archived_statuses = archived_statuses
 
     @builtins.property
-    def sort(self) -> "scout_asset_api_SortOptions":
+    def sort(self) -> "scout_asset_api_TypeSortOptions":
         return self._sort
 
     @builtins.property
@@ -17892,33 +17931,104 @@ scout_asset_api_SortField.__qualname__ = "SortField"
 scout_asset_api_SortField.__module__ = "nominal_api.scout_asset_api"
 
 
-class scout_asset_api_SortOptions(ConjureBeanType):
+class scout_asset_api_SortKey(ConjureUnionType):
+    _field: Optional["scout_asset_api_SortField"] = None
+    _property: Optional["scout_asset_api_SortProperty"] = None
 
     @builtins.classmethod
-    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'is_descending': ConjureFieldDefinition('isDescending', bool),
-            'field': ConjureFieldDefinition('field', scout_asset_api_SortField)
+            'field': ConjureFieldDefinition('field', scout_asset_api_SortField),
+            'property': ConjureFieldDefinition('property', scout_asset_api_SortProperty)
         }
 
-    __slots__: List[str] = ['_is_descending', '_field']
+    def __init__(
+            self,
+            field: Optional["scout_asset_api_SortField"] = None,
+            property: Optional["scout_asset_api_SortProperty"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (field is not None) + (property is not None) != 1:
+                raise ValueError('a union must contain a single member')
 
-    def __init__(self, field: "scout_asset_api_SortField", is_descending: bool) -> None:
-        self._is_descending = is_descending
-        self._field = field
+            if field is not None:
+                self._field = field
+                self._type = 'field'
+            if property is not None:
+                self._property = property
+                self._type = 'property'
 
-    @builtins.property
-    def is_descending(self) -> bool:
-        return self._is_descending
+        elif type_of_union == 'field':
+            if field is None:
+                raise ValueError('a union value must not be None')
+            self._field = field
+            self._type = 'field'
+        elif type_of_union == 'property':
+            if property is None:
+                raise ValueError('a union value must not be None')
+            self._property = property
+            self._type = 'property'
 
     @builtins.property
-    def field(self) -> "scout_asset_api_SortField":
+    def field(self) -> Optional["scout_asset_api_SortField"]:
         return self._field
 
+    @builtins.property
+    def property(self) -> Optional["scout_asset_api_SortProperty"]:
+        return self._property
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_asset_api_SortKeyVisitor):
+            raise ValueError('{} is not an instance of scout_asset_api_SortKeyVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'field' and self.field is not None:
+            return visitor._field(self.field)
+        if self._type == 'property' and self.property is not None:
+            return visitor._property(self.property)
+
+
+scout_asset_api_SortKey.__name__ = "SortKey"
+scout_asset_api_SortKey.__qualname__ = "SortKey"
+scout_asset_api_SortKey.__module__ = "nominal_api.scout_asset_api"
+
+
+class scout_asset_api_SortKeyVisitor:
+
+    @abstractmethod
+    def _field(self, field: "scout_asset_api_SortField") -> Any:
+        pass
+
+    @abstractmethod
+    def _property(self, property: "scout_asset_api_SortProperty") -> Any:
+        pass
+
+
+scout_asset_api_SortKeyVisitor.__name__ = "SortKeyVisitor"
+scout_asset_api_SortKeyVisitor.__qualname__ = "SortKeyVisitor"
+scout_asset_api_SortKeyVisitor.__module__ = "nominal_api.scout_asset_api"
+
+
+class scout_asset_api_SortProperty(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'name': ConjureFieldDefinition('name', api_PropertyName)
+        }
+
+    __slots__: List[str] = ['_name']
+
+    def __init__(self, name: str) -> None:
+        self._name = name
+
+    @builtins.property
+    def name(self) -> str:
+        return self._name
 
-scout_asset_api_SortOptions.__name__ = "SortOptions"
-scout_asset_api_SortOptions.__qualname__ = "SortOptions"
-scout_asset_api_SortOptions.__module__ = "nominal_api.scout_asset_api"
+
+scout_asset_api_SortProperty.__name__ = "SortProperty"
+scout_asset_api_SortProperty.__qualname__ = "SortProperty"
+scout_asset_api_SortProperty.__module__ = "nominal_api.scout_asset_api"
 
 
 class scout_asset_api_TagConfig(ConjureUnionType):
@@ -18043,6 +18153,35 @@ scout_asset_api_Type.__qualname__ = "Type"
 scout_asset_api_Type.__module__ = "nominal_api.scout_asset_api"
 
 
+class scout_asset_api_TypeSortOptions(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'is_descending': ConjureFieldDefinition('isDescending', bool),
+            'field': ConjureFieldDefinition('field', scout_asset_api_SortField)
+        }
+
+    __slots__: List[str] = ['_is_descending', '_field']
+
+    def __init__(self, field: "scout_asset_api_SortField", is_descending: bool) -> None:
+        self._is_descending = is_descending
+        self._field = field
+
+    @builtins.property
+    def is_descending(self) -> bool:
+        return self._is_descending
+
+    @builtins.property
+    def field(self) -> "scout_asset_api_SortField":
+        return self._field
+
+
+scout_asset_api_TypeSortOptions.__name__ = "TypeSortOptions"
+scout_asset_api_TypeSortOptions.__qualname__ = "TypeSortOptions"
+scout_asset_api_TypeSortOptions.__module__ = "nominal_api.scout_asset_api"
+
+
 class scout_asset_api_UpdateAssetRefNamesRequest(ConjureBeanType):
 
     @builtins.classmethod
@@ -68274,7 +68413,7 @@ class scout_run_api_SearchRunChannelsRequest(ConjureBeanType):
     @builtins.property
     def page_size(self) -> Optional[int]:
         """
-        Defaults to 1000. Will throw if larger than 10000.
+        Defaults to 1000. Will throw if larger than 1000.
         """
         return self._page_size
 
@@ -68341,7 +68480,7 @@ class scout_run_api_SearchRunsRequest(ConjureBeanType):
     @builtins.property
     def page_size(self) -> int:
         """
-        Will reject page sizes greater than 10k.
+        Will reject page sizes greater than 1000.
         """
         return self._page_size
 

nominal_api/scout_asset_api/__init__.py

@@ -3,6 +3,7 @@ from .._impl import (
     scout_asset_api_AddDataScopesToAssetRequest as AddDataScopesToAssetRequest,
     scout_asset_api_Asset as Asset,
     scout_asset_api_AssetDataScope as AssetDataScope,
+    scout_asset_api_AssetSortOptions as AssetSortOptions,
     scout_asset_api_AssetTypeDataScopeConfig as AssetTypeDataScopeConfig,
     scout_asset_api_Channel as Channel,
     scout_asset_api_ChannelMetadata as ChannelMetadata,
@@ -25,10 +26,13 @@ from .._impl import (
     scout_asset_api_SeriesTagName as SeriesTagName,
     scout_asset_api_SeriesTagValue as SeriesTagValue,
     scout_asset_api_SortField as SortField,
-    scout_asset_api_SortOptions as SortOptions,
+    scout_asset_api_SortKey as SortKey,
+    scout_asset_api_SortKeyVisitor as SortKeyVisitor,
+    scout_asset_api_SortProperty as SortProperty,
     scout_asset_api_TagConfig as TagConfig,
     scout_asset_api_TagConfigVisitor as TagConfigVisitor,
     scout_asset_api_Type as Type,
+    scout_asset_api_TypeSortOptions as TypeSortOptions,
     scout_asset_api_UpdateAssetRefNamesRequest as UpdateAssetRefNamesRequest,
     scout_asset_api_UpdateAssetRequest as UpdateAssetRequest,
     scout_asset_api_UpdateAttachmentsRequest as UpdateAttachmentsRequest,

{nominal_api-0.672.0.dist-info → nominal_api-0.673.0.dist-info}/METADATA

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

{nominal_api-0.672.0.dist-info → nominal_api-0.673.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=0oa-6UtLukXU7uZlPjwSu3ibAPjbydt5sV2z2qyhJcU,1955
-nominal_api/_impl.py,sha256=7KB_zTbsBNZsI9eQXOrrpbUrj5z0OyCY1wGgiHrKLAw,3149388
+nominal_api/__init__.py,sha256=6pODP_M5aR-xYkiYoE-Su5yoaJPDSsYXpPuZrIvWB2Y,1955
+nominal_api/_impl.py,sha256=xiITQvWFhrvCdTqvZSYjSxIEdAUo0wXtp2d4aRw2chk,3154341
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=1oJPOuAMfV2uClPUW8Ie1nj2Y6j81TDpedcc3yUFTe0,1294
 nominal_api/api_ids/__init__.py,sha256=CAtt44XgNZEEUDv-BbEbYtuxQ8y1wqSZU-STjBYdZv8,80
@@ -20,7 +20,7 @@ nominal_api/ingest_workflow_api/__init__.py,sha256=Xvz7jXoK5k_zEWzGnMB9EB942T-yC
 nominal_api/persistent_compute_api/__init__.py,sha256=ThraDBJyYB5nFrbB6FZZpDoVAmsq8GAibiK0nu63MVA,2050
 nominal_api/scout/__init__.py,sha256=ip3XK_9jJKAoFiCifUVMTpDMiUE4mWIdGzMDu7LASus,324
 nominal_api/scout_api/__init__.py,sha256=_yhqikk4r2QptjyRGhmcs8z3Ocjpw8rzvxqkc48HS5s,592
-nominal_api/scout_asset_api/__init__.py,sha256=yUVqFxkhS8u_5LWH5rXcr3xd3tFXxA_0oNBRRPbfUkc,2164
+nominal_api/scout_asset_api/__init__.py,sha256=HtfQh85WPglpfzHVb_tZ_CQjAUTeRK4zDNzrwyEQlMY,2374
 nominal_api/scout_assets/__init__.py,sha256=dT-b9HnbwVbI-fEalfskKSMGzhGRwZDZ2cdzWul1daY,87
 nominal_api/scout_catalog/__init__.py,sha256=dZeiBEaLbhHAYaOuwhheUsLPZVJuJrh7XCX8vVIgSJQ,3110
 nominal_api/scout_channelvariables_api/__init__.py,sha256=39HhqONasq2MWrbEXvYwap4BqpOP9Q0Mg07-J2Zenqs,762
@@ -72,7 +72,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=Q9iZHurmyDsJIFbUg-Eb
 nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=U9EhlqdF9qzD1O9al0vcvcdgS_C5lq-lN3Kmr0K3g84,1191
 nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
-nominal_api-0.672.0.dist-info/METADATA,sha256=TkYA0hXmrmhX8oXeClM0mfNUr20YOcvNMvmUyNh9C8o,199
-nominal_api-0.672.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-nominal_api-0.672.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.672.0.dist-info/RECORD,,
+nominal_api-0.673.0.dist-info/METADATA,sha256=8KNbBDV82xXHPXrtIYaJ-qLx8yytXWJluShhvJ6wdL0,199
+nominal_api-0.673.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+nominal_api-0.673.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.673.0.dist-info/RECORD,,