nominal-api 0.582.0__tar.gz → 0.584.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of nominal-api might be problematic. Click here for more details.

Files changed (80) hide show
  1. {nominal_api-0.582.0 → nominal_api-0.584.0}/PKG-INFO +1 -1
  2. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/__init__.py +1 -1
  3. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/_impl.py +122 -236
  4. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_api/__init__.py +2 -0
  5. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_run_api/__init__.py +0 -2
  6. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_video_api/__init__.py +0 -2
  7. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api.egg-info/PKG-INFO +1 -1
  8. {nominal_api-0.582.0 → nominal_api-0.584.0}/setup.py +1 -1
  9. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/api/__init__.py +0 -0
  10. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/api_rids/__init__.py +0 -0
  11. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/attachments_api/__init__.py +0 -0
  12. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/authentication_api/__init__.py +0 -0
  13. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/authorization/__init__.py +0 -0
  14. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/comments_api/__init__.py +0 -0
  15. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/connect_download/__init__.py +0 -0
  16. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/datasource/__init__.py +0 -0
  17. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/datasource_api/__init__.py +0 -0
  18. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/datasource_logset/__init__.py +0 -0
  19. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/datasource_logset_api/__init__.py +0 -0
  20. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/datasource_pagination_api/__init__.py +0 -0
  21. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/event/__init__.py +0 -0
  22. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/ingest_api/__init__.py +0 -0
  23. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/py.typed +0 -0
  24. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout/__init__.py +0 -0
  25. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_asset_api/__init__.py +0 -0
  26. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_assets/__init__.py +0 -0
  27. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_catalog/__init__.py +0 -0
  28. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_channelvariables_api/__init__.py +0 -0
  29. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_chart_api/__init__.py +0 -0
  30. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_chartdefinition_api/__init__.py +0 -0
  31. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_checklistexecution_api/__init__.py +0 -0
  32. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_checks_api/__init__.py +0 -0
  33. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_comparisonnotebook_api/__init__.py +0 -0
  34. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_comparisonrun_api/__init__.py +0 -0
  35. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_compute_api/__init__.py +0 -0
  36. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_compute_api_deprecated/__init__.py +0 -0
  37. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_compute_representation_api/__init__.py +0 -0
  38. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_compute_resolved_api/__init__.py +0 -0
  39. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_dataexport_api/__init__.py +0 -0
  40. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_datareview_api/__init__.py +0 -0
  41. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_datasource/__init__.py +0 -0
  42. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_datasource_connection/__init__.py +0 -0
  43. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_datasource_connection_api/__init__.py +0 -0
  44. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_datasource_connection_api_influx/__init__.py +0 -0
  45. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_favorites/__init__.py +0 -0
  46. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_favorites_api/__init__.py +0 -0
  47. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_integrations_api/__init__.py +0 -0
  48. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_internal_search_api/__init__.py +0 -0
  49. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_jobs_api/__init__.py +0 -0
  50. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_layout_api/__init__.py +0 -0
  51. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_metadata/__init__.py +0 -0
  52. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_notebook_api/__init__.py +0 -0
  53. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_plotting/__init__.py +0 -0
  54. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_rids_api/__init__.py +0 -0
  55. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_template_api/__init__.py +0 -0
  56. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_units_api/__init__.py +0 -0
  57. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_versioning_api/__init__.py +0 -0
  58. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_video/__init__.py +0 -0
  59. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/scout_workbookcommon_api/__init__.py +0 -0
  60. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/secrets_api/__init__.py +0 -0
  61. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/security_api_workspace/__init__.py +0 -0
  62. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/storage_datasource_api/__init__.py +0 -0
  63. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/storage_deletion_api/__init__.py +0 -0
  64. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/storage_series_api/__init__.py +0 -0
  65. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/storage_writer_api/__init__.py +0 -0
  66. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/themes_api/__init__.py +0 -0
  67. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/timeseries_archetype/__init__.py +0 -0
  68. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/timeseries_archetype_api/__init__.py +0 -0
  69. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/timeseries_channelmetadata/__init__.py +0 -0
  70. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/timeseries_channelmetadata_api/__init__.py +0 -0
  71. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/timeseries_logicalseries/__init__.py +0 -0
  72. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/timeseries_logicalseries_api/__init__.py +0 -0
  73. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/timeseries_seriescache/__init__.py +0 -0
  74. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/timeseries_seriescache_api/__init__.py +0 -0
  75. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api/upload_api/__init__.py +0 -0
  76. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api.egg-info/SOURCES.txt +0 -0
  77. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api.egg-info/dependency_links.txt +0 -0
  78. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api.egg-info/requires.txt +0 -0
  79. {nominal_api-0.582.0 → nominal_api-0.584.0}/nominal_api.egg-info/top_level.txt +0 -0
  80. {nominal_api-0.582.0 → nominal_api-0.584.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: nominal-api
3
- Version: 0.582.0
3
+ Version: 0.584.0
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<3,>=2.8.0
@@ -73,5 +73,5 @@ __all__ = [
73
73
 
74
74
  __conjure_generator_version__ = "4.9.0"
75
75
 
76
- __version__ = "0.582.0"
76
+ __version__ = "0.584.0"
77
77
 
@@ -6846,12 +6846,12 @@ class ingest_api_ExistingVideoIngestDestination(ConjureBeanType):
6846
6846
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
6847
6847
  return {
6848
6848
  'video_rid': ConjureFieldDefinition('videoRid', api_rids_VideoRid),
6849
- 'video_file_details': ConjureFieldDefinition('videoFileDetails', ingest_api_VideoFileIngestDetails)
6849
+ 'video_file_details': ConjureFieldDefinition('videoFileDetails', OptionalTypeWrapper[ingest_api_VideoFileIngestDetails])
6850
6850
  }
6851
6851
 
6852
6852
  __slots__: List[str] = ['_video_rid', '_video_file_details']
6853
6853
 
6854
- def __init__(self, video_file_details: "ingest_api_VideoFileIngestDetails", video_rid: str) -> None:
6854
+ def __init__(self, video_rid: str, video_file_details: Optional["ingest_api_VideoFileIngestDetails"] = None) -> None:
6855
6855
  self._video_rid = video_rid
6856
6856
  self._video_file_details = video_file_details
6857
6857
 
@@ -6863,7 +6863,7 @@ class ingest_api_ExistingVideoIngestDestination(ConjureBeanType):
6863
6863
  return self._video_rid
6864
6864
 
6865
6865
  @builtins.property
6866
- def video_file_details(self) -> "ingest_api_VideoFileIngestDetails":
6866
+ def video_file_details(self) -> Optional["ingest_api_VideoFileIngestDetails"]:
6867
6867
  """
6868
6868
  Metadata to associate with any created video file
6869
6869
  """
@@ -9615,13 +9615,13 @@ class ingest_api_VideoFileIngestDetails(ConjureBeanType):
9615
9615
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
9616
9616
  return {
9617
9617
  'file_description': ConjureFieldDefinition('fileDescription', OptionalTypeWrapper[str]),
9618
- 'file_properties': ConjureFieldDefinition('fileProperties', Dict[api_PropertyName, api_PropertyValue]),
9619
- 'file_labels': ConjureFieldDefinition('fileLabels', List[api_Label])
9618
+ 'file_properties': ConjureFieldDefinition('fileProperties', OptionalTypeWrapper[Dict[api_PropertyName, api_PropertyValue]]),
9619
+ 'file_labels': ConjureFieldDefinition('fileLabels', OptionalTypeWrapper[List[api_Label]])
9620
9620
  }
9621
9621
 
9622
9622
  __slots__: List[str] = ['_file_description', '_file_properties', '_file_labels']
9623
9623
 
9624
- def __init__(self, file_labels: List[str], file_properties: Dict[str, str], file_description: Optional[str] = None) -> None:
9624
+ def __init__(self, file_description: Optional[str] = None, file_labels: Optional[List[str]] = None, file_properties: Optional[Dict[str, str]] = None) -> None:
9625
9625
  self._file_description = file_description
9626
9626
  self._file_properties = file_properties
9627
9627
  self._file_labels = file_labels
@@ -9635,14 +9635,14 @@ If not provided, defaults to the description used to create the video.
9635
9635
  return self._file_description
9636
9636
 
9637
9637
  @builtins.property
9638
- def file_properties(self) -> Dict[str, str]:
9638
+ def file_properties(self) -> Optional[Dict[str, str]]:
9639
9639
  """
9640
9640
  Key-Value properties that are applied to the newly created video file.
9641
9641
  """
9642
9642
  return self._file_properties
9643
9643
 
9644
9644
  @builtins.property
9645
- def file_labels(self) -> List[str]:
9645
+ def file_labels(self) -> Optional[List[str]]:
9646
9646
  """
9647
9647
  Labels that are applied to the newly created video file.
9648
9648
  """
@@ -12086,6 +12086,83 @@ scout_api_ChannelLocator.__qualname__ = "ChannelLocator"
12086
12086
  scout_api_ChannelLocator.__module__ = "nominal_api.scout_api"
12087
12087
 
12088
12088
 
12089
+ class scout_api_DataScope(ConjureBeanType):
12090
+
12091
+ @builtins.classmethod
12092
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
12093
+ return {
12094
+ 'data_source': ConjureFieldDefinition('dataSource', scout_run_api_DataSource),
12095
+ 'offset': ConjureFieldDefinition('offset', scout_run_api_Duration),
12096
+ 'ref_name': ConjureFieldDefinition('refName', scout_api_DataSourceRefName),
12097
+ 'timestamp_type': ConjureFieldDefinition('timestampType', scout_api_WeakTimestampType),
12098
+ 'series_tags': ConjureFieldDefinition('seriesTags', Dict[api_TagName, api_TagValue])
12099
+ }
12100
+
12101
+ __slots__: List[str] = ['_data_source', '_offset', '_ref_name', '_timestamp_type', '_series_tags']
12102
+
12103
+ def __init__(self, data_source: "scout_run_api_DataSource", offset: "scout_run_api_Duration", ref_name: str, series_tags: Dict[str, str], timestamp_type: "scout_api_WeakTimestampType") -> None:
12104
+ self._data_source = data_source
12105
+ self._offset = offset
12106
+ self._ref_name = ref_name
12107
+ self._timestamp_type = timestamp_type
12108
+ self._series_tags = series_tags
12109
+
12110
+ @builtins.property
12111
+ def data_source(self) -> "scout_run_api_DataSource":
12112
+ return self._data_source
12113
+
12114
+ @builtins.property
12115
+ def offset(self) -> "scout_run_api_Duration":
12116
+ """
12117
+ This offset is used for small time-sync corrections. Notably, it is
12118
+ not the offset to move a relative data source to the start of the run.
12119
+ """
12120
+ return self._offset
12121
+
12122
+ @builtins.property
12123
+ def ref_name(self) -> str:
12124
+ return self._ref_name
12125
+
12126
+ @builtins.property
12127
+ def timestamp_type(self) -> "scout_api_WeakTimestampType":
12128
+ return self._timestamp_type
12129
+
12130
+ @builtins.property
12131
+ def series_tags(self) -> Dict[str, str]:
12132
+ """
12133
+ Used to resolve logical series for this data source.
12134
+ """
12135
+ return self._series_tags
12136
+
12137
+
12138
+ scout_api_DataScope.__name__ = "DataScope"
12139
+ scout_api_DataScope.__qualname__ = "DataScope"
12140
+ scout_api_DataScope.__module__ = "nominal_api.scout_api"
12141
+
12142
+
12143
+ class scout_api_WeakTimestampType(ConjureEnumType):
12144
+ """
12145
+ If a CSV data source is still being split, the timestamp type is not known.
12146
+ """
12147
+
12148
+ ABSOLUTE = 'ABSOLUTE'
12149
+ '''ABSOLUTE'''
12150
+ RELATIVE = 'RELATIVE'
12151
+ '''RELATIVE'''
12152
+ PENDING = 'PENDING'
12153
+ '''PENDING'''
12154
+ UNKNOWN = 'UNKNOWN'
12155
+ '''UNKNOWN'''
12156
+
12157
+ def __reduce_ex__(self, proto):
12158
+ return self.__class__, (self.name,)
12159
+
12160
+
12161
+ scout_api_WeakTimestampType.__name__ = "WeakTimestampType"
12162
+ scout_api_WeakTimestampType.__qualname__ = "WeakTimestampType"
12163
+ scout_api_WeakTimestampType.__module__ = "nominal_api.scout_api"
12164
+
12165
+
12089
12166
  class scout_asset_api_AddDataScopesToAssetRequest(ConjureBeanType):
12090
12167
 
12091
12168
  @builtins.classmethod
@@ -12225,6 +12302,10 @@ scout_asset_api_Asset.__module__ = "nominal_api.scout_asset_api"
12225
12302
 
12226
12303
 
12227
12304
  class scout_asset_api_AssetDataScope(ConjureBeanType):
12305
+ """
12306
+ This type is equivalent to the DataScope type, except it uses a dataScopeName instead of refName. It will
12307
+ eventually be deprecated in favor of DataScope.
12308
+ """
12228
12309
 
12229
12310
  @builtins.classmethod
12230
12311
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -12232,13 +12313,13 @@ class scout_asset_api_AssetDataScope(ConjureBeanType):
12232
12313
  'data_scope_name': ConjureFieldDefinition('dataScopeName', scout_asset_api_DataScopeName),
12233
12314
  'data_source': ConjureFieldDefinition('dataSource', scout_run_api_DataSource),
12234
12315
  'offset': ConjureFieldDefinition('offset', OptionalTypeWrapper[scout_run_api_Duration]),
12235
- 'timestamp_type': ConjureFieldDefinition('timestampType', scout_run_api_WeakTimestampType),
12316
+ 'timestamp_type': ConjureFieldDefinition('timestampType', scout_api_WeakTimestampType),
12236
12317
  'series_tags': ConjureFieldDefinition('seriesTags', Dict[scout_asset_api_SeriesTagName, scout_asset_api_SeriesTagValue])
12237
12318
  }
12238
12319
 
12239
12320
  __slots__: List[str] = ['_data_scope_name', '_data_source', '_offset', '_timestamp_type', '_series_tags']
12240
12321
 
12241
- def __init__(self, data_scope_name: str, data_source: "scout_run_api_DataSource", series_tags: Dict[str, str], timestamp_type: "scout_run_api_WeakTimestampType", offset: Optional["scout_run_api_Duration"] = None) -> None:
12322
+ def __init__(self, data_scope_name: str, data_source: "scout_run_api_DataSource", series_tags: Dict[str, str], timestamp_type: "scout_api_WeakTimestampType", offset: Optional["scout_run_api_Duration"] = None) -> None:
12242
12323
  self._data_scope_name = data_scope_name
12243
12324
  self._data_source = data_source
12244
12325
  self._offset = offset
@@ -12261,7 +12342,7 @@ class scout_asset_api_AssetDataScope(ConjureBeanType):
12261
12342
  return self._offset
12262
12343
 
12263
12344
  @builtins.property
12264
- def timestamp_type(self) -> "scout_run_api_WeakTimestampType":
12345
+ def timestamp_type(self) -> "scout_api_WeakTimestampType":
12265
12346
  return self._timestamp_type
12266
12347
 
12267
12348
  @builtins.property
@@ -60277,16 +60358,17 @@ class scout_run_api_Run(ConjureBeanType):
60277
60358
  'links': ConjureFieldDefinition('links', List[scout_run_api_Link]),
60278
60359
  'created_at': ConjureFieldDefinition('createdAt', str),
60279
60360
  'updated_at': ConjureFieldDefinition('updatedAt', str),
60280
- 'asset_data_scopes': ConjureFieldDefinition('assetDataScopes', List[scout_asset_api_AssetDataScope]),
60281
- 'data_sources': ConjureFieldDefinition('dataSources', Dict[scout_api_DataSourceRefName, scout_run_api_RunDataSource]),
60361
+ 'asset_data_scopes': ConjureFieldDefinition('assetDataScopes', List[scout_api_DataScope]),
60362
+ 'additional_data_scopes': ConjureFieldDefinition('additionalDataScopes', List[scout_api_DataScope]),
60363
+ 'data_sources': ConjureFieldDefinition('dataSources', Dict[scout_api_DataSourceRefName, scout_api_DataScope]),
60282
60364
  'attachments': ConjureFieldDefinition('attachments', List[api_rids_AttachmentRid]),
60283
60365
  'asset': ConjureFieldDefinition('asset', OptionalTypeWrapper[scout_rids_api_AssetRid]),
60284
60366
  'assets': ConjureFieldDefinition('assets', List[scout_rids_api_AssetRid])
60285
60367
  }
