nominal-api 0.526.0__tar.gz → 0.528.0__tar.gz

{nominal_api-0.526.0 → nominal_api-0.528.0}/PKG-INFO

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

{nominal_api-0.526.0 → nominal_api-0.528.0}/nominal_api/__init__.py

@@ -68,5 +68,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.526.0"
+__version__ = "0.528.0"
 

{nominal_api-0.526.0 → nominal_api-0.528.0}/nominal_api/_impl.py

@@ -5043,21 +5043,23 @@ class event_CreateEvent(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'asset_rids': ConjureFieldDefinition('assetRids', List[str]),
+            'asset_rids': ConjureFieldDefinition('assetRids', List[scout_rids_api_AssetRid]),
+            'origins': ConjureFieldDefinition('origins', List[event_EventOrigin]),
             'associations': ConjureFieldDefinition('associations', List[str]),
-            'authorization_rid': ConjureFieldDefinition('authorizationRid', str),
+            'authorization_rid': ConjureFieldDefinition('authorizationRid', OptionalTypeWrapper[str]),
             'timestamp': ConjureFieldDefinition('timestamp', api_Timestamp),
             'duration': ConjureFieldDefinition('duration', scout_run_api_Duration),
             'name': ConjureFieldDefinition('name', str),
             'type': ConjureFieldDefinition('type', event_EventType),
-            'labels': ConjureFieldDefinition('labels', OptionalTypeWrapper[List[scout_run_api_Label]]),
+            'labels': ConjureFieldDefinition('labels', List[scout_run_api_Label]),
             'properties': ConjureFieldDefinition('properties', Dict[scout_run_api_PropertyName, scout_run_api_PropertyValue])
         }
 
-    __slots__: List[str] = ['_asset_rids', '_associations', '_authorization_rid', '_timestamp', '_duration', '_name', '_type', '_labels', '_properties']
+    __slots__: List[str] = ['_asset_rids', '_origins', '_associations', '_authorization_rid', '_timestamp', '_duration', '_name', '_type', '_labels', '_properties']
 
-    def __init__(self, asset_rids: List[str], associations: List[str], authorization_rid: str, duration: "scout_run_api_Duration", name: str, properties: Dict[str, str], timestamp: "api_Timestamp", type: "event_EventType", labels: Optional[List[str]] = None) -> None:
+    def __init__(self, asset_rids: List[str], associations: List[str], duration: "scout_run_api_Duration", labels: List[str], name: str, origins: List["event_EventOrigin"], properties: Dict[str, str], timestamp: "api_Timestamp", type: "event_EventType", authorization_rid: Optional[str] = None) -> None:
         self._asset_rids = asset_rids
+        self._origins = origins
         self._associations = associations
         self._authorization_rid = authorization_rid
         self._timestamp = timestamp
