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

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: GetCommunicationData.*
//ExcludeTypes: 
//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.*;

public class dtos
{

    /**
    * 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 static class GetCommunicationData implements IReturn<GetCommunicationDataResponse>, ISubscription
    {
        /**
        * Bin Row Version of the last update
        */
        @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
        public byte[] BinRowVersion = 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")
        public UUID SuiteDataSourceInstanceId = null;

        /**
        * Batch Call Number.
        */
        @ApiMember(DataType="int", Description="Batch Call Number.", Name="BatchNumber")
        public Integer BatchNumber = null;

        /**
        * Number of records to retrieve per call.
        */
        @ApiMember(DataType="int", Description="Number of records to retrieve per call.", Name="BatchSize")
        public Integer BatchSize = null;

        public Boolean IgnoreValidation = null;
        
        public byte[] getBinRowVersion() { return BinRowVersion; }
        public GetCommunicationData setBinRowVersion(byte[] value) { this.BinRowVersion = value; return this; }
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public GetCommunicationData setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public Integer getBatchNumber() { return BatchNumber; }
        public GetCommunicationData setBatchNumber(Integer value) { this.BatchNumber = value; return this; }
        public Integer getBatchSize() { return BatchSize; }
        public GetCommunicationData setBatchSize(Integer value) { this.BatchSize = value; return this; }
        public Boolean isIgnoreValidation() { return IgnoreValidation; }
        public GetCommunicationData setIgnoreValidation(Boolean value) { this.IgnoreValidation = value; return this; }
        private static Object responseType = GetCommunicationDataResponse.class;
        public Object getResponseType() { return responseType; }
    }

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

        /**
        * Communication Data string (compressed/zipped)
        */
        @ApiMember(DataType="string", Description="Communication Data string (compressed/zipped)", Name="Communications")
        public String Communications = null;

        public ResponseStatus ResponseStatus = null;
        
        public byte[] getBinRowVersion() { return BinRowVersion; }
        public GetCommunicationDataResponse setBinRowVersion(byte[] value) { this.BinRowVersion = value; return this; }
        public String getCommunications() { return Communications; }
        public GetCommunicationDataResponse setCommunications(String value) { this.Communications = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetCommunicationDataResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static interface ISubscription
    {
        public UUID SuiteDataSourceInstanceId = null;
        public UUID ObjectId = null;
        public String AlternateKey = null;
        public Boolean IgnoreValidation = null;
    }

}