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

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


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

export interface ISubscription
{
    SuiteDataSourceInstanceId: string;
    ObjectId: string;
    AlternateKey: string;
    IgnoreValidation: boolean;
}

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

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

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

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

    public constructor(init?: Partial<ResponseError>) { (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="Eros RMS and UI Data for synching to Framework")
export class GetRmsUIDataResponse
{
    /** @description Bin Row Version of the last update */
    // @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    public BinRowVersion: string;

    /** @description XML string containing the Framework Data */
    // @ApiMember(DataType="string", Description="XML string containing the Framework Data", Name="FrameworkData")
    public FrameworkData: string;

    public ResponseStatus: ResponseStatus;

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

/** @description Retrieves Updated RMS and UI data to be saved to Framework */
// @Api(Description="Retrieves Updated RMS and UI data to be saved to Framework")
export class GetRmsUIData implements IReturn<GetRmsUIDataResponse>, ISubscription
{
    /** @description Bin Row Version of the last update */
    // @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    public BinRowVersion: string;

    /** @description Suite Data Source Instance Id to determine which licensees data to retrieve. */
    // @ApiMember(DataType="Guid", Description="Suite Data Source Instance Id to determine which licensees data to retrieve.", Name="SuiteDataSourceInstanceId")
    public SuiteDataSourceInstanceId: string;

    public IgnoreValidation: boolean;

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