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

kalshi_python_async/models/get_event_forecast_percentiles_history_response.py

@@ -0,0 +1,95 @@
+# 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.forecast_percentiles_point import ForecastPercentilesPoint
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetEventForecastPercentilesHistoryResponse(BaseModel):
+    """
+    GetEventForecastPercentilesHistoryResponse
+    """ # noqa: E501
+    forecast_history: List[ForecastPercentilesPoint] = Field(description="Array of forecast percentile data points over time.")
+    __properties: ClassVar[List[str]] = ["forecast_history"]
+
+    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 GetEventForecastPercentilesHistoryResponse 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 forecast_history (list)
+        _items = []
+        if self.forecast_history:
+            for _item_forecast_history in self.forecast_history:
+                if _item_forecast_history:
+                    _items.append(_item_forecast_history.to_dict())
+            _dict['forecast_history'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetEventForecastPercentilesHistoryResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "forecast_history": [ForecastPercentilesPoint.from_dict(_item) for _item in obj["forecast_history"]] if obj.get("forecast_history") is not None else None
+        })
+        return _obj
+
+

kalshi_python_async/models/get_event_metadata_response.py

@@ -0,0 +1,123 @@
+# 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, Optional
+from kalshi_python_async.models.market_metadata import MarketMetadata
+from kalshi_python_async.models.settlement_source import SettlementSource
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetEventMetadataResponse(BaseModel):
+    """
+    GetEventMetadataResponse
+    """ # noqa: E501
+    image_url: StrictStr = Field(description="A path to an image that represents this event.")
+    featured_image_url: Optional[StrictStr] = Field(default=None, description="A path to an image that represents the image of the featured market.")
+    market_details: List[MarketMetadata] = Field(description="Metadata for the markets in this event.")
+    settlement_sources: List[SettlementSource] = Field(description="A list of settlement sources for this event.")
+    competition: Optional[StrictStr] = Field(default=None, description="Event competition.")
+    competition_scope: Optional[StrictStr] = Field(default=None, description="Event scope, based on the competition.")
+    __properties: ClassVar[List[str]] = ["image_url", "featured_image_url", "market_details", "settlement_sources", "competition", "competition_scope"]
+
+    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 GetEventMetadataResponse 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 market_details (list)
+        _items = []
+        if self.market_details:
+            for _item_market_details in self.market_details:
+                if _item_market_details:
+                    _items.append(_item_market_details.to_dict())
+            _dict['market_details'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in settlement_sources (list)
+        _items = []
+        if self.settlement_sources:
+            for _item_settlement_sources in self.settlement_sources:
+                if _item_settlement_sources:
+                    _items.append(_item_settlement_sources.to_dict())
+            _dict['settlement_sources'] = _items
+        # set to None if competition (nullable) is None
+        # and model_fields_set contains the field
+        if self.competition is None and "competition" in self.model_fields_set:
+            _dict['competition'] = None
+
+        # set to None if competition_scope (nullable) is None
+        # and model_fields_set contains the field
+        if self.competition_scope is None and "competition_scope" in self.model_fields_set:
+            _dict['competition_scope'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetEventMetadataResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "image_url": obj.get("image_url"),
+            "featured_image_url": obj.get("featured_image_url"),
+            "market_details": [MarketMetadata.from_dict(_item) for _item in obj["market_details"]] if obj.get("market_details") is not None else None,
+            "settlement_sources": [SettlementSource.from_dict(_item) for _item in obj["settlement_sources"]] if obj.get("settlement_sources") is not None else None,
+            "competition": obj.get("competition"),
+            "competition_scope": obj.get("competition_scope")
+        })
+        return _obj
+
+

kalshi_python_async/models/get_event_response.py

@@ -0,0 +1,101 @@
+# 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.event_data import EventData
+from kalshi_python_async.models.market import Market
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetEventResponse(BaseModel):
+    """
+    GetEventResponse
+    """ # noqa: E501
+    event: EventData
+    markets: List[Market] = Field(description="Data for the markets in this event. This field is deprecated in favour of the \"markets\" field inside the event. Which will be filled with the same value if you use the query parameter \"with_nested_markets=true\".")
+    __properties: ClassVar[List[str]] = ["event", "markets"]
+
+    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 GetEventResponse 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 event
+        if self.event:
+            _dict['event'] = self.event.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in markets (list)
+        _items = []
+        if self.markets:
+            for _item_markets in self.markets:
+                if _item_markets:
+                    _items.append(_item_markets.to_dict())
+            _dict['markets'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetEventResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "event": EventData.from_dict(obj["event"]) if obj.get("event") is not None else None,
+            "markets": [Market.from_dict(_item) for _item in obj["markets"]] if obj.get("markets") is not None else None
+        })
+        return _obj
+
+

