kalshi-python-async 3.0.0__py3-none-any.whl

kalshi_python_async/models/price_distribution.py

@@ -0,0 +1,157 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PriceDistribution(BaseModel):
+    """
+    PriceDistribution
+    """ # noqa: E501
+    open: Optional[StrictInt] = Field(default=None, description="First traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.")
+    open_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    low: Optional[StrictInt] = Field(default=None, description="Lowest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.")
+    low_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    high: Optional[StrictInt] = Field(default=None, description="Highest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.")
+    high_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    close: Optional[StrictInt] = Field(default=None, description="Last traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.")
+    close_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    mean: Optional[StrictInt] = Field(default=None, description="Mean traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period.")
+    mean_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    previous: Optional[StrictInt] = Field(default=None, description="Last traded YES contract price on the market before the candlestick period (in cents). May be null if there were no trades before the period.")
+    previous_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    min: Optional[StrictInt] = Field(default=None, description="Minimum close price of any market during the candlestick period (in cents).")
+    min_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    max: Optional[StrictInt] = Field(default=None, description="Maximum close price of any market during the candlestick period (in cents).")
+    max_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    __properties: ClassVar[List[str]] = ["open", "open_dollars", "low", "low_dollars", "high", "high_dollars", "close", "close_dollars", "mean", "mean_dollars", "previous", "previous_dollars", "min", "min_dollars", "max", "max_dollars"]
+
+    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 PriceDistribution 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 open (nullable) is None
+        # and model_fields_set contains the field
+        if self.open is None and "open" in self.model_fields_set:
+            _dict['open'] = None
+
+        # set to None if low (nullable) is None
+        # and model_fields_set contains the field
+        if self.low is None and "low" in self.model_fields_set:
+            _dict['low'] = None
+
+        # set to None if high (nullable) is None
+        # and model_fields_set contains the field
+        if self.high is None and "high" in self.model_fields_set:
+            _dict['high'] = None
+
+        # set to None if close (nullable) is None
+        # and model_fields_set contains the field
+        if self.close is None and "close" in self.model_fields_set:
+            _dict['close'] = None
+
+        # set to None if mean (nullable) is None
+        # and model_fields_set contains the field
+        if self.mean is None and "mean" in self.model_fields_set:
+            _dict['mean'] = None
+
+        # set to None if previous (nullable) is None
+        # and model_fields_set contains the field
+        if self.previous is None and "previous" in self.model_fields_set:
+            _dict['previous'] = None
+
+        # set to None if min (nullable) is None
+        # and model_fields_set contains the field
+        if self.min is None and "min" in self.model_fields_set:
+            _dict['min'] = None
+
+        # set to None if max (nullable) is None
+        # and model_fields_set contains the field
+        if self.max is None and "max" in self.model_fields_set:
+            _dict['max'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PriceDistribution from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "open": obj.get("open"),
+            "open_dollars": obj.get("open_dollars"),
+            "low": obj.get("low"),
+            "low_dollars": obj.get("low_dollars"),
+            "high": obj.get("high"),
+            "high_dollars": obj.get("high_dollars"),
+            "close": obj.get("close"),
+            "close_dollars": obj.get("close_dollars"),
+            "mean": obj.get("mean"),
+            "mean_dollars": obj.get("mean_dollars"),
+            "previous": obj.get("previous"),
+            "previous_dollars": obj.get("previous_dollars"),
+            "min": obj.get("min"),
+            "min_dollars": obj.get("min_dollars"),
+            "max": obj.get("max"),
+            "max_dollars": obj.get("max_dollars")
+        })
+        return _obj
+
+

kalshi_python_async/models/price_range.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.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 PriceRange(BaseModel):
+    """
+    PriceRange
+    """ # noqa: E501
+    start: StrictStr = Field(description="Starting price for this range in dollars")
+    end: StrictStr = Field(description="Ending price for this range in dollars")
+    step: StrictStr = Field(description="Price step/tick size for this range in dollars")
+    __properties: ClassVar[List[str]] = ["start", "end", "step"]
+
+    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 PriceRange 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 PriceRange from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "start": obj.get("start"),
+            "end": obj.get("end"),
+            "step": obj.get("step")
+        })
+        return _obj
+
+

kalshi_python_async/models/quote.py

