import { ApplicationId, APIPayload, ISODateString } from '../../common/v2.js';
import '../../utils.js';

/**
 * Time bucket of the `visits` time series (15-minute window). Has no `type`
 * field because the dimension is time itself.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/analytics
 */
interface APINetworkAnalyticsTimeBucket {
    /** Start of the 15-minute window (ISO 8601). */
    date: ISODateString;
    /** Unique visitors. */
    visits: number;
    /** Total requests. */
    requests: number;
    /** Response bytes served. */
    bytes: number;
}
/**
 * Per-dimension bucket — `type` identifies the dimension value (e.g. country
 * name, HTTP method, browser, ASN tag).
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/analytics
 */
interface APINetworkAnalyticsBucket {
    /** Dimension value for this bucket. */
    type: string;
    /** Start of the 15-minute window (ISO 8601). */
    date: ISODateString;
    /** Unique visitors in this bucket. */
    visits: number;
    /** Total requests in this bucket. */
    requests: number;
    /** Response bytes served in this bucket. */
    bytes: number;
}
/**
 * Whole-window bucket (no time dimension) used by the `ips`, `status_codes`,
 * `bots` and `content_types` breakdowns — totals over the requested range
 * rather than 15-minute series.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/analytics
 */
interface APINetworkAnalyticsTotalBucket {
    /** Dimension value for this bucket. */
    type: string;
    /** Unique visitor count. */
    visits: number;
    /** Total request count. */
    requests: number;
    /** Response bytes served. */
    bytes: number;
}
/**
 * Aggregated edge analytics returned by `/v2/apps/{appId}/network/analytics`.
 * Each breakdown is an array of 15-minute buckets. The endpoint requires
 * `start`/`end` ISO timestamps (max 7 days retention; `start` is clamped to
 * the application's creation date).
 *
 * - `referers`: empty referer strings are normalized to `type: "Direct"`.
 * - `providers`: ASN breakdown — Square Cloud's own ASN is normalized to
 *   `type: "SQUARE-CLOUD-PLATFORM"`.
 *
 * The endpoint may also return an empty object `{}` when the requested window
 * precedes the application's creation date — see {@link APINetworkAnalyticsPayload}.
 *
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/analytics
 */
interface APINetworkAnalytics {
    visits: APINetworkAnalyticsTimeBucket[];
    countries: APINetworkAnalyticsBucket[];
    devices: APINetworkAnalyticsBucket[];
    os: APINetworkAnalyticsBucket[];
    browsers: APINetworkAnalyticsBucket[];
    protocols: APINetworkAnalyticsBucket[];
    methods: APINetworkAnalyticsBucket[];
    paths: APINetworkAnalyticsBucket[];
    referers: APINetworkAnalyticsBucket[];
    providers: APINetworkAnalyticsBucket[];
    /**
     * Top client IPs by request count over the whole window. IPs originating
     * from Square Cloud's own network are masked (`X.X.XXX.XXX`).
     */
    ips: APINetworkAnalyticsTotalBucket[];
    /** Edge response status codes over the whole window (all classes, not just errors). */
    status_codes: APINetworkAnalyticsTotalBucket[];
    /**
     * Verified-bot categories over the whole window. Traffic without a verified
     * bot category is `type: "Unverified"`.
     */
    bots: APINetworkAnalyticsTotalBucket[];
    /**
     * Response content types over the whole window. Unknown content types are
     * `type: "Unknown"`.
     */
    content_types: APINetworkAnalyticsTotalBucket[];
}
/**
 * Payload of `/v2/apps/{appId}/network/analytics`. `response` may be an empty
 * object `{}` when the requested window precedes the application's creation
 * date — guard with `'visits' in payload.response` before accessing fields.
 */
type APINetworkAnalyticsPayload = APIPayload<APINetworkAnalytics | Record<string, never>>;
/**
 * DNS record type returned by the DNS endpoint. `txt` covers both ownership
 * and SSL validation; `cname` is the traffic record.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/dns
 */
type APINetworkDNSRecordType = "txt" | "cname";
declare const APINetworkDNSRecordType: {
    readonly TXT: "txt";
    readonly CNAME: "cname";
};
/**
 * Known validation states for a DNS record. `status` is passed through from
 * the edge provider, so other values may appear.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/dns
 */
type APINetworkDNSStatus = "pending" | "pending_validation" | "active";
declare const APINetworkDNSStatus: {
    readonly Pending: "pending";
    readonly PendingValidation: "pending_validation";
    readonly Active: "active";
};
/**
 * One DNS record the user must set at their DNS provider for the custom
 * domain to validate and receive traffic.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/dns
 */
