@alienplatform/platform-api 1.11.2 → 1.13.0

package/src/funcs/machinesCreateJoinToken.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { AlienCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { AlienError } from "../models/errors/alienerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export function machinesCreateJoinToken(
+  client: AlienCore,
+  request: operations.CreateMachinesJoinTokenRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.CreateMachinesJoinTokenResponse,
+    | errors.APIError
+    | AlienError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: AlienCore,
+  request: operations.CreateMachinesJoinTokenRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.CreateMachinesJoinTokenResponse,
+      | errors.APIError
+      | AlienError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.CreateMachinesJoinTokenRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/machines/deployments/{id}/join-tokens")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "workspace": payload.workspace,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "createMachinesJoinToken",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.CreateMachinesJoinTokenResponse,
+    | errors.APIError
+    | AlienError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.CreateMachinesJoinTokenResponse$inboundSchema),
+    M.jsonErr([400, 404], errors.APIError$inboundSchema),
+    M.jsonErr(500, errors.APIError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/machinesDrainMachine.ts

@@ -3,7 +3,7 @@
  */
 
 import { AlienCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeJSON, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -101,6 +101,10 @@ async function $do(
     "/v1/machines/deployments/{id}/machines/{machineId}/drain",
   )(pathParams);
 
+  const query = encodeFormQuery({
+    "workspace": payload.workspace,
+  });
+
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
     Accept: "application/json",
@@ -131,6 +135,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,

package/src/funcs/machinesListInventory.ts

@@ -3,7 +3,7 @@
  */
 
 import { AlienCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -95,6 +95,10 @@ async function $do(
     pathParams,
   );
 
+  const query = encodeFormQuery({
+    "workspace": payload.workspace,
+  });
+
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
@@ -124,6 +128,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,

package/src/funcs/machinesListJoinTokens.ts

@@ -3,7 +3,7 @@
  */
 
 import { AlienCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -95,6 +95,10 @@ async function $do(
     pathParams,
   );
 
+  const query = encodeFormQuery({
+    "workspace": payload.workspace,
+  });
+
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
@@ -124,6 +128,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,

package/src/funcs/machinesRemoveMachine.ts

@@ -3,7 +3,7 @@
  */
 
 import { AlienCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -99,6 +99,10 @@ async function $do(
     pathParams,
   );
 
+  const query = encodeFormQuery({
+    "workspace": payload.workspace,
+  });
+
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
@@ -128,6 +132,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,

package/src/funcs/machinesRevokeJoinToken.ts

@@ -3,7 +3,7 @@
  */
 
 import { AlienCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -99,6 +99,10 @@ async function $do(
     "/v1/machines/deployments/{id}/join-tokens/{tokenId}",
   )(pathParams);
 
+  const query = encodeFormQuery({
+    "workspace": payload.workspace,
+  });
+
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
@@ -128,6 +132,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,

package/src/funcs/machinesRotateJoinToken.ts

@@ -3,7 +3,7 @@
  */
 
 import { AlienCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -95,6 +95,10 @@ async function $do(
     pathParams,
   );
 
+  const query = encodeFormQuery({
+    "workspace": payload.workspace,
+  });
+
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
@@ -124,6 +128,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,

package/src/funcs/projectsGetDeploymentLinkSetup.ts

@@ -0,0 +1,184 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { AlienCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { AlienError } from "../models/errors/alienerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get the active release stack and portal-visible setup availability for deployment-link configuration.
+ */
+export function projectsGetDeploymentLinkSetup(
+  client: AlienCore,
+  request: operations.GetProjectDeploymentLinkSetupRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.DeploymentLinkSetupResponse,
+    | errors.APIError
+    | AlienError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: AlienCore,
+  request: operations.GetProjectDeploymentLinkSetupRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.DeploymentLinkSetupResponse,
+      | errors.APIError
+      | AlienError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetProjectDeploymentLinkSetupRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    idOrName: encodeSimple("idOrName", payload.idOrName, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/projects/{idOrName}/deployment-link-setup")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "workspace": payload.workspace,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getProjectDeploymentLinkSetup",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.DeploymentLinkSetupResponse,
+    | errors.APIError
+    | AlienError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.DeploymentLinkSetupResponse$inboundSchema),
+    M.jsonErr(404, errors.APIError$inboundSchema),
+    M.jsonErr(500, errors.APIError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -61,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "1.0.196",
+  sdkVersion: "1.0.208",
   genVersion: "2.788.15",
   userAgent:
-    "speakeasy-sdk/typescript 1.0.196 2.788.15 1.0.0 @alienplatform/platform-api",
+    "speakeasy-sdk/typescript 1.0.208 2.788.15 1.0.0 @alienplatform/platform-api",
 } as const;

package/src/models/apierror.ts

@@ -57,6 +57,10 @@ export type APIError = {
    * 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.
    *
@@ -76,6 +80,10 @@ export type APIError = {
    * logged for debugging but replaced with generic error messages in responses.
    */
   internal: boolean;
+  /**
+   * Request ID echoed in the x-request-id response header and server logs.
+   */
+  requestId?: string | undefined;
 };
 
 /** @internal */
@@ -85,8 +93,10 @@ export const APIError$inboundSchema: z.ZodType<APIError, unknown> = z.object({
   source: z.nullable(z.any()).optional(),
   retryable: z.boolean().default(false),
   context: z.nullable(z.any()).optional(),
+  hint: z.nullable(z.string()).optional(),
   httpStatusCode: z.nullable(z.int()).optional(),
   internal: z.boolean(),
+  requestId: z.string().optional(),
 });
 
 export function apiErrorFromJSON(

package/src/models/createdeploymentresponse.ts

@@ -4,24 +4,49 @@
 
 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 { Deployment, Deployment$inboundSchema } from "./deployment.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
+/**
+ * Effective deployment model persisted for the deployment.
+ */
+export const CreateDeploymentResponseDeploymentModel = {
+  Push: "push",
+  Pull: "pull",
+} as const;
+/**
+ * Effective deployment model persisted for the deployment.
+ */
+export type CreateDeploymentResponseDeploymentModel = ClosedEnum<
+  typeof CreateDeploymentResponseDeploymentModel
+>;
+
 export type CreateDeploymentResponse = {
   deployment: Deployment;
+  /**
+   * Effective deployment model persisted for the deployment.
+   */
+  deploymentModel: CreateDeploymentResponseDeploymentModel;
   /**
    * Deployment token (only returned when using deployment group token)
    */
   token?: string | undefined;
 };
 
+/** @internal */
+export const CreateDeploymentResponseDeploymentModel$inboundSchema: z.ZodEnum<
+  typeof CreateDeploymentResponseDeploymentModel
+> = z.enum(CreateDeploymentResponseDeploymentModel);
+
 /** @internal */
 export const CreateDeploymentResponse$inboundSchema: z.ZodType<
   CreateDeploymentResponse,
   unknown
 > = z.object({
   deployment: Deployment$inboundSchema,
+  deploymentModel: CreateDeploymentResponseDeploymentModel$inboundSchema,
   token: z.string().optional(),
 });
 

package/src/models/createmachinesjointokenresponse.ts

@@ -0,0 +1,50 @@
+/*
+ * 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";
+import {
+  MachinesJoinTokenSummary,
+  MachinesJoinTokenSummary$inboundSchema,
+} from "./machinesjointokensummary.js";
+
+export type CreateMachinesJoinTokenResponse = {
+  joinToken: string;
+  controlPlaneUrl: string;
+  clusterId: string;
+  token: MachinesJoinTokenSummary;
+  /**
+   * Deploy CLI install script URL, or null when no ready CLI package exists.
+   */
+  cliInstallScriptUrl: string | null;
+  /**
+   * CLI command name to use in join instructions.
+   */
+  cliCommandName: string | null;
+};
+
+/** @internal */
+export const CreateMachinesJoinTokenResponse$inboundSchema: z.ZodType<
+  CreateMachinesJoinTokenResponse,
+  unknown
+> = z.object({
+  joinToken: z.string(),
+  controlPlaneUrl: z.string(),
+  clusterId: z.string(),
+  token: MachinesJoinTokenSummary$inboundSchema,
+  cliInstallScriptUrl: z.nullable(z.string()),
+  cliCommandName: z.nullable(z.string()),
+});
+
+export function createMachinesJoinTokenResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateMachinesJoinTokenResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateMachinesJoinTokenResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateMachinesJoinTokenResponse' from JSON`,
+  );
+}

package/src/models/createmanagerresponse.ts

@@ -42,6 +42,10 @@ export type CreateManagerResponseSetupConfig = {
   metadata: { [k: string]: any | null };
   policy: DeploymentSetupPolicy;
   inputValues?: { [k: string]: EncryptedStackInputValue } | undefined;
+  /**
+   * Operator-pinned deployment subdomain for this setup token.
+   */
+  publicSubdomain?: string | undefined;
   environmentVariables: Array<CreateManagerResponseEnvironmentVariable>;
 };
 
@@ -3610,6 +3614,7 @@ export const CreateManagerResponseSetupConfig$inboundSchema: z.ZodType<
   policy: DeploymentSetupPolicy$inboundSchema,
   inputValues: z.record(z.string(), EncryptedStackInputValue$inboundSchema)
     .optional(),
+  publicSubdomain: z.string().optional(),
   environmentVariables: z.array(
     z.lazy(() => CreateManagerResponseEnvironmentVariable$inboundSchema),
   ),