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

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetSuburbs.*
//ExcludeTypes: 
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.*
*/

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get all suburbs for the specified country, state and/or postcode
*/
@Route(Path="/suburbs")
@Api(Description="Get all suburbs for the specified country, state and/or postcode")
open class GetSuburbs : IReturn<GetSuburbsResponse>
{
    /**
    * Get suburbs matching the specified search text criteria.
    */
    @ApiMember(Description="Get suburbs matching the specified search text criteria.", Name="SearchText")
    open var SearchText:String? = null

    /**
    * State to get suburbs for
    */
    @ApiMember(Description="State to get suburbs for", Name="StateName")
    open var StateName:String? = null

    /**
    * Postcode to get suburbs for
    */
    @ApiMember(Description="Postcode to get suburbs for", Name="Postcode")
    open var PostCode:String? = null

    /**
    * Country to get suburbs for
    */
    @ApiMember(Description="Country to get suburbs for", Name="CountryId")
    open var CountryId:UUID? = null

    /**
    * Country to get suburbs for
    */
    @ApiMember(Description="Country to get suburbs for", Name="CountryName")
    open var CountryName:String? = null
    companion object { private val responseType = GetSuburbsResponse::class.java }
    override fun getResponseType(): Any? = GetSuburbs.responseType
}

@ApiResponse(Description="List of suburbs matching the criteria")
open class GetSuburbsResponse
{
    open var Suburbs:ArrayList<SuburbModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class SuburbModel
{
    open var SuburbId:UUID? = null
    open var Name:String? = null
    open var StateId:UUID? = null
    open var StateName:String? = null
    open var PostCode:String? = null
    open var CountryId:UUID? = null
    open var CountryName:String? = null
}