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

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: MessageTemplatesQuery.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

// @DataContract
export class QueryBase
{
    /** @description 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)
    public Skip?: number;

    /** @description 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)
    public Take?: number;

    /** @description 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)
    public OrderBy: string;

    /** @description 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)
    public OrderByDesc: string;

    /** @description 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)
    public Include: string;

    // @DataMember(Order=6)
    public Fields: string;

    // @DataMember(Order=7)
    public Meta: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<From, Into> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}

export interface ICompany
{
    CompanyId?: string;
}

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class MessageType extends BaseModel
{
    // @Required()
    public Name: string;

    // @Required()
    public Description: string;

    // @Required()
    public MaxCharacters: number;

    // @Required()
    public DefaultText: string;

    // @Required()
    public SendMethodId: number;

    public ModifiedDate?: string;
    public Id: number;

    public constructor(init?: Partial<MessageType>) { super(init); (Object as any).assign(this, init); }
}

export class MessageTypeQueryResponse
{
    /** @description The message type id */
    // @ApiMember(Description="The message type id")
    public Id: number;

    /** @description The message type name. */
    // @ApiMember(Description="The message type name.")
    public Name: string;

    /** @description The message type description. */
    // @ApiMember(Description="The message type description.")
    public Description: string;

    /** @description 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.")
    public MaxCharacters: number;

    /** @description 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.")
    public DefaultText: string;

    /** @description The send method for this type. 1 = Email, 2 = SMS. */
    // @ApiMember(Description="The send method for this type. 1 = Email, 2 = SMS.")
    public SendMethodId: number;

    public constructor(init?: Partial<MessageTypeQueryResponse>) { (Object as any).assign(this, init); }
}

export class CompanyMessageTemplateMessageServiceRelation extends BaseModel
{
    // @Required()
    public CompanyId: string;

    public Id: number;
    // @Required()
    public CompanyMessageTemplateId: number;

    // @Required()
    public ServiceId: number;

    public ModifiedDate?: string;

    public constructor(init?: Partial<CompanyMessageTemplateMessageServiceRelation>) { super(init); (Object as any).assign(this, init); }
}

export class CompanyMessageTemplate extends BaseModel
{
    // @References("typeof(BokaMera.API.ServiceModel.Db.MessageType)")
    // @Ignore()
    public Type: MessageType;

    public MessageServiceRelation: CompanyMessageTemplateMessageServiceRelation[];
    // @Ignore()
    public Services: Service[];

    // @Required()
    public CompanyId: string;

    public Id: number;
    // @Required()
    public TypeId: number;

    // @Required()
    public Name: string;

    // @Required()
    public Sender: string;

    public Title: string;
    // @Required()
    public Body: string;

    // @Required()
    public Default: boolean;

    // @Required()
    public Readonly: boolean;

    // @Required()
    public HeaderFooterBGColor: string;

    public ModifiedDate?: string;
    public MessageTemplate: string;
    public Language: string;

    public constructor(init?: Partial<CompanyMessageTemplate>) { super(init); (Object as any).assign(this, init); }
}

export class MessageServices
{
    public Id: number;
    /** @description Name of the service */
    // @ApiMember(Description="Name of the service")
    public Name: string;

    /** @description The image url of the service */
    // @ApiMember(Description="The image url of the service")
    public ImageUrl: string;

    public constructor(init?: Partial<MessageServices>) { (Object as any).assign(this, init); }
}

export class MessageTemplatesQueryResponse
{
    /** @description The message template id */
    // @ApiMember(Description="The message template id")
    public Id: number;

    /** @description The message template name. */
    // @ApiMember(Description="The message template name.")
    public Name: string;

    /** @description The message template title. */
    // @ApiMember(Description="The message template title.")
    public Title: string;

    /** @description The message template title. */
    // @ApiMember(Description="The message template title.")
    public Body: string;

    /** @description 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).")
    public Sender: string;

    /** @description If the message template is the default message currently in use. */
    // @ApiMember(Description="If the message template is the default message currently in use.")
    public Default: boolean;

    /** @description If the message type information. */
    // @ApiMember(Description="If the message type information.")
    public MessageType: MessageTypeQueryResponse;

    /** @description Template language. */
    // @ApiMember(Description="Template language.")
    public Language: string;

    /** @description 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.")
    public Services: MessageServices[];

    public constructor(init?: Partial<MessageTemplatesQueryResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<MessageTemplatesQueryResponse>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: MessageTemplatesQueryResponse[];

    // @DataMember(Order=4)
    public Meta: { [index: string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<MessageTemplatesQueryResponse>>) { (Object as any).assign(this, init); }
}

// @Route("/messages/templates", "GET")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class MessageTemplatesQuery extends QueryDb<CompanyMessageTemplate, MessageTemplatesQueryResponse> implements IReturn<QueryResponse<MessageTemplatesQueryResponse>>, ICompany
{
    /** @description 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.")
    public CompanyId?: string;

    /** @description The message template id. */
    // @ApiMember(Description="The message template id.")
    public Id?: number;

    /** @description The message type id. See GET /messages/templates/types  */
    // @ApiMember(Description="The message type id. See GET /messages/templates/types ")
    public TypeId?: number;

    /** @description 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 ")
    public MessageTypeSendMethodId?: number;

    /** @description If you only want to retrieve active message templates (not inactive). */
    // @ApiMember(Description="If you only want to retrieve active message templates (not inactive).")
    public Default?: boolean;

    /** @description If you want to include the message type information */
    // @ApiMember(DataType="boolean", Description="If you want to include the message type information", ParameterType="query")
    public IncludeMessageTypeInformation: boolean;

    /** @description 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")
    public IncludeConnectedServices: boolean;

    public constructor(init?: Partial<MessageTemplatesQuery>) { super(init); (Object as any).assign(this, init); }
    public getTypeName() { return 'MessageTemplatesQuery'; }
    public getMethod() { return 'GET'; }
    public createResponse() { return new QueryResponse<MessageTemplatesQueryResponse>(); }
}