@@ -5074,12 +5076,19 @@ class event_CreateEvent(ConjureBeanType):
         """
         return self._asset_rids
 
+    @builtins.property
+    def origins(self) -> List["event_EventOrigin"]:
+        """
+        Should be nonempty, but not enforced yet.
+        """
+        return self._origins
+
     @builtins.property
     def associations(self) -> List[str]:
         return self._associations
 
     @builtins.property
-    def authorization_rid(self) -> str:
+    def authorization_rid(self) -> Optional[str]:
         return self._authorization_rid
 
     @builtins.property
@@ -5099,7 +5108,7 @@ class event_CreateEvent(ConjureBeanType):
         return self._type
 
     @builtins.property
-    def labels(self) -> Optional[List[str]]:
+    def labels(self) -> List[str]:
         return self._labels
 
     @builtins.property
@@ -5118,21 +5127,24 @@ class event_Event(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'uuid': ConjureFieldDefinition('uuid', str),
-            'asset_rids': ConjureFieldDefinition('assetRids', List[str]),
-            'authorization_rid': ConjureFieldDefinition('authorizationRid', str),
+            'asset_rids': ConjureFieldDefinition('assetRids', List[scout_rids_api_AssetRid]),
+            'origins': ConjureFieldDefinition('origins', List[event_EventOrigin]),
+            'authorization_rid': ConjureFieldDefinition('authorizationRid', OptionalTypeWrapper[str]),
             'timestamp': ConjureFieldDefinition('timestamp', api_Timestamp),
             'duration': ConjureFieldDefinition('duration', scout_run_api_Duration),
             'name': ConjureFieldDefinition('name', str),
             'type': ConjureFieldDefinition('type', event_EventType),
-            'labels': ConjureFieldDefinition('labels', OptionalTypeWrapper[List[scout_run_api_Label]]),
-            'properties': ConjureFieldDefinition('properties', Dict[scout_run_api_PropertyName, scout_run_api_PropertyValue])
+            'labels': ConjureFieldDefinition('labels', List[scout_run_api_Label]),
+            'properties': ConjureFieldDefinition('properties', Dict[scout_run_api_PropertyName, scout_run_api_PropertyValue]),
+            'is_archived': ConjureFieldDefinition('isArchived', bool)
         }
 
-    __slots__: List[str] = ['_uuid', '_asset_rids', '_authorization_rid', '_timestamp', '_duration', '_name', '_type', '_labels', '_properties']
+    __slots__: List[str] = ['_uuid', '_asset_rids', '_origins', '_authorization_rid', '_timestamp', '_duration', '_name', '_type', '_labels', '_properties', '_is_archived']
 
-    def __init__(self, asset_rids: List[str], authorization_rid: str, duration: "scout_run_api_Duration", name: str, properties: Dict[str, str], timestamp: "api_Timestamp", type: "event_EventType", uuid: str, labels: Optional[List[str]] = None) -> None:
+    def __init__(self, asset_rids: List[str], duration: "scout_run_api_Duration", is_archived: bool, labels: List[str], name: str, origins: List["event_EventOrigin"], properties: Dict[str, str], timestamp: "api_Timestamp", type: "event_EventType", uuid: str, authorization_rid: Optional[str] = None) -> None:
         self._uuid = uuid
         self._asset_rids = asset_rids
+        self._origins = origins
         self._authorization_rid = authorization_rid
         self._timestamp = timestamp
         self._duration = duration
@@ -5140,6 +5152,7 @@ class event_Event(ConjureBeanType):
         self._type = type
         self._labels = labels
         self._properties = properties
+        self._is_archived = is_archived
 
     @builtins.property
     def uuid(self) -> str:
@@ -5153,7 +5166,14 @@ class event_Event(ConjureBeanType):
         return self._asset_rids
 
     @builtins.property
-    def authorization_rid(self) -> str:
+    def origins(self) -> List["event_EventOrigin"]:
+        """
+        A set of origins associated with the event.
+        """
+        return self._origins
+
+    @builtins.property
+    def authorization_rid(self) -> Optional[str]:
         """
         A user authorized for this rid can access the event. 
 Can be a workbook rid, asset rid, etc.
@@ -5177,19 +5197,155 @@ Can be a workbook rid, asset rid, etc.
         return self._type
 
     @builtins.property
-    def labels(self) -> Optional[List[str]]:
+    def labels(self) -> List[str]:
         return self._labels
 
     @builtins.property
     def properties(self) -> Dict[str, str]:
         return self._properties
 
+    @builtins.property
+    def is_archived(self) -> bool:
+        return self._is_archived
+
 
 event_Event.__name__ = "Event"
 event_Event.__qualname__ = "Event"
 event_Event.__module__ = "nominal_api.event"
 
 
