@alienplatform/platform-api 3.3.19 → 3.3.21

package/src/models/operations/approveaccessrequest.ts

@@ -0,0 +1,237 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
+
+export type ApproveAccessRequestGlobals = {
+  /**
+   * Workspace name. Platform API keys already select a workspace; other authentication methods can configure it once on the SDK client.
+   */
+  workspace?: string | undefined;
+};
+
+export type ApproveAccessRequestRequestBody = {
+  method: string;
+  actorId: string;
+  source?: { [k: string]: any | null } | undefined;
+  approvedForMinutes?: number | undefined;
+};
+
+export type ApproveAccessRequestRequest = {
+  id: string;
+  requestBody?: ApproveAccessRequestRequestBody | undefined;
+};
+
+export type ApproveAccessRequestDeployment = {
+  id: string;
+  name: string;
+  deploymentGroup?: models.DeploymentGroupInfo | undefined;
+};
+
+/**
+ * How risky an operation is (declared by the plugin metadata).
+ */
+export const ApproveAccessRequestTier = {
+  ReadOnly: "read-only",
+  Mutating: "mutating",
+  Destructive: "destructive",
+} as const;
+/**
+ * How risky an operation is (declared by the plugin metadata).
+ */
+export type ApproveAccessRequestTier = ClosedEnum<
+  typeof ApproveAccessRequestTier
+>;
+
+export type ApproveAccessRequestCommand = {
+  command: string;
+  summary: string;
+  params?: any | null | undefined;
+  /**
+   * How risky an operation is (declared by the plugin metadata).
+   */
+  tier?: ApproveAccessRequestTier | undefined;
+};
+
+/**
+ * How risky an operation is (declared by the plugin metadata).
+ */
+export const ApproveAccessRequestMaxRisk = {
+  ReadOnly: "read-only",
+  Mutating: "mutating",
+  Destructive: "destructive",
+} as const;
+/**
+ * How risky an operation is (declared by the plugin metadata).
+ */
+export type ApproveAccessRequestMaxRisk = ClosedEnum<
+  typeof ApproveAccessRequestMaxRisk
+>;
+
+/**
+ * The approved access request.
+ */
+export type ApproveAccessRequestResponse = {
+  id: string;
+  deploymentId: string;
+  deployment?: ApproveAccessRequestDeployment | undefined;
+  remediationPlanId: string | null;
+  title: string;
+  reason: string | null;
+  commands: Array<ApproveAccessRequestCommand>;
+  operationPattern: string | null;
+  /**
+   * How risky an operation is (declared by the plugin metadata).
+   */
+  maxRisk: ApproveAccessRequestMaxRisk | null;
+  status: models.AccessRequestStatus;
+  approvedUntil: string | null;
+  approvalMethod: string;
+};
+
+/** @internal */
+export type ApproveAccessRequestRequestBody$Outbound = {
+  method: string;
+  actorId: string;
+  source?: { [k: string]: any | null } | undefined;
+  approvedForMinutes?: number | undefined;
+};
+
+/** @internal */
+export const ApproveAccessRequestRequestBody$outboundSchema: z.ZodType<
+  ApproveAccessRequestRequestBody$Outbound,
+  ApproveAccessRequestRequestBody
+> = z.object({
+  method: z.string(),
+  actorId: z.string(),
+  source: z.record(z.string(), z.nullable(z.any())).optional(),
+  approvedForMinutes: z.int().optional(),
+});
+
+export function approveAccessRequestRequestBodyToJSON(
+  approveAccessRequestRequestBody: ApproveAccessRequestRequestBody,
+): string {
+  return JSON.stringify(
+    ApproveAccessRequestRequestBody$outboundSchema.parse(
+      approveAccessRequestRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type ApproveAccessRequestRequest$Outbound = {
+  id: string;
+  RequestBody?: ApproveAccessRequestRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const ApproveAccessRequestRequest$outboundSchema: z.ZodType<
+  ApproveAccessRequestRequest$Outbound,
+  ApproveAccessRequestRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => ApproveAccessRequestRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function approveAccessRequestRequestToJSON(
+  approveAccessRequestRequest: ApproveAccessRequestRequest,
+): string {
+  return JSON.stringify(
+    ApproveAccessRequestRequest$outboundSchema.parse(
+      approveAccessRequestRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ApproveAccessRequestDeployment$inboundSchema: z.ZodType<
+  ApproveAccessRequestDeployment,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  deploymentGroup: models.DeploymentGroupInfo$inboundSchema.optional(),
+});
+
+export function approveAccessRequestDeploymentFromJSON(
+  jsonString: string,
+): SafeParseResult<ApproveAccessRequestDeployment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApproveAccessRequestDeployment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApproveAccessRequestDeployment' from JSON`,
+  );
+}
+
+/** @internal */
+export const ApproveAccessRequestTier$inboundSchema: z.ZodEnum<
+  typeof ApproveAccessRequestTier
+> = z.enum(ApproveAccessRequestTier);
+
+/** @internal */
+export const ApproveAccessRequestCommand$inboundSchema: z.ZodType<
+  ApproveAccessRequestCommand,
+  unknown
+> = z.object({
+  command: z.string(),
+  summary: z.string(),
+  params: z.nullable(z.any()).optional(),
+  tier: ApproveAccessRequestTier$inboundSchema.optional(),
+});
+
+export function approveAccessRequestCommandFromJSON(
+  jsonString: string,
+): SafeParseResult<ApproveAccessRequestCommand, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApproveAccessRequestCommand$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApproveAccessRequestCommand' from JSON`,
+  );
+}
+
+/** @internal */
+export const ApproveAccessRequestMaxRisk$inboundSchema: z.ZodEnum<
+  typeof ApproveAccessRequestMaxRisk
+> = z.enum(ApproveAccessRequestMaxRisk);
+
+/** @internal */
+export const ApproveAccessRequestResponse$inboundSchema: z.ZodType<
+  ApproveAccessRequestResponse,
+  unknown
+> = z.object({
+  id: z.string(),
+  deploymentId: z.string(),
+  deployment: z.lazy(() => ApproveAccessRequestDeployment$inboundSchema)
+    .optional(),
+  remediationPlanId: z.nullable(z.string()),
+  title: z.string(),
+  reason: z.nullable(z.string()),
+  commands: z.array(z.lazy(() => ApproveAccessRequestCommand$inboundSchema)),
+  operationPattern: z.nullable(z.string()),
+  maxRisk: z.nullable(ApproveAccessRequestMaxRisk$inboundSchema),
+  status: models.AccessRequestStatus$inboundSchema,
+  approvedUntil: z.nullable(z.string()),
+  approvalMethod: z.string(),
+});
+
+export function approveAccessRequestResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ApproveAccessRequestResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApproveAccessRequestResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApproveAccessRequestResponse' from JSON`,
+  );
+}

