""" Options: Date: 2026-06-12 23:48:21 Version: 10.05 Tip: To override a DTO option, remove "#" prefix before updating BaseUrl: https://testapi.bokamera.se #GlobalNamespace: #AddServiceStackTypes: True #AddResponseStatus: False #AddImplicitVersion: #AddDescriptionAsComments: True IncludeTypes: ApiKeyQuery.* #ExcludeTypes: #DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum #DataClass: #DataClassJson: """ import datetime import decimal from marshmallow.fields import * from servicestack import * from typing import * from dataclasses import dataclass, field from dataclasses_json import dataclass_json, LetterCase, Undefined, config from enum import Enum, IntEnum Object = TypeVar('Object') class ICompany: company_id: Optional[str] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ApiKeyResponse: # @ApiMember(Description="The company the API key belongs to") company_id: Optional[str] = None """ The company the API key belongs to """ # @ApiMember(Description="The API key value to send in the x-api-key header") api_key: Optional[str] = None """ The API key value to send in the x-api-key header """ # @ApiMember(Description="Whether the key is active") active: bool = False """ Whether the key is active """ # @ApiMember(Description="When the key was created") created_date: datetime.datetime = datetime.datetime(1, 1, 1) """ When the key was created """ # @ApiMember(Description="When the key expires, if ever") expiry_date: Optional[datetime.datetime] = None """ When the key expires, if ever """ # @ApiMember(Description="Contact email registered for the key") contact_email: Optional[str] = None """ Contact email registered for the key """ # @ApiMember(Description="Free text notes for the key") notes: Optional[str] = None """ Free text notes for the key """ # @ApiMember(Description="Comma separated list of IP addresses the key is restricted to, if any") allowed_ip_addresses: Optional[str] = None """ Comma separated list of IP addresses the key is restricted to, if any """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ApiKeyQueryResponse: # @ApiMember(Description="The API keys for the company") api_keys: List[ApiKeyResponse] = field(default_factory=list) """ The API keys for the company """ response_status: Optional[ResponseStatus] = None # @Route("/apikeys", "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) @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ApiKeyQuery(IReturn[ApiKeyQueryResponse], ICompany): # @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") company_id: Optional[str] = None """ 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(DataType="boolean", Description="If true, only return keys that are active (not cancelled and not expired). Default is false (return all).", ParameterType="query") active_only: Optional[bool] = None """ If true, only return keys that are active (not cancelled and not expired). Default is false (return all). """