+class event_EventOrigin(ConjureUnionType):
+    """Describes where an event came from."""
+    _workbook: Optional[str] = None
+    _template: Optional[str] = None
+    _api_key: Optional[str] = None
+    _manual_user: Optional[str] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'workbook': ConjureFieldDefinition('workbook', scout_rids_api_NotebookRid),
+            'template': ConjureFieldDefinition('template', scout_rids_api_TemplateRid),
+            'api_key': ConjureFieldDefinition('apiKey', scout_rids_api_ApiKeyRid),
+            'manual_user': ConjureFieldDefinition('manualUser', scout_rids_api_UserRid)
+        }
+
+    def __init__(
+            self,
+            workbook: Optional[str] = None,
+            template: Optional[str] = None,
+            api_key: Optional[str] = None,
+            manual_user: Optional[str] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (workbook is not None) + (template is not None) + (api_key is not None) + (manual_user is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if workbook is not None:
+                self._workbook = workbook
+                self._type = 'workbook'
+            if template is not None:
+                self._template = template
+                self._type = 'template'
+            if api_key is not None:
+                self._api_key = api_key
+                self._type = 'apiKey'
+            if manual_user is not None:
+                self._manual_user = manual_user
+                self._type = 'manualUser'
+
+        elif type_of_union == 'workbook':
+            if workbook is None:
+                raise ValueError('a union value must not be None')
+            self._workbook = workbook
+            self._type = 'workbook'
+        elif type_of_union == 'template':
+            if template is None:
+                raise ValueError('a union value must not be None')
+            self._template = template
+            self._type = 'template'
+        elif type_of_union == 'apiKey':
+            if api_key is None:
+                raise ValueError('a union value must not be None')
+            self._api_key = api_key
+            self._type = 'apiKey'
+        elif type_of_union == 'manualUser':
+            if manual_user is None:
+                raise ValueError('a union value must not be None')
+            self._manual_user = manual_user
+            self._type = 'manualUser'
+
+    @builtins.property
+    def workbook(self) -> Optional[str]:
+        """
+        This event was created in this workbook
+        """
+        return self._workbook
+
+    @builtins.property
+    def template(self) -> Optional[str]:
+        """
+        This event was created in this template
+        """
+        return self._template
+
+    @builtins.property
+    def api_key(self) -> Optional[str]:
+        """
+        This event was created programmatically using this persistent API key
+        """
+        return self._api_key
+
+    @builtins.property
+    def manual_user(self) -> Optional[str]:
+        """
+        This event was created programmatically using ephemeral authentication by this user
+        """
+        return self._manual_user
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, event_EventOriginVisitor):
+            raise ValueError('{} is not an instance of event_EventOriginVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'workbook' and self.workbook is not None:
+            return visitor._workbook(self.workbook)
+        if self._type == 'template' and self.template is not None:
+            return visitor._template(self.template)
+        if self._type == 'apiKey' and self.api_key is not None:
+            return visitor._api_key(self.api_key)
+        if self._type == 'manualUser' and self.manual_user is not None:
+            return visitor._manual_user(self.manual_user)
+
+
+event_EventOrigin.__name__ = "EventOrigin"
+event_EventOrigin.__qualname__ = "EventOrigin"
+event_EventOrigin.__module__ = "nominal_api.event"
+
+
+class event_EventOriginVisitor:
+
+    @abstractmethod
+    def _workbook(self, workbook: str) -> Any:
+        pass
+
+    @abstractmethod
+    def _template(self, template: str) -> Any:
+        pass
+
+    @abstractmethod
+    def _api_key(self, api_key: str) -> Any:
+        pass
+
+    @abstractmethod
+    def _manual_user(self, manual_user: str) -> Any:
+        pass
+
+
+event_EventOriginVisitor.__name__ = "EventOriginVisitor"
+event_EventOriginVisitor.__qualname__ = "EventOriginVisitor"
+event_EventOriginVisitor.__module__ = "nominal_api.event"
+
+
 class event_EventService(Service):
     """
     An Event is an annotated moment or time range.
@@ -5325,7 +5481,7 @@ The Event Service is responsible for creating and retrieving events for a partic
 
     def search_events(self, auth_header: str, list_runs_request: "event_SearchEventsRequest") -> "event_SearchEventsResponse":
         """
-        Searches for events that match the given ƒilters.
+        Searches for events that match the given filters.
         """
 
         _headers: Dict[str, Any] = {
@@ -5414,16 +5570,18 @@ class event_SearchEventsRequest(ConjureBeanType):
             'sort': ConjureFieldDefinition('sort', event_SortOptions),
             'page_size': ConjureFieldDefinition('pageSize', int),
             'next_page_token': ConjureFieldDefinition('nextPageToken', OptionalTypeWrapper[scout_api_Token]),
-            'query': ConjureFieldDefinition('query', event_SearchQuery)
+            'query': ConjureFieldDefinition('query', event_SearchQuery),
+            'archived_statuses': ConjureFieldDefinition('archivedStatuses', OptionalTypeWrapper[List[scout_rids_api_ArchivedStatus]])
         }
 
-    __slots__: List[str] = ['_sort', '_page_size', '_next_page_token', '_query']
+    __slots__: List[str] = ['_sort', '_page_size', '_next_page_token', '_query', '_archived_statuses']
 
-    def __init__(self, page_size: int, query: "event_SearchQuery", sort: "event_SortOptions", next_page_token: Optional[str] = None) -> None:
+    def __init__(self, page_size: int, query: "event_SearchQuery", sort: "event_SortOptions", archived_statuses: Optional[List["scout_rids_api_ArchivedStatus"]] = None, next_page_token: Optional[str] = None) -> None:
         self._sort = sort
         self._page_size = page_size
         self._next_page_token = next_page_token
         self._query = query
+        self._archived_statuses = archived_statuses
 
     @builtins.property
     def sort(self) -> "event_SortOptions":
@@ -5444,6 +5602,13 @@ class event_SearchEventsRequest(ConjureBeanType):
     def query(self) -> "event_SearchQuery":
         return self._query
 
+    @builtins.property
+    def archived_statuses(self) -> Optional[List["scout_rids_api_ArchivedStatus"]]:
+        """
+        Default search status is NOT_ARCHIVED if none are provided. Allows for including archived events in search.
+        """
+        return self._archived_statuses
+
 
 event_SearchEventsRequest.__name__ = "SearchEventsRequest"
 event_SearchEventsRequest.__qualname__ = "SearchEventsRequest"
@@ -5718,7 +5883,8 @@ class event_UpdateEvent(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'uuid': ConjureFieldDefinition('uuid', str),
-            'asset_rids': ConjureFieldDefinition('assetRids', OptionalTypeWrapper[List[str]]),
+            'asset_rids': ConjureFieldDefinition('assetRids', OptionalTypeWrapper[List[scout_rids_api_AssetRid]]),
+            'origins': ConjureFieldDefinition('origins', OptionalTypeWrapper[List[event_EventOrigin]]),
             'authorization_rid': ConjureFieldDefinition('authorizationRid', OptionalTypeWrapper[str]),
             'timestamp': ConjureFieldDefinition('timestamp', OptionalTypeWrapper[api_Timestamp]),
             'duration': ConjureFieldDefinition('duration', OptionalTypeWrapper[scout_run_api_Duration]),
@@ -5728,11 +5894,12 @@ class event_UpdateEvent(ConjureBeanType):
             'properties': ConjureFieldDefinition('properties', OptionalTypeWrapper[Dict[scout_run_api_PropertyName, scout_run_api_PropertyValue]])
         }
 
-    __slots__: List[str] = ['_uuid', '_asset_rids', '_authorization_rid', '_timestamp', '_duration', '_name', '_type', '_labels', '_properties']
+    __slots__: List[str] = ['_uuid', '_asset_rids', '_origins', '_authorization_rid', '_timestamp', '_duration', '_name', '_type', '_labels', '_properties']
 
-    def __init__(self, uuid: str, asset_rids: Optional[List[str]] = None, authorization_rid: Optional[str] = None, duration: Optional["scout_run_api_Duration"] = None, labels: Optional[List[str]] = None, name: Optional[str] = None, properties: Optional[Dict[str, str]] = None, timestamp: Optional["api_Timestamp"] = None, type: Optional["event_EventType"] = None) -> None:
+    def __init__(self, uuid: str, asset_rids: Optional[List[str]] = None, authorization_rid: Optional[str] = None, duration: Optional["scout_run_api_Duration"] = None, labels: Optional[List[str]] = None, name: Optional[str] = None, origins: Optional[List["event_EventOrigin"]] = None, properties: Optional[Dict[str, str]] = None, timestamp: Optional["api_Timestamp"] = None, type: Optional["event_EventType"] = None) -> None:
         self._uuid = uuid
         self._asset_rids = asset_rids
+        self._origins = origins
         self._authorization_rid = authorization_rid
         self._timestamp = timestamp
         self._duration = duration
@@ -5747,8 +5914,16 @@ class event_UpdateEvent(ConjureBeanType):
 
     @builtins.property
     def asset_rids(self) -> Optional[List[str]]:
+        """
+        If provided, will replace the existing asset rids.
+If provided, must contain at least one asset rid.
+        """
         return self._asset_rids
 
+    @builtins.property
+    def origins(self) -> Optional[List["event_EventOrigin"]]:
+        return self._origins
+
     @builtins.property
     def authorization_rid(self) -> Optional[str]:
         return self._authorization_rid
@@ -5960,15 +6135,19 @@ class ingest_api_CsvOpts(ConjureBeanType):
         return {
             'source': ConjureFieldDefinition('source', ingest_api_IngestSource),
             'target': ConjureFieldDefinition('target', ingest_api_DatasetIngestTarget),
-            'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', ingest_api_TimestampMetadata)
+            'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', ingest_api_TimestampMetadata),
+            'tag_keys_from_columns': ConjureFieldDefinition('tagKeysFromColumns', OptionalTypeWrapper[List[api_TagName]]),
+            'additional_file_tags': ConjureFieldDefinition('additionalFileTags', OptionalTypeWrapper[Dict[api_TagName, api_TagValue]])
         }
 
-    __slots__: List[str] = ['_source', '_target', '_timestamp_metadata']
+    __slots__: List[str] = ['_source', '_target', '_timestamp_metadata', '_tag_keys_from_columns', '_additional_file_tags']
 
-    def __init__(self, source: "ingest_api_IngestSource", target: "ingest_api_DatasetIngestTarget", timestamp_metadata: "ingest_api_TimestampMetadata") -> None:
+    def __init__(self, source: "ingest_api_IngestSource", target: "ingest_api_DatasetIngestTarget", timestamp_metadata: "ingest_api_TimestampMetadata", additional_file_tags: Optional[Dict[str, str]] = None, tag_keys_from_columns: Optional[List[str]] = None) -> None:
         self._source = source
         self._target = target
         self._timestamp_metadata = timestamp_metadata
+        self._tag_keys_from_columns = tag_keys_from_columns
+        self._additional_file_tags = additional_file_tags
 
     @builtins.property
     def source(self) -> "ingest_api_IngestSource":
@@ -5982,6 +6161,14 @@ class ingest_api_CsvOpts(ConjureBeanType):
     def timestamp_metadata(self) -> "ingest_api_TimestampMetadata":
         return self._timestamp_metadata
 
+    @builtins.property
+    def tag_keys_from_columns(self) -> Optional[List[str]]:
+        return self._tag_keys_from_columns
+
+    @builtins.property
+    def additional_file_tags(self) -> Optional[Dict[str, str]]:
+        return self._additional_file_tags
+
 
 ingest_api_CsvOpts.__name__ = "CsvOpts"
 ingest_api_CsvOpts.__qualname__ = "CsvOpts"
@@ -67482,6 +67669,8 @@ scout_datasource_connection_api_SecretRid = str
 
 authorization_ApiKeyRid = str
 
+scout_rids_api_ApiKeyRid = str
+
 scout_rids_api_AssetRid = str
 
 comments_api_CommentRid = str

{nominal_api-0.526.0 → nominal_api-0.528.0}/nominal_api/event/__init__.py

@@ -3,6 +3,8 @@ from .._impl import (
     event_ArchiveEvent as ArchiveEvent,
     event_CreateEvent as CreateEvent,
     event_Event as Event,
+    event_EventOrigin as EventOrigin,
+    event_EventOriginVisitor as EventOriginVisitor,
     event_EventRid as EventRid,
     event_EventService as EventService,
     event_EventType as EventType,

{nominal_api-0.526.0 → nominal_api-0.528.0}/nominal_api/scout_rids_api/__init__.py

@@ -1,5 +1,6 @@
 # coding=utf-8
 from .._impl import (
+    scout_rids_api_ApiKeyRid as ApiKeyRid,
     scout_rids_api_ArchivedStatus as ArchivedStatus,
     scout_rids_api_AssetRid as AssetRid,
     scout_rids_api_CheckAlertState as CheckAlertState,

{nominal_api-0.526.0 → nominal_api-0.528.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.526.0 → nominal_api-0.528.0}/setup.py

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