nominal-api 0.600.1__tar.gz → 0.602.0__tar.gz

{nominal_api-0.600.1 → nominal_api-0.602.0}/PKG-INFO

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

{nominal_api-0.600.1 → nominal_api-0.602.0}/nominal_api/__init__.py

@@ -75,5 +75,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.600.1"
+__version__ = "0.602.0"
 

{nominal_api-0.600.1 → nominal_api-0.602.0}/nominal_api/_impl.py

@@ -23020,13 +23020,15 @@ class scout_checklistexecution_api_ListStreamingChecklistRequest(ConjureBeanType
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'page_size': ConjureFieldDefinition('pageSize', OptionalTypeWrapper[int]),
+            'workspace_ids': ConjureFieldDefinition('workspaceIds', List[api_ids_WorkspaceId]),
             'page_token': ConjureFieldDefinition('pageToken', OptionalTypeWrapper[str])
         }
 
-    __slots__: List[str] = ['_page_size', '_page_token']
+    __slots__: List[str] = ['_page_size', '_workspace_ids', '_page_token']
 
-    def __init__(self, page_size: Optional[int] = None, page_token: Optional[str] = None) -> None:
+    def __init__(self, workspace_ids: List[str], page_size: Optional[int] = None, page_token: Optional[str] = None) -> None:
         self._page_size = page_size
+        self._workspace_ids = workspace_ids
         self._page_token = page_token
 
     @builtins.property
