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

kalshi_python_async/exceptions.py

@@ -0,0 +1,216 @@
+# 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 typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

kalshi_python_async/models/__init__.py

@@ -0,0 +1,136 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    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
+
+# import models into model package
+from kalshi_python_async.models.accept_quote_request import AcceptQuoteRequest
+from kalshi_python_async.models.amend_order_request import AmendOrderRequest
+from kalshi_python_async.models.amend_order_response import AmendOrderResponse
+from kalshi_python_async.models.announcement import Announcement
+from kalshi_python_async.models.api_key import ApiKey
+from kalshi_python_async.models.associated_event import AssociatedEvent
+from kalshi_python_async.models.batch_cancel_orders_individual_response import BatchCancelOrdersIndividualResponse
+from kalshi_python_async.models.batch_cancel_orders_request import BatchCancelOrdersRequest
+from kalshi_python_async.models.batch_cancel_orders_response import BatchCancelOrdersResponse
+from kalshi_python_async.models.batch_create_orders_individual_response import BatchCreateOrdersIndividualResponse
+from kalshi_python_async.models.batch_create_orders_request import BatchCreateOrdersRequest
+from kalshi_python_async.models.batch_create_orders_response import BatchCreateOrdersResponse
+from kalshi_python_async.models.batch_get_market_candlesticks_response import BatchGetMarketCandlesticksResponse
+from kalshi_python_async.models.bid_ask_distribution import BidAskDistribution
+from kalshi_python_async.models.cancel_order_response import CancelOrderResponse
+from kalshi_python_async.models.create_api_key_request import CreateApiKeyRequest
+from kalshi_python_async.models.create_api_key_response import CreateApiKeyResponse
+from kalshi_python_async.models.create_market_in_multivariate_event_collection_request import CreateMarketInMultivariateEventCollectionRequest
+from kalshi_python_async.models.create_market_in_multivariate_event_collection_response import CreateMarketInMultivariateEventCollectionResponse
+from kalshi_python_async.models.create_order_group_request import CreateOrderGroupRequest
+from kalshi_python_async.models.create_order_group_response import CreateOrderGroupResponse
+from kalshi_python_async.models.create_order_request import CreateOrderRequest
+from kalshi_python_async.models.create_order_response import CreateOrderResponse
+from kalshi_python_async.models.create_quote_request import CreateQuoteRequest
+from kalshi_python_async.models.create_quote_response import CreateQuoteResponse
+from kalshi_python_async.models.create_rfq_request import CreateRFQRequest
+from kalshi_python_async.models.create_rfq_response import CreateRFQResponse
+from kalshi_python_async.models.daily_schedule import DailySchedule
+from kalshi_python_async.models.decrease_order_request import DecreaseOrderRequest
+from kalshi_python_async.models.decrease_order_response import DecreaseOrderResponse
+from kalshi_python_async.models.error_response import ErrorResponse
+from kalshi_python_async.models.event_data import EventData
+from kalshi_python_async.models.event_position import EventPosition
+from kalshi_python_async.models.exchange_status import ExchangeStatus
+from kalshi_python_async.models.fill import Fill
+from kalshi_python_async.models.forecast_percentiles_point import ForecastPercentilesPoint
+from kalshi_python_async.models.generate_api_key_request import GenerateApiKeyRequest
+from kalshi_python_async.models.generate_api_key_response import GenerateApiKeyResponse
+from kalshi_python_async.models.get_api_keys_response import GetApiKeysResponse
+from kalshi_python_async.models.get_balance_response import GetBalanceResponse
+from kalshi_python_async.models.get_communications_id_response import GetCommunicationsIDResponse
+from kalshi_python_async.models.get_event_candlesticks_response import GetEventCandlesticksResponse
+from kalshi_python_async.models.get_event_forecast_percentiles_history_response import GetEventForecastPercentilesHistoryResponse
+from kalshi_python_async.models.get_event_metadata_response import GetEventMetadataResponse
+from kalshi_python_async.models.get_event_response import GetEventResponse
+from kalshi_python_async.models.get_events_response import GetEventsResponse
+from kalshi_python_async.models.get_exchange_announcements_response import GetExchangeAnnouncementsResponse
+from kalshi_python_async.models.get_exchange_schedule_response import GetExchangeScheduleResponse
+from kalshi_python_async.models.get_fills_response import GetFillsResponse
+from kalshi_python_async.models.get_filters_by_sports_response import GetFiltersBySportsResponse
+from kalshi_python_async.models.get_incentive_programs_response import GetIncentiveProgramsResponse
+from kalshi_python_async.models.get_live_data_response import GetLiveDataResponse
+from kalshi_python_async.models.get_live_datas_response import GetLiveDatasResponse
+from kalshi_python_async.models.get_market_candlesticks_response import GetMarketCandlesticksResponse
+from kalshi_python_async.models.get_market_orderbook_response import GetMarketOrderbookResponse
+from kalshi_python_async.models.get_market_response import GetMarketResponse
+from kalshi_python_async.models.get_markets_response import GetMarketsResponse
+from kalshi_python_async.models.get_milestone_response import GetMilestoneResponse
+from kalshi_python_async.models.get_milestones_response import GetMilestonesResponse
+from kalshi_python_async.models.get_multivariate_event_collection_lookup_history_response import GetMultivariateEventCollectionLookupHistoryResponse
+from kalshi_python_async.models.get_multivariate_event_collection_response import GetMultivariateEventCollectionResponse
+from kalshi_python_async.models.get_multivariate_event_collections_response import GetMultivariateEventCollectionsResponse
+from kalshi_python_async.models.get_multivariate_events_response import GetMultivariateEventsResponse
+from kalshi_python_async.models.get_order_group_response import GetOrderGroupResponse
+from kalshi_python_async.models.get_order_groups_response import GetOrderGroupsResponse
+from kalshi_python_async.models.get_order_queue_position_response import GetOrderQueuePositionResponse
+from kalshi_python_async.models.get_order_queue_positions_response import GetOrderQueuePositionsResponse
+from kalshi_python_async.models.get_order_response import GetOrderResponse
+from kalshi_python_async.models.get_orders_response import GetOrdersResponse
+from kalshi_python_async.models.get_portfolio_resting_order_total_value_response import GetPortfolioRestingOrderTotalValueResponse
+from kalshi_python_async.models.get_positions_response import GetPositionsResponse
+from kalshi_python_async.models.get_quote_response import GetQuoteResponse
+from kalshi_python_async.models.get_quotes_response import GetQuotesResponse
+from kalshi_python_async.models.get_rfq_response import GetRFQResponse
+from kalshi_python_async.models.get_rfqs_response import GetRFQsResponse
+from kalshi_python_async.models.get_series_fee_changes_response import GetSeriesFeeChangesResponse
+from kalshi_python_async.models.get_series_list_response import GetSeriesListResponse
+from kalshi_python_async.models.get_series_response import GetSeriesResponse
+from kalshi_python_async.models.get_settlements_response import GetSettlementsResponse
+from kalshi_python_async.models.get_structured_target_response import GetStructuredTargetResponse
+from kalshi_python_async.models.get_structured_targets_response import GetStructuredTargetsResponse
+from kalshi_python_async.models.get_tags_for_series_categories_response import GetTagsForSeriesCategoriesResponse
+from kalshi_python_async.models.get_trades_response import GetTradesResponse
+from kalshi_python_async.models.get_user_data_timestamp_response import GetUserDataTimestampResponse
+from kalshi_python_async.models.incentive_program import IncentiveProgram
+from kalshi_python_async.models.live_data import LiveData
+from kalshi_python_async.models.lookup_point import LookupPoint
+from kalshi_python_async.models.lookup_tickers_for_market_in_multivariate_event_collection_request import LookupTickersForMarketInMultivariateEventCollectionRequest
+from kalshi_python_async.models.lookup_tickers_for_market_in_multivariate_event_collection_response import LookupTickersForMarketInMultivariateEventCollectionResponse
+from kalshi_python_async.models.maintenance_window import MaintenanceWindow
+from kalshi_python_async.models.market import Market
+from kalshi_python_async.models.market_candlestick import MarketCandlestick
+from kalshi_python_async.models.market_candlesticks_response import MarketCandlesticksResponse
+from kalshi_python_async.models.market_metadata import MarketMetadata
+from kalshi_python_async.models.market_position import MarketPosition
+from kalshi_python_async.models.milestone import Milestone
+from kalshi_python_async.models.multivariate_event_collection import MultivariateEventCollection
+from kalshi_python_async.models.mve_selected_leg import MveSelectedLeg
+from kalshi_python_async.models.order import Order
+from kalshi_python_async.models.order_group import OrderGroup
+from kalshi_python_async.models.order_queue_position import OrderQueuePosition
+from kalshi_python_async.models.order_status import OrderStatus
+from kalshi_python_async.models.orderbook import Orderbook
+from kalshi_python_async.models.percentile_point import PercentilePoint
+from kalshi_python_async.models.price_distribution import PriceDistribution
+from kalshi_python_async.models.price_range import PriceRange
+from kalshi_python_async.models.quote import Quote
+from kalshi_python_async.models.rfq import RFQ
+from kalshi_python_async.models.schedule import Schedule
+from kalshi_python_async.models.scope_list import ScopeList
+from kalshi_python_async.models.self_trade_prevention_type import SelfTradePreventionType
+from kalshi_python_async.models.series import Series
+from kalshi_python_async.models.series_fee_change import SeriesFeeChange
+from kalshi_python_async.models.settlement import Settlement
+from kalshi_python_async.models.settlement_source import SettlementSource
+from kalshi_python_async.models.sport_filter_details import SportFilterDetails
+from kalshi_python_async.models.structured_target import StructuredTarget
+from kalshi_python_async.models.ticker_pair import TickerPair
+from kalshi_python_async.models.trade import Trade
+from kalshi_python_async.models.weekly_schedule import WeeklySchedule
+

