pingram-python 0.1.0__py3-none-any.whl

pingram/models/get_notifications_response_inner_options_email_weekly.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetNotificationsResponseInnerOptionsEMAILWeekly(BaseModel):
+    """
+    GetNotificationsResponseInnerOptionsEMAILWeekly
+    """ # noqa: E501
+    enabled: StrictBool
+    hour: Optional[StrictStr] = None
+    day: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["enabled", "hour", "day"]
+
+    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 GetNotificationsResponseInnerOptionsEMAILWeekly 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 GetNotificationsResponseInnerOptionsEMAILWeekly from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "enabled": obj.get("enabled"),
+            "hour": obj.get("hour"),
+            "day": obj.get("day")
+        })
+        return _obj
+
+

pingram/models/get_notifications_response_inner_templates_inner.py

@@ -0,0 +1,90 @@
+# 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 GetNotificationsResponseInnerTemplatesInner(BaseModel):
+    """
+    GetNotificationsResponseInnerTemplatesInner
+    """ # noqa: E501
+    channel: ChannelsEnum
+    template_ids: List[StrictStr] = Field(alias="templateIds")
+    __properties: ClassVar[List[str]] = ["channel", "templateIds"]
+
+    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 GetNotificationsResponseInnerTemplatesInner 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 GetNotificationsResponseInnerTemplatesInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "channel": obj.get("channel"),
+            "templateIds": obj.get("templateIds")
+        })
+        return _obj
+
+

pingram/models/get_notifications_response_inner_throttling.py

@@ -0,0 +1,111 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetNotificationsResponseInnerThrottling(BaseModel):
+    """
+    GetNotificationsResponseInnerThrottling
+    """ # noqa: E501
+    max: Union[StrictFloat, StrictInt]
+    period: Union[StrictFloat, StrictInt]
+    unit: StrictStr
+    forever: StrictBool
+    scope: Annotated[List[StrictStr], Field(min_length=2, max_length=2)]
+    __properties: ClassVar[List[str]] = ["max", "period", "unit", "forever", "scope"]
+
+    @field_validator('unit')
+    def unit_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['seconds', 'minutes', 'hours', 'days', 'months', 'years']):
+            raise ValueError("must be one of enum values ('seconds', 'minutes', 'hours', 'days', 'months', 'years')")
+        return value
+
+    @field_validator('scope')
+    def scope_validate_enum(cls, value):
+        """Validates the enum"""
+        for i in value:
+            if i not in set(['userId', 'notificationId']):
+                raise ValueError("each list item must be one of ('userId', 'notificationId')")
+        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 GetNotificationsResponseInnerThrottling 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 GetNotificationsResponseInnerThrottling from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "max": obj.get("max"),
+            "period": obj.get("period"),
+            "unit": obj.get("unit"),
+            "forever": obj.get("forever"),
+            "scope": obj.get("scope")
+        })
+        return _obj
+
+

pingram/models/get_senders_response_inner.py

@@ -0,0 +1,128 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetSendersResponseInner(BaseModel):
+    """
+    GetSendersResponseInner
+    """ # noqa: E501
+    sender: StrictStr
+    status: StrictStr
+    last_sync: datetime = Field(alias="lastSync")
+    type: StrictStr
+    verification_tokens: Optional[List[StrictStr]] = Field(default=None, alias="verificationTokens")
+    mail_from_domain_status: Optional[StrictStr] = Field(default=None, alias="mailFromDomainStatus")
+    created_at: StrictStr = Field(alias="createdAt")
+    private_dkim_key: Optional[StrictStr] = Field(default=None, alias="privateDKIMKey")
+    reminder_sent_at: Optional[StrictStr] = Field(default=None, alias="reminderSentAt")
+    __properties: ClassVar[List[str]] = ["sender", "status", "lastSync", "type", "verificationTokens", "mailFromDomainStatus", "createdAt", "privateDKIMKey", "reminderSentAt"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['SUCCESS', 'PENDING', 'FAILED', 'TEMPORARY_FAILURE', 'NOT_STARTED']):
+            raise ValueError("must be one of enum values ('SUCCESS', 'PENDING', 'FAILED', 'TEMPORARY_FAILURE', 'NOT_STARTED')")
+        return value
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['domain', 'email']):
+            raise ValueError("must be one of enum values ('domain', 'email')")
+        return value
+
+    @field_validator('mail_from_domain_status')
+    def mail_from_domain_status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['PENDING', 'SUCCESS', 'FAILED', 'TEMPORARY_FAILURE']):
+            raise ValueError("must be one of enum values ('PENDING', 'SUCCESS', 'FAILED', 'TEMPORARY_FAILURE')")
+        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 GetSendersResponseInner 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 GetSendersResponseInner 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"),
+            "status": obj.get("status"),
+            "lastSync": obj.get("lastSync"),
+            "type": obj.get("type"),
+            "verificationTokens": obj.get("verificationTokens"),
+            "mailFromDomainStatus": obj.get("mailFromDomainStatus"),
+            "createdAt": obj.get("createdAt"),
+            "privateDKIMKey": obj.get("privateDKIMKey"),
+            "reminderSentAt": obj.get("reminderSentAt")
+        })
+        return _obj
+
+

