pingram-python 0.1.0__py3-none-any.whl

pingram/models/email_component_response.py

@@ -0,0 +1,120 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List
+from pingram.models.email_component_response_referenced_by_inner import EmailComponentResponseReferencedByInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmailComponentResponse(BaseModel):
+    """
+    EmailComponentResponse
+    """ # noqa: E501
+    env_id: StrictStr = Field(alias="envId")
+    component_id: StrictStr = Field(alias="componentId")
+    name: StrictStr
+    internal: StrictStr
+    internal_page: StrictStr = Field(alias="internalPage")
+    html: StrictStr
+    created_at: StrictStr = Field(alias="createdAt")
+    modified_at: StrictStr = Field(alias="modifiedAt")
+    referenced_by: List[EmailComponentResponseReferencedByInner] = Field(alias="referencedBy")
+    channel: StrictStr
+    __properties: ClassVar[List[str]] = ["envId", "componentId", "name", "internal", "internalPage", "html", "createdAt", "modifiedAt", "referencedBy", "channel"]
+
+    @field_validator('channel')
+    def channel_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['EMAIL']):
+            raise ValueError("must be one of enum values ('EMAIL')")
+        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 EmailComponentResponse 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 referenced_by (list)
+        _items = []
+        if self.referenced_by:
+            for _item_referenced_by in self.referenced_by:
+                if _item_referenced_by:
+                    _items.append(_item_referenced_by.to_dict())
+            _dict['referencedBy'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EmailComponentResponse 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"),
+            "componentId": obj.get("componentId"),
+            "name": obj.get("name"),
+            "internal": obj.get("internal"),
+            "internalPage": obj.get("internalPage"),
+            "html": obj.get("html"),
+            "createdAt": obj.get("createdAt"),
+            "modifiedAt": obj.get("modifiedAt"),
+            "referencedBy": [EmailComponentResponseReferencedByInner.from_dict(_item) for _item in obj["referencedBy"]] if obj.get("referencedBy") is not None else None,
+            "channel": obj.get("channel")
+        })
+        return _obj
+
+

pingram/models/email_component_response_referenced_by_inner.py

@@ -0,0 +1,92 @@
+# 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
+from pingram.models.channels_enum import ChannelsEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmailComponentResponseReferencedByInner(BaseModel):
+    """
+    EmailComponentResponseReferencedByInner
+    """ # noqa: E501
+    notification_id: StrictStr = Field(alias="notificationId")
+    channel: ChannelsEnum
+    template_id: StrictStr = Field(alias="templateId")
+    __properties: ClassVar[List[str]] = ["notificationId", "channel", "templateId"]
+
+    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 EmailComponentResponseReferencedByInner 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 EmailComponentResponseReferencedByInner 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"),
+            "channel": obj.get("channel"),
+            "templateId": obj.get("templateId")
+        })
+        return _obj
+
+

pingram/models/environment.py

@@ -0,0 +1,96 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from pingram.models.channels_enum import ChannelsEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Environment(BaseModel):
+    """
+    Environment
+    """ # noqa: E501
+    client_id: StrictStr = Field(alias="clientId")
+    client_secret: StrictStr = Field(alias="clientSecret")
+    title: StrictStr
+    disable_sending: List[ChannelsEnum] = Field(alias="disableSending")
+    secure_mode: StrictBool = Field(alias="secureMode")
+    __properties: ClassVar[List[str]] = ["clientId", "clientSecret", "title", "disableSending", "secureMode"]
+
+    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 Environment 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 Environment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "clientId": obj.get("clientId"),
+            "clientSecret": obj.get("clientSecret"),
+            "title": obj.get("title"),
+            "disableSending": obj.get("disableSending"),
+            "secureMode": obj.get("secureMode")
+        })
+        return _obj
+
+

pingram/models/environment_create_request.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 EnvironmentCreateRequest(BaseModel):
+    """
+    EnvironmentCreateRequest
+    """ # noqa: E501
+    title: StrictStr
+    __properties: ClassVar[List[str]] = ["title"]
+
+    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 EnvironmentCreateRequest 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 EnvironmentCreateRequest 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")
+        })
+        return _obj
+
+

pingram/models/environment_patch_request.py

@@ -0,0 +1,94 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from pingram.models.channels_enum import ChannelsEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EnvironmentPatchRequest(BaseModel):
+    """
+    EnvironmentPatchRequest
+    """ # noqa: E501
+    reset_secret: Optional[StrictBool] = Field(default=None, alias="resetSecret")
+    disable_sending: Optional[List[ChannelsEnum]] = Field(default=None, alias="disableSending")
+    title: Optional[StrictStr] = None
+    secure_mode: Optional[StrictBool] = Field(default=None, alias="secureMode")
+    __properties: ClassVar[List[str]] = ["resetSecret", "disableSending", "title", "secureMode"]
+
+    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 EnvironmentPatchRequest 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 EnvironmentPatchRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "resetSecret": obj.get("resetSecret"),
+            "disableSending": obj.get("disableSending"),
+            "title": obj.get("title"),
+            "secureMode": obj.get("secureMode")
+        })
+        return _obj
+
+

pingram/models/get_account_metadata_response.py

@@ -0,0 +1,91 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from pingram.models.get_account_metadata_response_user_account_metadata import GetAccountMetadataResponseUserAccountMetadata
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetAccountMetadataResponse(BaseModel):
+    """
+    GetAccountMetadataResponse
+    """ # noqa: E501
+    user_account_metadata: GetAccountMetadataResponseUserAccountMetadata = Field(alias="userAccountMetadata")
+    __properties: ClassVar[List[str]] = ["userAccountMetadata"]
+
+    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 GetAccountMetadataResponse 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 user_account_metadata
+        if self.user_account_metadata:
+            _dict['userAccountMetadata'] = self.user_account_metadata.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetAccountMetadataResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "userAccountMetadata": GetAccountMetadataResponseUserAccountMetadata.from_dict(obj["userAccountMetadata"]) if obj.get("userAccountMetadata") is not None else None
+        })
+        return _obj
+
+

pingram/models/get_account_metadata_response_user_account_metadata.py

@@ -0,0 +1,91 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetAccountMetadataResponseUserAccountMetadata(BaseModel):
+    """
+    GetAccountMetadataResponseUserAccountMetadata
+    """ # noqa: E501
+    logo: StrictStr
+    environment_vapid_public_key: StrictStr = Field(alias="environmentVapidPublicKey")
+    has_web_push_enabled: StrictBool = Field(alias="hasWebPushEnabled")
+    __properties: ClassVar[List[str]] = ["logo", "environmentVapidPublicKey", "hasWebPushEnabled"]
+
+    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 GetAccountMetadataResponseUserAccountMetadata 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 GetAccountMetadataResponseUserAccountMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "logo": obj.get("logo"),
+            "environmentVapidPublicKey": obj.get("environmentVapidPublicKey"),
+            "hasWebPushEnabled": obj.get("hasWebPushEnabled")
+        })
+        return _obj
+
+