types.ts

/*
 Generated by typeshare 1.13.0
*/

/** Helper type for typeshare */
export type SecretStoreT = Record<string, string>;

export interface AddCertificateRequest {
	subject: string;
}

export enum TeamRole {
	Owner = "owner",
	Admin = "admin",
	Member = "member",
}

/**
 * Provide user id to add user.
 * Provide email address to invite user via email.
 */
export interface AddTeamMemberRequest {
	user_id?: string;
	email?: string;
	/** Role of the user in the team */
	role?: TeamRole;
}

export interface ApiError {
	message: string;
	status_code: number;
}

export interface BetterstackConfig {
	ingesting_host: string;
	source_token: string;
}

export interface BuildArgsRust {
	/** Version of shuttle-runtime used by this crate */
	shuttle_runtime_version?: string;
	/** Use the built in cargo chef setup for caching */
	cargo_chef: boolean;
	/** Build with the built in `cargo build` setup */
	cargo_build: boolean;
	/** The cargo package name to compile */
	package_name?: string;
	/** The cargo binary name to compile */
	binary_name?: string;
	/** comma-separated list of features to activate */
	features?: string;
	/** Passed on to `cargo build` */
	no_default_features: boolean;
	/** Use the mold linker */
	mold: boolean;
}

export interface BuildMeta {
	git_commit_id?: string;
	git_commit_msg?: string;
	git_branch?: string;
	git_dirty?: boolean;
}

export interface CertificateResponse {
	id: string;
	subject: string;
	serial_hex: string;
	not_after: string;
}

export interface CertificateListResponse {
	certificates: CertificateResponse[];
}

export enum AccountTier {
	Basic = "basic",
	/** Partial access to Pro features and higher limits than Basic */
	ProTrial = "protrial",
	/** A Basic user that is pending a payment to go back to Pro */
	PendingPaymentPro = "pendingpaymentpro",
	/** Pro user with an expiring subscription */
	CancelledPro = "cancelledpro",
	Pro = "pro",
	Growth = "growth",
	/** Growth tier but even higher limits */
	Employee = "employee",
	/** No limits, full API access, admin endpoint access */
	Admin = "admin",
}

export interface CreateAccountRequest {
	auth0_id: string;
	account_tier: AccountTier;
}

/** Holds the data for building a database connection string. */
export interface DatabaseInfo {
	engine: string;
	role_name: string;
	role_password: string;
	database_name: string;
	port: string;
	hostname: string;
	/**
	 * The RDS instance name, which is required for deleting provisioned RDS instances, it's
	 * optional because it isn't needed for shared PG deletion.
	 */
	instance_name?: string;
}

export interface DatadogConfig {
	api_key: string;
}

export interface DeleteCertificateRequest {
	subject: string;
}

export enum DeploymentState {
	Pending = "pending",
	Building = "building",
	Running = "running",
	InProgress = "inprogress",
	Stopped = "stopped",
	Stopping = "stopping",
	Failed = "failed",
}

export interface DeploymentResponse {
	id: string;
	state: DeploymentState;
	created_at: string;
	updated_at: string;
	/** URIs where this deployment can currently be reached (only relevant for Running state) */
	uris: string[];
	build_id?: string;
	build_meta?: BuildMeta;
}

export interface DeploymentListResponse {
	deployments: DeploymentResponse[];
}

export type BuildArgs = 
	| { type: "Rust", content: BuildArgsRust };

export enum ComputeTier {
	XS = "xs",
	S = "s",
	M = "m",
	L = "l",
	XL = "xl",
	XXL = "xxl",
}

export interface InfraRequest {
	instance_size?: ComputeTier;
	replicas?: number;
}

export interface DeploymentRequestBuildArchive {
	/** The S3 object version ID of the archive to use */
	archive_version_id: string;
	build_args?: BuildArgs;
	/**
	 * Secrets to add before this deployment.
	 * TODO: Remove this in favour of a separate secrets uploading action.
	 */
	secrets?: Record<string, string>;
	build_meta?: BuildMeta;
	infra?: InfraRequest;
}

export interface DeploymentRequestImage {
	image: string;
	/** TODO: Remove this in favour of a separate secrets uploading action. */
	secrets?: Record<string, string>;
}