interface APINetworkDNSRecord {
    type: APINetworkDNSRecordType;
    /** Record name to set at the DNS provider. */
    name: string;
    /** Record value. For `cname`, this is always `cname.squareweb.app`. */
    value: string;
    /**
     * Upstream validation state (e.g. `pending`, `pending_validation`,
     * `active` — see {@link APINetworkDNSStatus}). Passed through from the
     * edge provider.
     */
    status: string;
}
/**
 * Response of `GET /v2/apps/{appId}/network/dns` — the DNS records the user
 * must configure, with their current validation state.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/dns
 */
type APINetworkDNS = APINetworkDNSRecord[];
type APINetworkDNSPayload = APIPayload<APINetworkDNS>;
/**
 * Summary block of the edge errors response.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/errors
 */
interface APINetworkErrorsSummary {
    total: number;
    by_class: {
        "4xx": number;
        "5xx": number;
    };
}
/**
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/errors
 */
interface APINetworkErrorsByStatus {
    status: number;
    requests: number;
}
/**
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/errors
 */
interface APINetworkErrorsTimeseries {
    date: ISODateString;
    /** Status-code → count map for the bucket. */
    buckets: Record<string, number>;
    total: number;
}
/**
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/errors
 */
interface APINetworkErrorsTopPath {
    path: string;
    /** HTTP method. `null` when the edge couldn't attribute one. */
    method: string | null;
    total: number;
    /** Map of HTTP status code (as string) to request count. */
    by_status: Record<string, number>;
}
/**
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/errors
 */
interface APINetworkErrorsByMethod {
    /** HTTP method. `null` when the edge couldn't attribute one. */
    method: string | null;
    total: number;
    /** Map of HTTP status code (as string) to request count. */
    by_status: Record<string, number>;
}
/**
 * Aggregated edge error breakdown returned by `/v2/apps/{appId}/network/errors`.
 *
 * **Note:** `by_status` at the top level is a flat **array** of
 * `{ status, requests }`, while the nested `by_status` maps inside `top_paths`
 * and `by_method` are objects keyed by status code.
 *
 * May also be an empty object `{}` when the requested window precedes the
 * application's creation date — see {@link APINetworkErrorsPayload}.
 *
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/errors
 */
interface APINetworkErrors {
    summary: APINetworkErrorsSummary;
    by_status: APINetworkErrorsByStatus[];
    timeseries: APINetworkErrorsTimeseries[];
    top_paths: APINetworkErrorsTopPath[];
    by_method: APINetworkErrorsByMethod[];
}
/**
 * Payload of `/v2/apps/{appId}/network/errors`. `response` may be an empty
 * object `{}` when the requested window precedes the application's creation
 * date — guard with `'summary' in payload.response` before accessing fields.
 */
type APINetworkErrorsPayload = APIPayload<APINetworkErrors | Record<string, never>>;
/**
 * Client info embedded in each edge log entry.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/logs
 */
interface APINetworkLogClient {
    ip: string | null;
    country: string | null;
    location: string | null;
    asn: string;
    agent: string | null;
    category: string | null;
}
/**
 * Request info embedded in each edge log entry.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/logs
 */
interface APINetworkLogRequest {
    mitigated: boolean;
    method: string;
    host: string;
    path: string;
    query: string | null;
    protocol: string;
    referer: string | null;
}
/**
 * Response info embedded in each edge log entry.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/logs
 */
interface APINetworkLogResponse {
    status: number;
    contentType: string | null;
    cache: string | null;
}
/**
 * A single edge log entry. Available on Pro+ plans.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/logs
 */
interface APINetworkLog {
    timestamp: ISODateString;
    client: APINetworkLogClient;
    request: APINetworkLogRequest;
    response: APINetworkLogResponse;
}
type APINetworkLogs = APINetworkLog[];
type APINetworkLogsPayload = APIPayload<APINetworkLogs>;
/**
 * Latency percentile triple used by the performance endpoint.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/performance
 */
interface APINetworkLatency {
    p50: number;
    p95: number;
    p99: number;
}
/**
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/performance
 */
interface APINetworkPerformanceSummary {
    edge: APINetworkLatency;
    origin: APINetworkLatency;
    requests: number;
}
/**
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/performance
 */
interface APINetworkPerformanceTimeseries {
    date: ISODateString;
    requests: number;
    edge: APINetworkLatency;
    origin: APINetworkLatency;
}
/**
 * Per-country latency breakdown. `type` is the country name as resolved by the
 * edge provider (e.g. `"Brazil"`).
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/performance
 */
interface APINetworkPerformanceCountry {
    type: string;
    p50: number;
    p95: number;
    requests: number;
}
/**
 * Per-colo (datacenter) latency breakdown. `type` is the IATA-like colo code
 * (e.g. `"GRU"`).
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/performance
 */
