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

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetSuburbs.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

export class SuburbModel
{
    public SuburbId: string;
    public Name: string;
    public StateId: string;
    public StateName: string;
    public PostCode: string;
    public CountryId: string;
    public CountryName: string;

    public constructor(init?: Partial<SuburbModel>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public ErrorCode: string;

    // @DataMember(Order=2)
    public Message: string;

    // @DataMember(Order=3)
    public StackTrace: string;

    // @DataMember(Order=4)
    public Errors: ResponseError[];

    // @DataMember(Order=5)
    public Meta: { [index:string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List of suburbs matching the criteria")
export class GetSuburbsResponse
{
    public Suburbs: SuburbModel[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetSuburbsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get all suburbs for the specified country, state and/or postcode */
// @Route("/suburbs")
// @Api(Description="Get all suburbs for the specified country, state and/or postcode")
export class GetSuburbs implements IReturn<GetSuburbsResponse>
{
    /** @description Get suburbs matching the specified search text criteria. */
    // @ApiMember(Description="Get suburbs matching the specified search text criteria.", Name="SearchText")
    public SearchText: string;

    /** @description State to get suburbs for */
    // @ApiMember(Description="State to get suburbs for", Name="StateName")
    public StateName: string;

    /** @description Postcode to get suburbs for */
    // @ApiMember(Description="Postcode to get suburbs for", Name="Postcode")
    public PostCode: string;

    /** @description Country to get suburbs for */
    // @ApiMember(Description="Country to get suburbs for", Name="CountryId")
    public CountryId: string;

    /** @description Country to get suburbs for */
    // @ApiMember(Description="Country to get suburbs for", Name="CountryName")
    public CountryName: string;

    public constructor(init?: Partial<GetSuburbs>) { (Object as any).assign(this, init); }
    public getTypeName() { return 'GetSuburbs'; }
    public getMethod() { return 'GET'; }
    public createResponse() { return new GetSuburbsResponse(); }
}