export interface GenericOtelConfig {
	/** Endpoint for the exporter to target */
	endpoint: string;
	/** Set either the full authorization header or just the bearer token */
	authorization?: string;
	/** Set either the full authorization header or just the bearer token */
	bearer_token?: string;
	/** Add http/grpc compression to exporter. Example: gzip */
	compression?: string;
	/** true: otlp, false: otlphttp */
	grpc: boolean;
	/** Enable logs pipeline (if included in tier) */
	logs: boolean;
	/** Enable traces pipeline (if included in tier) */
	traces: boolean;
	/** Enable metrics pipeline */
	metrics: boolean;
}

export interface GrafanaCloudConfig {
	token: string;
	endpoint: string;
	instance_id: string;
}

export interface LogItem {
	timestamp: string;
	/** Which container / log stream this line came from */
	source: string;
	line: string;
}

export interface LogfireConfig {
	endpoint: string;
	write_token: string;
}

export interface LogsResponse {
	logs: LogItem[];
}

export interface ProjectCreateRequest {
	name: string;
}

export interface ProjectResponse {
	id: string;
	/** Display name */
	name: string;
	/** Project owner */
	user_id: string;
	/** Team project belongs to */
	team_id?: string;
	created_at: string;
	compute_tier?: ComputeTier;
	/** State of the current deployment if one exists (something has been deployed). */
	deployment_state?: DeploymentState;
	/** URIs where running deployments can be reached */
	uris: string[];
}

export interface ProjectListResponse {
	projects: ProjectResponse[];
}

/** Set wanted field(s) to Some to update those parts of the project */
export interface ProjectUpdateRequest {
	/** Change display name */
	name?: string;
	/** Transfer to other user */
	user_id?: string;
	/** Transfer to a team */
	team_id?: string;
	/** Transfer away from current team */
	remove_from_team?: boolean;
	/** Project runtime configuration */
	config?: any;
}

/** Build Minutes subquery for the [`ProjectUsageResponse`] struct */
export interface ProjectUsageBuild {
	/** Number of build minutes used by this project. */
	used: number;
	/** Limit of build minutes for this project, before additional charges are liable. */
	limit: number;
}

export interface ProjectUsageDaily {
	avg_cpu_utilised: number;
	avg_mem_utilised: number;
	billable_vcpu_hours: number;
	build_minutes: number;
	isodate: string;
	max_cpu_reserved: number;
	max_mem_reserved: number;
	min_cpu_reserved: number;
	min_mem_reserved: number;
	reserved_vcpu_hours: number;
	runtime_minutes: number;
}

/** VCPU subquery for the [`ProjectUsageResponse`] struct */
export interface ProjectUsageVCPU {
	/** Used reserved VCPU hours for a project. */
	reserved_hours: number;
	/** Used VCPU hours beyond the included reserved VCPU hours for a project. */
	billable_hours: number;
}

/** Sub-Response for the /user/me/usage backend endpoint */
export interface ProjectUsageResponse {
	/** Show the build minutes clocked against this Project. */
	build_minutes: ProjectUsageBuild;
	/** Show the VCPU used by this project on the container platform. */
	vcpu: ProjectUsageVCPU;
	/** Daily usage breakdown for this project */
	daily: ProjectUsageDaily[];
}

export enum ResourceType {
	DatabaseSharedPostgres = "database::shared::postgres",
	DatabaseAwsRdsPostgres = "database::aws_rds::postgres",
	DatabaseAwsRdsMySql = "database::aws_rds::mysql",
	DatabaseAwsRdsMariaDB = "database::aws_rds::mariadb",
	/** (Will probably be removed) */
	Secrets = "secrets",
	/** Local provisioner only */
	Container = "container",
}

export interface ProvisionResourceRequest {
	/** The type of this resource */
	type: ResourceType;
	/**
	 * The config used when creating this resource.
	 * Use `Self::r#type` to know how to parse this data.
	 */
	config: any;
}

/** The resource state represents the stage of the provisioning process the resource is in. */
export enum ResourceState {
	Authorizing = "authorizing",
	Provisioning = "provisioning",
	Failed = "failed",
	Ready = "ready",
	Deleting = "deleting",
	Deleted = "deleted",
}

export interface ResourceResponse {
	type: ResourceType;
	state: ResourceState;
	/** The config used when creating this resource. Use the `r#type` to know how to parse this data. */
	config: any;
	/** The output type for this resource, if state is Ready. Use the `r#type` to know how to parse this data. */
	output: any;
}

export interface ResourceListResponse {
	resources: ResourceResponse[];
}

export interface SetEnvVarsRequest {
	vars: Record<string, string>;
}