interface APINetworkPerformanceColo {
    type: string;
    city: string;
    country: string;
    p50: number;
    p95: number;
    requests: number;
}
/**
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/performance
 */
interface APINetworkPerformanceSlowestPath {
    path: string;
    p95: number;
    p99: number;
    requests: number;
}
/**
 * Latency percentiles plus per-country/per-colo breakdowns and the slowest
 * paths. Available on Pro+ plans.
 *
 * May also be an empty object `{}` when the requested window precedes the
 * application's creation date — see {@link APINetworkPerformancePayload}.
 *
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/performance
 */
interface APINetworkPerformance {
    summary: APINetworkPerformanceSummary;
    timeseries: APINetworkPerformanceTimeseries[];
    countries: APINetworkPerformanceCountry[];
    colos: APINetworkPerformanceColo[];
    slowest_paths: APINetworkPerformanceSlowestPath[];
}
/**
 * Payload of `/v2/apps/{appId}/network/performance`. `response` may be an
 * empty object `{}` when the requested window precedes the application's
 * creation date — guard with `'summary' in payload.response` before accessing
 * fields.
 */
type APINetworkPerformancePayload = APIPayload<APINetworkPerformance | Record<string, never>>;
/**
 * Kind of hostname listed by `GET /v2/apps/domains` — `subdomain` for the
 * default `*.squareweb.app` hostname, `custom` for an attached custom domain.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/domains
 */
type APIAppDomainType = "subdomain" | "custom";
declare const APIAppDomainType: {
    readonly Subdomain: "subdomain";
    readonly Custom: "custom";
};
/**
 * One hostname configured on one of the account's applications, as returned
 * by `GET /v2/apps/domains`. Custom domains are listed first, followed by the
 * default subdomains; applications without a web domain are omitted.
 *
 * Served from the cached project list (does not count against per-application
 * network rate limits). Rate limited to 20 requests per 60s per user.
 *
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/domains
 */
interface APIAppDomain {
    /** Application the domain belongs to. */
    app_id: ApplicationId;
    /** The fully qualified hostname. */
    hostname: string;
    type: APIAppDomainType;
}
type APIAppDomainsPayload = APIPayload<APIAppDomain[]>;
/**
 * Application serving a load-balanced custom domain.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/load-balancers
 */
interface APILoadBalancerApp {
    id: ApplicationId;
    name: string;
    /** Cluster currently hosting the application. */
    cluster?: string;
}
/**
 * One custom domain and the applications serving it. A group with two or more
 * applications is an active load balancer — traffic is balanced across them
 * at the edge, with automatic failover when an application is offline.
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/load-balancers
 */
interface APILoadBalancer {
    /** The custom domain. */
    hostname: string;
    apps: APILoadBalancerApp[];
}
/**
 * Response of `GET /v2/apps/load-balancers` — the caller's applications
 * grouped by attached custom domain.
 *
 * Served from the cached project list. Rate limited to 20 requests per 60s
 * per user.
 *
 * @see https://docs.squarecloud.app/en/api-reference/endpoint/apps/load-balancers
 */
interface APILoadBalancers {
    /**
     * Maximum applications allowed on one domain for the caller's plan:
     * 2 on Standard, 5 on Pro, 10 on Enterprise.
     */
    limit: number;
    balancers: APILoadBalancer[];
}
type APILoadBalancersPayload = APIPayload<APILoadBalancers>;

export { type APIAppDomain, APIAppDomainType, type APIAppDomainsPayload, type APILoadBalancer, type APILoadBalancerApp, type APILoadBalancers, type APILoadBalancersPayload, type APINetworkAnalytics, type APINetworkAnalyticsBucket, type APINetworkAnalyticsPayload, type APINetworkAnalyticsTimeBucket, type APINetworkAnalyticsTotalBucket, type APINetworkDNS, type APINetworkDNSPayload, type APINetworkDNSRecord, APINetworkDNSRecordType, APINetworkDNSStatus, type APINetworkErrors, type APINetworkErrorsByMethod, type APINetworkErrorsByStatus, type APINetworkErrorsPayload, type APINetworkErrorsSummary, type APINetworkErrorsTimeseries, type APINetworkErrorsTopPath, type APINetworkLatency, type APINetworkLog, type APINetworkLogClient, type APINetworkLogRequest, type APINetworkLogResponse, type APINetworkLogs, type APINetworkLogsPayload, type APINetworkPerformance, type APINetworkPerformanceColo, type APINetworkPerformanceCountry, type APINetworkPerformancePayload, type APINetworkPerformanceSlowestPath, type APINetworkPerformanceSummary, type APINetworkPerformanceTimeseries };