visier-platform-sdk 22222222.99200.21494__py3-none-any.whl → 22222222.99200.22144__py3-none-any.whl

visier_platform_sdk/models/{put_project_commits_request.py → event_alert_delete_success_dto.py}

@@ -5,7 +5,7 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99200.21494
+    The version of the OpenAPI document: 22222222.99200.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -23,12 +23,12 @@ from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class PutProjectCommitsRequest(BaseModel):
+class EventAlertDeleteSuccessDTO(BaseModel):
     """
-    PutProjectCommitsRequest
+    The alert that was successfully deleted.
     """ # noqa: E501
-    project_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the draft project you want to import committed changes into.", alias="projectId")
-    __properties: ClassVar[List[str]] = ["projectId"]
+    alert_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the deleted alert.", alias="alertId")
+    __properties: ClassVar[List[str]] = ["alertId"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -48,7 +48,7 @@ class PutProjectCommitsRequest(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of PutProjectCommitsRequest from a JSON string"""
+        """Create an instance of EventAlertDeleteSuccessDTO from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -73,7 +73,7 @@ class PutProjectCommitsRequest(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of PutProjectCommitsRequest from a dict"""
+        """Create an instance of EventAlertDeleteSuccessDTO from a dict"""
         if obj is None:
             return None
 
@@ -81,7 +81,7 @@ class PutProjectCommitsRequest(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "projectId": obj.get("projectId")
+            "alertId": obj.get("alertId")
         })
         return _obj
 

visier_platform_sdk/models/event_alert_dto.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.22144
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.event_alert_trigger_criteria_dto import EventAlertTriggerCriteriaDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EventAlertDTO(BaseModel):
+    """
+    A personalized alert's details, such as its ID and trigger criteria.
+    """ # noqa: E501
+    alert_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the alert.", alias="alertId")
+    trigger_criteria: Optional[EventAlertTriggerCriteriaDTO] = Field(default=None, description="The conditions on which to trigger the personalized alert.", alias="triggerCriteria")
+    display_name: Optional[StrictStr] = Field(default=None, description="The display name of the alert.", alias="displayName")
+    is_enabled_for_user: Optional[StrictBool] = Field(default=None, description="If `true`, the personalized alert is enabled for the user.", alias="isEnabledForUser")
+    __properties: ClassVar[List[str]] = ["alertId", "triggerCriteria", "displayName", "isEnabledForUser"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EventAlertDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of trigger_criteria
+        if self.trigger_criteria:
+            _dict['triggerCriteria'] = self.trigger_criteria.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EventAlertDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "alertId": obj.get("alertId"),
+            "triggerCriteria": EventAlertTriggerCriteriaDTO.from_dict(obj["triggerCriteria"]) if obj.get("triggerCriteria") is not None else None,
+            "displayName": obj.get("displayName"),
+            "isEnabledForUser": obj.get("isEnabledForUser")
+        })
+        return _obj
+
+

visier_platform_sdk/models/event_alert_notification_result_alert_details_dto.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.22144
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.event_alert_trigger_criteria_dto import EventAlertTriggerCriteriaDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EventAlertNotificationResultAlertDetailsDTO(BaseModel):
+    """
+    Information about the alert notification that triggered.
+    """ # noqa: E501
+    trigger_type: Optional[StrictStr] = Field(default=None, description="The event type that triggered the alert.  * `UNSPECIFIED`: An unspecified event triggers the alert. Throws an exception if used.  * `DV_UPDATE`: A data version update triggers the alert.", alias="triggerType")
+    trigger_criteria: Optional[EventAlertTriggerCriteriaDTO] = Field(default=None, description="The conditions on which to trigger the personalized alert.", alias="triggerCriteria")
+    __properties: ClassVar[List[str]] = ["triggerType", "triggerCriteria"]
+
+    @field_validator('trigger_type')
+    def trigger_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['UNSPECIFIED', 'DV_UPDATE']):
+            raise ValueError("must be one of enum values ('UNSPECIFIED', 'DV_UPDATE')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EventAlertNotificationResultAlertDetailsDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of trigger_criteria
+        if self.trigger_criteria:
+            _dict['triggerCriteria'] = self.trigger_criteria.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EventAlertNotificationResultAlertDetailsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "triggerType": obj.get("triggerType"),
+            "triggerCriteria": EventAlertTriggerCriteriaDTO.from_dict(obj["triggerCriteria"]) if obj.get("triggerCriteria") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/event_alert_notification_result_dto.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.22144
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.event_alert_notification_result_alert_details_dto import EventAlertNotificationResultAlertDetailsDTO
+from visier_platform_sdk.models.trigger_criteria_result_info_dto import TriggerCriteriaResultInfoDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EventAlertNotificationResultDTO(BaseModel):
+    """
+    A notification that has triggered for the user.
+    """ # noqa: E501
+    alert_notification_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the alert notification.", alias="alertNotificationId")
+    alert_id: Optional[StrictStr] = Field(default=None, description="The unique identifier the alert that triggered the notification", alias="alertId")
+    created_date: Optional[StrictStr] = Field(default=None, description="The date that the notification generated.", alias="createdDate")
+    alert_details: Optional[EventAlertNotificationResultAlertDetailsDTO] = Field(default=None, description="Information about the triggered alert.", alias="alertDetails")
+    result_info: Optional[List[TriggerCriteriaResultInfoDTO]] = Field(default=None, description="Information about the evaluated metric value.", alias="resultInfo")
+    result_type: Optional[StrictStr] = Field(default=None, description="Whether the metric value was nominal (did not trigger the alert) or triggered the alert. Valid values:  * `TRIGGERED`: The alert was triggered.  * `NOMINAL`: The alert was nominal (not triggered).", alias="resultType")
+    __properties: ClassVar[List[str]] = ["alertNotificationId", "alertId", "createdDate", "alertDetails", "resultInfo", "resultType"]
+
+    @field_validator('result_type')
+    def result_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['NOMINAL', 'TRIGGERED']):
+            raise ValueError("must be one of enum values ('NOMINAL', 'TRIGGERED')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EventAlertNotificationResultDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of alert_details
+        if self.alert_details:
+            _dict['alertDetails'] = self.alert_details.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in result_info (list)
+        _items = []
+        if self.result_info:
+            for _item_result_info in self.result_info:
+                if _item_result_info:
+                    _items.append(_item_result_info.to_dict())
+            _dict['resultInfo'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EventAlertNotificationResultDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "alertNotificationId": obj.get("alertNotificationId"),
+            "alertId": obj.get("alertId"),
+            "createdDate": obj.get("createdDate"),
+            "alertDetails": EventAlertNotificationResultAlertDetailsDTO.from_dict(obj["alertDetails"]) if obj.get("alertDetails") is not None else None,
+            "resultInfo": [TriggerCriteriaResultInfoDTO.from_dict(_item) for _item in obj["resultInfo"]] if obj.get("resultInfo") is not None else None,
+            "resultType": obj.get("resultType")
+        })
+        return _obj
+
+

visier_platform_sdk/models/event_alert_notification_results_dto.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.22144
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.event_alert_notification_result_dto import EventAlertNotificationResultDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EventAlertNotificationResultsDTO(BaseModel):
+    """
+    The notifications that have triggered for the user.
+    """ # noqa: E501
+    notifications: Optional[List[EventAlertNotificationResultDTO]] = Field(default=None, description="The alert notifications that have triggered for the user.")
+    __properties: ClassVar[List[str]] = ["notifications"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EventAlertNotificationResultsDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in notifications (list)
+        _items = []
+        if self.notifications:
+            for _item_notifications in self.notifications:
+                if _item_notifications:
+                    _items.append(_item_notifications.to_dict())
+            _dict['notifications'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EventAlertNotificationResultsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "notifications": [EventAlertNotificationResultDTO.from_dict(_item) for _item in obj["notifications"]] if obj.get("notifications") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/event_alert_trigger_criteria_dto.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.22144
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.grouped_metric_value_threshold_criteria_dto import GroupedMetricValueThresholdCriteriaDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EventAlertTriggerCriteriaDTO(BaseModel):
+    """
+    The conditions on which to trigger the personalized alert.
+    """ # noqa: E501
+    grouped_metric_value_threshold: Optional[GroupedMetricValueThresholdCriteriaDTO] = Field(default=None, description="The metric value threshold and additional conditions that trigger the alert.", alias="groupedMetricValueThreshold")
+    __properties: ClassVar[List[str]] = ["groupedMetricValueThreshold"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EventAlertTriggerCriteriaDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of grouped_metric_value_threshold
+        if self.grouped_metric_value_threshold:
+            _dict['groupedMetricValueThreshold'] = self.grouped_metric_value_threshold.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EventAlertTriggerCriteriaDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "groupedMetricValueThreshold": GroupedMetricValueThresholdCriteriaDTO.from_dict(obj["groupedMetricValueThreshold"]) if obj.get("groupedMetricValueThreshold") is not None else None
+        })
+        return _obj
+
+