@alienplatform/platform-api 1.3.5 → 1.4.0

package/src/models/deploymentinfosetupconfig.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  DeploymentSetupPolicy,
+  DeploymentSetupPolicy$inboundSchema,
+} from "./deploymentsetuppolicy.js";
+import {
+  EnvironmentVariableType,
+  EnvironmentVariableType$inboundSchema,
+} from "./environmentvariabletype.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type DeploymentInfoSetupConfigEnvironmentVariable = {
+  /**
+   * Variable name
+   */
+  name: string;
+  /**
+   * Variable type (plain or secret)
+   */
+  type: EnvironmentVariableType;
+  /**
+   * Target resource patterns (null = all resources, array = wildcard patterns)
+   */
+  targetResources: Array<string> | null;
+};
+
+export type DeploymentInfoSetupConfig = {
+  metadata: { [k: string]: any | null };
+  policy: DeploymentSetupPolicy;
+  environmentVariables: Array<DeploymentInfoSetupConfigEnvironmentVariable>;
+};
+
+/** @internal */
+export const DeploymentInfoSetupConfigEnvironmentVariable$inboundSchema:
+  z.ZodType<DeploymentInfoSetupConfigEnvironmentVariable, unknown> = z.object({
+    name: z.string(),
+    type: EnvironmentVariableType$inboundSchema,
+    targetResources: z.nullable(z.array(z.string())),
+  });
+
+export function deploymentInfoSetupConfigEnvironmentVariableFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  DeploymentInfoSetupConfigEnvironmentVariable,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DeploymentInfoSetupConfigEnvironmentVariable$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'DeploymentInfoSetupConfigEnvironmentVariable' from JSON`,
+  );
+}
+
+/** @internal */
+export const DeploymentInfoSetupConfig$inboundSchema: z.ZodType<
+  DeploymentInfoSetupConfig,
+  unknown
+> = z.object({
+  metadata: z.record(z.string(), z.nullable(z.any())),
+  policy: DeploymentSetupPolicy$inboundSchema,
+  environmentVariables: z.array(
+    z.lazy(() => DeploymentInfoSetupConfigEnvironmentVariable$inboundSchema),
+  ),
+});
+
+export function deploymentInfoSetupConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<DeploymentInfoSetupConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeploymentInfoSetupConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeploymentInfoSetupConfig' from JSON`,
+  );
+}

package/src/models/deploymentlistitemresponse.ts

@@ -38,6 +38,7 @@ export const DeploymentListItemResponseStatus = {
   Deleting: "deleting",
   DeleteFailed: "delete-failed",
   Deleted: "deleted",
+  Error: "error",
 } as const;
 /**
  * Deployment status in the deployment lifecycle
@@ -193,6 +194,21 @@ export type DeploymentListItemResponseEnvironmentInfoUnion =
   | DeploymentListItemResponseEnvironmentInfoTest
   | any;
 
+/**
+ * Setup source that imported this deployment
+ */
+export const DeploymentListItemResponseImportSource = {
+  Cloudformation: "cloudformation",
+  Terraform: "terraform",
+  Helm: "helm",
+} as const;
+/**
+ * Setup source that imported this deployment
+ */
+export type DeploymentListItemResponseImportSource = ClosedEnum<
+  typeof DeploymentListItemResponseImportSource
+>;
+
 /**
  * Latest error information if in a failed state
  */
