@alienplatform/platform-api 1.4.1 → 1.5.1

package/esm/models/packagedomain.d.ts

@@ -0,0 +1,143 @@
+import * as z from "zod/v4";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { DeploymentPortalManagedDnsRecord } from "./deploymentportalmanageddnsrecord.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+export declare const PackageDomainStatus: {
+    readonly WaitingForDomain: "waiting-for-domain";
+    readonly PendingEdge: "pending-edge";
+    readonly PendingHealth: "pending-health";
+    readonly Active: "active";
+    readonly Failed: "failed";
+    readonly Deleting: "deleting";
+};
+export type PackageDomainStatus = ClosedEnum<typeof PackageDomainStatus>;
+/**
+ * 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 PackageDomainError = {
+    /**
+     * 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 PackageDomain = {
+    /**
+     * Unique identifier for the package domain.
+     */
+    id: string;
+    /**
+     * Unique identifier for the workspace.
+     */
+    workspaceId: string;
+    /**
+     * Unique identifier for the domain.
+     */
+    domainId: string;
+    hostname: string;
+    status: PackageDomainStatus;
+    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?: PackageDomainError | null | undefined;
+    lockedAt?: Date | null | undefined;
+    lockedBy?: string | null | undefined;
+    retryAttempts: number;
+    nextStepAfter?: Date | null | undefined;
+    createdAt: Date;
+    updatedAt: Date;
+};
+/** @internal */
+export declare const PackageDomainStatus$inboundSchema: z.ZodEnum<typeof PackageDomainStatus>;
+/** @internal */
+export declare const PackageDomainError$inboundSchema: z.ZodType<PackageDomainError, unknown>;
+export declare function packageDomainErrorFromJSON(jsonString: string): SafeParseResult<PackageDomainError, SDKValidationError>;
+/** @internal */
+export declare const PackageDomain$inboundSchema: z.ZodType<PackageDomain, unknown>;
+export declare function packageDomainFromJSON(jsonString: string): SafeParseResult<PackageDomain, SDKValidationError>;
+//# sourceMappingURL=packagedomain.d.ts.map

package/esm/models/packagedomain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packagedomain.d.ts","sourceRoot":"","sources":["../../src/models/packagedomain.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EACL,gCAAgC,EAEjC,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,eAAO,MAAM,mBAAmB;;;;;;;CAOtB,CAAC;AACX,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEzE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC3C;;;;;;;;OAQG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;;OAQG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,iBAAiB,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAC3D;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9C,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,OAAO,mBAAmB,CACG,CAAC;AAEhC,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,OAAO,CAUP,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD;AAED,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAoBtE,CAAC;AAEL,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAMpD"}

