/* Options:
Date: 2026-06-13 00:59:35
Version: 10.05
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://api.bookmore.com

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


@Route(Path="/apikeys", Verbs="GET")
@ApiResponse(Description="Returned if the current user is not authenticated", StatusCode=401)
// @ApiResponse(Description="Returned if the current user does not have the required role", StatusCode=403)
open class ApiKeyQuery : IReturn<ApiKeyQueryResponse>, ICompany
{
    /**
    * The company to list API keys for. Defaults to the logged in user's company. Only a SuperAdmin may specify a company other than their own; for other roles this value is ignored.
    */
    @ApiMember(Description="The company to list API keys for. Defaults to the logged in user's company. Only a SuperAdmin may specify a company other than their own; for other roles this value is ignored.", ParameterType="query")
    override var CompanyId:UUID? = null

    /**
    * If true, only return keys that are active (not cancelled and not expired). Default is false (return all).
    */
    @ApiMember(DataType="boolean", Description="If true, only return keys that are active (not cancelled and not expired). Default is false (return all).", ParameterType="query")
    open var ActiveOnly:Boolean? = null
    companion object { private val responseType = ApiKeyQueryResponse::class.java }
    override fun getResponseType(): Any? = ApiKeyQuery.responseType
}

open class ApiKeyQueryResponse
{
    /**
    * The API keys for the company
    */
    @ApiMember(Description="The API keys for the company")
    open var ApiKeys:ArrayList<ApiKeyResponse> = ArrayList<ApiKeyResponse>()

    open var ResponseStatus:ResponseStatus? = null
}

interface ICompany
{
    var CompanyId:UUID?
}

open class ApiKeyResponse
{
    /**
    * The company the API key belongs to
    */
    @ApiMember(Description="The company the API key belongs to")
    open var CompanyId:UUID? = null

    /**
    * The API key value to send in the x-api-key header
    */
    @ApiMember(Description="The API key value to send in the x-api-key header")
    open var ApiKey:UUID? = null

    /**
    * Whether the key is active
    */
    @ApiMember(Description="Whether the key is active")
    open var Active:Boolean? = null

    /**
    * When the key was created
    */
    @ApiMember(Description="When the key was created")
    open var CreatedDate:Date? = null

    /**
    * When the key expires, if ever
    */
    @ApiMember(Description="When the key expires, if ever")
    open var ExpiryDate:Date? = null

    /**
    * Contact email registered for the key
    */
    @ApiMember(Description="Contact email registered for the key")
    open var ContactEmail:String? = null

    /**
    * Free text notes for the key
    */
    @ApiMember(Description="Free text notes for the key")
    open var Notes:String? = null

    /**
    * Comma separated list of IP addresses the key is restricted to, if any
    */
    @ApiMember(Description="Comma separated list of IP addresses the key is restricted to, if any")
    open var AllowedIpAddresses:String? = null
}