60286
60368
 
60287
- __slots__: List[str] = ['_rid', '_run_number', '_run_prefix', '_title', '_description', '_author_rid', '_start_time', '_end_time', '_properties', '_labels', '_links', '_created_at', '_updated_at', '_asset_data_scopes', '_data_sources', '_attachments', '_asset', '_assets']
60369
+ __slots__: List[str] = ['_rid', '_run_number', '_run_prefix', '_title', '_description', '_author_rid', '_start_time', '_end_time', '_properties', '_labels', '_links', '_created_at', '_updated_at', '_asset_data_scopes', '_additional_data_scopes', '_data_sources', '_attachments', '_asset', '_assets']
60288
60370
 
60289
- def __init__(self, asset_data_scopes: List["scout_asset_api_AssetDataScope"], assets: List[str], attachments: List[str], created_at: str, data_sources: Dict[str, "scout_run_api_RunDataSource"], description: str, labels: List[str], links: List["scout_run_api_Link"], properties: Dict[str, str], rid: str, run_number: int, start_time: "scout_run_api_UtcTimestamp", title: str, updated_at: str, asset: Optional[str] = None, author_rid: Optional[str] = None, end_time: Optional["scout_run_api_UtcTimestamp"] = None, run_prefix: Optional[str] = None) -> None:
60371
+ def __init__(self, additional_data_scopes: List["scout_api_DataScope"], asset_data_scopes: List["scout_api_DataScope"], assets: List[str], attachments: List[str], created_at: str, data_sources: Dict[str, "scout_api_DataScope"], description: str, labels: List[str], links: List["scout_run_api_Link"], properties: Dict[str, str], rid: str, run_number: int, start_time: "scout_run_api_UtcTimestamp", title: str, updated_at: str, asset: Optional[str] = None, author_rid: Optional[str] = None, end_time: Optional["scout_run_api_UtcTimestamp"] = None, run_prefix: Optional[str] = None) -> None:
60290
60372
  self._rid = rid
