pingram-python 0.1.0__py3-none-any.whl

pingram/models/notification.py

@@ -0,0 +1,126 @@
+# coding: utf-8
+
+"""
+    NotificationAPI
+
+    Internal API for notification delivery and management
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from pingram.models.channels_enum import ChannelsEnum
+from pingram.models.get_notifications_response_inner_deduplication import GetNotificationsResponseInnerDeduplication
+from pingram.models.get_notifications_response_inner_options import GetNotificationsResponseInnerOptions
+from pingram.models.get_notifications_response_inner_templates_inner import GetNotificationsResponseInnerTemplatesInner
+from pingram.models.get_notifications_response_inner_throttling import GetNotificationsResponseInnerThrottling
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Notification(BaseModel):
+    """
+    Notification
+    """ # noqa: E501
+    env_id: StrictStr = Field(alias="envId")
+    notification_id: StrictStr = Field(alias="notificationId")
+    title: StrictStr
+    channels: List[ChannelsEnum]
+    enabled: StrictBool
+    deduplication: Optional[GetNotificationsResponseInnerDeduplication] = None
+    throttling: Optional[GetNotificationsResponseInnerThrottling] = None
+    retention: Optional[Union[StrictFloat, StrictInt]] = None
+    options: Optional[GetNotificationsResponseInnerOptions] = None
+    templates: Optional[List[GetNotificationsResponseInnerTemplatesInner]] = None
+    __properties: ClassVar[List[str]] = ["envId", "notificationId", "title", "channels", "enabled", "deduplication", "throttling", "retention", "options", "templates"]
+
+    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 Notification 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 deduplication
+        if self.deduplication:
+            _dict['deduplication'] = self.deduplication.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of throttling
+        if self.throttling:
+            _dict['throttling'] = self.throttling.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of options
+        if self.options:
+            _dict['options'] = self.options.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in templates (list)
+        _items = []
+        if self.templates:
+            for _item_templates in self.templates:
+                if _item_templates:
+                    _items.append(_item_templates.to_dict())
+            _dict['templates'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Notification from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "envId": obj.get("envId"),
+            "notificationId": obj.get("notificationId"),
+            "title": obj.get("title"),
+            "channels": obj.get("channels"),
+            "enabled": obj.get("enabled"),
+            "deduplication": GetNotificationsResponseInnerDeduplication.from_dict(obj["deduplication"]) if obj.get("deduplication") is not None else None,
+            "throttling": GetNotificationsResponseInnerThrottling.from_dict(obj["throttling"]) if obj.get("throttling") is not None else None,
+            "retention": obj.get("retention"),
+            "options": GetNotificationsResponseInnerOptions.from_dict(obj["options"]) if obj.get("options") is not None else None,
+            "templates": [GetNotificationsResponseInnerTemplatesInner.from_dict(_item) for _item in obj["templates"]] if obj.get("templates") is not None else None
+        })
+        return _obj
+
+

pingram/models/notification_create_request.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    NotificationAPI
+
+    Internal API for notification delivery and management
+
+    The version of the OpenAPI document: 1.0.0
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from pingram.models.get_notifications_response_inner_options import GetNotificationsResponseInnerOptions
+from typing import Optional, Set
+from typing_extensions import Self
+
+class NotificationCreateRequest(BaseModel):
+    """
+    NotificationCreateRequest
+    """ # noqa: E501
+    notification_id: StrictStr = Field(alias="notificationId")
+    title: StrictStr
+    channels: List[StrictStr]
+    options: Optional[GetNotificationsResponseInnerOptions] = None
+    __properties: ClassVar[List[str]] = ["notificationId", "title", "channels", "options"]
+
+    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 NotificationCreateRequest 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 options
+        if self.options:
+            _dict['options'] = self.options.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NotificationCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "notificationId": obj.get("notificationId"),
+            "title": obj.get("title"),
+            "channels": obj.get("channels"),
+            "options": GetNotificationsResponseInnerOptions.from_dict(obj["options"]) if obj.get("options") is not None else None
+        })
+        return _obj
+
+

pingram/models/notification_patch_request.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    NotificationAPI
+
+    Internal API for notification delivery and management
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from pingram.models.channels_enum import ChannelsEnum
+from pingram.models.get_notifications_response_inner_deduplication import GetNotificationsResponseInnerDeduplication
+from pingram.models.get_notifications_response_inner_options import GetNotificationsResponseInnerOptions
+from pingram.models.get_notifications_response_inner_throttling import GetNotificationsResponseInnerThrottling
+from typing import Optional, Set
+from typing_extensions import Self
+
+class NotificationPatchRequest(BaseModel):
+    """
+    NotificationPatchRequest
+    """ # noqa: E501
+    title: Optional[StrictStr] = None
+    channels: Optional[List[ChannelsEnum]] = None
+    enabled: Optional[StrictBool] = None
+    deduplication: Optional[GetNotificationsResponseInnerDeduplication] = None
+    throttling: Optional[GetNotificationsResponseInnerThrottling] = None
+    retention: Optional[Union[StrictFloat, StrictInt]] = None
+    options: Optional[GetNotificationsResponseInnerOptions] = None
+    __properties: ClassVar[List[str]] = ["title", "channels", "enabled", "deduplication", "throttling", "retention", "options"]
+
+    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 NotificationPatchRequest 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 deduplication
+        if self.deduplication:
+            _dict['deduplication'] = self.deduplication.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of throttling
+        if self.throttling:
+            _dict['throttling'] = self.throttling.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of options
+        if self.options:
+            _dict['options'] = self.options.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NotificationPatchRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "title": obj.get("title"),
+            "channels": obj.get("channels"),
+            "enabled": obj.get("enabled"),
+            "deduplication": GetNotificationsResponseInnerDeduplication.from_dict(obj["deduplication"]) if obj.get("deduplication") is not None else None,
+            "throttling": GetNotificationsResponseInnerThrottling.from_dict(obj["throttling"]) if obj.get("throttling") is not None else None,
+            "retention": obj.get("retention"),
+            "options": GetNotificationsResponseInnerOptions.from_dict(obj["options"]) if obj.get("options") is not None else None
+        })
+        return _obj
+
+

pingram/models/post_email_test_request.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    NotificationAPI
+
+    Internal API for notification delivery and management
+
+    The version of the OpenAPI document: 1.0.0
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostEmailTestRequest(BaseModel):
+    """
+    PostEmailTestRequest
+    """ # noqa: E501
+    notification_id: StrictStr = Field(alias="notificationId")
+    to: StrictStr
+    subject: StrictStr
+    html: StrictStr
+    from_address: StrictStr = Field(alias="fromAddress")
+    from_name: StrictStr = Field(alias="fromName")
+    preview_text: Optional[StrictStr] = Field(default=None, alias="previewText")
+    __properties: ClassVar[List[str]] = ["notificationId", "to", "subject", "html", "fromAddress", "fromName", "previewText"]
+
+    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 PostEmailTestRequest 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostEmailTestRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "notificationId": obj.get("notificationId"),
+            "to": obj.get("to"),
+            "subject": obj.get("subject"),
+            "html": obj.get("html"),
+            "fromAddress": obj.get("fromAddress"),
+            "fromName": obj.get("fromName"),
+            "previewText": obj.get("previewText")
+        })
+        return _obj
+
+

pingram/models/post_email_test_response.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    NotificationAPI
+
+    Internal API for notification delivery and management
+
+    The version of the OpenAPI document: 1.0.0
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostEmailTestResponse(BaseModel):
+    """
+    PostEmailTestResponse
+    """ # noqa: E501
+    tracking_id: StrictStr = Field(alias="trackingId")
+    messages: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["trackingId", "messages"]
+
+    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 PostEmailTestResponse 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostEmailTestResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "trackingId": obj.get("trackingId"),
+            "messages": obj.get("messages")
+        })
+        return _obj
+
+

pingram/models/post_senders_request_body.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    NotificationAPI
+
+    Internal API for notification delivery and management
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostSendersRequestBody(BaseModel):
+    """
+    PostSendersRequestBody
+    """ # noqa: E501
+    sender: StrictStr
+    __properties: ClassVar[List[str]] = ["sender"]
+
+    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 PostSendersRequestBody 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostSendersRequestBody from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sender": obj.get("sender")
+        })
+        return _obj
+
+