nominal-api 0.575.0__py3-none-any.whl → 0.577.0__py3-none-any.whl

nominal_api/__init__.py

@@ -56,6 +56,7 @@ __all__ = [
     'secrets_api',
     'security_api_workspace',
     'storage_datasource_api',
+    'storage_deletion_api',
     'storage_series_api',
     'storage_writer_api',
     'themes_api',
@@ -70,5 +71,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.575.0"
+__version__ = "0.577.0"
 

nominal_api/_impl.py

@@ -67121,6 +67121,121 @@ storage_datasource_api_UpdateNominalDataSourceRequest.__qualname__ = "UpdateNomi
 storage_datasource_api_UpdateNominalDataSourceRequest.__module__ = "nominal_api.storage_datasource_api"
 
 
+class storage_deletion_api_DeleteDataRequest(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'data_source_rid': ConjureFieldDefinition('dataSourceRid', api_rids_NominalDataSourceRid),
+            'time_range': ConjureFieldDefinition('timeRange', OptionalTypeWrapper[storage_deletion_api_TimeRange]),
+            'tags': ConjureFieldDefinition('tags', OptionalTypeWrapper[Dict[api_TagName, api_TagValue]])
+        }
+
+    __slots__: List[str] = ['_data_source_rid', '_time_range', '_tags']
+
+    def __init__(self, data_source_rid: str, tags: Optional[Dict[str, str]] = None, time_range: Optional["storage_deletion_api_TimeRange"] = None) -> None:
+        self._data_source_rid = data_source_rid
+        self._time_range = time_range
+        self._tags = tags
+
+    @builtins.property
+    def data_source_rid(self) -> str:
+        return self._data_source_rid
+
+    @builtins.property
+    def time_range(self) -> Optional["storage_deletion_api_TimeRange"]:
+        """
+        If specified, will only delete data within the given time range.
+If not specified, will delete data across all time.
+        """
+        return self._time_range
+
+    @builtins.property
+    def tags(self) -> Optional[Dict[str, str]]:
+        """
+        If specified, will only delete data that fully matches the given tags.
+If not specified, will delete data across all tags.
+        """
+        return self._tags
+
+
+storage_deletion_api_DeleteDataRequest.__name__ = "DeleteDataRequest"
+storage_deletion_api_DeleteDataRequest.__qualname__ = "DeleteDataRequest"
+storage_deletion_api_DeleteDataRequest.__module__ = "nominal_api.storage_deletion_api"
+
+
+class storage_deletion_api_InternalNominalStorageDataDeletionService(Service):
+    """
+    For internal user only. Contact Nominal support if you need to delete data.
+    """
+
+    def delete(self, auth_header: str, request: "storage_deletion_api_DeleteDataRequest") -> None:
+        """
+        Deletes stored data. This is an irreversible operation so be careful about specified
+time range and tag scope.
+        """
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, Any] = {
+        }
+
+        _json: Any = ConjureEncoder().default(request)
+
+        _path = '/internal/storage-data-deletion/v1/delete-data'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'POST',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        return
+
+
+storage_deletion_api_InternalNominalStorageDataDeletionService.__name__ = "InternalNominalStorageDataDeletionService"
+storage_deletion_api_InternalNominalStorageDataDeletionService.__qualname__ = "InternalNominalStorageDataDeletionService"
+storage_deletion_api_InternalNominalStorageDataDeletionService.__module__ = "nominal_api.storage_deletion_api"
+
+
+class storage_deletion_api_TimeRange(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'start': ConjureFieldDefinition('start', api_Timestamp),
+            'end': ConjureFieldDefinition('end', api_Timestamp)
+        }
+
+    __slots__: List[str] = ['_start', '_end']
+
+    def __init__(self, end: "api_Timestamp", start: "api_Timestamp") -> None:
+        self._start = start
+        self._end = end
+
+    @builtins.property
+    def start(self) -> "api_Timestamp":
+        return self._start
+
+    @builtins.property
+    def end(self) -> "api_Timestamp":
+        return self._end
+
+
+storage_deletion_api_TimeRange.__name__ = "TimeRange"
+storage_deletion_api_TimeRange.__qualname__ = "TimeRange"
+storage_deletion_api_TimeRange.__module__ = "nominal_api.storage_deletion_api"
+
+
 class storage_series_api_BatchCreateOrGetResponse(ConjureBeanType):
 
     @builtins.classmethod

