static_schedule_options.py

# coding: utf-8

"""
    Klaviyo API

    The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.

    The version of the OpenAPI document: 2024-10-15
    Contact: developers@klaviyo.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 datetime import datetime
from pydantic import BaseModel, ConfigDict, Field, StrictBool
from typing import Any, ClassVar, Dict, List, Optional
from typing import Optional, Set
from typing_extensions import Self

class StaticScheduleOptions(BaseModel):
    """
    StaticScheduleOptions
    """ # noqa: E501
    datetime_: datetime = Field(description="The time to send at", alias="datetime")
    is_local: Optional[StrictBool] = Field(default=None, description="If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False.")
    send_past_recipients_immediately: Optional[StrictBool] = Field(default=None, description="Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False.")
    __properties: ClassVar[List[str]] = ["datetime", "is_local", "send_past_recipients_immediately"]

    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 StaticScheduleOptions 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,
        )
        # set to None if is_local (nullable) is None
        # and model_fields_set contains the field
        if self.is_local is None and "is_local" in self.model_fields_set:
            _dict['is_local'] = None

        # set to None if send_past_recipients_immediately (nullable) is None
        # and model_fields_set contains the field
        if self.send_past_recipients_immediately is None and "send_past_recipients_immediately" in self.model_fields_set:
            _dict['send_past_recipients_immediately'] = None

        return _dict

    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of StaticScheduleOptions from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate({
            "datetime": obj.get("datetime"),
            "is_local": obj.get("is_local"),
            "send_past_recipients_immediately": obj.get("send_past_recipients_immediately")
        })
        return _obj