export enum SubscriptionType {
	Pro = "pro",
	Rds = "rds",
}

export interface Subscription {
	id: string;
	type: SubscriptionType;
	quantity: number;
	created_at: string;
	updated_at: string;
}

export interface SubscriptionRequest {
	id: string;
	type: SubscriptionType;
	quantity: number;
}

export interface TeamInvite {
	id: string;
	email: string;
	/** Role of the user in the team */
	role: TeamRole;
	expires_at: string;
}

export interface TeamMembership {
	user_id: string;
	/** Role of the user in the team */
	role: TeamRole;
	/** Auth0 display name */
	nickname?: string;
	/** URL to profile picture */
	picture?: string;
	/** Auth0 primary email */
	email?: string;
}

export interface TeamResponse {
	id: string;
	/** Display name */
	name: string;
	/** Membership info of the calling user */
	membership: TeamMembership;
}

export interface TeamListResponse {
	teams: TeamResponse[];
}

export interface TeamMembersResponse {
	members: TeamMembership[];
	invites: TeamInvite[];
}

/** Status of a telemetry export configuration for an external sink */
export interface TelemetrySinkStatus {
	/** Indicates that the associated project is configured to export telemetry data to this sink */
	enabled: boolean;
}

/** A safe-for-display representation of the current telemetry export configuration for a given project */
export interface TelemetryConfigResponse {
	betterstack?: TelemetrySinkStatus;
	datadog?: TelemetrySinkStatus;
	grafana_cloud?: TelemetrySinkStatus;
	logfire?: TelemetrySinkStatus;
	generic?: TelemetrySinkStatus;
}

export interface UpdateAccountTierRequest {
	account_tier: AccountTier;
}

export interface UploadArchiveResponse {
	/** The S3 object version ID of the uploaded object */
	archive_version_id: string;
}

/** Sub-Response for the /user/me/usage backend endpoint */
export interface UserBillingCycle {
	/**
	 * Billing cycle start, or monthly from user creation
	 * depending on the account tier
	 */
	start: string;
	/**
	 * Billing cycle end, or end of month from user creation
	 * depending on the account tier
	 */
	end: string;
}

export interface UserUsageCustomDomains {
	used: number;
	limit: number;
}

export interface UserUsageProjects {
	used: number;
	limit: number;
}

export interface UserUsageTeamMembers {
	used: number;
	limit: number;
}

export interface UserOverviewResponse {
	custom_domains: UserUsageCustomDomains;
	projects: UserUsageProjects;
	team_members?: UserUsageTeamMembers;
}

export interface UserResponse {
	id: string;
	/** Auth0 id */
	auth0_id?: string;
	created_at: string;
	key?: string;
	account_tier: AccountTier;
	subscriptions?: Subscription[];
	flags?: string[];
}

/** Response for the /user/me/usage backend endpoint */
export interface UserUsageResponse {
	/** Billing cycle for user, will be None if no usage data exists for user. */
	billing_cycle?: UserBillingCycle;
	/** User overview information including project and domain counts */
	user?: UserOverviewResponse;
	/**
	 * HashMap of project related metrics for this cycle keyed by project_id. Will be empty
	 * if no project usage data exists for user.
	 */
	projects: Record<string, ProjectUsageResponse>;
}

export type DeploymentRequest = 
	/** Build an image from the source code in an attached zip archive */
	| { type: "BuildArchive", content: DeploymentRequestBuildArchive }
	/** Use this image directly. Can be used to skip the build step. */
	| { type: "Image", content: DeploymentRequestImage };

/** The user-supplied config required to export telemetry to a given external sink */
export type TelemetrySinkConfig = 
	/** [Betterstack](https://betterstack.com/docs/logs/open-telemetry/) */
	| { type: "betterstack", content: BetterstackConfig }
	/** [Datadog](https://docs.datadoghq.com/opentelemetry/collector_exporter/otel_collector_datadog_exporter) */
	| { type: "datadog", content: DatadogConfig }
	/** [Grafana Cloud](https://grafana.com/docs/grafana-cloud/send-data/otlp/) */
	| { type: "grafana_cloud", content: GrafanaCloudConfig }
	/** [Logfire](https://logfire.pydantic.dev/docs/how-to-guides/alternative-clients/) */
	| { type: "logfire", content: LogfireConfig }
	/** Generic config for Otel sinks that only need a host and Bearer token */
	| { type: "generic_otel", content: GenericOtelConfig };