@@ -217,6 +233,10 @@ export type DeploymentListItemResponseError = {
    * caused the issue, or other relevant context information.
    */
   context?: any | null | undefined;
+  /**
+   * Optional human-facing remediation hint.
+   */
+  hint?: string | null | undefined;
   /**
    * HTTP status code for this error.
    *
@@ -285,6 +305,10 @@ export type DeploymentListItemResponse = {
    * Target platform for the deployment
    */
   platform: DeploymentListItemResponsePlatform;
+  /**
+   * DeploymentState protocol version owned by the runtime/manager
+   */
+  deploymentProtocolVersion: number;
   /**
    * ID of deployment group this deployment belongs to
    */
@@ -313,6 +337,22 @@ export type DeploymentListItemResponse = {
    * ID of the pinned release
    */
   pinnedReleaseId?: string | null | undefined;
+  /**
+   * Setup source that imported this deployment
+   */
+  importSource?: DeploymentListItemResponseImportSource | null | undefined;
+  /**
+   * Imported setup target for compatibility checks
+   */
+  setupTarget?: string | null | undefined;
+  /**
+   * Imported setup compatibility fingerprint
+   */
+  setupFingerprint?: string | null | undefined;
+  /**
+   * Imported setup fingerprint version
+   */
+  setupFingerprintVersion?: number | null | undefined;
   /**
    * Timestamp of the last received heartbeat
    */
@@ -528,6 +568,11 @@ export function deploymentListItemResponseEnvironmentInfoUnionFromJSON(
   );
 }
 
+/** @internal */
+export const DeploymentListItemResponseImportSource$inboundSchema: z.ZodEnum<
+  typeof DeploymentListItemResponseImportSource
+> = z.enum(DeploymentListItemResponseImportSource);
+
 /** @internal */
 export const DeploymentListItemResponseError$inboundSchema: z.ZodType<
   DeploymentListItemResponseError,
@@ -535,6 +580,7 @@ export const DeploymentListItemResponseError$inboundSchema: z.ZodType<
 > = z.object({
   code: z.string(),
   context: z.nullable(z.any()).optional(),
+  hint: z.nullable(z.string()).optional(),
   httpStatusCode: z.nullable(z.int()).optional(),
   internal: z.boolean(),
   message: z.string(),
@@ -562,6 +608,7 @@ export const DeploymentListItemResponse$inboundSchema: z.ZodType<
   status: DeploymentListItemResponseStatus$inboundSchema,
   projectId: z.string(),
   platform: DeploymentListItemResponsePlatform$inboundSchema,
+  deploymentProtocolVersion: z.int(),
   deploymentGroupId: z.string(),
   environmentInfo: z.nullable(
     z.union([
@@ -582,6 +629,11 @@ export const DeploymentListItemResponse$inboundSchema: z.ZodType<
   currentReleaseId: z.nullable(z.string()).optional(),
   desiredReleaseId: z.nullable(z.string()).optional(),
   pinnedReleaseId: z.nullable(z.string()).optional(),
+  importSource: z.nullable(DeploymentListItemResponseImportSource$inboundSchema)
+    .optional(),
+  setupTarget: z.nullable(z.string()).optional(),
+  setupFingerprint: z.nullable(z.string()).optional(),
+  setupFingerprintVersion: z.nullable(z.int()).optional(),
   lastHeartbeatAt: z.nullable(
     z.iso.datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),

package/src/models/deploymentportalaccentcolor.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Accent color used for highlights and primary actions.
+ */
+export const DeploymentPortalAccentColor = {
+  Blue: "blue",
+  Purple: "purple",
+  Green: "green",
+  Orange: "orange",
+  Pink: "pink",
+  Slate: "slate",
+} as const;
+/**
+ * Accent color used for highlights and primary actions.
+ */
+export type DeploymentPortalAccentColor = ClosedEnum<
+  typeof DeploymentPortalAccentColor
+>;
+
+/** @internal */
+export const DeploymentPortalAccentColor$inboundSchema: z.ZodEnum<
+  typeof DeploymentPortalAccentColor
+> = z.enum(DeploymentPortalAccentColor);
+/** @internal */
+export const DeploymentPortalAccentColor$outboundSchema: z.ZodEnum<
+  typeof DeploymentPortalAccentColor
+> = DeploymentPortalAccentColor$inboundSchema;

package/src/models/deploymentportalappearance.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  DeploymentPortalAccentColor,
+  DeploymentPortalAccentColor$inboundSchema,
+} from "./deploymentportalaccentcolor.js";
+import {
+  DeploymentPortalAppearancePreset,
+  DeploymentPortalAppearancePreset$inboundSchema,
+} from "./deploymentportalappearancepreset.js";
+import {
+  DeploymentPortalDensity,
+  DeploymentPortalDensity$inboundSchema,
+} from "./deploymentportaldensity.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type DeploymentPortalAppearance = {
+  /**
+   * Optional project-specific avatar override for the deployment portal.
+   */
+  avatarUrl?: string | null | undefined;
+  /**
+   * Curated visual style for the deployment portal.
+   */
+  preset: DeploymentPortalAppearancePreset;
+  /**
+   * Accent color used for highlights and primary actions.
+   */
+  accentColor: DeploymentPortalAccentColor;
+  /**
+   * Optional portal title. Defaults to the project name.
+   */
+  title?: string | null | undefined;
+  /**
+   * Optional customer-facing subtitle.
+   */
+  subtitle?: string | null | undefined;
+  /**
+   * Optional support or contact URL.
+   */
+  supportUrl?: string | null | undefined;
+  /**
+   * Optional documentation URL.
+   */
+  docsUrl?: string | null | undefined;
+  /**
+   * Layout density for portal content.
+   */
+  density: DeploymentPortalDensity;
+};
+
+/** @internal */
+export const DeploymentPortalAppearance$inboundSchema: z.ZodType<
+  DeploymentPortalAppearance,
+  unknown
+> = z.object({
+  avatarUrl: z.nullable(z.string()).optional(),
+  preset: DeploymentPortalAppearancePreset$inboundSchema.default("clean"),
+  accentColor: DeploymentPortalAccentColor$inboundSchema.default("blue"),
+  title: z.nullable(z.string()).optional(),
+  subtitle: z.nullable(z.string()).optional(),
+  supportUrl: z.nullable(z.string()).optional(),
+  docsUrl: z.nullable(z.string()).optional(),
+  density: DeploymentPortalDensity$inboundSchema.default("comfortable"),
+});
+
+export function deploymentPortalAppearanceFromJSON(
+  jsonString: string,
+): SafeParseResult<DeploymentPortalAppearance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeploymentPortalAppearance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeploymentPortalAppearance' from JSON`,
+  );
+}

package/src/models/deploymentportalappearancepreset.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Curated visual style for the deployment portal.
+ */
+export const DeploymentPortalAppearancePreset = {
+  Clean: "clean",
+  Technical: "technical",
+  Enterprise: "enterprise",
+  Playful: "playful",
+  Minimal: "minimal",
+} as const;
+/**
+ * Curated visual style for the deployment portal.
+ */
+export type DeploymentPortalAppearancePreset = ClosedEnum<
+  typeof DeploymentPortalAppearancePreset
+>;
+
+/** @internal */
+export const DeploymentPortalAppearancePreset$inboundSchema: z.ZodEnum<
+  typeof DeploymentPortalAppearancePreset
+> = z.enum(DeploymentPortalAppearancePreset);
+/** @internal */
+export const DeploymentPortalAppearancePreset$outboundSchema: z.ZodEnum<
+  typeof DeploymentPortalAppearancePreset
+> = DeploymentPortalAppearancePreset$inboundSchema;

package/src/models/deploymentportaldensity.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Layout density for portal content.
+ */
+export const DeploymentPortalDensity = {
+  Comfortable: "comfortable",
+  Compact: "compact",
+} as const;
+/**
+ * Layout density for portal content.
+ */
+export type DeploymentPortalDensity = ClosedEnum<
+  typeof DeploymentPortalDensity
+>;
+
+/** @internal */
+export const DeploymentPortalDensity$inboundSchema: z.ZodEnum<
+  typeof DeploymentPortalDensity
+> = z.enum(DeploymentPortalDensity);
+/** @internal */
+export const DeploymentPortalDensity$outboundSchema: z.ZodEnum<
+  typeof DeploymentPortalDensity
+> = DeploymentPortalDensity$inboundSchema;

package/src/models/deploymentportaldomain.ts

@@ -0,0 +1,226 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  DeploymentPortalManagedDnsRecord,
+  DeploymentPortalManagedDnsRecord$inboundSchema,
+} from "./deploymentportalmanageddnsrecord.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export const DeploymentPortalDomainStatus = {
+  WaitingForDomain: "waiting-for-domain",
+  PendingVercel: "pending-vercel",
+  PendingDns: "pending-dns",
+  Active: "active",
+  Failed: "failed",
+  Deleting: "deleting",
+} as const;
+export type DeploymentPortalDomainStatus = ClosedEnum<
+  typeof DeploymentPortalDomainStatus
+>;
+
+/**
+ * Canonical error container that provides a structured way to represent errors
+ *
+ * @remarks
+ * with rich metadata including error codes, human-readable messages, context,
+ * and chaining capabilities for error propagation.
+ *
+ * This struct is designed to be both machine-readable and user-friendly,
+ * supporting serialization for API responses and detailed error reporting
+ * in distributed systems.
+ */
+export type DeploymentPortalDomainError = {
+  /**
+   * A unique identifier for the type of error.
+   *
+   * @remarks
+   *
+   * This should be a short, machine-readable string that can be used
+   * by clients to programmatically handle different error types.
+   * Examples: "NOT_FOUND", "VALIDATION_ERROR", "TIMEOUT"
+   */
+  code: string;
+  /**
+   * Additional diagnostic information about the error context.
+   *
+   * @remarks
+   *
+   * This optional field can contain structured data providing more details
+   * about the error, such as validation errors, request parameters that
+   * caused the issue, or other relevant context information.
+   */
+  context?: any | null | undefined;
+  /**
+   * Optional human-facing remediation hint.
+   */
+  hint?: string | null | undefined;
+  /**
+   * HTTP status code for this error.
+   *
+   * @remarks
+   *
+   * Used when converting the error to an HTTP response. If None, falls back to
+   * the error type's default status code or 500.
+   */
+  httpStatusCode?: number | null | undefined;
+  /**
+   * Indicates if this is an internal error that should not be exposed to users.
+   *
+   * @remarks
+   *
+   * When `true`, this error contains sensitive information or implementation
+   * details that should not be shown to end-users. Such errors should be
+   * logged for debugging but replaced with generic error messages in responses.
+   */
+  internal: boolean;
+  /**
+   * Human-readable error message.
+   *
+   * @remarks
+   *
+   * This message should be clear and actionable for developers or end-users,
+   * providing context about what went wrong and potentially how to fix it.
+   */
+  message: string;
+  /**
+   * Indicates whether the operation that caused the error should be retried.
+   *
+   * @remarks
+   *
+   * When `true`, the error is transient and the operation might succeed
+   * if attempted again. When `false`, retrying the same operation is
+   * unlikely to succeed without changes.
+   */
+  retryable: boolean;
+  /**
+   * The underlying error that caused this error, creating an error chain.
+   *
+   * @remarks
+   *
+   * This allows for proper error propagation and debugging by maintaining
+   * the full context of how an error occurred through multiple layers
+   * of an application.
+   */
+  source?: any | null | undefined;
+};
+
+export type DeploymentPortalDomain = {
+  /**
+   * Unique identifier for the deployment portal domain.
+   */
+  id: string;
+  /**
+   * Unique identifier for the workspace.
+   */
+  workspaceId: string;
+  /**
+   * Unique identifier for the project.
+   */
+  projectId: string;
+  /**
+   * Unique identifier for the domain.
+   */
+  domainId: string;
+  hostname: string;
+  status: DeploymentPortalDomainStatus;
+  vercelProjectDomain?: { [k: string]: any | null } | null | undefined;
+  vercelVerification?: { [k: string]: any | null } | null | undefined;
+  vercelDomainConfig?: { [k: string]: any | null } | null | undefined;
+  managedDnsRecords: Array<DeploymentPortalManagedDnsRecord>;
+  /**
+   * Canonical error container that provides a structured way to represent errors
+   *
+   * @remarks
+   * with rich metadata including error codes, human-readable messages, context,
+   * and chaining capabilities for error propagation.
+   *
+   * This struct is designed to be both machine-readable and user-friendly,
+   * supporting serialization for API responses and detailed error reporting
+   * in distributed systems.
+   */
+  error?: DeploymentPortalDomainError | null | undefined;
+  lockedAt?: Date | null | undefined;
+  lockedBy?: string | null | undefined;
+  retryAttempts: number;
+  nextStepAfter?: Date | null | undefined;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const DeploymentPortalDomainStatus$inboundSchema: z.ZodEnum<
+  typeof DeploymentPortalDomainStatus
+> = z.enum(DeploymentPortalDomainStatus);
+
+/** @internal */
+export const DeploymentPortalDomainError$inboundSchema: z.ZodType<
+  DeploymentPortalDomainError,
+  unknown
+> = z.object({
+  code: z.string(),
+  context: z.nullable(z.any()).optional(),
+  hint: z.nullable(z.string()).optional(),
+  httpStatusCode: z.nullable(z.int()).optional(),
+  internal: z.boolean(),
+  message: z.string(),
+  retryable: z.boolean().default(false),
+  source: z.nullable(z.any()).optional(),
+});
+
+export function deploymentPortalDomainErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<DeploymentPortalDomainError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeploymentPortalDomainError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeploymentPortalDomainError' from JSON`,
+  );
+}
+
+/** @internal */
+export const DeploymentPortalDomain$inboundSchema: z.ZodType<
+  DeploymentPortalDomain,
+  unknown
+> = z.object({
+  id: z.string(),
+  workspaceId: z.string(),
+  projectId: z.string(),
+  domainId: z.string(),
+  hostname: z.string(),
+  status: DeploymentPortalDomainStatus$inboundSchema,
+  vercelProjectDomain: z.nullable(z.record(z.string(), z.nullable(z.any())))
+    .optional(),
+  vercelVerification: z.nullable(z.record(z.string(), z.nullable(z.any())))
+    .optional(),
+  vercelDomainConfig: z.nullable(z.record(z.string(), z.nullable(z.any())))
+    .optional(),
+  managedDnsRecords: z.array(DeploymentPortalManagedDnsRecord$inboundSchema),
+  error: z.nullable(z.lazy(() => DeploymentPortalDomainError$inboundSchema))
+    .optional(),
+  lockedAt: z.nullable(
+    z.iso.datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  lockedBy: z.nullable(z.string()).optional(),
+  retryAttempts: z.int(),
+  nextStepAfter: z.nullable(
+    z.iso.datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  createdAt: z.iso.datetime({ offset: true }).transform(v => new Date(v)),
+  updatedAt: z.iso.datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function deploymentPortalDomainFromJSON(
+  jsonString: string,
+): SafeParseResult<DeploymentPortalDomain, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeploymentPortalDomain$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeploymentPortalDomain' from JSON`,
+  );
+}

package/src/models/deploymentportaldomainresponse.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  DeploymentPortalDomain,
+  DeploymentPortalDomain$inboundSchema,
+} from "./deploymentportaldomain.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type DeploymentPortalDomainResponse = {
+  deploymentPortalDomain: DeploymentPortalDomain | null;
+};
+
+/** @internal */
+export const DeploymentPortalDomainResponse$inboundSchema: z.ZodType<
+  DeploymentPortalDomainResponse,
+  unknown
+> = z.object({
+  deploymentPortalDomain: z.nullable(DeploymentPortalDomain$inboundSchema),
+});
+
+export function deploymentPortalDomainResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeploymentPortalDomainResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeploymentPortalDomainResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeploymentPortalDomainResponse' from JSON`,
+  );
+}

package/src/models/deploymentportalmanageddnsrecord.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type DeploymentPortalManagedDnsRecord = {
+  name: string;
+  type: string;
+  value: string;
+  ttl?: number | null | undefined;
+};
+
+/** @internal */
+export const DeploymentPortalManagedDnsRecord$inboundSchema: z.ZodType<
+  DeploymentPortalManagedDnsRecord,
+  unknown
+> = z.object({
+  name: z.string(),
+  type: z.string(),
+  value: z.string(),
+  ttl: z.nullable(z.int()).optional(),
+});
+
+export function deploymentPortalManagedDnsRecordFromJSON(
+  jsonString: string,
+): SafeParseResult<DeploymentPortalManagedDnsRecord, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeploymentPortalManagedDnsRecord$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeploymentPortalManagedDnsRecord' from JSON`,
+  );
+}