pingram/models/get_templates_response.py

@@ -0,0 +1,136 @@
+# 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
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import List, Optional
+from pingram.models.get_inapp_notifications_response_notifications_inner_template_any_of import GetInappNotificationsResponseNotificationsInnerTemplateAnyOf
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+GETTEMPLATESRESPONSE_ANY_OF_SCHEMAS = ["GetInappNotificationsResponseNotificationsInnerTemplateAnyOf", "List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]"]
+
+class GetTemplatesResponse(BaseModel):
+    """
+    GetTemplatesResponse
+    """
+
+    # data type: GetInappNotificationsResponseNotificationsInnerTemplateAnyOf
+    anyof_schema_1_validator: Optional[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf] = None
+    # data type: List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]
+    anyof_schema_2_validator: Optional[List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf, List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "GetInappNotificationsResponseNotificationsInnerTemplateAnyOf", "List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = GetTemplatesResponse.model_construct()
+        error_messages = []
+        # validate data type: GetInappNotificationsResponseNotificationsInnerTemplateAnyOf
+        if not isinstance(v, GetInappNotificationsResponseNotificationsInnerTemplateAnyOf):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `GetInappNotificationsResponseNotificationsInnerTemplateAnyOf`")
+        else:
+            return v
+
+        # validate data type: List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]
+        try:
+            instance.anyof_schema_2_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in GetTemplatesResponse with anyOf schemas: GetInappNotificationsResponseNotificationsInnerTemplateAnyOf, List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf] = None
+        try:
+            instance.actual_instance = GetInappNotificationsResponseNotificationsInnerTemplateAnyOf.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # deserialize data into List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]
+        try:
+            # validation
+            instance.anyof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_2_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into GetTemplatesResponse with anyOf schemas: GetInappNotificationsResponseNotificationsInnerTemplateAnyOf, List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], GetInappNotificationsResponseNotificationsInnerTemplateAnyOf, List[GetInappNotificationsResponseNotificationsInnerTemplateAnyOf]]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

pingram/models/get_users_response.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from pingram.models.get_users_response_users_inner import GetUsersResponseUsersInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetUsersResponse(BaseModel):
+    """
+    GetUsersResponse
+    """ # noqa: E501
+    users: List[GetUsersResponseUsersInner]
+    last_evaluated_key: Optional[StrictStr] = Field(default=None, alias="lastEvaluatedKey")
+    has_more: StrictBool = Field(alias="hasMore")
+    __properties: ClassVar[List[str]] = ["users", "lastEvaluatedKey", "hasMore"]
+
+    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 GetUsersResponse 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 users (list)
+        _items = []
+        if self.users:
+            for _item_users in self.users:
+                if _item_users:
+                    _items.append(_item_users.to_dict())
+            _dict['users'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetUsersResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "users": [GetUsersResponseUsersInner.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None,
+            "lastEvaluatedKey": obj.get("lastEvaluatedKey"),
+            "hasMore": obj.get("hasMore")
+        })
+        return _obj
+
+