/* Options:
Date: 2024-11-21 12:03:08
Version: 8.23
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://api.bokamera.se

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: MessageTemplatesQuery.*
//ExcludeTypes: 
//InitializeCollections: True
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*,com.google.gson.annotations.*,com.google.gson.reflect.*
*/

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@Route(Path="/messages/templates", Verbs="GET")
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class MessageTemplatesQuery : QueryDb<CompanyMessageTemplate, MessageTemplatesQueryResponse>(), IReturn<QueryResponse<MessageTemplatesQueryResponse>>, ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    var CompanyId:UUID? = null

    /**
    * The message template id.
    */
    @ApiMember(Description="The message template id.")
    var Id:Int? = null

    /**
    * The message type id. See GET /messages/templates/types 
    */
    @ApiMember(Description="The message type id. See GET /messages/templates/types ")
    var TypeId:Int? = null

    /**
    * The message send method id.1 = Email and 2 = SMS. See GET /messages/templates/types 
    */
    @ApiMember(Description="The message send method id.1 = Email and 2 = SMS. See GET /messages/templates/types ")
    var MessageTypeSendMethodId:Int? = null

    /**
    * If you only want to retrieve active message templates (not inactive).
    */
    @ApiMember(Description="If you only want to retrieve active message templates (not inactive).")
    var Default:Boolean? = null

    /**
    * If you want to include the message type information
    */
    @ApiMember(DataType="boolean", Description="If you want to include the message type information", ParameterType="query")
    var IncludeMessageTypeInformation:Boolean? = null

    /**
    * If you want to include the services that are conencted to this template
    */
    @ApiMember(DataType="boolean", Description="If you want to include the services that are conencted to this template", ParameterType="query")
    var IncludeConnectedServices:Boolean? = null
    companion object { private val responseType = object : TypeToken<QueryResponse<MessageTemplatesQueryResponse>>(){}.type }
    override fun getResponseType(): Any? = MessageTemplatesQuery.responseType
}

@DataContract
open class QueryResponse<MessageTemplatesQueryResponse>
{
    @DataMember(Order=1)
    var Offset:Int? = null

    @DataMember(Order=2)
    var Total:Int? = null

    @DataMember(Order=3)
    var Results:ArrayList<MessageTemplatesQueryResponse> = ArrayList<MessageTemplatesQueryResponse>()

    @DataMember(Order=4)
    var Meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var ResponseStatus:ResponseStatus? = null
}

open class QueryDb<From, Into> : QueryBase()
{
}

open interface ICompany
{
    var CompanyId:UUID?
}

open class MessageType : BaseModel()
{
    @Required()
    var Name:String? = null

    @Required()
    var Description:String? = null

    @Required()
    var MaxCharacters:Int? = null

    @Required()
    var DefaultText:String? = null

    @Required()
    var SendMethodId:Int? = null

    var ModifiedDate:Date? = null
    var Id:Int? = null
}

open class MessageTypeQueryResponse
{
    /**
    * The message type id
    */
    @ApiMember(Description="The message type id")
    var Id:Int? = null

    /**
    * The message type name.
    */
    @ApiMember(Description="The message type name.")
    var Name:String? = null

    /**
    * The message type description.
    */
    @ApiMember(Description="The message type description.")
    var Description:String? = null

    /**
    * The maximum number of charachters that can be entered into message body using this type.
    */
    @ApiMember(Description="The maximum number of charachters that can be entered into message body using this type.")
    var MaxCharacters:Int? = null

    /**
    * The default text that is always included when sending messages of this type.
    */
    @ApiMember(Description="The default text that is always included when sending messages of this type.")
    var DefaultText:String? = null

    /**
    * The send method for this type. 1 = Email, 2 = SMS.
    */
    @ApiMember(Description="The send method for this type. 1 = Email, 2 = SMS.")
    var SendMethodId:Int? = null
}

open class CompanyMessageTemplate : BaseModel()
{
    @References(MessageType.class)
    @Ignore()
    var Type:MessageType? = null

    var MessageServiceRelation:ArrayList<CompanyMessageTemplateMessageServiceRelation> = ArrayList<CompanyMessageTemplateMessageServiceRelation>()
    @Ignore()
    var Services:ArrayList<Service> = ArrayList<Service>()

    @Required()
    var CompanyId:UUID? = null

    var Id:Int? = null
    @Required()
    var TypeId:Int? = null

    @Required()
    var Name:String? = null

    @Required()
    var Sender:String? = null

    var Title:String? = null
    @Required()
    var Body:String? = null

    @Required()
    var Default:Boolean? = null

    @Required()
    var Readonly:Boolean? = null

    @Required()
    var HeaderFooterBGColor:String? = null

    var ModifiedDate:Date? = null
    var MessageTemplate:String? = null
    var Language:String? = null
}

open class MessageServices
{
    var Id:Int? = null
    /**
    * Name of the service
    */
    @ApiMember(Description="Name of the service")
    var Name:String? = null

    /**
    * The image url of the service
    */
    @ApiMember(Description="The image url of the service")
    var ImageUrl:Uri? = null
}

@DataContract
open class QueryBase
{
    /**
    * Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
    */
    @DataMember(Order=1)
    var Skip:Int? = null

    /**
    * Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
    */
    @DataMember(Order=2)
    var Take:Int? = null

    /**
    * Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
    */
    @DataMember(Order=3)
    var OrderBy:String? = null

    /**
    * Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
    */
    @DataMember(Order=4)
    var OrderByDesc:String? = null

    /**
    * Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
    */
    @DataMember(Order=5)
    var Include:String? = null

    @DataMember(Order=6)
    var Fields:String? = null

    @DataMember(Order=7)
    var Meta:HashMap<String,String> = HashMap<String,String>()
}

open class BaseModel
{
}

open class CompanyMessageTemplateMessageServiceRelation : BaseModel()
{
    @Required()
    var CompanyId:UUID? = null

    var Id:Int? = null
    @Required()
    var CompanyMessageTemplateId:Int? = null

    @Required()
    var ServiceId:Int? = null

    var ModifiedDate:Date? = null
}

open class MessageTemplatesQueryResponse
{
    /**
    * The message template id
    */
    @ApiMember(Description="The message template id")
    var Id:Int? = null

    /**
    * The message template name.
    */
    @ApiMember(Description="The message template name.")
    var Name:String? = null

    /**
    * The message template title.
    */
    @ApiMember(Description="The message template title.")
    var Title:String? = null

    /**
    * The message template title.
    */
    @ApiMember(Description="The message template title.")
    var Body:String? = null

    /**
    * The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).
    */
    @ApiMember(Description="The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).")
    var Sender:String? = null

    /**
    * If the message template is the default message currently in use.
    */
    @ApiMember(Description="If the message template is the default message currently in use.")
    var Default:Boolean? = null

    /**
    * If the message type information.
    */
    @ApiMember(Description="If the message type information.")
    var MessageType:MessageTypeQueryResponse? = null

    /**
    * Template language.
    */
    @ApiMember(Description="Template language.")
    var Language:String? = null

    /**
    * The connected services which the template is valid for. If empty then it's valid for all services.
    */
    @ApiMember(Description="The connected services which the template is valid for. If empty then it's valid for all services.")
    var Services:ArrayList<MessageServices> = ArrayList<MessageServices>()
}