pingram-python 0.1.0__py3-none-any.whl

pingram/models/template_patch_request_any_of1_batch.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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TemplatePatchRequestAnyOf1Batch(BaseModel):
+    """
+    In-app batch delivery: title, redirect URL, and image URL shown when the notification is delivered in batch.
+    """ # noqa: E501
+    title: StrictStr
+    redirect_url: StrictStr = Field(alias="redirectURL")
+    image_url: StrictStr = Field(alias="imageURL")
+    __properties: ClassVar[List[str]] = ["title", "redirectURL", "imageURL"]
+
+    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 TemplatePatchRequestAnyOf1Batch 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 TemplatePatchRequestAnyOf1Batch 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"),
+            "redirectURL": obj.get("redirectURL"),
+            "imageURL": obj.get("imageURL")
+        })
+        return _obj
+
+

pingram/models/template_patch_request_any_of1_instant.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TemplatePatchRequestAnyOf1Instant(BaseModel):
+    """
+    In-app instant delivery: title, redirect URL, and image URL shown when the notification is delivered in real time.
+    """ # noqa: E501
+    title: Optional[StrictStr] = None
+    redirect_url: Optional[StrictStr] = Field(default=None, alias="redirectURL")
+    image_url: StrictStr = Field(description="Required for instant. Image URL shown in the in-app notification.", alias="imageURL")
+    __properties: ClassVar[List[str]] = ["title", "redirectURL", "imageURL"]
+
+    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 TemplatePatchRequestAnyOf1Instant 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 TemplatePatchRequestAnyOf1Instant 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"),
+            "redirectURL": obj.get("redirectURL"),
+            "imageURL": obj.get("imageURL")
+        })
+        return _obj
+
+

pingram/models/template_post_request.py

@@ -0,0 +1,131 @@
+# 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.template_post_request_batch import TemplatePostRequestBatch
+from pingram.models.template_post_request_instant import TemplatePostRequestInstant
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TemplatePostRequest(BaseModel):
+    """
+    Request body for creating a template. Include templateId (required) plus any channel-specific fields for the channel in the path. Which fields apply depends on the channel (EMAIL, INAPP_WEB, SMS, PUSH, etc.).
+    """ # noqa: E501
+    template_id: StrictStr = Field(description="Unique ID for this template within the notification and channel. Required.", alias="templateId")
+    html: Optional[StrictStr] = Field(default=None, description="HTML body of the email.")
+    preview_text: Optional[StrictStr] = Field(default=None, description="Preview text (e.g. for inbox).", alias="previewText")
+    internal: Optional[StrictStr] = Field(default=None, description="Internal editor representation of the email content (e.g. Bee or Redactor JSON). Used for editing and component embedding; the actual email sent to recipients uses the html field.")
+    subject: Optional[StrictStr] = Field(default=None, description="Email subject line.")
+    sender_name: Optional[StrictStr] = Field(default=None, description="Sender display name.", alias="senderName")
+    sender_email: Optional[StrictStr] = Field(default=None, description="Sender email address.", alias="senderEmail")
+    migration: Optional[StrictStr] = Field(default=None, description="Migration metadata (e.g. from template migration).")
+    title: Optional[StrictStr] = Field(default=None, description="Notification title (in-app).")
+    redirect_url: Optional[StrictStr] = Field(default=None, description="URL to open when the user taps the notification.", alias="redirectURL")
+    image_url: Optional[StrictStr] = Field(default=None, description="Image URL shown in the in-app notification.", alias="imageURL")
+    instant: Optional[TemplatePostRequestInstant] = None
+    batch: Optional[TemplatePostRequestBatch] = None
+    text: Optional[StrictStr] = Field(default=None, description="Message text (SMS or call).")
+    message: Optional[StrictStr] = Field(default=None, description="Push notification body text. (title is shared with INAPP_WEB above.)")
+    icon: Optional[StrictStr] = Field(default=None, description="Web push: icon URL. Slack: bot icon (emoji or URL).")
+    url: Optional[StrictStr] = Field(default=None, description="Web push: URL to open when the notification is clicked.")
+    blocks: Optional[List[Dict[str, Any]]] = Field(default=None, description="Slack message blocks (optional).")
+    username: Optional[StrictStr] = Field(default=None, description="Slack bot username.")
+    __properties: ClassVar[List[str]] = ["templateId", "html", "previewText", "internal", "subject", "senderName", "senderEmail", "migration", "title", "redirectURL", "imageURL", "instant", "batch", "text", "message", "icon", "url", "blocks", "username"]
+
+    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 TemplatePostRequest 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 instant
+        if self.instant:
+            _dict['instant'] = self.instant.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of batch
+        if self.batch:
+            _dict['batch'] = self.batch.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TemplatePostRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "templateId": obj.get("templateId"),
+            "html": obj.get("html"),
+            "previewText": obj.get("previewText"),
+            "internal": obj.get("internal"),
+            "subject": obj.get("subject"),
+            "senderName": obj.get("senderName"),
+            "senderEmail": obj.get("senderEmail"),
+            "migration": obj.get("migration"),
+            "title": obj.get("title"),
+            "redirectURL": obj.get("redirectURL"),
+            "imageURL": obj.get("imageURL"),
+            "instant": TemplatePostRequestInstant.from_dict(obj["instant"]) if obj.get("instant") is not None else None,
+            "batch": TemplatePostRequestBatch.from_dict(obj["batch"]) if obj.get("batch") is not None else None,
+            "text": obj.get("text"),
+            "message": obj.get("message"),
+            "icon": obj.get("icon"),
+            "url": obj.get("url"),
+            "blocks": obj.get("blocks"),
+            "username": obj.get("username")
+        })
+        return _obj
+
+