kalshi_python_async/models/get_events_candlesticks_response.py

@@ -0,0 +1,95 @@
+# 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: 2.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.get_events_candlesticks_response_events_inner import GetEventsCandlesticksResponseEventsInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetEventsCandlesticksResponse(BaseModel):
+    """
+    GetEventsCandlesticksResponse
+    """ # noqa: E501
+    events: List[GetEventsCandlesticksResponseEventsInner] = Field(description="Array of event candlestick responses, one for each event ticker.")
+    __properties: ClassVar[List[str]] = ["events"]
+
+    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 GetEventsCandlesticksResponse 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 events (list)
+        _items = []
+        if self.events:
+            for _item_events in self.events:
+                if _item_events:
+                    _items.append(_item_events.to_dict())
+            _dict['events'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetEventsCandlesticksResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "events": [GetEventsCandlesticksResponseEventsInner.from_dict(_item) for _item in obj["events"]] if obj.get("events") is not None else None
+        })
+        return _obj
+
+

kalshi_python_async/models/get_events_candlesticks_response_events_inner.py

@@ -0,0 +1,106 @@
+# 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: 2.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
+from kalshi_python_async.models.market_candlestick import MarketCandlestick
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetEventsCandlesticksResponseEventsInner(BaseModel):
+    """
+    GetEventsCandlesticksResponseEventsInner
+    """ # noqa: E501
+    event_ticker: StrictStr = Field(description="The event ticker")
+    market_tickers: List[StrictStr] = Field(description="Array of market tickers in the event.")
+    market_candlesticks: List[List[MarketCandlestick]] = Field(description="Array of market candlestick arrays, one for each market in the event.")
+    adjusted_end_ts: StrictInt = Field(description="Adjusted end timestamp if the requested candlesticks would be larger than maxAggregateCandidates.")
+    __properties: ClassVar[List[str]] = ["event_ticker", "market_tickers", "market_candlesticks", "adjusted_end_ts"]
+
+    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 GetEventsCandlesticksResponseEventsInner 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 market_candlesticks (list of list)
+        _items = []
+        if self.market_candlesticks:
+            for _item_market_candlesticks in self.market_candlesticks:
+                if _item_market_candlesticks:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_market_candlesticks if _inner_item is not None]
+                    )
+            _dict['market_candlesticks'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetEventsCandlesticksResponseEventsInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "event_ticker": obj.get("event_ticker"),
+            "market_tickers": obj.get("market_tickers"),
+            "market_candlesticks": [
+                    [MarketCandlestick.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["market_candlesticks"]
+                ] if obj.get("market_candlesticks") is not None else None,
+            "adjusted_end_ts": obj.get("adjusted_end_ts")
+        })
+        return _obj
+
+

kalshi_python_async/models/get_events_response.py

@@ -0,0 +1,107 @@
+# 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, Optional
+from kalshi_python_async.models.event_data import EventData
+from kalshi_python_async.models.milestone import Milestone
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetEventsResponse(BaseModel):
+    """
+    GetEventsResponse
+    """ # noqa: E501
+    events: List[EventData] = Field(description="Array of events matching the query criteria.")
+    milestones: Optional[List[Milestone]] = Field(default=None, description="Array of milestones related to the events.")
+    cursor: StrictStr = Field(description="Pagination cursor for the next page. Empty if there are no more results.")
+    __properties: ClassVar[List[str]] = ["events", "milestones", "cursor"]
+
+    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 GetEventsResponse 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 events (list)
+        _items = []
+        if self.events:
+            for _item_events in self.events:
+                if _item_events:
+                    _items.append(_item_events.to_dict())
+            _dict['events'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in milestones (list)
+        _items = []
+        if self.milestones:
+            for _item_milestones in self.milestones:
+                if _item_milestones:
+                    _items.append(_item_milestones.to_dict())
+            _dict['milestones'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetEventsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "events": [EventData.from_dict(_item) for _item in obj["events"]] if obj.get("events") is not None else None,
+            "milestones": [Milestone.from_dict(_item) for _item in obj["milestones"]] if obj.get("milestones") is not None else None,
+            "cursor": obj.get("cursor")
+        })
+        return _obj
+
+