package/src/models/operations/denyaccessrequest.ts

@@ -0,0 +1,228 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
+
+export type DenyAccessRequestGlobals = {
+  /**
+   * Workspace name. Platform API keys already select a workspace; other authentication methods can configure it once on the SDK client.
+   */
+  workspace?: string | undefined;
+};
+
+export type DenyAccessRequestRequestBody = {
+  method: string;
+  actorId: string;
+  source?: { [k: string]: any | null } | undefined;
+};
+
+export type DenyAccessRequestRequest = {
+  id: string;
+  requestBody?: DenyAccessRequestRequestBody | undefined;
+};
+
+export type DenyAccessRequestDeployment = {
+  id: string;
+  name: string;
+  deploymentGroup?: models.DeploymentGroupInfo | undefined;
+};
+
+/**
+ * How risky an operation is (declared by the plugin metadata).
+ */
+export const DenyAccessRequestTier = {
+  ReadOnly: "read-only",
+  Mutating: "mutating",
+  Destructive: "destructive",
+} as const;
+/**
+ * How risky an operation is (declared by the plugin metadata).
+ */
+export type DenyAccessRequestTier = ClosedEnum<typeof DenyAccessRequestTier>;
+
+export type DenyAccessRequestCommand = {
+  command: string;
+  summary: string;
+  params?: any | null | undefined;
+  /**
+   * How risky an operation is (declared by the plugin metadata).
+   */
+  tier?: DenyAccessRequestTier | undefined;
+};
+
+/**
+ * How risky an operation is (declared by the plugin metadata).
+ */
+export const DenyAccessRequestMaxRisk = {
+  ReadOnly: "read-only",
+  Mutating: "mutating",
+  Destructive: "destructive",
+} as const;
+/**
+ * How risky an operation is (declared by the plugin metadata).
+ */
+export type DenyAccessRequestMaxRisk = ClosedEnum<
+  typeof DenyAccessRequestMaxRisk
+>;
+
+/**
+ * The rejected access request.
+ */
+export type DenyAccessRequestResponse = {
+  id: string;
+  deploymentId: string;
+  deployment?: DenyAccessRequestDeployment | undefined;
+  remediationPlanId: string | null;
+  title: string;
+  reason: string | null;
+  commands: Array<DenyAccessRequestCommand>;
+  operationPattern: string | null;
+  /**
+   * How risky an operation is (declared by the plugin metadata).
+   */
+  maxRisk: DenyAccessRequestMaxRisk | null;
+  status: models.AccessRequestStatus;
+  approvedUntil: string | null;
+};
+
+/** @internal */
+export type DenyAccessRequestRequestBody$Outbound = {
+  method: string;
+  actorId: string;
+  source?: { [k: string]: any | null } | undefined;
+};
+
+/** @internal */
+export const DenyAccessRequestRequestBody$outboundSchema: z.ZodType<
+  DenyAccessRequestRequestBody$Outbound,
+  DenyAccessRequestRequestBody
+> = z.object({
+  method: z.string(),
+  actorId: z.string(),
+  source: z.record(z.string(), z.nullable(z.any())).optional(),
+});
+
+export function denyAccessRequestRequestBodyToJSON(
+  denyAccessRequestRequestBody: DenyAccessRequestRequestBody,
+): string {
+  return JSON.stringify(
+    DenyAccessRequestRequestBody$outboundSchema.parse(
+      denyAccessRequestRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type DenyAccessRequestRequest$Outbound = {
+  id: string;
+  RequestBody?: DenyAccessRequestRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const DenyAccessRequestRequest$outboundSchema: z.ZodType<
+  DenyAccessRequestRequest$Outbound,
+  DenyAccessRequestRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => DenyAccessRequestRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function denyAccessRequestRequestToJSON(
+  denyAccessRequestRequest: DenyAccessRequestRequest,
+): string {
+  return JSON.stringify(
+    DenyAccessRequestRequest$outboundSchema.parse(denyAccessRequestRequest),
+  );
+}
+
+/** @internal */
+export const DenyAccessRequestDeployment$inboundSchema: z.ZodType<
+  DenyAccessRequestDeployment,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  deploymentGroup: models.DeploymentGroupInfo$inboundSchema.optional(),
+});
+
+export function denyAccessRequestDeploymentFromJSON(
+  jsonString: string,
+): SafeParseResult<DenyAccessRequestDeployment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DenyAccessRequestDeployment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DenyAccessRequestDeployment' from JSON`,
+  );
+}
+
+/** @internal */
+export const DenyAccessRequestTier$inboundSchema: z.ZodEnum<
+  typeof DenyAccessRequestTier
+> = z.enum(DenyAccessRequestTier);
+
+/** @internal */
+export const DenyAccessRequestCommand$inboundSchema: z.ZodType<
+  DenyAccessRequestCommand,
+  unknown
+> = z.object({
+  command: z.string(),
+  summary: z.string(),
+  params: z.nullable(z.any()).optional(),
+  tier: DenyAccessRequestTier$inboundSchema.optional(),
+});
+
+export function denyAccessRequestCommandFromJSON(
+  jsonString: string,
+): SafeParseResult<DenyAccessRequestCommand, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DenyAccessRequestCommand$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DenyAccessRequestCommand' from JSON`,
+  );
+}
+
+/** @internal */
+export const DenyAccessRequestMaxRisk$inboundSchema: z.ZodEnum<
+  typeof DenyAccessRequestMaxRisk
+> = z.enum(DenyAccessRequestMaxRisk);
+
+/** @internal */
+export const DenyAccessRequestResponse$inboundSchema: z.ZodType<
+  DenyAccessRequestResponse,
+  unknown
+> = z.object({
+  id: z.string(),
+  deploymentId: z.string(),
+  deployment: z.lazy(() => DenyAccessRequestDeployment$inboundSchema)
+    .optional(),
+  remediationPlanId: z.nullable(z.string()),
+  title: z.string(),
+  reason: z.nullable(z.string()),
+  commands: z.array(z.lazy(() => DenyAccessRequestCommand$inboundSchema)),
+  operationPattern: z.nullable(z.string()),
+  maxRisk: z.nullable(DenyAccessRequestMaxRisk$inboundSchema),
+  status: models.AccessRequestStatus$inboundSchema,
+  approvedUntil: z.nullable(z.string()),
+});
+
+export function denyAccessRequestResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DenyAccessRequestResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DenyAccessRequestResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DenyAccessRequestResponse' from JSON`,
+  );
+}

package/src/models/operations/getdeploymentinfo.ts

@@ -49,6 +49,8 @@ export type GetDeploymentInfoRequest = {
    */
   platform?: GetDeploymentInfoPlatform | undefined;
   setupItem?: GetDeploymentInfoSetupItem | undefined;
+  deploymentId?: string | undefined;
+  updateOperationId?: string | undefined;
 };
 
 /** @internal */
@@ -65,6 +67,8 @@ export const GetDeploymentInfoSetupItem$outboundSchema: z.ZodEnum<
 export type GetDeploymentInfoRequest$Outbound = {
   platform?: string | undefined;
   setupItem?: string | undefined;
+  deploymentId?: string | undefined;
+  updateOperationId?: string | undefined;
 };
 
 /** @internal */
@@ -74,6 +78,8 @@ export const GetDeploymentInfoRequest$outboundSchema: z.ZodType<
 > = z.object({
   platform: GetDeploymentInfoPlatform$outboundSchema.optional(),
   setupItem: GetDeploymentInfoSetupItem$outboundSchema.optional(),
+  deploymentId: z.string().optional(),
+  updateOperationId: z.string().optional(),
 });
 
 export function getDeploymentInfoRequestToJSON(