nominal_api/storage_deletion_api/__init__.py

@@ -0,0 +1,7 @@
+# coding=utf-8
+from .._impl import (
+    storage_deletion_api_DeleteDataRequest as DeleteDataRequest,
+    storage_deletion_api_InternalNominalStorageDataDeletionService as InternalNominalStorageDataDeletionService,
+    storage_deletion_api_TimeRange as TimeRange,
+)
+

{nominal_api-0.575.0.dist-info → nominal_api-0.577.0.dist-info}/METADATA

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

{nominal_api-0.575.0.dist-info → nominal_api-0.577.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=HCKQc2z2QvBS11aFF-6EutJymt_qr1gXbHbJsj6owxI,1823
-nominal_api/_impl.py,sha256=HYCAbZ7xojfMbOVAhIV18ifh0GRix-ucGB6SLzB5ysQ,2811995
+nominal_api/__init__.py,sha256=WpxIsCJJqYGo_bt7mfGSmyNDPSjb8KC6li7a8dFyKRs,1851
+nominal_api/_impl.py,sha256=Ic-DWaFn7WKkhVCmlOlyjg9oe7IIKJEv31FZL2GkmQA,2815967
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=kJBEE_HLVpKYdLH12KyO-cSAVzwxYpBwaaDutCtT-LM,1236
 nominal_api/api_rids/__init__.py,sha256=Bu-pKUh3aS9_f5m-DZf6W_BUlVo9qYE7EDvaT-rvWQ0,423
@@ -57,6 +57,7 @@ nominal_api/scout_workbookcommon_api/__init__.py,sha256=6Ai0cYNOOw2A6JOlKzraTbpZ
 nominal_api/secrets_api/__init__.py,sha256=V5BpnbNzjdMP8kgvR2N6SEVcVyXi6Vyl_lh_5fKjJzw,736
 nominal_api/security_api_workspace/__init__.py,sha256=18MQr8sUGDfaXl50sMR7objE5rBJ9dZ1Sjwuyf997dA,156
 nominal_api/storage_datasource_api/__init__.py,sha256=jh_OZE_b4nBNAvnyenBjw8aGZOnvIXR6qvUKd31fXOk,445
+nominal_api/storage_deletion_api/__init__.py,sha256=2bIuAU0tcnT_8lqae0fcII4R45A_RzfV0y_E-vTkpSQ,267
 nominal_api/storage_series_api/__init__.py,sha256=HapfYMCap8kDYXh7_kjsdywLqwterOB0OdVUyU3QZz8,829
 nominal_api/storage_writer_api/__init__.py,sha256=kr14YqN44wGfHJIy_7hti6KFq5caA1523i45P2GX8hM,909
 nominal_api/themes_api/__init__.py,sha256=w-G93T5f6_2zSSUi-ffyUHxH8QA_2oI9jM7YBSMFpwY,924
@@ -67,7 +68,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=7NlQhIzOKOcjwMNUI89f
 nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=U9EhlqdF9qzD1O9al0vcvcdgS_C5lq-lN3Kmr0K3g84,1191
 nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
-nominal_api-0.575.0.dist-info/METADATA,sha256=fCOx2cAm1jPb5vYqtC7bBUTBaUV1QATH3Im0LUrDgjQ,199
-nominal_api-0.575.0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-nominal_api-0.575.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.575.0.dist-info/RECORD,,
+nominal_api-0.577.0.dist-info/METADATA,sha256=qtT6o47rR41f4FoKoNeNdOruxqVosFycq51PobUOcgI,199
+nominal_api-0.577.0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+nominal_api-0.577.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.577.0.dist-info/RECORD,,