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

//BaseClass: 
//AddModelExtensions: True
//AddServiceStackTypes: True
//MakePropertiesOptional: True
IncludeTypes: GetCommunicationData.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

/**
* Retrieves communications from the Communication database to be saved to Framework
*/
// @Api(Description="Retrieves communications from the Communication database to be saved to Framework")
public class GetCommunicationData : IReturn, ISubscription, Codable
{
    public typealias Return = GetCommunicationDataResponse

    /**
    * Bin Row Version of the last update
    */
    // @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    public var binRowVersion:[UInt8]?

    /**
    * 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 var suiteDataSourceInstanceId:String?

    /**
    * Batch Call Number.
    */
    // @ApiMember(DataType="int", Description="Batch Call Number.", Name="BatchNumber")
    public var batchNumber:Int?

    /**
    * Number of records to retrieve per call.
    */
    // @ApiMember(DataType="int", Description="Number of records to retrieve per call.", Name="BatchSize")
    public var batchSize:Int?

    public var ignoreValidation:Bool?

    required public init(){}
}

// @ApiResponse(Description="Communications Data for synching to Framework")
public class GetCommunicationDataResponse : Codable
{
    /**
    * Bin Row Version of the last update
    */
    // @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    public var binRowVersion:[UInt8]?

    /**
    * Communication Data string (compressed/zipped)
    */
    // @ApiMember(DataType="string", Description="Communication Data string (compressed/zipped)", Name="Communications")
    public var communications:String?

    public var responseStatus:ResponseStatus?

    required public init(){}
}

public protocol ISubscription
{
    var suiteDataSourceInstanceId:String? { get set }
    var objectId:String? { get set }
    var alternateKey:String? { get set }
    var ignoreValidation:Bool? { get set }

}