@synteq/cli 0.1.0

package/dist/api/types.d.ts

@@ -0,0 +1,738 @@
+export interface WhoAmI {
+    id: string;
+    email: string;
+    full_name: string;
+    role: string;
+    email_verified: boolean;
+    avatar_url?: string | null;
+    totp_enabled?: boolean;
+    phone?: string | null;
+    admin_roles?: string[];
+    admin_permissions?: string[];
+    is_super_admin?: boolean;
+    onboarding_completed?: boolean;
+}
+export interface Team {
+    id: string;
+    name: string;
+    is_owner: boolean;
+    is_default: boolean;
+    my_role?: string;
+    resource_count?: number;
+}
+export interface Project {
+    id: string;
+    team_id: string;
+    name: string;
+    description: string | null;
+    is_default: boolean;
+    created_at: string;
+}
+export interface VPSPlan {
+    name?: string;
+    category?: string;
+    cpu_cores?: number;
+    ram_mb?: number;
+    disk_gb?: number;
+    monthly_price?: number;
+    is_custom?: boolean;
+}
+export interface VPSLocation {
+    name?: string;
+    city?: string;
+    country?: string;
+}
+export interface VPSIp {
+    id: string;
+    address: string;
+    subnet_cidr: string;
+    gateway: string | null;
+    version: number;
+    ptr_record: string | null;
+}
+export interface VPS {
+    id: string;
+    hostname: string;
+    status: string;
+    plan: VPSPlan | null;
+    location: VPSLocation | null;
+    location_id?: string;
+    project_id: string | null;
+    project_name: string | null;
+    created_at: string;
+    ip_addresses?: VPSIp[];
+    node?: string;
+    vmid?: number;
+    cluster_id?: string;
+    managed_os?: string | null;
+    last_installed_os?: string | null;
+    ptr_record?: string | null;
+    team_id?: string | null;
+    team_name?: string | null;
+    is_suspended?: boolean;
+    suspension_reason?: string | null;
+    cancellation_requested?: boolean;
+    cancellation_reason?: string | null;
+    cancellation_date?: string | null;
+    next_due?: string | null;
+    billing_anchor_at?: string | null;
+    effective_monthly_price?: number | null;
+    gpu_count?: number;
+    gpu_model_name?: string | null;
+    gpu_vram_gb?: number | null;
+}
+export interface BaremetalService {
+    id: string;
+    reference: string;
+    hostname: string | null;
+    location_name: string | null;
+    location_city: string | null;
+    cpu_cores: number | null;
+    ram_gb: number | null;
+    primary_ipv4: string | null;
+    is_active: boolean;
+    project_id: string | null;
+    project_name: string | null;
+}
+export interface StorageVolume {
+    id: string;
+    name: string;
+    size_gb: number;
+    status: string;
+    is_attached: boolean;
+    disk_slot: string | null;
+    monthly_price: number | null;
+    vps_id: string | null;
+    vps_hostname: string | null;
+    project_id: string;
+    project_name: string | null;
+    location_id: string | null;
+    location_name: string | null;
+    created_at: string;
+}
+export interface TransitService {
+    id: string;
+    service_name: string;
+    description: string | null;
+    commit_rate_bps: number | null;
+    project_id: string | null;
+    project_name: string | null;
+}
+export interface ResourceListItem {
+    kind: "vps" | "metal" | "colo" | "transit" | "storage";
+    id: string;
+    name: string;
+    status: string;
+    location: string;
+    project_name: string;
+}
+export interface TokenPair {
+    access_token: string;
+    refresh_token: string;
+    token_type: "Bearer";
+    expires_in: number;
+    user_id: string;
+    team_id: string | null;
+}
+export interface DeviceCodeOut {
+    device_code: string;
+    user_code: string;
+    verification_uri: string;
+    interval: number;
+    expires_in: number;
+}
+export interface CreditEntry {
+    id: string;
+    credit_number: string;
+    amount: number;
+    remaining: number;
+    currency: string;
+    description: string;
+    reference: string | null;
+    created_at: string;
+}
+export interface BalanceOut {
+    outstanding?: string | number;
+    credit?: string | number;
+    net_balance?: string | number;
+    currency?: string;
+    [k: string]: unknown;
+}
+export interface BandwidthPeriod {
+    period_start: string;
+    period_end: string;
+    bytes_in: number;
+    bytes_out: number;
+    used_tb: number;
+    last_polled_at: string | null;
+    overage_invoiced_at: string | null;
+}
+export interface BandwidthSummary {
+    included_tb: number | null;
+    overage_per_tb: number | null;
+    current: BandwidthPeriod | null;
+    history: BandwidthPeriod[];
+}
+export interface CreditTopupIn {
+    payment_method_id: string;
+    amount: number;
+    currency?: string;
+    bitpay_redirect_url?: string;
+}
+export interface CreditTopupOut {
+    status: string;
+    charge_id: string | null;
+    provider: string;
+    checkout_url: string | null;
+    credits_applied: string;
+    failure_reason: string | null;
+    invoice_id: string;
+}
+export interface PaymentMethod {
+    id: string;
+    provider: "stripe" | "paypal" | "gocardless" | "bitpay";
+    card_brand: string | null;
+    card_last4: string | null;
+    nickname: string | null;
+    is_default: boolean;
+    is_active: boolean;
+}
+export interface SetDefaultMethodOut {
+    id: string;
+    is_default: boolean;
+}
+export interface ReinstallIn {
+    image_id: string;
+    password?: string;
+    ssh_key_ids?: string[];
+    ssh_public_key?: string;
+    ciuser?: string;
+}
+export interface HypervisorTask {
+    task_id: string;
+    status: string;
+    action: string;
+}
+export interface BootOrderOut {
+    boot_order: "disk_first" | "cdrom_first";
+    requires_reboot: boolean;
+    pending_keys: string[];
+}
+export interface ActivityActor {
+    id: string;
+    full_name: string;
+    email: string;
+    avatar_url: string | null;
+}
+export interface ActivityEntry {
+    id: number;
+    action: string;
+    detail: string | null;
+    ip_address: string | null;
+    created_at: string;
+    actor: ActivityActor | null;
+}
+export interface ActivityList {
+    items: ActivityEntry[];
+    total: number;
+}
+export interface OrderCatalogPlan {
+    id: string;
+    slug: string;
+    name: string;
+    category: string;
+    cpu_cores: number;
+    ram_mb: number;
+    disk_gb: number;
+    monthly_price: number;
+    is_custom: boolean;
+    bandwidth_mbps?: number | null;
+    included_tb?: number | null;
+    gpu_model?: string | null;
+    gpu_vram_gb?: number | null;
+    in_stock: boolean;
+    out_of_stock_reason?: string | null;
+    per_location_stock?: Record<string, {
+        in_stock: boolean;
+        qty: number | null;
+    }>;
+}
+export interface OrderCatalogLocation {
+    id: string;
+    code: string;
+    name: string;
+    city: string;
+    country: string;
+    vat_exempt?: boolean;
+}
+export interface OrderCatalogImage {
+    id: string;
+    display_name: string;
+    os_type: string;
+    os_logo_url?: string | null;
+}
+export interface DedicatedPricing {
+    base_price: number;
+    price_per_cpu: number;
+    price_per_ram_gb: number;
+    price_per_disk_gb: number;
+    price_per_tb: number;
+    cpu_min: number;
+    cpu_max: number;
+    cpu_step: number;
+    cpu_stops: number[] | null;
+}
+export interface CustomVPSConfig {
+    enabled: boolean;
+    cpu_min: number;
+    cpu_max: number;
+    cpu_step: number;
+    ram_min_gb: number;
+    ram_max_gb: number;
+    ram_step_gb: number;
+    disk_min_gb: number;
+    disk_max_gb: number;
+    disk_step_gb: number;
+    base_price: number;
+    price_per_cpu: number;
+    price_per_ram_gb: number;
+    price_per_disk_gb: number;
+    bandwidth_min_tb: number;
+    bandwidth_max_tb: number;
+    bandwidth_step_tb: number;
+    bandwidth_included_tb: number;
+    price_per_tb: number;
+    cpu_stops: number[] | null;
+    ram_stops: number[] | null;
+    disk_stops: number[] | null;
+    bandwidth_stops: number[] | null;
+    dedicated: DedicatedPricing;
+}
+export interface OrderCatalogAddon {
+    addon_type: string;
+    monthly_price: number | null;
+    max_per_resource: number | null;
+    customer_billing_mode: "prorate_only" | "new_cycle_only" | "customer_choice";
+    customer_default_billing_mode: "prorate" | "new_cycle";
+}
+export interface OrderCatalog {
+    plans: OrderCatalogPlan[];
+    locations: OrderCatalogLocation[];
+    images: OrderCatalogImage[];
+    categories?: unknown[];
+    custom_config?: CustomVPSConfig | null;
+    addons?: OrderCatalogAddon[];
+    order_quantity?: {
+        cap: number;
+        tier: string;
+        paid_invoice_count: number;
+        lifetime_spend: string;
+    };
+}
+export interface VPSCustomSpec {
+    cpu_cores: number;
+    ram_mb: number;
+    disk_gb: number;
+    bandwidth_tb?: number;
+    dedicated?: boolean;
+}
+export interface VPSOrderIn {
+    project_id: string;
+    plan_id?: string;
+    custom_spec?: VPSCustomSpec;
+    location_id: string;
+    image_id: string;
+    hostname?: string;
+    hostnames?: string[];
+    quantity?: number;
+    payment_kind?: "method" | "bitpay";
+    payment_method_id?: string;
+    apply_credits?: boolean;
+    ssh_key_id?: string;
+    ssh_public_key?: string;
+    password?: string;
+    ciuser?: string;
+    bitpay_redirect_url?: string;
+}
+export interface OrderResultOut {
+    status: string;
+    order_id?: string | null;
+    invoice_id?: string | null;
+    charge_id?: string | null;
+    provider?: string | null;
+    checkout_url?: string | null;
+    credits_applied?: string | null;
+    failure_reason?: string | null;
+}
+export interface StorageCatalog {
+    is_active: boolean;
+    pricing_mode: string;
+    price_per_gb: number | string;
+    price_unit: "gb" | "tb";
+    min_size_gb: number;
+    max_size_gb: number;
+    step_gb: number;
+    size_stops?: {
+        size_gb: number;
+        monthly_price: number;
+    }[];
+    locations: {
+        id: string;
+        code?: string;
+        name: string;
+        city?: string;
+        country?: string;
+        in_stock: boolean;
+    }[];
+}
+export interface BlockVolumeCreateIn {
+    name: string;
+    size_gb: number;
+    location_id: string;
+    attach_vps_id?: string;
+    payment_method_id?: string;
+    apply_credits?: boolean;
+    bitpay_redirect_url?: string;
+}
+export interface BlockVolumeCreateOut {
+    status: "succeeded" | "pending" | "failed";
+    volume_id: string | null;
+    order_id: string | null;
+    invoice_id: string | null;
+    charge_id: string | null;
+    provider: string | null;
+    checkout_url: string | null;
+    credits_applied: string | null;
+    failure_reason: string | null;
+}
+export interface AttachOut {
+    status: "attached";
+    volume_id: string;
+    vps_id: string;
+    disk_slot: string | null;
+}
+export interface DetachOut {
+    status: "detached";
+    volume_id: string;
+}
+export interface VpsAddon {
+    id: string;
+    addon_type: string;
+    label: string | null;
+    ip_address: string | null;
+    as_set: string | null;
+    speed_mbps: number | null;
+    monthly_price: number | null;
+    created_at: string | null;
+}
+export interface PendingVpsAddon {
+    id: string;
+    addon_type: string;
+    label: string | null;
+    ip_address: string | null;
+    monthly_price: number;
+    charge_amount: number;
+    billing_anchor_at: string | null;
+    proration_mode: string | null;
+    pending_invoice_id: string | null;
+    created_at: string | null;
+    order_id?: string;
+    quantity?: number;
+}
+export interface AddonAttachIn {
+    addon_type: string;
+    count: number;
+    billing_mode: "prorate" | "new_cycle";
+    apply_credits?: boolean;
+    payment_method_id?: string;
+}
+export interface AddonAttachOut {
+    status: "succeeded" | "pending" | "failed";
+    addons: {
+        id: string;
+        ip_address: string | null;
+        monthly_price: number;
+    }[];
+    invoice_id: string | null;
+    order_id?: string | null;
+    charge_id: string | null;
+    provider: string | null;
+    checkout_url: string | null;
+    credits_applied: string | null;
+    failure_reason: string | null;
+    amount_paid: number;
+    billing_mode: string;
+}
+export interface AddonRemoveOut {
+    id: string;
+    status: string;
+}
+export type TeamInviteRole = "admin" | "billing" | "technical" | "read_only";
+export interface TeamInviteIn {
+    email: string;
+    role: TeamInviteRole;
+    project_ids?: string[];
+}
+export interface OrgDetails {
+    id: string;
+    name: string;
+    entity_type: "personal" | "business";
+    billing_email: string | null;
+    phone: string | null;
+    legal_name: string | null;
+    address_line1: string | null;
+    address_line2: string | null;
+    city: string | null;
+    state: string | null;
+    postcode: string | null;
+    country: string | null;
+    vat_number: string | null;
+    tax_exempt: boolean;
+    xero_contact_id: string | null;
+}
+export interface SSHKey {
+    id: string;
+    name: string;
+    public_key: string;
+    created_at: string;
+    resource_count: number;
+}
+export interface ApiKeyWhoami {
+    team_id: string;
+    team_name: string;
+    projects: {
+        id: string;
+        name: string;
+        is_default: boolean;
+    }[];
+    project_scoped: boolean;
+}
+export interface VpsOrderStatusOut {
+    order_id: string;
+    status: string;
+    vps_id: string | null;
+    hostname?: string | null;
+    error_detail?: string | null;
+    created_at?: string;
+    [k: string]: unknown;
+}
+export interface ReinstallStatusOut {
+    reinstalling: boolean;
+    step?: string | null;
+    progress_percent?: number;
+}
+export interface VPSResizeIn {
+    cpu_cores: number;
+    ram_mb: number;
+    disk_gb: number;
+    bandwidth_tb?: number;
+    dedicated?: boolean | null;
+    payment_method_id?: string;
+    apply_credits?: boolean;
+    bitpay_redirect_url?: string;
+}
+export interface ResizeSpecOut {
+    cpu_cores: number;
+    ram_mb: number;
+    disk_gb: number;
+    dedicated: boolean;
+}
+export interface VPSResizeQuoteOut {
+    current_spec: ResizeSpecOut;
+    requested_spec: ResizeSpecOut;
+    current_monthly_price: number;
+    new_monthly_price: number;
+    monthly_delta: number;
+    prorated_amount: number;
+    action: string;
+    next_due: string | null;
+    restart_required: boolean;
+    can_resize: boolean;
+    message: string;
+    in_stock: boolean;
+    out_of_stock_reason?: string | null;
+    credit_balance_available?: string;
+    can_switch_to_dedicated?: boolean;
+}
+export interface VPSResizeOut {
+    status: string;
+    pending_resize_id: string | null;
+    direction: string;
+    charge_id?: string | null;
+    provider: string | null;
+    checkout_url: string | null;
+    credits_applied: string;
+    failure_reason: string | null;
+}
+export interface PendingResizeOut {
+    id: string;
+    status: string;
+    direction: string;
+    target_cpu_cores: number | null;
+    target_ram_mb: number | null;
+    target_disk_gb: number | null;
+    target_included_tb: number | null;
+    target_monthly_price: number;
+    dedicated_cpu: boolean | null;
+    current_dedicated_cpu: boolean | null;
+    invoice_id: string | null;
+    effective_at: string | null;
+    current_snapshot?: Record<string, unknown> | null;
+}
+export interface BlockVolumeResizeQuoteIn {
+    new_size_gb: number;
+}
+export interface BlockVolumeResizeQuoteOut {
+    current_size_gb: number;
+    new_size_gb: number;
+    new_monthly_price: string;
+    monthly_delta: string;
+    prorated_amount: string;
+    currency: string;
+}
+export interface BlockVolumeResizeIn {
+    new_size_gb: number;
+    payment_method_id?: string;
+    apply_credits?: boolean;
+    bitpay_redirect_url?: string;
+}
+export interface BlockVolumeResizeOut {
+    status: string;
+    volume_id: string;
+    invoice_id: string | null;
+    charge_id: string | null;
+    provider: string | null;
+    checkout_url: string | null;
+    credits_applied: string | null;
+    failure_reason: string | null;
+}
+export interface BlockVolumeCancelIn {
+    reason: string;
+    notes?: string;
+}
+export interface BlockVolumeDeleteIn {
+    password: string;
+    reason?: string;
+    notes?: string;
+}
+export interface BlockVolumeDetailOut {
+    id: string;
+    project_id: string;
+    cluster_id: string;
+    vps_id: string | null;
+    name: string;
+    size_gb: number;
+    status: string;
+    monthly_price: string | null;
+    cancellation_requested: boolean;
+    cancellation_reason: string | null;
+    cancellation_notes: string | null;
+    cancellation_date: string | null;
+    cancellation_initiated_by: string | null;
+    attached_vps_hostname: string | null;
+    location_name: string | null;
+    location_country: string | null;
+    [k: string]: unknown;
+}
+export interface ConsoleTokenOut {
+    token: string;
+    console_type: "serial" | "vnc";
+    keyboard?: string | null;
+    preview?: boolean;
+}
+export type TicketStatus = "open" | "in_progress" | "waiting_customer" | "waiting_staff" | "resolved" | "closed";
+export type TicketPriority = "low" | "normal" | "high" | "urgent";
+export interface TicketDepartment {
+    key: string;
+    name: string;
+}
+export interface TicketListMessage {
+    id: string;
+    body: string;
+    is_staff: boolean;
+    author_name: string | null;
+    created_at: string;
+}
+export interface TicketListItem {
+    id: string;
+    display_id: number;
+    user_id: string;
+    user_email: string | null;
+    user_name: string | null;
+    user_company: string | null;
+    team_id: string;
+    team_name: string | null;
+    subject: string;
+    status: TicketStatus;
+    priority: TicketPriority;
+    department: string;
+    service_type: string | null;
+    service_id: string | null;
+    created_at: string;
+    updated_at: string;
+    assigned_to_id: string | null;
+    assigned_to_name: string | null;
+    message_count: number;
+    latest_message_preview: string | null;
+    messages: TicketListMessage[];
+    last_message_at: string;
+    viewer_role: "owner" | "cc" | "team_admin";
+    is_unread: boolean;
+    last_seen_at: string | null;
+}
+export interface Ticket {
+    id: string;
+    display_id: number;
+    user_id: string;
+    user_email: string | null;
+    user_name: string | null;
+    user_company: string | null;
+    team_id: string;
+    team_name: string | null;
+    subject: string;
+    status: TicketStatus;
+    priority: TicketPriority;
+    department: string;
+    service_type: string | null;
+    service_id: string | null;
+    created_at: string;
+    updated_at: string;
+    assigned_to_id: string | null;
+    assigned_to_name: string | null;
+    message_count: number;
+}
+export interface TicketAttachment {
+    id: string;
+    ticket_message_id: string;
+    filename: string;
+    content_type: string;
+    size_bytes: number;
+    created_at: string;
+}
+export interface TicketMessage {
+    id: string;
+    ticket_id: string;
+    author_id: string;
+    author_name: string | null;
+    author_email: string | null;
+    body: string;
+    is_staff: boolean;
+    created_at: string;
+    attachments: TicketAttachment[];
+}
+export interface TicketCreateIn {
+    subject: string;
+    body: string;
+    priority?: TicketPriority;
+    department?: string;
+    service_type?: string | null;
+    service_id?: string | null;
+    team_id?: string | null;
+    recipient_emails?: string[] | null;
+}
+export interface TicketMessageIn {
+    body: string;
+}
+export interface TicketStatusIn {
+    status: TicketStatus;
+}