@@ -0,0 +1,153 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.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, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Quote(BaseModel):
+    """
+    Quote
+    """ # noqa: E501
+    id: StrictStr = Field(description="Unique identifier for the quote")
+    rfq_id: StrictStr = Field(description="ID of the RFQ this quote is responding to")
+    creator_id: StrictStr = Field(description="Public communications ID of the quote creator")
+    rfq_creator_id: StrictStr = Field(description="Public communications ID of the RFQ creator")
+    market_ticker: StrictStr = Field(description="The ticker of the market this quote is for")
+    contracts: StrictInt = Field(description="Number of contracts in the quote")
+    yes_bid: StrictInt = Field(description="Bid price for YES contracts, in cents")
+    no_bid: StrictInt = Field(description="Bid price for NO contracts, in cents")
+    yes_bid_dollars: StrictStr = Field(description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    no_bid_dollars: StrictStr = Field(description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    created_ts: datetime = Field(description="Timestamp when the quote was created")
+    updated_ts: datetime = Field(description="Timestamp when the quote was last updated")
+    status: StrictStr = Field(description="Current status of the quote")
+    accepted_side: Optional[StrictStr] = Field(default=None, description="The side that was accepted (yes or no)")
+    accepted_ts: Optional[datetime] = Field(default=None, description="Timestamp when the quote was accepted")
+    confirmed_ts: Optional[datetime] = Field(default=None, description="Timestamp when the quote was confirmed")
+    executed_ts: Optional[datetime] = Field(default=None, description="Timestamp when the quote was executed")
+    cancelled_ts: Optional[datetime] = Field(default=None, description="Timestamp when the quote was cancelled")
+    rest_remainder: Optional[StrictBool] = Field(default=None, description="Whether to rest the remainder of the quote after execution")
+    cancellation_reason: Optional[StrictStr] = Field(default=None, description="Reason for quote cancellation if cancelled")
+    creator_user_id: Optional[StrictStr] = Field(default=None, description="User ID of the quote creator (private field)")
+    rfq_creator_user_id: Optional[StrictStr] = Field(default=None, description="User ID of the RFQ creator (private field)")
+    rfq_target_cost_centi_cents: Optional[StrictInt] = Field(default=None, description="Total value requested in the RFQ in centi-cents")
+    rfq_creator_order_id: Optional[StrictStr] = Field(default=None, description="Order ID for the RFQ creator (private field)")
+    creator_order_id: Optional[StrictStr] = Field(default=None, description="Order ID for the quote creator (private field)")
+    __properties: ClassVar[List[str]] = ["id", "rfq_id", "creator_id", "rfq_creator_id", "market_ticker", "contracts", "yes_bid", "no_bid", "yes_bid_dollars", "no_bid_dollars", "created_ts", "updated_ts", "status", "accepted_side", "accepted_ts", "confirmed_ts", "executed_ts", "cancelled_ts", "rest_remainder", "cancellation_reason", "creator_user_id", "rfq_creator_user_id", "rfq_target_cost_centi_cents", "rfq_creator_order_id", "creator_order_id"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['open', 'accepted', 'confirmed', 'executed', 'cancelled']):
+            raise ValueError("must be one of enum values ('open', 'accepted', 'confirmed', 'executed', 'cancelled')")
+        return value
+
+    @field_validator('accepted_side')
+    def accepted_side_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['true', 'false']):
+            raise ValueError("must be one of enum values ('true', 'false')")
+        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 Quote 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 Quote from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "rfq_id": obj.get("rfq_id"),
+            "creator_id": obj.get("creator_id"),
+            "rfq_creator_id": obj.get("rfq_creator_id"),
+            "market_ticker": obj.get("market_ticker"),
+            "contracts": obj.get("contracts"),
+            "yes_bid": obj.get("yes_bid"),
+            "no_bid": obj.get("no_bid"),
+            "yes_bid_dollars": obj.get("yes_bid_dollars"),
+            "no_bid_dollars": obj.get("no_bid_dollars"),
+            "created_ts": obj.get("created_ts"),
+            "updated_ts": obj.get("updated_ts"),
+            "status": obj.get("status"),
+            "accepted_side": obj.get("accepted_side"),
+            "accepted_ts": obj.get("accepted_ts"),
+            "confirmed_ts": obj.get("confirmed_ts"),
+            "executed_ts": obj.get("executed_ts"),
+            "cancelled_ts": obj.get("cancelled_ts"),
+            "rest_remainder": obj.get("rest_remainder"),
+            "cancellation_reason": obj.get("cancellation_reason"),
+            "creator_user_id": obj.get("creator_user_id"),
+            "rfq_creator_user_id": obj.get("rfq_creator_user_id"),
+            "rfq_target_cost_centi_cents": obj.get("rfq_target_cost_centi_cents"),
+            "rfq_creator_order_id": obj.get("rfq_creator_order_id"),
+            "creator_order_id": obj.get("creator_order_id")
+        })
+        return _obj
+
+

kalshi_python_async/models/rfq.py