@@ -23036,6 +23038,10 @@ class scout_checklistexecution_api_ListStreamingChecklistRequest(ConjureBeanType
         """
         return self._page_size
 
+    @builtins.property
+    def workspace_ids(self) -> List[str]:
+        return self._workspace_ids
+
     @builtins.property
     def page_token(self) -> Optional[str]:
         return self._page_token
@@ -51521,7 +51527,7 @@ the automatic checks against the run.
 
     def get_check_alerts_histogram(self, auth_header: str, request: "scout_datareview_api_CheckAlertsHistogramRequest") -> "scout_datareview_api_CheckAlertsHistogramResponse":
         """
-        Returns a histogram of alerts that occur across the provided runs.
+        Returns a histogram of alerts that occur across the provided runs or assets. At least one run or asset must be specified.
         """
 
         _headers: Dict[str, Any] = {
@@ -51553,7 +51559,7 @@ the automatic checks against the run.
 
     def search_check_alerts(self, auth_header: str, request: "scout_datareview_api_SearchCheckAlertsRequest") -> "scout_datareview_api_SearchCheckAlertsResponse":
         """
-        Returns the check alerts under the provided search parameters.
+        Returns the check alerts under the provided search parameters. At least one run or asset must be specified.
         """
 
         _headers: Dict[str, Any] = {
@@ -57028,15 +57034,17 @@ class scout_integrations_api_CreateIntegrationRequest(ConjureBeanType):
         return {
             'name': ConjureFieldDefinition('name', str),
             'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
-            'create_integration_details': ConjureFieldDefinition('createIntegrationDetails', scout_integrations_api_CreateIntegrationDetails)
+            'create_integration_details': ConjureFieldDefinition('createIntegrationDetails', scout_integrations_api_CreateIntegrationDetails),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_name', '_description', '_create_integration_details']
+    __slots__: List[str] = ['_name', '_description', '_create_integration_details', '_workspace']
 
-    def __init__(self, create_integration_details: "scout_integrations_api_CreateIntegrationDetails", name: str, description: Optional[str] = None) -> None:
+    def __init__(self, create_integration_details: "scout_integrations_api_CreateIntegrationDetails", name: str, description: Optional[str] = None, workspace: Optional[str] = None) -> None:
         self._name = name
         self._description = description
         self._create_integration_details = create_integration_details
+        self._workspace = workspace
 
     @builtins.property
     def name(self) -> str:
@@ -57050,6 +57058,14 @@ class scout_integrations_api_CreateIntegrationRequest(ConjureBeanType):
     def create_integration_details(self) -> "scout_integrations_api_CreateIntegrationDetails":
         return self._create_integration_details
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to create the integration. If not provided, the integration will be created in the default workspace for
+the user's organization, if the default workspace for the organization is configured.
+        """
+        return self._workspace
+
 
 scout_integrations_api_CreateIntegrationRequest.__name__ = "CreateIntegrationRequest"
 scout_integrations_api_CreateIntegrationRequest.__qualname__ = "CreateIntegrationRequest"
@@ -57290,7 +57306,7 @@ class scout_integrations_api_IntegrationsService(Service):
     Service for managing integrations with external services.
     """
 
-    def generate_slack_webhook_link(self, auth_header: str) -> "scout_integrations_api_GenerateSlackWebhookResponse":
+    def generate_slack_webhook_link(self, auth_header: str, workspace: Optional[str] = None) -> "scout_integrations_api_GenerateSlackWebhookResponse":
         """
         Generates link to request permissions for Slack bot to join workspaces and use a webhook.
         """
@@ -57301,6 +57317,7 @@ class scout_integrations_api_IntegrationsService(Service):
         }
 
         _params: Dict[str, Any] = {
+            'workspace': workspace,
         }
 
         _path_params: Dict[str, Any] = {
@@ -57481,10 +57498,11 @@ class scout_integrations_api_IntegrationsService(Service):
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), scout_integrations_api_Integration, self._return_none_for_unknown_union_types)
 
-    def list_integrations(self, auth_header: str) -> List["scout_integrations_api_Integration"]:
+    def list_integrations(self, auth_header: str, workspaces: List[str] = None) -> List["scout_integrations_api_Integration"]:
         """
         Lists all integrations.
         """
+        workspaces = workspaces if workspaces is not None else []
 
         _headers: Dict[str, Any] = {
             'Accept': 'application/json',
@@ -57492,6 +57510,7 @@ class scout_integrations_api_IntegrationsService(Service):
         }
 
         _params: Dict[str, Any] = {
+            'workspaces': workspaces,
         }
 
         _path_params: Dict[str, Any] = {
@@ -58256,9 +58275,9 @@ scout_internal_search_api_TimestampField.__qualname__ = "TimestampField"
 scout_internal_search_api_TimestampField.__module__ = "nominal_api.scout_internal_search_api"
 
 
-class scout_jobs_api_JobService(Service):
+class scout_jobs_api_InternalJobService(Service):
     """
-    The Job Service is responsible for running jobs for checklist executions.
+    The Internal Job Service is responsible for running jobs for checklist executions.
     """
 
     def submit_jobs(self, auth_header: str, request: "scout_checks_api_SubmitJobsRequest") -> "scout_checks_api_SubmitJobsResponse":
@@ -58280,7 +58299,7 @@ class scout_jobs_api_JobService(Service):
 
         _json: Any = ConjureEncoder().default(request)
 
-        _path = '/jobs/v1/submitJobs'
+        _path = '/internal/jobs/v1/submitJobs'
         _path = _path.format(**_path_params)
 
         _response: Response = self._request(
@@ -58293,6 +58312,17 @@ class scout_jobs_api_JobService(Service):
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), scout_checks_api_SubmitJobsResponse, self._return_none_for_unknown_union_types)
 
+
+scout_jobs_api_InternalJobService.__name__ = "InternalJobService"
+scout_jobs_api_InternalJobService.__qualname__ = "InternalJobService"
+scout_jobs_api_InternalJobService.__module__ = "nominal_api.scout_jobs_api"
+
+
+class scout_jobs_api_JobService(Service):
+    """
+    The Job Service is responsible for returning information about jobs for checklist executions.
+    """
+
     def get_job_report(self, auth_header: str, job_rid: str) -> "scout_checks_api_JobReport":
         """
         Fetches the job report for a job RID. Throws ResourcesNotFound if no job exists with this job RID.
@@ -65082,6 +65112,41 @@ optional set of bounds.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), List[scout_video_api_SegmentSummary], self._return_none_for_unknown_union_types)
 
+    def get_file_summaries(self, auth_header: str, request: "scout_video_api_GetFileSummariesRequest", video_rid: str) -> "scout_video_api_GetFileSummariesResponse":
+        """
+        Returns the min and max absolute timestamps from non-archived video files associated with a given video that
+overlap with an optional set of bounds. The files on the edges of the bounds will be truncated to segments
+that are inside or overlap with the bounds.
+        """
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, Any] = {
+            'videoRid': video_rid,
+        }
+
+        _json: Any = ConjureEncoder().default(request)
+
+        _path = '/video/v1/videos/{videoRid}/get-ranges-with-existing-segment-data'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'POST',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        _decoder = ConjureDecoder()
+        return _decoder.decode(_response.json(), scout_video_api_GetFileSummariesResponse, self._return_none_for_unknown_union_types)
+
 
 scout_video_VideoService.__name__ = "VideoService"
 scout_video_VideoService.__qualname__ = "VideoService"
@@ -65474,6 +65539,35 @@ scout_video_api_ErrorIngestStatus.__qualname__ = "ErrorIngestStatus"
 scout_video_api_ErrorIngestStatus.__module__ = "nominal_api.scout_video_api"
 
 