package/esm/models/packagedomain.js

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+import { DeploymentPortalManagedDnsRecord$inboundSchema, } from "./deploymentportalmanageddnsrecord.js";
+export const PackageDomainStatus = {
+    WaitingForDomain: "waiting-for-domain",
+    PendingEdge: "pending-edge",
+    PendingHealth: "pending-health",
+    Active: "active",
+    Failed: "failed",
+    Deleting: "deleting",
+};
+/** @internal */
+export const PackageDomainStatus$inboundSchema = z.enum(PackageDomainStatus);
+/** @internal */
+export const PackageDomainError$inboundSchema = 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 packageDomainErrorFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => PackageDomainError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PackageDomainError' from JSON`);
+}
+/** @internal */
+export const PackageDomain$inboundSchema = z
+    .object({
+    id: z.string(),
+    workspaceId: z.string(),
+    domainId: z.string(),
+    hostname: z.string(),
+    status: PackageDomainStatus$inboundSchema,
+    managedDnsRecords: z.array(DeploymentPortalManagedDnsRecord$inboundSchema),
+    error: z.nullable(z.lazy(() => PackageDomainError$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 packageDomainFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => PackageDomain$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PackageDomain' from JSON`);
+}
+//# sourceMappingURL=packagedomain.js.map

package/esm/models/packagedomain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packagedomain.js","sourceRoot":"","sources":["../../src/models/packagedomain.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAG9C,OAAO,EAEL,8CAA8C,GAC/C,MAAM,uCAAuC,CAAC;AAG/C,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,gBAAgB,EAAE,oBAAoB;IACtC,WAAW,EAAE,cAAc;IAC3B,aAAa,EAAE,gBAAgB;IAC/B,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACZ,CAAC;AA6HX,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAE1C,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;AAEhC,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAGzC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC9C,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACrC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GAAsC,CAAC;KAC5E,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,MAAM,EAAE,iCAAiC;IACzC,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,8CAA8C,CAAC;IAC1E,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,gCAAgC,CAAC,CAAC;SAC9D,QAAQ,EAAE;IACb,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAClB,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAC7D,CAAC,QAAQ,EAAE;IACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,aAAa,EAAE,CAAC,CAAC,GAAG,EAAE;IACtB,aAAa,EAAE,CAAC,CAAC,QAAQ,CACvB,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAC7D,CAAC,QAAQ,EAAE;IACZ,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IACvE,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;CACxE,CAAC,CAAC;AAEL,MAAM,UAAU,qBAAqB,CACnC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2BAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvD,2CAA2C,CAC5C,CAAC;AACJ,CAAC"}

package/esm/models/persistimporteddeploymentrequest.d.ts

@@ -20,6 +20,21 @@ export declare const PersistImportedDeploymentRequestPlatformEnum: {
  * Represents the target cloud platform.
  */
 export type PersistImportedDeploymentRequestPlatformEnum = ClosedEnum<typeof PersistImportedDeploymentRequestPlatformEnum>;
+/**
+ * Base cloud platform for cloud-backed Kubernetes imports.
+ */
+export declare const PersistImportedDeploymentRequestBasePlatform: {
+    readonly Aws: "aws";
+    readonly Gcp: "gcp";
+    readonly Azure: "azure";
+    readonly Kubernetes: "kubernetes";
+    readonly Local: "local";
+    readonly Test: "test";
+};
+/**
+ * Base cloud platform for cloud-backed Kubernetes imports.
+ */
+export type PersistImportedDeploymentRequestBasePlatform = ClosedEnum<typeof PersistImportedDeploymentRequestBasePlatform>;
 /**
  * Deployment model: how updates are delivered to the remote environment.
  */
@@ -37,6 +52,7 @@ export type PersistImportedDeploymentRequestAws = {
 export type PersistImportedDeploymentRequestAwsUnion = PersistImportedDeploymentRequestAws | any;
 export type PersistImportedDeploymentRequestAzureStackSettings = {
     keyVaultCertificateId: string;
+    keyVaultResourceId?: string | null | undefined;
 };
 export type PersistImportedDeploymentRequestAzureUnion = PersistImportedDeploymentRequestAzureStackSettings | any;
 export type PersistImportedDeploymentRequestGcpStackSettings = {
@@ -660,6 +676,10 @@ export declare const PersistImportedDeploymentRequestTypeByoVnetAzure: {
 };
 export type PersistImportedDeploymentRequestTypeByoVnetAzure = ClosedEnum<typeof PersistImportedDeploymentRequestTypeByoVnetAzure>;
 export type PersistImportedDeploymentRequestNetworkByoVnetAzure = {
+    /**
+     * Name of the dedicated classic Application Gateway subnet within the VNet.
+     */
+    applicationGatewaySubnetName?: string | null | undefined;
     /**
      * Name of the private subnet within the VNet
      */
@@ -2186,6 +2206,10 @@ export type PersistImportedDeploymentRequest = {
      * Represents the target cloud platform.
      */
     platform: PersistImportedDeploymentRequestPlatformEnum;
+    /**
+     * Base cloud platform for cloud-backed Kubernetes imports.
+     */
+    basePlatform?: PersistImportedDeploymentRequestBasePlatform | undefined;
     /**
      * User-customizable deployment settings specified at deploy time.
      *
@@ -2257,6 +2281,8 @@ export declare const ModePersist$outboundSchema: z.ZodEnum<typeof ModePersist>;
 /** @internal */
 export declare const PersistImportedDeploymentRequestPlatformEnum$outboundSchema: z.ZodEnum<typeof PersistImportedDeploymentRequestPlatformEnum>;
 /** @internal */
+export declare const PersistImportedDeploymentRequestBasePlatform$outboundSchema: z.ZodEnum<typeof PersistImportedDeploymentRequestBasePlatform>;
+/** @internal */
 export declare const PersistImportedDeploymentRequestDeploymentModel$outboundSchema: z.ZodEnum<typeof PersistImportedDeploymentRequestDeploymentModel>;
 /** @internal */
 export type PersistImportedDeploymentRequestAws$Outbound = {
@@ -2273,6 +2299,7 @@ export declare function persistImportedDeploymentRequestAwsUnionToJSON(persistIm
 /** @internal */
 export type PersistImportedDeploymentRequestAzureStackSettings$Outbound = {
     keyVaultCertificateId: string;
+    keyVaultResourceId?: string | null | undefined;
 };
 /** @internal */
 export declare const PersistImportedDeploymentRequestAzureStackSettings$outboundSchema: z.ZodType<PersistImportedDeploymentRequestAzureStackSettings$Outbound, PersistImportedDeploymentRequestAzureStackSettings>;
@@ -2773,6 +2800,7 @@ export declare function persistImportedDeploymentRequestKubernetesUnionToJSON(pe
 export declare const PersistImportedDeploymentRequestTypeByoVnetAzure$outboundSchema: z.ZodEnum<typeof PersistImportedDeploymentRequestTypeByoVnetAzure>;
 /** @internal */
 export type PersistImportedDeploymentRequestNetworkByoVnetAzure$Outbound = {
+    application_gateway_subnet_name?: string | null | undefined;
     private_subnet_name: string;
     public_subnet_name: string;
     type: string;
@@ -3647,6 +3675,7 @@ export type PersistImportedDeploymentRequest$Outbound = {
     deploymentGroupId: string;
     managerId: string;
     platform: string;
+    basePlatform?: string | undefined;
     stackSettings: PersistImportedDeploymentRequestStackSettings$Outbound;
     stackState?: any | null | undefined;
     environmentInfo?: PersistImportedDeploymentRequestEnvironmentInfoGcp$Outbound | PersistImportedDeploymentRequestEnvironmentInfoAzure$Outbound | PersistImportedDeploymentRequestEnvironmentInfoLocal$Outbound | PersistImportedDeploymentRequestEnvironmentInfoAws$Outbound | PersistImportedDeploymentRequestEnvironmentInfoTest$Outbound | any | null | undefined;