""" Options:
Date: 2026-04-04 01:02:48
Version: 8.52
Tip: To override a DTO option, remove "#" prefix before updating
BaseUrl: https://pfapi.pstpf.com.au/api

#GlobalNamespace: 
#AddServiceStackTypes: True
#AddResponseStatus: False
#AddImplicitVersion: 
#AddDescriptionAsComments: True
IncludeTypes: GetSuburbs.*
#ExcludeTypes: 
#DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum
#DataClass: 
#DataClassJson: 
"""

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SuburbModel:
    suburb_id: Optional[str] = None
    name: Optional[str] = None
    state_id: Optional[str] = None
    state_name: Optional[str] = None
    post_code: Optional[str] = None
    country_id: Optional[str] = None
    country_name: Optional[str] = None


# @ApiResponse(Description="List of suburbs matching the criteria")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSuburbsResponse:
    suburbs: Optional[List[SuburbModel]] = None
    response_status: Optional[ResponseStatus] = None


# @Route("/suburbs")
# @Api(Description="Get all suburbs for the specified country, state and/or postcode")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSuburbs(IReturn[GetSuburbsResponse]):
    """
    Get all suburbs for the specified country, state and/or postcode
    """

    # @ApiMember(Description="Get suburbs matching the specified search text criteria.", Name="SearchText")
    search_text: Optional[str] = None
    """
    Get suburbs matching the specified search text criteria.
    """


    # @ApiMember(Description="State to get suburbs for", Name="StateName")
    state_name: Optional[str] = None
    """
    State to get suburbs for
    """


    # @ApiMember(Description="Postcode to get suburbs for", Name="Postcode")
    post_code: Optional[str] = None
    """
    Postcode to get suburbs for
    """


    # @ApiMember(Description="Country to get suburbs for", Name="CountryId")
    country_id: Optional[str] = None
    """
    Country to get suburbs for
    """


    # @ApiMember(Description="Country to get suburbs for", Name="CountryName")
    country_name: Optional[str] = None
    """
    Country to get suburbs for
    """