nominal-api 0.600.0__tar.gz → 0.601.0__tar.gz

{nominal_api-0.600.0 → nominal_api-0.601.0}/PKG-INFO

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

{nominal_api-0.600.0 → nominal_api-0.601.0}/nominal_api/__init__.py

@@ -75,5 +75,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.600.0"
+__version__ = "0.601.0"
 

{nominal_api-0.600.0 → nominal_api-0.601.0}/nominal_api/_impl.py

@@ -57028,15 +57028,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 +57052,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 +57300,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 +57311,7 @@ class scout_integrations_api_IntegrationsService(Service):
         }
 
         _params: Dict[str, Any] = {
+            'workspace': workspace,
         }
 
         _path_params: Dict[str, Any] = {
@@ -57481,10 +57492,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 +57504,7 @@ class scout_integrations_api_IntegrationsService(Service):
         }
 
         _params: Dict[str, Any] = {
+            'workspaces': workspaces,
         }
 
         _path_params: Dict[str, Any] = {
@@ -57914,6 +57927,7 @@ class scout_internal_search_api_SearchQuery(ConjureUnionType):
     _property: Optional["api_Property"] = None
     _and_: Optional[List["scout_internal_search_api_SearchQuery"]] = None
     _or_: Optional[List["scout_internal_search_api_SearchQuery"]] = None
+    _workspace: Optional[str] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -57928,7 +57942,8 @@ class scout_internal_search_api_SearchQuery(ConjureUnionType):
             'label': ConjureFieldDefinition('label', api_Label),
             'property': ConjureFieldDefinition('property', api_Property),
             'and_': ConjureFieldDefinition('and', List[scout_internal_search_api_SearchQuery]),
-            'or_': ConjureFieldDefinition('or', List[scout_internal_search_api_SearchQuery])
+            'or_': ConjureFieldDefinition('or', List[scout_internal_search_api_SearchQuery]),
+            'workspace': ConjureFieldDefinition('workspace', api_ids_WorkspaceId)
         }
 
     def __init__(
@@ -57944,10 +57959,11 @@ class scout_internal_search_api_SearchQuery(ConjureUnionType):
             property: Optional["api_Property"] = None,
             and_: Optional[List["scout_internal_search_api_SearchQuery"]] = None,
             or_: Optional[List["scout_internal_search_api_SearchQuery"]] = None,
+            workspace: Optional[str] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (date_time_field is not None) + (string_field is not None) + (timestamp_field is not None) + (long_field is not None) + (boolean_field is not None) + (exact_match is not None) + (search_text is not None) + (label is not None) + (property is not None) + (and_ is not None) + (or_ is not None) != 1:
+            if (date_time_field is not None) + (string_field is not None) + (timestamp_field is not None) + (long_field is not None) + (boolean_field is not None) + (exact_match is not None) + (search_text is not None) + (label is not None) + (property is not None) + (and_ is not None) + (or_ is not None) + (workspace is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if date_time_field is not None:
@@ -57983,6 +57999,9 @@ class scout_internal_search_api_SearchQuery(ConjureUnionType):
             if or_ is not None:
                 self._or_ = or_
                 self._type = 'or'
+            if workspace is not None:
+                self._workspace = workspace
+                self._type = 'workspace'
 
         elif type_of_union == 'dateTimeField':
             if date_time_field is None:
@@ -58039,6 +58058,11 @@ class scout_internal_search_api_SearchQuery(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._or_ = or_
             self._type = 'or'
+        elif type_of_union == 'workspace':
+            if workspace is None:
+                raise ValueError('a union value must not be None')
+            self._workspace = workspace
+            self._type = 'workspace'
 
     @builtins.property
     def date_time_field(self) -> Optional["scout_internal_search_api_DateTimeField"]:
@@ -58087,6 +58111,10 @@ class scout_internal_search_api_SearchQuery(ConjureUnionType):
     def or_(self) -> Optional[List["scout_internal_search_api_SearchQuery"]]:
         return self._or_
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        return self._workspace
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, scout_internal_search_api_SearchQueryVisitor):
             raise ValueError('{} is not an instance of scout_internal_search_api_SearchQueryVisitor'.format(visitor.__class__.__name__))
@@ -58112,6 +58140,8 @@ class scout_internal_search_api_SearchQuery(ConjureUnionType):
             return visitor._and(self.and_)
         if self._type == 'or' and self.or_ is not None:
             return visitor._or(self.or_)
+        if self._type == 'workspace' and self.workspace is not None:
+            return visitor._workspace(self.workspace)
 
 
 scout_internal_search_api_SearchQuery.__name__ = "SearchQuery"
@@ -58165,6 +58195,10 @@ class scout_internal_search_api_SearchQueryVisitor:
     def _or(self, or_: List["scout_internal_search_api_SearchQuery"]) -> Any:
         pass
 
+    @abstractmethod
+    def _workspace(self, workspace: str) -> Any:
+        pass
+
 
 scout_internal_search_api_SearchQueryVisitor.__name__ = "SearchQueryVisitor"
 scout_internal_search_api_SearchQueryVisitor.__qualname__ = "SearchQueryVisitor"
@@ -61202,14 +61236,16 @@ class scout_run_api_GetRunByIdRequest(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'run_number': ConjureFieldDefinition('runNumber', int),
-            'run_prefix': ConjureFieldDefinition('runPrefix', OptionalTypeWrapper[str])
+            'run_prefix': ConjureFieldDefinition('runPrefix', OptionalTypeWrapper[str]),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_run_number', '_run_prefix']
+    __slots__: List[str] = ['_run_number', '_run_prefix', '_workspace']
 
-    def __init__(self, run_number: int, run_prefix: Optional[str] = None) -> None:
+    def __init__(self, run_number: int, run_prefix: Optional[str] = None, workspace: Optional[str] = None) -> None:
         self._run_number = run_number
         self._run_prefix = run_prefix
+        self._workspace = workspace
 
     @builtins.property
     def run_number(self) -> int:
@@ -61219,6 +61255,16 @@ class scout_run_api_GetRunByIdRequest(ConjureBeanType):
     def run_prefix(self) -> Optional[str]:
         return self._run_prefix
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to query for the run. If not provided, the run
+will be queried in the default workspace for the user's organization,
+if the default workspace for the organization is configured and the user
+has access to it.
+        """
+        return self._workspace
+
 
 scout_run_api_GetRunByIdRequest.__name__ = "GetRunByIdRequest"
 scout_run_api_GetRunByIdRequest.__qualname__ = "GetRunByIdRequest"
@@ -65049,6 +65095,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"
@@ -65441,6 +65522,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
@@ -65470,6 +65580,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.0 → nominal_api-0.601.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.0 → nominal_api-0.601.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.600.0 → nominal_api-0.601.0}/setup.py

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