+class scout_video_api_FileSummary(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'file_rid': ConjureFieldDefinition('fileRid', api_rids_VideoFileRid),
+            'bounds': ConjureFieldDefinition('bounds', scout_video_api_Bounds)
+        }
+
+    __slots__: List[str] = ['_file_rid', '_bounds']
+
+    def __init__(self, bounds: "scout_video_api_Bounds", file_rid: str) -> None:
+        self._file_rid = file_rid
+        self._bounds = bounds
+
+    @builtins.property
+    def file_rid(self) -> str:
+        return self._file_rid
+
+    @builtins.property
+    def bounds(self) -> "scout_video_api_Bounds":
+        return self._bounds
+
+
+scout_video_api_FileSummary.__name__ = "FileSummary"
+scout_video_api_FileSummary.__qualname__ = "FileSummary"
+scout_video_api_FileSummary.__module__ = "nominal_api.scout_video_api"
+
+
 class scout_video_api_GetEnrichedVideoIngestStatusRequest(ConjureBeanType):
 
     @builtins.classmethod
@@ -65503,6 +65597,52 @@ scout_video_api_GetEnrichedVideoIngestStatusRequest.__qualname__ = "GetEnrichedV
 scout_video_api_GetEnrichedVideoIngestStatusRequest.__module__ = "nominal_api.scout_video_api"
 
 
+class scout_video_api_GetFileSummariesRequest(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'bounds': ConjureFieldDefinition('bounds', OptionalTypeWrapper[scout_video_api_Bounds])
+        }
+
+    __slots__: List[str] = ['_bounds']
+
+    def __init__(self, bounds: Optional["scout_video_api_Bounds"] = None) -> None:
+        self._bounds = bounds
+
+    @builtins.property
+    def bounds(self) -> Optional["scout_video_api_Bounds"]:
+        return self._bounds
+
+
+scout_video_api_GetFileSummariesRequest.__name__ = "GetFileSummariesRequest"
+scout_video_api_GetFileSummariesRequest.__qualname__ = "GetFileSummariesRequest"
+scout_video_api_GetFileSummariesRequest.__module__ = "nominal_api.scout_video_api"
+
+
+class scout_video_api_GetFileSummariesResponse(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'file_summaries': ConjureFieldDefinition('fileSummaries', List[scout_video_api_FileSummary])
+        }
+
+    __slots__: List[str] = ['_file_summaries']
+
+    def __init__(self, file_summaries: List["scout_video_api_FileSummary"]) -> None:
+        self._file_summaries = file_summaries
+
+    @builtins.property
+    def file_summaries(self) -> List["scout_video_api_FileSummary"]:
+        return self._file_summaries
+
+
+scout_video_api_GetFileSummariesResponse.__name__ = "GetFileSummariesResponse"
+scout_video_api_GetFileSummariesResponse.__qualname__ = "GetFileSummariesResponse"
+scout_video_api_GetFileSummariesResponse.__module__ = "nominal_api.scout_video_api"
+
+
 class scout_video_api_GetIngestStatusResponse(ConjureBeanType):
 
     @builtins.classmethod

{nominal_api-0.600.1 → nominal_api-0.602.0}/nominal_api/scout_jobs_api/__init__.py

@@ -1,5 +1,6 @@
 # coding=utf-8
 from .._impl import (
+    scout_jobs_api_InternalJobService as InternalJobService,
     scout_jobs_api_JobService as JobService,
 )
 

{nominal_api-0.600.1 → nominal_api-0.602.0}/nominal_api/scout_video_api/__init__.py

@@ -11,7 +11,10 @@ from .._impl import (
     scout_video_api_EnrichedVideoIngestStatus as EnrichedVideoIngestStatus,
     scout_video_api_ErrorIngestStatus as ErrorIngestStatus,
     scout_video_api_ErrorType as ErrorType,
+    scout_video_api_FileSummary as FileSummary,
     scout_video_api_GetEnrichedVideoIngestStatusRequest as GetEnrichedVideoIngestStatusRequest,
+    scout_video_api_GetFileSummariesRequest as GetFileSummariesRequest,
+    scout_video_api_GetFileSummariesResponse as GetFileSummariesResponse,
     scout_video_api_GetIngestStatusResponse as GetIngestStatusResponse,
     scout_video_api_GetPlaylistInBoundsRequest as GetPlaylistInBoundsRequest,
     scout_video_api_GetSegmentByTimestampRequest as GetSegmentByTimestampRequest,

{nominal_api-0.600.1 → nominal_api-0.602.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.600.1 → nominal_api-0.602.0}/setup.py

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