60291
60373
  self._run_number = run_number
60292
60374
  self._run_prefix = run_prefix
@@ -60301,6 +60383,7 @@ class scout_run_api_Run(ConjureBeanType):
60301
60383
  self._created_at = created_at
60302
60384
  self._updated_at = updated_at
60303
60385
  self._asset_data_scopes = asset_data_scopes
60386
+ self._additional_data_scopes = additional_data_scopes
60304
60387
  self._data_sources = data_sources
60305
60388
  self._attachments = attachments
60306
60389
  self._asset = asset
@@ -60359,14 +60442,24 @@ class scout_run_api_Run(ConjureBeanType):
60359
60442
  return self._updated_at
60360
60443
 
60361
60444
  @builtins.property
60362
- def asset_data_scopes(self) -> List["scout_asset_api_AssetDataScope"]:
60445
+ def asset_data_scopes(self) -> List["scout_api_DataScope"]:
60363
60446
  """
60364
60447
  returns the data scopes for the assets associated with the run.
60365
60448
  """
60366
60449
  return self._asset_data_scopes
60367
60450
 
60368
60451
  @builtins.property
60369
- def data_sources(self) -> Dict[str, "scout_run_api_RunDataSource"]:
60452
+ def additional_data_scopes(self) -> List["scout_api_DataScope"]:
60453
+ """
60454
+ returns any data scopes added directly to the run.
60455
+ """
60456
+ return self._additional_data_scopes
60457
+
60458
+ @builtins.property
60459
+ def data_sources(self) -> Dict[str, "scout_api_DataScope"]:
60460
+ """
60461
+ returns all of the data scopes under the run. This includes data scopes of any associated assets. If there are data scopes attached directly to the run that have the same ref name as data scopes from the asset, they will override them.
60462
+ """
60370
60463
  return self._data_sources