pingram/models/template_post_request_batch.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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TemplatePostRequestBatch(BaseModel):
+    """
+    Copy for batch delivery.
+    """ # noqa: E501
+    title: StrictStr
+    redirect_url: StrictStr = Field(alias="redirectURL")
+    image_url: StrictStr = Field(alias="imageURL")
+    __properties: ClassVar[List[str]] = ["title", "redirectURL", "imageURL"]
+
+    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 TemplatePostRequestBatch 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 TemplatePostRequestBatch 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"),
+            "redirectURL": obj.get("redirectURL"),
+            "imageURL": obj.get("imageURL")
+        })
+        return _obj
+
+

pingram/models/template_post_request_instant.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TemplatePostRequestInstant(BaseModel):
+    """
+    Copy for instant (real-time) delivery.
+    """ # noqa: E501
+    title: Optional[StrictStr] = None
+    redirect_url: Optional[StrictStr] = Field(default=None, alias="redirectURL")
+    image_url: StrictStr = Field(alias="imageURL")
+    __properties: ClassVar[List[str]] = ["title", "redirectURL", "imageURL"]
+
+    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 TemplatePostRequestInstant 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 TemplatePostRequestInstant 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"),
+            "redirectURL": obj.get("redirectURL"),
+            "imageURL": obj.get("imageURL")
+        })
+        return _obj
+
+

pingram/models/update_address_request.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdateAddressRequest(BaseModel):
+    """
+    UpdateAddressRequest
+    """ # noqa: E501
+    full_address: StrictStr = Field(alias="fullAddress")
+    prefix: Optional[StrictStr] = None
+    display_name: Optional[StrictStr] = Field(default=None, alias="displayName")
+    __properties: ClassVar[List[str]] = ["fullAddress", "prefix", "displayName"]
+
+    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 UpdateAddressRequest 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 UpdateAddressRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "fullAddress": obj.get("fullAddress"),
+            "prefix": obj.get("prefix"),
+            "displayName": obj.get("displayName")
+        })
+        return _obj
+
+