nominal-api 0.532.0__py3-none-any.whl → 0.532.1__py3-none-any.whl

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.
nominal_api/__init__.py CHANGED
@@ -68,5 +68,5 @@ __all__ = [
68
68
 
69
69
  __conjure_generator_version__ = "4.9.0"
70
70
 
71
- __version__ = "0.532.0"
71
+ __version__ = "0.532.1"
72
72
 
nominal_api/_impl.py CHANGED
@@ -5080,6 +5080,22 @@ datasource_pagination_api_PageResponse.__qualname__ = "PageResponse"
5080
5080
  datasource_pagination_api_PageResponse.__module__ = "nominal_api.datasource_pagination_api"
5081
5081
 
5082
5082
 
5083
+ class event_ApiEventOrigin(ConjureBeanType):
5084
+
5085
+ @builtins.classmethod
5086
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
5087
+ return {
5088
+ }
5089
+
5090
+ __slots__: List[str] = []
5091
+
5092
+
5093
+
5094
+ event_ApiEventOrigin.__name__ = "ApiEventOrigin"
5095
+ event_ApiEventOrigin.__qualname__ = "ApiEventOrigin"
5096
+ event_ApiEventOrigin.__module__ = "nominal_api.event"
5097
+
5098
+
5083
5099
  class event_ArchiveEvent(ConjureBeanType):
5084
5100
 
5085
5101
  @builtins.classmethod
@@ -5144,7 +5160,7 @@ class event_CreateEvent(ConjureBeanType):
5144
5160
  @builtins.property
5145
5161
  def origins(self) -> List["event_EventOrigin"]:
5146
5162
  """
5147
- Should be nonempty, but not enforced yet.
5163
+ If empty, will default to set<EventOrigin.api>. Should be nonempty, but not enforced yet.
5148
5164
  """
5149
5165
  return self._origins
5150
5166
 
@@ -5281,30 +5297,27 @@ event_Event.__module__ = "nominal_api.event"
5281
5297
 
5282
5298
  class event_EventOrigin(ConjureUnionType):
5283
5299
  """Describes where an event came from."""
5284
- _workbook: Optional[str] = None
5285
- _template: Optional[str] = None
5286
- _api_key: Optional[str] = None
5287
- _manual_user: Optional[str] = None
5300
+ _workbook: Optional["event_WorkbookEventOrigin"] = None
5301
+ _template: Optional["event_TemplateEventOrigin"] = None
5302
+ _api: Optional["event_ApiEventOrigin"] = None
5288
5303
 
5289
5304
  @builtins.classmethod
5290
5305
  def _options(cls) -> Dict[str, ConjureFieldDefinition]:
5291
5306
  return {
5292
- 'workbook': ConjureFieldDefinition('workbook', scout_rids_api_NotebookRid),
5293
- 'template': ConjureFieldDefinition('template', scout_rids_api_TemplateRid),
5294
- 'api_key': ConjureFieldDefinition('apiKey', scout_rids_api_ApiKeyRid),
5295
- 'manual_user': ConjureFieldDefinition('manualUser', scout_rids_api_UserRid)
5307
+ 'workbook': ConjureFieldDefinition('workbook', event_WorkbookEventOrigin),
5308
+ 'template': ConjureFieldDefinition('template', event_TemplateEventOrigin),
5309
+ 'api': ConjureFieldDefinition('api', event_ApiEventOrigin)
5296
5310
  }
5297
5311
 
5298
5312
  def __init__(
5299
5313
  self,
5300
- workbook: Optional[str] = None,
5301
- template: Optional[str] = None,
5302
- api_key: Optional[str] = None,
5303
- manual_user: Optional[str] = None,
5314
+ workbook: Optional["event_WorkbookEventOrigin"] = None,
5315
+ template: Optional["event_TemplateEventOrigin"] = None,
5316
+ api: Optional["event_ApiEventOrigin"] = None,
5304
5317
  type_of_union: Optional[str] = None
5305
5318
  ) -> None:
5306
5319
  if type_of_union is None:
5307
- if (workbook is not None) + (template is not None) + (api_key is not None) + (manual_user is not None) != 1:
5320
+ if (workbook is not None) + (template is not None) + (api is not None) != 1:
5308
5321
  raise ValueError('a union must contain a single member')
5309
5322
 
5310
5323
  if workbook is not None:
@@ -5313,12 +5326,9 @@ class event_EventOrigin(ConjureUnionType):
5313
5326
  if template is not None:
5314
5327
  self._template = template
5315
5328
  self._type = 'template'
5316
- if api_key is not None:
5317
- self._api_key = api_key
5318
- self._type = 'apiKey'
5319
- if manual_user is not None:
5320
- self._manual_user = manual_user
5321
- self._type = 'manualUser'
5329
+ if api is not None:
5330
+ self._api = api
5331
+ self._type = 'api'
5322
5332
 
5323
5333
  elif type_of_union == 'workbook':
5324
5334
  if workbook is None:
@@ -5330,44 +5340,32 @@ class event_EventOrigin(ConjureUnionType):
5330
5340
  raise ValueError('a union value must not be None')
5331
5341
  self._template = template
5332
5342
  self._type = 'template'
5333
- elif type_of_union == 'apiKey':
5334
- if api_key is None:
5343
+ elif type_of_union == 'api':
5344
+ if api is None:
5335
5345
  raise ValueError('a union value must not be None')
5336
- self._api_key = api_key
5337
- self._type = 'apiKey'
5338
- elif type_of_union == 'manualUser':
5339
- if manual_user is None:
5340
- raise ValueError('a union value must not be None')
5341
- self._manual_user = manual_user
5342
- self._type = 'manualUser'
5346
+ self._api = api
5347
+ self._type = 'api'
5343
5348
 
5344
5349
  @builtins.property
5345
- def workbook(self) -> Optional[str]:
5350
+ def workbook(self) -> Optional["event_WorkbookEventOrigin"]:
5346
5351
  """
5347
5352
  This event was created in this workbook
5348
5353
  """
5349
5354
  return self._workbook
5350
5355
 
5351
5356
  @builtins.property
5352
- def template(self) -> Optional[str]:
5357
+ def template(self) -> Optional["event_TemplateEventOrigin"]:
5353
5358
  """
5354
5359
  This event was created in this template
5355
5360
  """
5356
5361
  return self._template
5357
5362
 
5358
5363
  @builtins.property
5359
- def api_key(self) -> Optional[str]:
5364
+ def api(self) -> Optional["event_ApiEventOrigin"]:
5360
5365
  """
5361
- This event was created programmatically using this persistent API key
5366
+ This event was created programmatically via the API
5362
5367
  """
5363
- return self._api_key
5364
-
5365
- @builtins.property
5366
- def manual_user(self) -> Optional[str]:
5367
- """
5368
- This event was created programmatically using ephemeral authentication by this user
5369
- """
5370
- return self._manual_user
5368
+ return self._api
5371
5369
 
5372
5370
  def accept(self, visitor) -> Any:
5373
5371
  if not isinstance(visitor, event_EventOriginVisitor):
@@ -5376,10 +5374,8 @@ class event_EventOrigin(ConjureUnionType):
5376
5374
  return visitor._workbook(self.workbook)
5377
5375
  if self._type == 'template' and self.template is not None:
5378
5376
  return visitor._template(self.template)
5379
- if self._type == 'apiKey' and self.api_key is not None:
5380
- return visitor._api_key(self.api_key)
5381
- if self._type == 'manualUser' and self.manual_user is not None:
5382
- return visitor._manual_user(self.manual_user)
5377
+ if self._type == 'api' and self.api is not None:
5378
+ return visitor._api(self.api)
5383
5379
 
5384
5380
 
5385
5381
  event_EventOrigin.__name__ = "EventOrigin"
@@ -5390,19 +5386,15 @@ event_EventOrigin.__module__ = "nominal_api.event"
5390
5386
  class event_EventOriginVisitor:
5391
5387
 
5392
5388
  @abstractmethod
5393
- def _workbook(self, workbook: str) -> Any:
5394
- pass
5395
-
5396
- @abstractmethod
5397
- def _template(self, template: str) -> Any:
5389
+ def _workbook(self, workbook: "event_WorkbookEventOrigin") -> Any:
5398
5390
  pass
5399
5391
 
5400
5392
  @abstractmethod
5401
- def _api_key(self, api_key: str) -> Any:
5393
+ def _template(self, template: "event_TemplateEventOrigin") -> Any:
5402
5394
  pass
5403
5395
 
5404
5396
  @abstractmethod
5405
- def _manual_user(self, manual_user: str) -> Any:
5397
+ def _api(self, api: "event_ApiEventOrigin") -> Any:
5406
5398
  pass
5407
5399
 
5408
5400
 
@@ -5963,6 +5955,29 @@ event_SortOptions.__qualname__ = "SortOptions"
5963
5955
  event_SortOptions.__module__ = "nominal_api.event"
5964
5956
 
5965
5957
 
5958
+ class event_TemplateEventOrigin(ConjureBeanType):
5959
+
5960
+ @builtins.classmethod
5961
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
5962
+ return {
5963
+ 'rid': ConjureFieldDefinition('rid', scout_rids_api_TemplateRid)
5964
+ }
5965
+
5966
+ __slots__: List[str] = ['_rid']
5967
+
5968
+ def __init__(self, rid: str) -> None:
5969
+ self._rid = rid
5970
+
5971
+ @builtins.property
5972
+ def rid(self) -> str:
5973
+ return self._rid
5974
+
5975
+
5976
+ event_TemplateEventOrigin.__name__ = "TemplateEventOrigin"
5977
+ event_TemplateEventOrigin.__qualname__ = "TemplateEventOrigin"
5978
+ event_TemplateEventOrigin.__module__ = "nominal_api.event"
5979
+
5980
+
5966
5981
  class event_UpdateEvent(ConjureBeanType):
5967
5982
 
5968
5983
  @builtins.classmethod
@@ -5970,7 +5985,6 @@ class event_UpdateEvent(ConjureBeanType):
5970
5985
  return {
5971
5986
  'uuid': ConjureFieldDefinition('uuid', str),
5972
5987
  'asset_rids': ConjureFieldDefinition('assetRids', OptionalTypeWrapper[List[scout_rids_api_AssetRid]]),
5973
- 'origins': ConjureFieldDefinition('origins', OptionalTypeWrapper[List[event_EventOrigin]]),
5974
5988
  'authorization_rid': ConjureFieldDefinition('authorizationRid', OptionalTypeWrapper[str]),
5975
5989
  'timestamp': ConjureFieldDefinition('timestamp', OptionalTypeWrapper[api_Timestamp]),
5976
5990
  'duration': ConjureFieldDefinition('duration', OptionalTypeWrapper[scout_run_api_Duration]),
@@ -5980,12 +5994,11 @@ class event_UpdateEvent(ConjureBeanType):
5980
5994
  'properties': ConjureFieldDefinition('properties', OptionalTypeWrapper[Dict[scout_run_api_PropertyName, scout_run_api_PropertyValue]])
5981
5995
  }
5982
5996
 
5983
- __slots__: List[str] = ['_uuid', '_asset_rids', '_origins', '_authorization_rid', '_timestamp', '_duration', '_name', '_type', '_labels', '_properties']
5997
+ __slots__: List[str] = ['_uuid', '_asset_rids', '_authorization_rid', '_timestamp', '_duration', '_name', '_type', '_labels', '_properties']
5984
5998
 
5985
- 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:
5999
+ 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:
5986
6000
  self._uuid = uuid
5987
6001
  self._asset_rids = asset_rids
5988
- self._origins = origins
5989
6002
  self._authorization_rid = authorization_rid
5990
6003
  self._timestamp = timestamp
5991
6004
  self._duration = duration
@@ -6006,10 +6019,6 @@ If provided, must contain at least one asset rid.
6006
6019
  """
6007
6020
  return self._asset_rids
6008
6021
 
6009
- @builtins.property
6010
- def origins(self) -> Optional[List["event_EventOrigin"]]:
6011
- return self._origins
6012
-
6013
6022
  @builtins.property
6014
6023
  def authorization_rid(self) -> Optional[str]:
6015
6024
  return self._authorization_rid
@@ -6044,6 +6053,29 @@ event_UpdateEvent.__qualname__ = "UpdateEvent"
6044
6053
  event_UpdateEvent.__module__ = "nominal_api.event"
6045
6054
 
6046
6055
 
6056
+ class event_WorkbookEventOrigin(ConjureBeanType):
6057
+
6058
+ @builtins.classmethod
6059
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
6060
+ return {
6061
+ 'rid': ConjureFieldDefinition('rid', scout_rids_api_NotebookRid)
6062
+ }
6063
+
6064
+ __slots__: List[str] = ['_rid']
6065
+
6066
+ def __init__(self, rid: str) -> None:
6067
+ self._rid = rid
6068
+
6069
+ @builtins.property
6070
+ def rid(self) -> str:
6071
+ return self._rid
6072
+
6073
+
6074
+ event_WorkbookEventOrigin.__name__ = "WorkbookEventOrigin"
6075
+ event_WorkbookEventOrigin.__qualname__ = "WorkbookEventOrigin"
6076
+ event_WorkbookEventOrigin.__module__ = "nominal_api.event"
6077
+
6078
+
6047
6079
  class ingest_api_AbsoluteTimestamp(ConjureUnionType):
6048
6080
  _iso8601: Optional["ingest_api_Iso8601Timestamp"] = None
6049
6081
  _epoch_of_time_unit: Optional["ingest_api_EpochTimestamp"] = None
@@ -1,5 +1,6 @@
1
1
  # coding=utf-8
2
2
  from .._impl import (
3
+ event_ApiEventOrigin as ApiEventOrigin,
3
4
  event_ArchiveEvent as ArchiveEvent,
4
5
  event_CreateEvent as CreateEvent,
5
6
  event_Event as Event,
@@ -15,6 +16,8 @@ from .._impl import (
15
16
  event_SearchQueryVisitor as SearchQueryVisitor,
16
17
  event_SortField as SortField,
17
18
  event_SortOptions as SortOptions,
19
+ event_TemplateEventOrigin as TemplateEventOrigin,
18
20
  event_UpdateEvent as UpdateEvent,
21
+ event_WorkbookEventOrigin as WorkbookEventOrigin,
19
22
  )
20
23
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: nominal-api
3
- Version: 0.532.0
3
+ Version: 0.532.1
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<3,>=2.8.0
@@ -1,5 +1,5 @@
1
- nominal_api/__init__.py,sha256=ZjIVy-oHiLM5DrOVv0cWRSrlDjVZJ1mEhCgig5qcxFE,1762
2
- nominal_api/_impl.py,sha256=Zc2DxEYdQKI_hEp1oJW9JCIbfnmHkYpRtPldBbE0ClE,2614360
1
+ nominal_api/__init__.py,sha256=6v-h5xKA7PXtrBjMWbMxYJljPPDwKMyfhwfV6sdp1_Y,1762
2
+ nominal_api/_impl.py,sha256=EzWLv4Mg9VRQhV2qxTVgMde0TZZ8M3VGpqh3j6IZXPM,2614815
3
3
  nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
4
4
  nominal_api/api/__init__.py,sha256=CaUmWhW0zcP8jVWFQEgj-lpoBi-Unm0wBd2s9dPeWmo,656
5
5
  nominal_api/api_rids/__init__.py,sha256=p7dKiMV692oGtYStr5FZJEJNg3YbF7scJK1WFMpBiW0,298
@@ -13,7 +13,7 @@ nominal_api/datasource_api/__init__.py,sha256=aEC6jdCM8G2fLwxYfOZiQ_mjCq_lwDHqBf
13
13
  nominal_api/datasource_logset/__init__.py,sha256=H3fNxqyYC490MwvdWbt5BwhgWQUev7uieaLz5hUbZDc,94
14
14
  nominal_api/datasource_logset_api/__init__.py,sha256=oaCU4hTiUXPnJbivlCUoPPYRw7prpZtxbv-hgUaiOWQ,1048
15
15
  nominal_api/datasource_pagination_api/__init__.py,sha256=3GO8TAUavOe6dUEitOhje74aSZHjTKVI5N1MNuct1lI,212
16
- nominal_api/event/__init__.py,sha256=B1OINwLPb5GGiFFJiALLbVj81w9cS7GACG4zMj8agY0,684
16
+ nominal_api/event/__init__.py,sha256=YUhvDFXtyAn08WNd7Xwnybz3PtflvtTcIOaunRS5-1I,836
17
17
  nominal_api/ingest_api/__init__.py,sha256=q9Ep0KofeeXH-qz5qrFHDHvc3ZkIAH8jxVnRc5jBLac,5752
18
18
  nominal_api/scout/__init__.py,sha256=ip3XK_9jJKAoFiCifUVMTpDMiUE4mWIdGzMDu7LASus,324
19
19
  nominal_api/scout_api/__init__.py,sha256=1qhOIaeE1BOyulaGr6dd9rSneKMEeqW9aJgz_Wg2qd0,208
@@ -65,7 +65,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=Jl2NCquuN8bNw6Pl1J-X
65
65
  nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
66
66
  nominal_api/timeseries_seriescache_api/__init__.py,sha256=YLixotb-W-adYR6t_RBsJDwoHttppkOBesoaXERwhVs,1240
67
67
  nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
68
- nominal_api-0.532.0.dist-info/METADATA,sha256=PMEBn_W1-9Scw0lO985RC3Tvonz74KduUQhExKEZ5Vg,199
69
- nominal_api-0.532.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
70
- nominal_api-0.532.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
71
- nominal_api-0.532.0.dist-info/RECORD,,
68
+ nominal_api-0.532.1.dist-info/METADATA,sha256=eoNOW6gpRc9SRsGponb_zFmrhw4NVQ-NPaxJ7Eih4ic,199
69
+ nominal_api-0.532.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
70
+ nominal_api-0.532.1.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
71
+ nominal_api-0.532.1.dist-info/RECORD,,