60371
60464
 
60372
60465
  @builtins.property
@@ -60464,66 +60557,6 @@ scout_run_api_RunDataReviewSummary.__qualname__ = "RunDataReviewSummary"
60464
60557
  scout_run_api_RunDataReviewSummary.__module__ = "nominal_api.scout_run_api"
60465
60558
 
60466
60559
 
60467
- class scout_run_api_RunDataSource(ConjureBeanType):
60468
- """
60469
- For read requests, we want to require all fields
60470
- """
60471
-
60472
- @builtins.classmethod
60473
- def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
60474
- return {
60475
- 'data_source': ConjureFieldDefinition('dataSource', scout_run_api_DataSource),
60476
- 'offset': ConjureFieldDefinition('offset', scout_run_api_Duration),
60477
- 'ref_name': ConjureFieldDefinition('refName', scout_api_DataSourceRefName),
60478
- 'timestamp_type': ConjureFieldDefinition('timestampType', scout_run_api_WeakTimestampType),
60479
- 'series_tags': ConjureFieldDefinition('seriesTags', Dict[api_TagName, api_TagValue])
60480
- }
60481
-
60482
- __slots__: List[str] = ['_data_source', '_offset', '_ref_name', '_timestamp_type', '_series_tags']
60483
-
60484
- def __init__(self, data_source: "scout_run_api_DataSource", offset: "scout_run_api_Duration", ref_name: str, series_tags: Dict[str, str], timestamp_type: "scout_run_api_WeakTimestampType") -> None:
60485
- self._data_source = data_source
60486
- self._offset = offset
60487
- self._ref_name = ref_name
60488
- self._timestamp_type = timestamp_type
60489
- self._series_tags = series_tags
60490
-
60491
- @builtins.property
60492
- def data_source(self) -> "scout_run_api_DataSource":
60493
- return self._data_source
60494
-
60495
- @builtins.property
60496
- def offset(self) -> "scout_run_api_Duration":
60497
- """
60498
- This offset is used for small time-sync corrections. Notably, it is
60499
- not the offset to move a relative data source to the start of the run.
60500
- """
60501
- return self._offset
60502
-
60503
- @builtins.property
60504
- def ref_name(self) -> str:
60505
- """
60506
- Included for convenience, duplicated from the key of the map
60507
- """
60508
- return self._ref_name
60509
-
60510
- @builtins.property
60511
- def timestamp_type(self) -> "scout_run_api_WeakTimestampType":
60512
- return self._timestamp_type
60513
-
60514
- @builtins.property
60515
- def series_tags(self) -> Dict[str, str]:
60516
- """
60517
- Used to resolve logical series for this data source.
60518
- """
60519
- return self._series_tags
60520
-
60521
-
60522
- scout_run_api_RunDataSource.__name__ = "RunDataSource"
60523
- scout_run_api_RunDataSource.__qualname__ = "RunDataSource"
60524
- scout_run_api_RunDataSource.__module__ = "nominal_api.scout_run_api"
60525
-
60526
-
60527
60560
  class scout_run_api_RunWithDataReviewMetrics(ConjureBeanType):