@@ -0,0 +1,129 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.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, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from kalshi_python_async.models.mve_selected_leg import MveSelectedLeg
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RFQ(BaseModel):
+    """
+    RFQ
+    """ # noqa: E501
+    id: StrictStr = Field(description="Unique identifier for the RFQ")
+    creator_id: StrictStr = Field(description="Public communications ID of the RFQ creator")
+    market_ticker: StrictStr = Field(description="The ticker of the market this RFQ is for")
+    contracts: StrictInt = Field(description="Number of contracts requested in the RFQ")
+    target_cost_centi_cents: Optional[StrictInt] = Field(default=None, description="Total value of the RFQ in centi-cents")
+    status: StrictStr = Field(description="Current status of the RFQ (open, closed)")
+    created_ts: datetime = Field(description="Timestamp when the RFQ was created")
+    mve_collection_ticker: Optional[StrictStr] = Field(default=None, description="Ticker of the MVE collection this market belongs to")
+    mve_selected_legs: Optional[List[MveSelectedLeg]] = Field(default=None, description="Selected legs for the MVE collection")
+    rest_remainder: Optional[StrictBool] = Field(default=None, description="Whether to rest the remainder of the RFQ after execution")
+    cancellation_reason: Optional[StrictStr] = Field(default=None, description="Reason for RFQ cancellation if cancelled")
+    creator_user_id: Optional[StrictStr] = Field(default=None, description="User ID of the RFQ creator (private field)")
+    cancelled_ts: Optional[datetime] = Field(default=None, description="Timestamp when the RFQ was cancelled")
+    updated_ts: Optional[datetime] = Field(default=None, description="Timestamp when the RFQ was last updated")
+    __properties: ClassVar[List[str]] = ["id", "creator_id", "market_ticker", "contracts", "target_cost_centi_cents", "status", "created_ts", "mve_collection_ticker", "mve_selected_legs", "rest_remainder", "cancellation_reason", "creator_user_id", "cancelled_ts", "updated_ts"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['open', 'closed']):
+            raise ValueError("must be one of enum values ('open', 'closed')")
+        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 RFQ 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 mve_selected_legs (list)
+        _items = []
+        if self.mve_selected_legs:
+            for _item_mve_selected_legs in self.mve_selected_legs:
+                if _item_mve_selected_legs:
+                    _items.append(_item_mve_selected_legs.to_dict())
+            _dict['mve_selected_legs'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RFQ from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "creator_id": obj.get("creator_id"),
+            "market_ticker": obj.get("market_ticker"),
+            "contracts": obj.get("contracts"),
+            "target_cost_centi_cents": obj.get("target_cost_centi_cents"),
+            "status": obj.get("status"),
+            "created_ts": obj.get("created_ts"),
+            "mve_collection_ticker": obj.get("mve_collection_ticker"),
+            "mve_selected_legs": [MveSelectedLeg.from_dict(_item) for _item in obj["mve_selected_legs"]] if obj.get("mve_selected_legs") is not None else None,
+            "rest_remainder": obj.get("rest_remainder"),
+            "cancellation_reason": obj.get("cancellation_reason"),
+            "creator_user_id": obj.get("creator_user_id"),
+            "cancelled_ts": obj.get("cancelled_ts"),
+            "updated_ts": obj.get("updated_ts")
+        })
+        return _obj
+
+

kalshi_python_async/models/schedule.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.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 kalshi_python_async.models.maintenance_window import MaintenanceWindow
+from kalshi_python_async.models.weekly_schedule import WeeklySchedule
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Schedule(BaseModel):
+    """
+    Schedule
+    """ # noqa: E501
+    standard_hours: List[WeeklySchedule] = Field(description="The standard operating hours of the exchange. All times are expressed in ET. Outside of these times trading will be unavailable.")
+    maintenance_windows: List[MaintenanceWindow] = Field(description="Scheduled maintenance windows, during which the exchange may be unavailable.")
+    __properties: ClassVar[List[str]] = ["standard_hours", "maintenance_windows"]
+
+    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 Schedule 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 standard_hours (list)
+        _items = []
+        if self.standard_hours:
+            for _item_standard_hours in self.standard_hours:
+                if _item_standard_hours:
+                    _items.append(_item_standard_hours.to_dict())
+            _dict['standard_hours'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in maintenance_windows (list)
+        _items = []
+        if self.maintenance_windows:
+            for _item_maintenance_windows in self.maintenance_windows:
+                if _item_maintenance_windows:
+                    _items.append(_item_maintenance_windows.to_dict())
+            _dict['maintenance_windows'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Schedule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "standard_hours": [WeeklySchedule.from_dict(_item) for _item in obj["standard_hours"]] if obj.get("standard_hours") is not None else None,
+            "maintenance_windows": [MaintenanceWindow.from_dict(_item) for _item in obj["maintenance_windows"]] if obj.get("maintenance_windows") is not None else None
+        })
+        return _obj
+
+