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

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetCommunicationData.*
//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.*


/**
* Retrieves communications from the Communication database to be saved to Framework
*/
@Api(Description="Retrieves communications from the Communication database to be saved to Framework")
open class GetCommunicationData : IReturn<GetCommunicationDataResponse>, ISubscription
{
    /**
    * Bin Row Version of the last update
    */
    @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    open var BinRowVersion:ByteArray? = null

    /**
    * 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")
    override var SuiteDataSourceInstanceId:UUID? = null

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

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

    override var IgnoreValidation:Boolean? = null
    companion object { private val responseType = GetCommunicationDataResponse::class.java }
    override fun getResponseType(): Any? = GetCommunicationData.responseType
}

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

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

    open var ResponseStatus:ResponseStatus? = null
}

interface ISubscription
{
    var SuiteDataSourceInstanceId:UUID?
    var ObjectId:UUID?
    var AlternateKey:String?
    var IgnoreValidation:Boolean?
}