60528
60561
 
60529
60562
  @builtins.classmethod
@@ -61378,29 +61411,6 @@ scout_run_api_UtcTimestamp.__qualname__ = "UtcTimestamp"
61378
61411
  scout_run_api_UtcTimestamp.__module__ = "nominal_api.scout_run_api"
61379
61412
 
61380
61413
 
61381
- class scout_run_api_WeakTimestampType(ConjureEnumType):
61382
- """
61383
- If a CSV data source is still being split, the timestamp type is not known.
61384
- """
61385
-
61386
- ABSOLUTE = 'ABSOLUTE'
61387
- '''ABSOLUTE'''
61388
- RELATIVE = 'RELATIVE'
61389
- '''RELATIVE'''
61390
- PENDING = 'PENDING'
61391
- '''PENDING'''
61392
- UNKNOWN = 'UNKNOWN'
61393
- '''UNKNOWN'''
61394
-
61395
- def __reduce_ex__(self, proto):
61396
- return self.__class__, (self.name,)
61397
-
61398
-
61399
- scout_run_api_WeakTimestampType.__name__ = "WeakTimestampType"
61400
- scout_run_api_WeakTimestampType.__qualname__ = "WeakTimestampType"
61401
- scout_run_api_WeakTimestampType.__module__ = "nominal_api.scout_run_api"
61402
-
61403
-
61404
61414
  class scout_template_api_CommitTemplateRequest(ConjureBeanType):
61405
61415
 
61406
61416
  @builtins.classmethod
@@ -62960,7 +62970,7 @@ class scout_video_VideoFileService(Service):
62960
62970
 
62961
62971
  def batch_get(self, auth_header: str, video_file_rids: List[str] = None) -> List["scout_video_api_VideoFile"]:
62962
62972
  """
62963
- Returns video file metadata associated with the given video file RIDs.
62973
+ Returns all video files and their metadata associated with the given RIDs
62964
62974
  """
62965
62975
  video_file_rids = video_file_rids if video_file_rids is not None else []
62966
62976
 
@@ -62991,9 +63001,9 @@ class scout_video_VideoFileService(Service):
62991
63001
  _decoder = ConjureDecoder()
62992
63002
  return _decoder.decode(_response.json(), List[scout_video_api_VideoFile], self._return_none_for_unknown_union_types)
62993
63003
 
62994
- def search(self, auth_header: str, request: "scout_video_api_SearchVideoFilesRequest") -> "scout_video_api_SearchVideoFilesResponse":
63004
+ def list_files_in_video(self, auth_header: str, video_rid: str) -> List["scout_video_api_VideoFile"]:
62995
63005
  """
62996
- Returns metadata about video files that match a given query.
63006
+ Returns all video files and their metadata associated with the given video RID.
62997
63007
  """
62998
63008
 
