@alienplatform/platform-api 1.0.68

package/src/models/project.ts

@@ -0,0 +1,421 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4"
+import { safeParse } from "../lib/schemas.js"
+import type { ClosedEnum } from "../types/enums.js"
+import type { Result as SafeParseResult } from "../types/fp.js"
+import type { SDKValidationError } from "./errors/sdkvalidationerror.js"
+
+/**
+ * The Git Provider of the repository
+ */
+export const ProjectTypeGithub = {
+  Github: "github",
+} as const
+/**
+ * The Git Provider of the repository
+ */
+export type ProjectTypeGithub = ClosedEnum<typeof ProjectTypeGithub>
+
+/**
+ * The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed
+ */
+export type ProjectGitRepository = {
+  /**
+   * The Git Provider of the repository
+   */
+  type: ProjectTypeGithub
+  /**
+   * The name of the git repository
+   */
+  repo: string
+}
+
+/**
+ * Type of animated background to display on the deployment page.
+ */
+export const ProjectDeploymentPageBackgroundType = {
+  GradientMesh: "gradient-mesh",
+  FloatingOrbs: "floating-orbs",
+  FlickeringGrid: "flickering-grid",
+  BubbleGlow: "bubble-glow",
+  ParticleField: "particle-field",
+} as const
+/**
+ * Type of animated background to display on the deployment page.
+ */
+export type ProjectDeploymentPageBackgroundType = ClosedEnum<
+  typeof ProjectDeploymentPageBackgroundType
+>
+
+/**
+ * Color mode for the background animation.
+ */
+export const ProjectMode = {
+  Dark: "dark",
+  Light: "light",
+} as const
+/**
+ * Color mode for the background animation.
+ */
+export type ProjectMode = ClosedEnum<typeof ProjectMode>
+
+/**
+ * Color scheme for the background animation.
+ */
+export const ProjectColorScheme = {
+  Blue: "blue",
+  Purple: "purple",
+  Green: "green",
+  Orange: "orange",
+  Pink: "pink",
+} as const
+/**
+ * Color scheme for the background animation.
+ */
+export type ProjectColorScheme = ClosedEnum<typeof ProjectColorScheme>
+
+/**
+ * Customization settings for the deployment page background animation.
+ */
+export type ProjectDeploymentPageBackground = {
+  /**
+   * Type of animated background to display on the deployment page.
+   */
+  type: ProjectDeploymentPageBackgroundType
+  /**
+   * Color mode for the background animation.
+   */
+  mode: ProjectMode
+  /**
+   * Color scheme for the background animation.
+   */
+  colorScheme: ProjectColorScheme
+}
+
+/**
+ * CLI package configuration. If null, CLI packages will not be generated.
+ */
+export type ProjectCli = {
+  /**
+   * Human-friendly display name for help banners and about text
+   */
+  displayName: string
+  /**
+   * Binary name displayed in help and usage (e.g., "my-cli")
+   */
+  name: string
+  /**
+   * Whether CLI package generation is enabled
+   */
+  enabled: boolean
+}
+
+/**
+ * CloudFormation package configuration. If null, CloudFormation packages will not be generated.
+ */
+export type ProjectCloudformation = {
+  /**
+   * Whether CloudFormation package generation is enabled
+   */
+  enabled: boolean
+}
+
+/**
+ * Operator image package configuration. Required when Helm is enabled. If null, operator image packages will not be generated.
+ */
+export type ProjectOperatorImage = {
+  /**
+   * Human-friendly display name for logs and startup messages
+   */
+  displayName: string
+  /**
+   * Binary name (e.g., "acme-operator")
+   */
+  name: string
+  /**
+   * Whether operator image package generation is enabled
+   */
+  enabled: boolean
+}
+
+/**
+ * Helm chart package configuration. If null, Helm packages will not be generated.
+ */
+export type ProjectHelm = {
+  /**
+   * Chart name (e.g., "acme-operator")
+   */
+  chartName: string
+  /**
+   * Human-friendly description of the chart
+   */
+  description: string
+  /**
+   * Whether Helm chart package generation is enabled
+   */
+  enabled: boolean
+}
+
+/**
+ * Terraform provider package configuration. If null, Terraform packages will not be generated.
+ */
+export type ProjectTerraform = {
+  /**
+   * Terraform provider name (e.g., "acme")
+   */
+  providerName: string
+  /**
+   * Terraform resource type name (e.g., "agent")
+   */
+  resourceType: string
+  /**
+   * Whether Terraform provider package generation is enabled
+   */
+  enabled: boolean
+}
+
+/**
+ * Configuration for embedded packages (CLI, CloudFormation, Helm, Terraform)
+ */
+export type ProjectPackagesConfig = {
+  /**
+   * CLI package configuration. If null, CLI packages will not be generated.
+   */
+  cli?: ProjectCli | null | undefined
+  /**
+   * CloudFormation package configuration. If null, CloudFormation packages will not be generated.
+   */
+  cloudformation?: ProjectCloudformation | null | undefined
+  /**
+   * Operator image package configuration. Required when Helm is enabled. If null, operator image packages will not be generated.
+   */
+  operatorImage?: ProjectOperatorImage | null | undefined
+  /**
+   * Helm chart package configuration. If null, Helm packages will not be generated.
+   */
+  helm?: ProjectHelm | null | undefined
+  /**
+   * Terraform provider package configuration. If null, Terraform packages will not be generated.
+   */
+  terraform?: ProjectTerraform | null | undefined
+}
+
+export type Project = {
+  /**
+   * Unique identifier for the project.
+   */
+  id: string
+  /**
+   * Project name.
+   */
+  name: string
+  /**
+   * The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed
+   */
+  gitRepository?: ProjectGitRepository | null | undefined
+  /**
+   * The name of a directory or relative path to the source code of your project. When null is used it will default to the project root
+   */
+  rootDirectory?: string | null | undefined
+  /**
+   * Customization settings for the deployment page background animation.
+   */
+  deploymentPageBackground?: ProjectDeploymentPageBackground | null | undefined
+  /**
+   * Configuration for embedded packages (CLI, CloudFormation, Helm, Terraform)
+   */
+  packagesConfig?: ProjectPackagesConfig | null | undefined
+  /**
+   * Selected domain for this project (null = default system domain)
+   */
+  domainId?: string | null | undefined
+  createdAt: Date
+  /**
+   * Unique identifier for the workspace.
+   */
+  workspaceId: string
+}
+
+/** @internal */
+export const ProjectTypeGithub$inboundSchema: z.ZodEnum<typeof ProjectTypeGithub> =
+  z.enum(ProjectTypeGithub)
+
+/** @internal */
+export const ProjectGitRepository$inboundSchema: z.ZodType<ProjectGitRepository, unknown> =
+  z.object({
+    type: ProjectTypeGithub$inboundSchema,
+    repo: z.string(),
+  })
+
+export function projectGitRepositoryFromJSON(
+  jsonString: string,
+): SafeParseResult<ProjectGitRepository, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    x => ProjectGitRepository$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProjectGitRepository' from JSON`,
+  )
+}
+
+/** @internal */
+export const ProjectDeploymentPageBackgroundType$inboundSchema: z.ZodEnum<
+  typeof ProjectDeploymentPageBackgroundType
+> = z.enum(ProjectDeploymentPageBackgroundType)
+
+/** @internal */
+export const ProjectMode$inboundSchema: z.ZodEnum<typeof ProjectMode> = z.enum(ProjectMode)
+
+/** @internal */
+export const ProjectColorScheme$inboundSchema: z.ZodEnum<typeof ProjectColorScheme> =
+  z.enum(ProjectColorScheme)
+
+/** @internal */
+export const ProjectDeploymentPageBackground$inboundSchema: z.ZodType<
+  ProjectDeploymentPageBackground,
+  unknown
+> = z.object({
+  type: ProjectDeploymentPageBackgroundType$inboundSchema,
+  mode: ProjectMode$inboundSchema,
+  colorScheme: ProjectColorScheme$inboundSchema,
+})
+
+export function projectDeploymentPageBackgroundFromJSON(
+  jsonString: string,
+): SafeParseResult<ProjectDeploymentPageBackground, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    x => ProjectDeploymentPageBackground$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProjectDeploymentPageBackground' from JSON`,
+  )
+}
+
+/** @internal */
+export const ProjectCli$inboundSchema: z.ZodType<ProjectCli, unknown> = z.object({
+  displayName: z.string(),
+  name: z.string(),
+  enabled: z.boolean(),
+})
+
+export function projectCliFromJSON(
+  jsonString: string,
+): SafeParseResult<ProjectCli, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    x => ProjectCli$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProjectCli' from JSON`,
+  )
+}
+
+/** @internal */
+export const ProjectCloudformation$inboundSchema: z.ZodType<ProjectCloudformation, unknown> =
+  z.object({
+    enabled: z.boolean(),
+  })
+
+export function projectCloudformationFromJSON(
+  jsonString: string,
+): SafeParseResult<ProjectCloudformation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    x => ProjectCloudformation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProjectCloudformation' from JSON`,
+  )
+}
+
+/** @internal */
+export const ProjectOperatorImage$inboundSchema: z.ZodType<ProjectOperatorImage, unknown> =
+  z.object({
+    displayName: z.string(),
+    name: z.string(),
+    enabled: z.boolean(),
+  })
+
+export function projectOperatorImageFromJSON(
+  jsonString: string,
+): SafeParseResult<ProjectOperatorImage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    x => ProjectOperatorImage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProjectOperatorImage' from JSON`,
+  )
+}
+
+/** @internal */
+export const ProjectHelm$inboundSchema: z.ZodType<ProjectHelm, unknown> = z.object({
+  chartName: z.string(),
+  description: z.string(),
+  enabled: z.boolean(),
+})
+
+export function projectHelmFromJSON(
+  jsonString: string,
+): SafeParseResult<ProjectHelm, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    x => ProjectHelm$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProjectHelm' from JSON`,
+  )
+}
+
+/** @internal */
+export const ProjectTerraform$inboundSchema: z.ZodType<ProjectTerraform, unknown> = z.object({
+  providerName: z.string(),
+  resourceType: z.string(),
+  enabled: z.boolean(),
+})
+
+export function projectTerraformFromJSON(
+  jsonString: string,
+): SafeParseResult<ProjectTerraform, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    x => ProjectTerraform$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProjectTerraform' from JSON`,
+  )
+}
+
+/** @internal */
+export const ProjectPackagesConfig$inboundSchema: z.ZodType<ProjectPackagesConfig, unknown> =
+  z.object({
+    cli: z.nullable(z.lazy(() => ProjectCli$inboundSchema)).optional(),
+    cloudformation: z.nullable(z.lazy(() => ProjectCloudformation$inboundSchema)).optional(),
+    operatorImage: z.nullable(z.lazy(() => ProjectOperatorImage$inboundSchema)).optional(),
+    helm: z.nullable(z.lazy(() => ProjectHelm$inboundSchema)).optional(),
+    terraform: z.nullable(z.lazy(() => ProjectTerraform$inboundSchema)).optional(),
+  })
+
+export function projectPackagesConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<ProjectPackagesConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    x => ProjectPackagesConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProjectPackagesConfig' from JSON`,
+  )
+}
+
+/** @internal */
+export const Project$inboundSchema: z.ZodType<Project, unknown> = z.object({
+  id: z.string(),
+  name: z.string(),
+  gitRepository: z.nullable(z.lazy(() => ProjectGitRepository$inboundSchema)).optional(),
+  rootDirectory: z.nullable(z.string()).optional(),
+  deploymentPageBackground: z
+    .nullable(z.lazy(() => ProjectDeploymentPageBackground$inboundSchema))
+    .optional(),
+  packagesConfig: z.nullable(z.lazy(() => ProjectPackagesConfig$inboundSchema)).optional(),
+  domainId: z.nullable(z.string()).optional(),
+  createdAt: z.iso.datetime({ offset: true }).transform(v => new Date(v)),
+  workspaceId: z.string(),
+})
+
+export function projectFromJSON(jsonString: string): SafeParseResult<Project, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    x => Project$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Project' from JSON`,
+  )
+}