kalshi_python_async/models/accept_quote_request.py

@@ -0,0 +1,94 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AcceptQuoteRequest(BaseModel):
+    """
+    AcceptQuoteRequest
+    """ # noqa: E501
+    accepted_side: StrictStr = Field(description="The side of the quote to accept (yes or no)")
+    __properties: ClassVar[List[str]] = ["accepted_side"]
+
+    @field_validator('accepted_side')
+    def accepted_side_validate_enum(cls, value):
+        """Validates the enum"""
+        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 AcceptQuoteRequest 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 AcceptQuoteRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accepted_side": obj.get("accepted_side")
+        })
+        return _obj
+
+

kalshi_python_async/models/amend_order_request.py

@@ -0,0 +1,120 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AmendOrderRequest(BaseModel):
+    """
+    AmendOrderRequest
+    """ # noqa: E501
+    ticker: StrictStr = Field(description="Market ticker")
+    side: StrictStr = Field(description="Side of the order")
+    action: StrictStr = Field(description="Action of the order")
+    client_order_id: StrictStr = Field(description="The original client-specified order ID to be amended")
+    updated_client_order_id: StrictStr = Field(description="The new client-specified order ID after amendment")
+    yes_price: Optional[Annotated[int, Field(le=99, strict=True, ge=1)]] = Field(default=None, description="Updated yes price for the order in cents")
+    no_price: Optional[Annotated[int, Field(le=99, strict=True, ge=1)]] = Field(default=None, description="Updated no price for the order in cents")
+    yes_price_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    no_price_dollars: Optional[StrictStr] = Field(default=None, description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    count: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Updated quantity for the order")
+    __properties: ClassVar[List[str]] = ["ticker", "side", "action", "client_order_id", "updated_client_order_id", "yes_price", "no_price", "yes_price_dollars", "no_price_dollars", "count"]
+
+    @field_validator('side')
+    def side_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['yes', 'no']):
+            raise ValueError("must be one of enum values ('yes', 'no')")
+        return value
+
+    @field_validator('action')
+    def action_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['buy', 'sell']):
+            raise ValueError("must be one of enum values ('buy', 'sell')")
+        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 AmendOrderRequest 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 AmendOrderRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ticker": obj.get("ticker"),
+            "side": obj.get("side"),
+            "action": obj.get("action"),
+            "client_order_id": obj.get("client_order_id"),
+            "updated_client_order_id": obj.get("updated_client_order_id"),
+            "yes_price": obj.get("yes_price"),
+            "no_price": obj.get("no_price"),
+            "yes_price_dollars": obj.get("yes_price_dollars"),
+            "no_price_dollars": obj.get("no_price_dollars"),
+            "count": obj.get("count")
+        })
+        return _obj
+
+

kalshi_python_async/models/amend_order_response.py

@@ -0,0 +1,96 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from kalshi_python_async.models.order import Order
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AmendOrderResponse(BaseModel):
+    """
+    AmendOrderResponse
+    """ # noqa: E501
+    old_order: Order
+    order: Order
+    __properties: ClassVar[List[str]] = ["old_order", "order"]
+
+    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 AmendOrderResponse 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 old_order
+        if self.old_order:
+            _dict['old_order'] = self.old_order.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of order
+        if self.order:
+            _dict['order'] = self.order.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AmendOrderResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "old_order": Order.from_dict(obj["old_order"]) if obj.get("old_order") is not None else None,
+            "order": Order.from_dict(obj["order"]) if obj.get("order") is not None else None
+        })
+        return _obj
+
+