62999
63009
  _headers: Dict[str, Any] = {
@@ -63008,9 +63018,9 @@ class scout_video_VideoFileService(Service):
63008
63018
  _path_params: Dict[str, Any] = {
63009
63019
  }
63010
63020
 
63011
- _json: Any = ConjureEncoder().default(request)
63021
+ _json: Any = ConjureEncoder().default(video_rid)
63012
63022
 
63013
- _path = '/video-files/v1/video-files/search'
63023
+ _path = '/video-files/v1/video-files/list-files-in-video'
63014
63024
  _path = _path.format(**_path_params)
63015
63025
 
63016
63026
  _response: Response = self._request(
@@ -63021,7 +63031,7 @@ class scout_video_VideoFileService(Service):
63021
63031
  json=_json)
63022
63032
 
63023
63033
  _decoder = ConjureDecoder()
63024
- return _decoder.decode(_response.json(), scout_video_api_SearchVideoFilesResponse, self._return_none_for_unknown_union_types)
63034
+ return _decoder.decode(_response.json(), List[scout_video_api_VideoFile], self._return_none_for_unknown_union_types)
63025
63035
 
63026
63036
  def update(self, auth_header: str, request: "scout_video_api_UpdateVideoFileRequest", video_file_rid: str) -> "scout_video_api_VideoFile":
63027
63037
  """
@@ -63921,19 +63931,15 @@ class scout_video_api_CreateVideoFileRequest(ConjureBeanType):
63921
63931
  return {
63922
63932
  'title': ConjureFieldDefinition('title', str),
63923
63933
  'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
63924
- 'labels': ConjureFieldDefinition('labels', List[api_Label]),
63925
- 'properties': ConjureFieldDefinition('properties', Dict[api_PropertyName, api_PropertyValue]),
63926
63934
  'origin_metadata': ConjureFieldDefinition('originMetadata', scout_video_api_VideoFileOriginMetadata),
63927
63935
  'video_rid': ConjureFieldDefinition('videoRid', api_rids_VideoRid)
63928
63936
  }
63929
63937
 
63930
- __slots__: List[str] = ['_title', '_description', '_labels', '_properties', '_origin_metadata', '_video_rid']
63938
+ __slots__: List[str] = ['_title', '_description', '_origin_metadata', '_video_rid']
63931
63939
 
63932
- def __init__(self, labels: List[str], origin_metadata: "scout_video_api_VideoFileOriginMetadata", properties: Dict[str, str], title: str, video_rid: str, description: Optional[str] = None) -> None:
63940
+ def __init__(self, origin_metadata: "scout_video_api_VideoFileOriginMetadata", title: str, video_rid: str, description: Optional[str] = None) -> None:
63933
63941
  self._title = title
63934
63942
  self._description = description
63935
- self._labels = labels
63936
- self._properties = properties
63937
63943
  self._origin_metadata = origin_metadata
63938
63944
  self._video_rid = video_rid
63939
63945
 
@@ -63945,14 +63951,6 @@ class scout_video_api_CreateVideoFileRequest(ConjureBeanType):
63945
63951
  def description(self) -> Optional[str]:
63946
63952
  return self._description
63947
63953
 
63948
- @builtins.property
63949
- def labels(self) -> List[str]:
63950
- return self._labels
63951
-
63952
- @builtins.property
63953
- def properties(self) -> Dict[str, str]:
63954
- return self._properties
63955
-
63956
63954
  @builtins.property
63957
63955
  def origin_metadata(self) -> "scout_video_api_VideoFileOriginMetadata":
63958
63956
  return self._origin_metadata
@@ -64438,94 +64436,6 @@ scout_video_api_ScaleParameterVisitor.__qualname__ = "ScaleParameterVisitor"
64438
64436
  scout_video_api_ScaleParameterVisitor.__module__ = "nominal_api.scout_video_api"
64439
64437
 
64440
64438
 
64441
- class scout_video_api_SearchVideoFilesRequest(ConjureBeanType):
64442
- """
64443
- Request to get video files based on a user-provided query
64444
- """
64445
-
64446
- @builtins.classmethod
64447
- def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
64448
- return {
64449
- 'query': ConjureFieldDefinition('query', scout_video_api_SearchVideosQuery),
64450
- 'page_size': ConjureFieldDefinition('pageSize', OptionalTypeWrapper[int]),
64451
- 'token': ConjureFieldDefinition('token', OptionalTypeWrapper[api_Token]),
64452
- 'sort_options': ConjureFieldDefinition('sortOptions', scout_video_api_SortOptions),
64453
- 'archived_statuses': ConjureFieldDefinition('archivedStatuses', OptionalTypeWrapper[List[api_ArchivedStatus]])
64454
- }
64455
-
64456
- __slots__: List[str] = ['_query', '_page_size', '_token', '_sort_options', '_archived_statuses']
64457
-
64458
- def __init__(self, query: "scout_video_api_SearchVideosQuery", sort_options: "scout_video_api_SortOptions", archived_statuses: Optional[List["api_ArchivedStatus"]] = None, page_size: Optional[int] = None, token: Optional[str] = None) -> None:
64459
- self._query = query
64460
- self._page_size = page_size
64461
- self._token = token
64462
- self._sort_options = sort_options
64463
- self._archived_statuses = archived_statuses
64464
-
64465
- @builtins.property
64466
- def query(self) -> "scout_video_api_SearchVideosQuery":
64467
- return self._query
64468
-
64469
- @builtins.property
64470
- def page_size(self) -> Optional[int]:
64471
- """
64472
- Defaults to 100. Will throw if larger than 1_000.
64473
- """
64474
- return self._page_size
64475
-
64476
- @builtins.property
64477
- def token(self) -> Optional[str]:
64478
- return self._token
64479
-
64480
- @builtins.property
64481
- def sort_options(self) -> "scout_video_api_SortOptions":
64482
- return self._sort_options
64483
-
64484
- @builtins.property
64485
- def archived_statuses(self) -> Optional[List["api_ArchivedStatus"]]:
64486
- """
64487
- Default search status is NOT_ARCHIVED if none are provided.
64488
- """
64489
- return self._archived_statuses
64490
-
64491
-
64492
- scout_video_api_SearchVideoFilesRequest.__name__ = "SearchVideoFilesRequest"
64493
- scout_video_api_SearchVideoFilesRequest.__qualname__ = "SearchVideoFilesRequest"
64494
- scout_video_api_SearchVideoFilesRequest.__module__ = "nominal_api.scout_video_api"
64495
-
64496
-
64497
- class scout_video_api_SearchVideoFilesResponse(ConjureBeanType):
64498
- """
64499
- Paginated response containing requested video file metadata.
64500
- """
64501
-
64502
- @builtins.classmethod
64503
- def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
64504
- return {
64505
- 'results': ConjureFieldDefinition('results', List[scout_video_api_VideoFile]),
64506
- 'next_page_token': ConjureFieldDefinition('nextPageToken', OptionalTypeWrapper[api_Token])
64507
- }
64508
-
64509
- __slots__: List[str] = ['_results', '_next_page_token']
64510
-
64511
- def __init__(self, results: List["scout_video_api_VideoFile"], next_page_token: Optional[str] = None) -> None:
64512
- self._results = results
64513
- self._next_page_token = next_page_token
64514
-
64515
- @builtins.property
64516
- def results(self) -> List["scout_video_api_VideoFile"]:
64517
- return self._results
64518
-
64519
- @builtins.property
64520
- def next_page_token(self) -> Optional[str]:
64521
- return self._next_page_token
64522
-
64523
-
64524
- scout_video_api_SearchVideoFilesResponse.__name__ = "SearchVideoFilesResponse"
64525
- scout_video_api_SearchVideoFilesResponse.__qualname__ = "SearchVideoFilesResponse"
64526
- scout_video_api_SearchVideoFilesResponse.__module__ = "nominal_api.scout_video_api"
64527
-
64528
-
64529
64439
  class scout_video_api_SearchVideosQuery(ConjureUnionType):
64530
64440
  _search_text: Optional[str] = None
64531
64441
  _label: Optional[str] = None
@@ -65163,20 +65073,16 @@ class scout_video_api_UpdateVideoFileRequest(ConjureBeanType):
65163
65073
  'video_rid': ConjureFieldDefinition('videoRid', OptionalTypeWrapper[api_rids_VideoRid]),
65164
65074
  'title': ConjureFieldDefinition('title', OptionalTypeWrapper[str]),
65165
65075
  'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
65166
- 'labels': ConjureFieldDefinition('labels', OptionalTypeWrapper[List[api_Label]]),
65167
- 'properties': ConjureFieldDefinition('properties', OptionalTypeWrapper[Dict[api_PropertyName, api_PropertyValue]]),
65168
65076
  'starting_timestamp': ConjureFieldDefinition('startingTimestamp', OptionalTypeWrapper[api_Timestamp]),
65169
65077
  'scale_parameter': ConjureFieldDefinition('scaleParameter', OptionalTypeWrapper[scout_video_api_ScaleParameter])
65170
65078
  }
65171
65079
 
65172
- __slots__: List[str] = ['_video_rid', '_title', '_description', '_labels', '_properties', '_starting_timestamp', '_scale_parameter']
65080
+ __slots__: List[str] = ['_video_rid', '_title', '_description', '_starting_timestamp', '_scale_parameter']
65173
65081
 
65174
- def __init__(self, description: Optional[str] = None, labels: Optional[List[str]] = None, properties: Optional[Dict[str, str]] = None, scale_parameter: Optional["scout_video_api_ScaleParameter"] = None, starting_timestamp: Optional["api_Timestamp"] = None, title: Optional[str] = None, video_rid: Optional[str] = None) -> None:
65082
+ def __init__(self, description: Optional[str] = None, scale_parameter: Optional["scout_video_api_ScaleParameter"] = None, starting_timestamp: Optional["api_Timestamp"] = None, title: Optional[str] = None, video_rid: Optional[str] = None) -> None:
65175
65083
  self._video_rid = video_rid
65176
65084
  self._title = title
65177
65085
  self._description = description
65178
- self._labels = labels
65179
- self._properties = properties
65180
65086
  self._starting_timestamp = starting_timestamp
65181
65087
  self._scale_parameter = scale_parameter
65182
65088
 
@@ -65192,14 +65098,6 @@ class scout_video_api_UpdateVideoFileRequest(ConjureBeanType):
65192
65098
  def description(self) -> Optional[str]:
65193
65099
  return self._description
65194
65100
 
65195
- @builtins.property
65196
- def labels(self) -> Optional[List[str]]:
65197
- return self._labels
65198
-
65199
- @builtins.property
65200
- def properties(self) -> Optional[Dict[str, str]]:
65201
- return self._properties
65202
-
65203
65101
  @builtins.property
65204
65102
  def starting_timestamp(self) -> Optional["api_Timestamp"]:
65205
65103
  return self._starting_timestamp
@@ -65457,23 +65355,19 @@ class scout_video_api_VideoFile(ConjureBeanType):
65457
65355
  'video_rid': ConjureFieldDefinition('videoRid', api_rids_VideoRid),
65458
65356
  'title': ConjureFieldDefinition('title', str),
65459
65357
  'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
65460
- 'labels': ConjureFieldDefinition('labels', List[api_Label]),
65461
- 'properties': ConjureFieldDefinition('properties', Dict[api_PropertyName, api_PropertyValue]),
65462
65358
  'created_by': ConjureFieldDefinition('createdBy', str),
65463
65359
  'created_at': ConjureFieldDefinition('createdAt', str),
65464
65360
  'origin_metadata': ConjureFieldDefinition('originMetadata', scout_video_api_VideoFileOriginMetadata),
65465
65361
  'segment_metadata': ConjureFieldDefinition('segmentMetadata', OptionalTypeWrapper[scout_video_api_VideoFileSegmentsMetadata])
65466
65362
  }
65467
65363
 
65468
- __slots__: List[str] = ['_rid', '_video_rid', '_title', '_description', '_labels', '_properties', '_created_by', '_created_at', '_origin_metadata', '_segment_metadata']
65364
+ __slots__: List[str] = ['_rid', '_video_rid', '_title', '_description', '_created_by', '_created_at', '_origin_metadata', '_segment_metadata']
65469
65365
 
65470
- def __init__(self, created_at: str, created_by: str, labels: List[str], origin_metadata: "scout_video_api_VideoFileOriginMetadata", properties: Dict[str, str], rid: str, title: str, video_rid: str, description: Optional[str] = None, segment_metadata: Optional["scout_video_api_VideoFileSegmentsMetadata"] = None) -> None:
65366
+ def __init__(self, created_at: str, created_by: str, origin_metadata: "scout_video_api_VideoFileOriginMetadata", rid: str, title: str, video_rid: str, description: Optional[str] = None, segment_metadata: Optional["scout_video_api_VideoFileSegmentsMetadata"] = None) -> None:
65471
65367
  self._rid = rid
65472
65368
  self._video_rid = video_rid
65473
65369
  self._title = title
65474
65370
  self._description = description
65475
- self._labels = labels
65476
- self._properties = properties
65477
65371
  self._created_by = created_by
65478
65372
  self._created_at = created_at
65479
65373
  self._origin_metadata = origin_metadata
@@ -65495,14 +65389,6 @@ class scout_video_api_VideoFile(ConjureBeanType):
65495
65389
  def description(self) -> Optional[str]:
65496
65390
  return self._description
65497
65391
 
65498
- @builtins.property
65499
- def labels(self) -> List[str]:
65500
- return self._labels
65501
-
65502
- @builtins.property
65503
- def properties(self) -> Dict[str, str]:
65504
- return self._properties
65505
-
65506
65392
  @builtins.property
65507
65393
  def created_by(self) -> str:
65508
65394
  return self._created_by
@@ -1,7 +1,9 @@
1
1
  # coding=utf-8
2
2
  from .._impl import (
3
3
  scout_api_ChannelLocator as ChannelLocator,
4
+ scout_api_DataScope as DataScope,
4
5
  scout_api_DataSourceRefName as DataSourceRefName,
5
6
  scout_api_HexColor as HexColor,
7
+ scout_api_WeakTimestampType as WeakTimestampType,
6
8
  )
7
9
 
@@ -24,7 +24,6 @@ from .._impl import (
24
24
  scout_run_api_Run as Run,
25
25
  scout_run_api_RunDataReviewEvaluationStatus as RunDataReviewEvaluationStatus,
26
26
  scout_run_api_RunDataReviewSummary as RunDataReviewSummary,
27
- scout_run_api_RunDataSource as RunDataSource,
28
27
  scout_run_api_RunRid as RunRid,
29
28
  scout_run_api_RunWithDataReviewMetrics as RunWithDataReviewMetrics,
30
29
  scout_run_api_RunWithDataReviewSummary as RunWithDataReviewSummary,
@@ -42,6 +41,5 @@ from .._impl import (
42
41
  scout_run_api_UpdateAttachmentsRequest as UpdateAttachmentsRequest,
43
42
  scout_run_api_UpdateRunRequest as UpdateRunRequest,
44
43
  scout_run_api_UtcTimestamp as UtcTimestamp,
45
- scout_run_api_WeakTimestampType as WeakTimestampType,
46
44
  )
47
45
 
@@ -19,8 +19,6 @@ from .._impl import (
19
19
  scout_video_api_NoTimestampManifest as NoTimestampManifest,
20
20
  scout_video_api_ScaleParameter as ScaleParameter,
21
21
  scout_video_api_ScaleParameterVisitor as ScaleParameterVisitor,
22
- scout_video_api_SearchVideoFilesRequest as SearchVideoFilesRequest,
23
- scout_video_api_SearchVideoFilesResponse as SearchVideoFilesResponse,
24
22
  scout_video_api_SearchVideosQuery as SearchVideosQuery,
25
23
  scout_video_api_SearchVideosQueryVisitor as SearchVideosQueryVisitor,
26
24
  scout_video_api_SearchVideosRequest as SearchVideosRequest,
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: nominal-api
3
- Version: 0.582.0
3
+ Version: 0.584.0
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<3,>=2.8.0
@@ -6,7 +6,7 @@ from setuptools import (
6
6
 
7
7
  setup(
8
8
  name='nominal-api',
9
- version='0.582.0',
9
+ version='0.584.0',
10
10
  python_requires='>=3.8',
11
11
  package_data={"": ["py.typed"]},
12
12
  packages=find_packages(),
File without changes