admin-frontend-domain/src/types/api.ts

/* eslint-disable */
/* tslint:disable */
// @ts-nocheck
/*
 * ---------------------------------------------------------------
 * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
 * ##                                                           ##
 * ## AUTHOR: acacode                                           ##
 * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
 * ---------------------------------------------------------------
 */

/** @format int32 */
export enum ModelRole {
    RoleAdmin = 0,
    RoleMember = 1,
}

export interface GithubComNezhahqNezhaModelCommonResponseAny {
    data?: any
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelAlertRule {
    data?: ModelAlertRule[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelCron {
    data?: ModelCron[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelDDNSProfile {
    data?: ModelDDNSProfile[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelNAT {
    data?: ModelNAT[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelNotification {
    data?: ModelNotification[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelNotificationGroupResponseItem {
    data?: ModelNotificationGroupResponseItem[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelServer {
    data?: ModelServer[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelServerGroupResponseItem {
    data?: ModelServerGroupResponseItem[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelService {
    data?: ModelService[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelServiceInfos {
    data?: ModelServiceInfos[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayModelUser {
    data?: ModelUser[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayString {
    data?: string[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseArrayUint64 {
    data?: number[]
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseModelLoginResponse {
    data?: ModelLoginResponse
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseModelProfile {
    data?: ModelProfile
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseModelServerTaskResponse {
    data?: ModelServerTaskResponse
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseModelServiceResponse {
    data?: ModelServiceResponse
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseModelSettingResponse {
    data?: ModelSettingResponse
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseString {
    data?: string
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelCommonResponseUint64 {
    data?: number
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelPaginatedResponseArrayModelOnlineUserModelOnlineUser {
    data?: GithubComNezhahqNezhaModelValueArrayModelOnlineUser
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelPaginatedResponseArrayModelWAFApiMockModelWAFApiMock {
    data?: GithubComNezhahqNezhaModelValueArrayModelWAFApiMock
    error?: string
    success?: boolean
}

export interface GithubComNezhahqNezhaModelValueArrayModelOnlineUser {
    pagination?: ModelPagination
    value?: ModelOnlineUser[]
}

export interface GithubComNezhahqNezhaModelValueArrayModelWAFApiMock {
    pagination?: ModelPagination
    value?: ModelWAFApiMock[]
}

export interface ModelAlertRule {
    created_at?: string
    enable?: boolean
    /** 失败时执行的触发任务id */
    fail_trigger_tasks: number[]
    id?: number
    name: string
    /** 该报警规则所在的通知组 */
    notification_group_id: number
    /** 恢复时执行的触发任务id */
    recover_trigger_tasks: number[]
    rules: ModelRule[]
    /** 触发模式: 0-始终触发(默认) 1-单次触发 */
    trigger_mode: number
    updated_at?: string
}

export interface ModelAlertRuleForm {
    enable?: boolean
    /** 失败时触发的任务id */
    fail_trigger_tasks: number[]
    /** @minLength 1 */
    name: string
    notification_group_id: number
    /** 恢复时触发的任务id */
    recover_trigger_tasks: number[]
    rules: ModelRule[]
    /** @default 0 */
    trigger_mode: number
}

export interface ModelBatchMoveServerForm {
    ids: number[]
    to_user: number
}

export interface ModelCreateFMResponse {
    session_id?: string
}

export interface ModelCreateTerminalResponse {
    server_id?: number
    server_name?: string
    session_id?: string
}

export interface ModelCron {
    command?: string
    /** 计划任务覆盖范围 (0:仅覆盖特定服务器 1:仅忽略特定服务器 2:由触发该计划任务的服务器执行) */
    cover: number
    created_at?: string
    cron_job_id?: number
    id?: number
    /** 最后一次执行时间 */
    last_executed_at?: string
    /** 最后一次执行结果 */
    last_result?: boolean
    name: string
    /** 指定通知方式的分组 */
    notification_group_id: number
    /** 推送成功的通知 */
    push_successful?: boolean
    /** 分钟 小时 天 月 星期 */
    scheduler: string
    servers: number[]
    /** 0:计划任务 1:触发任务 */
    task_type: number
    updated_at?: string
}

export interface ModelCronForm {
    command?: string
    /** @default 0 */
    cover?: number
    /** @minLength 1 */
    name?: string
    notification_group_id?: number
    push_successful?: boolean
    scheduler?: string
    servers?: number[]
    /**
     * 0:计划任务 1:触发任务
     * @default 0
     */
    task_type?: number
}

export interface ModelCycleTransferStats {
    from: string
    max: number
    min: number
    name: string
    next_update?: Record<string, string>
    server_name?: Record<string, string>
    to: string
    transfer?: Record<string, number>
}

export interface ModelDDNSForm {
    access_id?: string
    access_secret?: string
    domains?: string[]
    enable_ipv4?: boolean
    enable_ipv6?: boolean
    /** @default 3 */
    max_retries?: number
    /** @minLength 1 */
    name?: string
    provider?: string
    webhook_headers?: string
    /** @default 1 */
    webhook_method?: number
    webhook_request_body?: string
    /** @default 1 */
    webhook_request_type?: number
    webhook_url?: string
}

export interface ModelDDNSProfile {
    access_id?: string
    access_secret?: string
    created_at?: string
    domains: string[]
    enable_ipv4?: boolean
    enable_ipv6?: boolean
    id?: number
    max_retries: number
    name: string
    provider: string
    updated_at?: string
    webhook_headers?: string
    webhook_method?: number
    webhook_request_body?: string
    webhook_request_type?: number
    webhook_url?: string
}

export interface ModelFrontendTemplate {
    author?: string
    is_admin?: boolean
    is_official?: boolean
    name?: string
    path?: string
    repository?: string
    version?: string
}

export interface ModelGeoIP {
    country_code?: string
    ip?: ModelIP
}

export interface ModelHost {
    arch?: string
    boot_time?: number
    cpu?: string[]
    disk_total?: number
    gpu?: string[]
    mem_total?: number
    platform?: string
    platform_version?: string
    swap_total?: number
    version?: string
    virtualization?: string
}

export interface ModelHostState {
    cpu?: number
    disk_used?: number
    gpu?: number[]
    load_1?: number
    load_15?: number
    load_5?: number
    mem_used?: number
    net_in_speed?: number
    net_in_transfer?: number
    net_out_speed?: number
    net_out_transfer?: number
    process_count?: number
    swap_used?: number
    tcp_conn_count?: number
    temperatures?: ModelSensorTemperature[]
    udp_conn_count?: number
    uptime?: number
}

export interface ModelIP {
    ipv4_addr?: string
    ipv6_addr?: string
}

export interface ModelLoginRequest {
    password?: string
    username?: string
}

export interface ModelLoginResponse {
    expire?: string
    token?: string
}

export interface ModelNAT {
    created_at?: string
    domain: string
    enabled: boolean
    host: string
    id?: number
    name: string
    server_id: number
    updated_at?: string
}

export interface ModelNATForm {
    domain?: string
    enabled?: boolean
    host?: string
    /** @minLength 1 */
    name?: string
    server_id?: number
}

export interface ModelNotification {
    created_at?: string
    id?: number
    name: string
    type?: number
    request_body: string
    request_header: string
    request_method: number
    request_type: number
    updated_at?: string
    url: string
    verify_tls?: boolean
    skip_check?: boolean
    format_metric_units?: boolean
}

export interface ModelNotificationForm {
    /** @minLength 1 */
    name?: string
    type?: number
    request_body?: string
    request_header?: string
    request_method?: number
    request_type?: number
    skip_check?: boolean
    url?: string
    verify_tls?: boolean
    skip_check?: boolean
    format_metric_units?: boolean
}

export interface ModelNotificationGroup {
    created_at?: string
    id?: number
    name: string
    updated_at?: string
}

export interface ModelNotificationGroupForm {
    /** @minLength 1 */
    name: string
    notifications: number[]
}

export interface ModelNotificationGroupResponseItem {
    group: ModelNotificationGroup
    notifications: number[]
}

export interface ModelOauth2LoginResponse {
    redirect?: string
}

export interface ModelOnlineUser {
    connected_at?: string
    ip?: string
    user_id?: number
}

export interface ModelPagination {
    limit?: number
    offset?: number
    total?: number
}

export interface ModelProfile {
    agent_secret?: string
    created_at?: string
    id?: number
    login_ip?: string
    oauth2_bind?: Record<string, string>
    password?: string
    reject_password?: boolean
    role?: ModelRole
    updated_at?: string
    username?: string
}

export interface ModelProfileForm {
    new_password?: string
    new_username?: string
    original_password?: string
    reject_password?: boolean
}

export interface ModelBillingDataMod {
    registrar?: string
    registeredDate?: string
    endDate?: string
    renewalPrice?: string
    autoRenewal?: string
    notes?: string
    cycle?: string
    amount?: string
}

export interface ModelRule {
    /** 覆盖范围 RuleCoverAll/IgnoreAll */
    cover: number
    /** 流量统计周期 */
    cycle_interval?: number
    /** 流量统计的开始时间 */
    cycle_start?: string
    /**
     * 流量统计周期单位，默认hour,可选(hour, day, week, month, year)
     * @default "hour"
     */
    cycle_unit?: "hour" | "day" | "week" | "month" | "year"
    /** 持续时间 (秒) */
    duration?: number
    /** 覆盖范围的排除 */
    ignore?: Record<string, boolean>
    /** 最大阈值 (百分比、字节 kb ÷ 1024) */
    max?: number
    /** 最小阈值 (百分比、字节 kb ÷ 1024) */
    min?: number
    /**
     * 指标类型，cpu、memory、swap、disk、net_in_speed、net_out_speed
     * net_all_speed、transfer_in、transfer_out、transfer_all、offline
     * transfer_in_cycle、transfer_out_cycle、transfer_all_cycle
     */
    type: string
}

export interface ModelSensorTemperature {
    name?: string
    /** @format float64 */
    temperature?: number
}

export interface ModelServer {
    created_at?: string
    /** DDNS配置 */
    ddns_profiles?: number[]
    /** 展示排序，越大越靠前 */
    display_index: number
    /** 启用DDNS */
    enable_ddns?: boolean
    geoip?: ModelGeoIP
    /** 对游客隐藏 */
    hide_for_guest?: boolean
    host?: ModelHost
    id?: number
    last_active?: string
    name: string
    /** 管理员可见备注 */
    note?: string
    override_ddns_domains?: Record<string, string[]>
    /** 公开备注 */
    public_note?: string
    state?: ModelHostState
    billing_data?: ModelBillingDataMod
    updated_at?: string
    uuid?: string
}

export interface ModelServerConfigForm {
    config?: string
    servers?: number[]
}

export interface ModelServerForm {
    /** DDNS配置 */
    ddns_profiles?: number[]
    /**
     * 展示排序，越大越靠前
     * @default 0
     */
    display_index?: number
    /** 启用DDNS */
    enable_ddns?: boolean
    /** 对游客隐藏 */
    hide_for_guest?: boolean
    name?: string
    /** 管理员可见备注 */
    note?: string
    override_ddns_domains?: Record<string, string[]>
    /** 公开备注 */
    public_note?: string
    billing_data?: ModelBillingDataMod
}

export interface ModelServerGroup {
    created_at?: string
    id?: number
    name: string
    updated_at?: string
}

export interface ModelServerGroupForm {
    /** @minLength 1 */
    name: string
    servers: number[]
}

export interface ModelServerGroupResponseItem {
    group: ModelServerGroup
    servers: number[]
}

export interface ModelServerTaskResponse {
    failure?: number[]
    offline?: number[]
    success?: number[]
}

export interface ModelService {
    cover: number
    created_at?: string
    duration: number
    enable_show_in_service?: boolean
    enable_trigger_task?: boolean
    /** 失败时执行的触发任务id */
    fail_trigger_tasks: number[]
    display_index: number
    id?: number
    latency_notify?: boolean
    max_latency: number
    min_latency: number
    name: string
    /** 当前服务监控所属的通知组 ID */
    notification_group_id: number
    notify?: boolean
    /** 恢复时执行的触发任务id */
    recover_trigger_tasks: number[]
    skip_servers: Record<string, boolean>
    target: string
    type: number
    updated_at?: string
}

export interface ModelServiceForm {
    cover?: number
    duration?: number
    enable_show_in_service?: boolean
    enable_trigger_task?: boolean
    fail_trigger_tasks?: number[]
    latency_notify?: boolean
    /** @default 0 */
    max_latency?: number
    /** @default 0 */
    min_latency?: number
    /** @minLength 1 */
    name?: string
    notification_group_id?: number
    notify?: boolean
    recover_trigger_tasks?: number[]
    skip_servers?: Record<string, boolean>
    target?: string
    type?: number
}

export interface ModelServiceInfos {
    avg_delay: number[]
    created_at: number[]
    monitor_id: number
    monitor_name: string
    server_id: number
    server_name: string
}

export interface ModelServiceResponse {
    cycle_transfer_stats?: Record<string, ModelCycleTransferStats>
    services?: Record<string, ModelServiceResponseItem>
}

export interface ModelServiceResponseItem {
    current_down: number
    current_up: number
    delay?: number[]
    down?: number[]
    service_name?: string
    total_down: number
    total_up: number
    up?: number[]
}

export interface ModelSetting {
    admin_template?: string
    /** Agent真实IP */
    agent_real_ip_header?: string
    /** 覆盖范围（0:提醒未被 IgnoredIPNotification 包含的所有服务器; 1:仅提醒被 IgnoredIPNotification 包含的服务器;） */
    cover: number
    custom_code?: string
    custom_code_dashboard?: string
    dns_servers?: string
    /** IP变更提醒 */
    enable_ip_change_notification?: boolean
    /** 通知信息IP不打码 */
    enable_plain_ip_in_notification?: boolean
    expiry_notification_group_id?: number
    /** 特定服务器IP（多个服务器用逗号分隔） */
    ignored_ip_notification?: string
    ignored_ip_notification_server_ids?: Record<string, boolean>
    install_host?: string
    ip_change_notification_group_id: number
    /** 系统语言，默认 zh_CN */
    language: string
    oauth2_providers?: string[]
    site_name: string
    /** 用于前端判断生成的安装命令是否启用 TLS */
    tls?: boolean
    user_template?: string
    web_real_ip_header?: string
    custom_logo?: string
    custom_description?: string
    custom_links?: string
    background_image_day?: string
    background_image_night?: string
    telegram_bot_token?: string
    telegram_admin_chat_id?: string
    smtp_server?: string
    smtp_user?: string
    smtp_password?: string
    admin_email?: string
}

export interface ModelSettingForm {
    /** Agent真实IP */
    agent_real_ip_header?: string
    cover?: number
    custom_code?: string
    custom_code_dashboard?: string
    dns_servers?: string
    enable_ip_change_notification?: boolean
    enable_plain_ip_in_notification?: boolean
    expiry_notification_group_id?: number
    ignored_ip_notification?: string
    install_host?: string
    /** IP变更提醒的通知组 */
    ip_change_notification_group_id?: number
    /** @minLength 2 */
    language?: string
    /** @minLength 1 */
    site_name?: string
    tls?: boolean
    user_template?: string
    web_real_ip_header?: string
    /** 自定义Logo链接 */
    custom_logo?: string
    /** 自定义描述/副标题 */
    custom_description?: string
    /** 自定义导航链接 (JSON) */
    custom_links?: string
    /** 白天背景图链接 */
    background_image_day?: string
    /** 夜间背景图链接 */
    background_image_night?: string
    telegram_bot_token?: string
    telegram_admin_chat_id?: string
    smtp_server?: string
    smtp_user?: string
    smtp_password?: string
    admin_email?: string
}

export interface ModelSettingResponse {
    config: ModelSetting
    frontend_templates?: ModelFrontendTemplate[]
    version?: string
}

export interface ModelStreamServer {
    country_code?: string
    /** 展示排序，越大越靠前 */
    display_index?: number
    host?: ModelHost
    id?: number
    last_active?: string
    name?: string
    /** 公开备注，只第一个数据包有值 */
    public_note?: string
    state?: ModelHostState
}

export interface ModelStreamServerData {
    now?: number
    online?: number
    servers?: ModelStreamServer[]
}

export interface ModelTerminalForm {
    protocol?: string
    server_id?: number
}

export interface ModelUser {
    agent_secret?: string
    created_at?: string
    id?: number
    password?: string
    reject_password?: boolean
    role?: ModelRole
    updated_at?: string
    username?: string
}

export interface ModelUserForm {
    password?: string
    role?: ModelRole
    username?: string
}

export interface ModelWAFApiMock {
    block_identifier?: number
    block_reason?: number
    block_timestamp?: number
    count?: number
    ip?: string
}