/* Options:
Date: 2024-11-21 11:53:37
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: NewsletterTemplatesQuery.*
//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="/newsletter/templates", Verbs="GET")
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class NewsletterTemplatesQuery : QueryDb<NewsletterTemplate, NewsletterTemplatesQueryResponse>(), IReturn<QueryResponse<NewsletterTemplatesQueryResponse>>, 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 newsletter template id.
    */
    @ApiMember(Description="The newsletter template id.")
    var Id:Int? = null

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

    /**
    * If you want to include the email template information
    */
    @ApiMember(DataType="boolean", Description="If you want to include the email template information", ParameterType="query")
    var IncludeEmailTemplateInformation:Boolean? = null
    companion object { private val responseType = object : TypeToken<QueryResponse<NewsletterTemplatesQueryResponse>>(){}.type }
    override fun getResponseType(): Any? = NewsletterTemplatesQuery.responseType
}

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

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

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

    @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 SendMethod : BaseModel()
{
    @Required()
    var Name:String? = null

    @Required()
    var Description:String? = null

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

open class NewsletterSendMethodQueryResponse
{
    /**
    * The send method id
    */
    @ApiMember(Description="The send method id")
    var Id:Int? = null

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

    /**
    * The send method description.
    */
    @ApiMember(Description="The send method description.")
    var Description:String? = null
}

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

    @Required()
    var Description:String? = null

    @Required()
    var Body:String? = null

    @Required()
    var Type:Int? = null

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

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

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

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

    /**
    * The email template html content.
    */
    @ApiMember(Description="The email template html content.")
    var Body:String? = null
}

open class NewsletterTemplate : BaseModel()
{
    var SendMethod:SendMethod? = null
    var EmailTemplate:EmailTemplate? = null
    @Required()
    var CompanyId:UUID? = null

    var Id:Int? = null
    @Required()
    var Heading:String? = null

    @Required()
    var Body:String? = null

    var ImageUrl:String? = null
    @Required()
    var SendMethodId:Int? = null

    var EmailTemplateId:Int? = null
    @Required()
    var Created:Date? = null

    var ModifiedDate:Date? = 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 NewsletterTemplatesQueryResponse
{
    /**
    * The newsletter template id
    */
    @ApiMember(Description="The newsletter template id")
    var Id:Int? = null

    /**
    * The newsletter template heading.
    */
    @ApiMember(Description="The newsletter template heading.")
    var Heading:String? = null

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

    /**
    * The email template the newsletter uses.
    */
    @ApiMember(Description="The email template the newsletter uses.")
    var EmailTemplateId:Int? = null

    /**
    * Send Method. 1 = Email, 2 = SMS
    */
    @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    var SendMethodId:Int? = null

    /**
    * The newsletter template image url.
    */
    @ApiMember(Description="The newsletter template image url.")
    var ImageUrl:String? = null

    /**
    * The newsletter created date.
    */
    @ApiMember(Description="The newsletter created date.")
    var Created:Date? = null

    /**
    * Send method information.
    */
    @ApiMember(Description="Send method information.")
    var SendMethodInformation:NewsletterSendMethodQueryResponse? = null

    /**
    * Email template information.
    */
    @ApiMember(Description="Email template information.")
    var EmailTemplateInformation:NewsletterEmailTemplatesQueryResponse? = null
}