@alienplatform/platform-api 3.3.42 → 3.3.43

package/src/models/webhooksigningsecret.ts

@@ -0,0 +1,30 @@
+/*
+ * 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 WebhookSigningSecret = {
+  key: string;
+};
+
+/** @internal */
+export const WebhookSigningSecret$inboundSchema: z.ZodType<
+  WebhookSigningSecret,
+  unknown
+> = z.object({
+  key: z.string(),
+});
+
+export function webhookSigningSecretFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookSigningSecret, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookSigningSecret$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookSigningSecret' from JSON`,
+  );
+}

package/src/react-query/acceptTerraformKeySetup.ts

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { AlienCore } from "../core.js";
+import { acceptTerraformKeySetup } from "../funcs/acceptTerraformKeySetup.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 { unwrapAsync } from "../types/fp.js";
+import { useAlienContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type AcceptTerraformKeySetupMutationVariables = {
+  request?: models.TerraformKeySetupRequest | undefined;
+  options?: RequestOptions;
+};
+
+export type AcceptTerraformKeySetupMutationData =
+  operations.AcceptTerraformKeySetupResponse;
+
+export type AcceptTerraformKeySetupMutationError =
+  | errors.APIError
+  | AlienError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+export function useAcceptTerraformKeySetupMutation(
+  options?: MutationHookOptions<
+    AcceptTerraformKeySetupMutationData,
+    AcceptTerraformKeySetupMutationError,
+    AcceptTerraformKeySetupMutationVariables
+  >,
+): UseMutationResult<
+  AcceptTerraformKeySetupMutationData,
+  AcceptTerraformKeySetupMutationError,
+  AcceptTerraformKeySetupMutationVariables
+> {
+  const client = useAlienContext();
+  return useMutation({
+    ...buildAcceptTerraformKeySetupMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAcceptTerraformKeySetup(): MutationKey {
+  return ["@alienplatform/platform-api", "acceptTerraformKeySetup"];
+}
+
+export function buildAcceptTerraformKeySetupMutation(
+  client$: AlienCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AcceptTerraformKeySetupMutationVariables,
+  ) => Promise<AcceptTerraformKeySetupMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAcceptTerraformKeySetup(),
+    mutationFn: function acceptTerraformKeySetupMutationFn({
+      request,
+      options,
+    }): Promise<AcceptTerraformKeySetupMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(acceptTerraformKeySetup(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/deploymentsCreate.ts

@@ -46,7 +46,7 @@ export type DeploymentsCreateMutationError =
   | SDKValidationError;
 
 /**
- * Create a new deployment. Deployment group tokens automatically use their group. Workspace/project tokens must provide deploymentGroupId.
+ * Create a new deployment. Deployment group tokens automatically use their group. Workspace/project tokens must provide deploymentGroupId or deploymentGroupExternalId. Pending installation retries keep the originally reserved release and CloudFormation stack name, even after a new release is published. Other installation options must remain unchanged.
  */
 export function useDeploymentsCreateMutation(
   options?: MutationHookOptions<

package/src/react-query/deploymentsReportDeploymentSetupProgress.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { AlienCore } from "../core.js";
+import { deploymentsReportDeploymentSetupProgress } from "../funcs/deploymentsReportDeploymentSetupProgress.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 { unwrapAsync } from "../types/fp.js";
+import { useAlienContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type DeploymentsReportDeploymentSetupProgressMutationVariables = {
+  request?: models.DeploymentSetupProgressRequest | undefined;
+  options?: RequestOptions;
+};
+
+export type DeploymentsReportDeploymentSetupProgressMutationData = void;
+
+export type DeploymentsReportDeploymentSetupProgressMutationError =
+  | errors.APIError
+  | AlienError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Record that a reserved CloudFormation setup started its stack, or that AWS rolled the stack back before it registered. Called by the template's DeploymentSetupStarted resource with the reservation's deployment credential.
+ */
+export function useDeploymentsReportDeploymentSetupProgressMutation(
+  options?: MutationHookOptions<
+    DeploymentsReportDeploymentSetupProgressMutationData,
+    DeploymentsReportDeploymentSetupProgressMutationError,
+    DeploymentsReportDeploymentSetupProgressMutationVariables
+  >,
+): UseMutationResult<
+  DeploymentsReportDeploymentSetupProgressMutationData,
+  DeploymentsReportDeploymentSetupProgressMutationError,
+  DeploymentsReportDeploymentSetupProgressMutationVariables
+> {
+  const client = useAlienContext();
+  return useMutation({
+    ...buildDeploymentsReportDeploymentSetupProgressMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyDeploymentsReportDeploymentSetupProgress(): MutationKey {
+  return [
+    "@alienplatform/platform-api",
+    "deployments",
+    "reportDeploymentSetupProgress",
+  ];
+}
+
+export function buildDeploymentsReportDeploymentSetupProgressMutation(
+  client$: AlienCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: DeploymentsReportDeploymentSetupProgressMutationVariables,
+  ) => Promise<DeploymentsReportDeploymentSetupProgressMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyDeploymentsReportDeploymentSetupProgress(),
+    mutationFn: function deploymentsReportDeploymentSetupProgressMutationFn({
+      request,
+      options,
+    }): Promise<DeploymentsReportDeploymentSetupProgressMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(deploymentsReportDeploymentSetupProgress(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/getDeploymentPreparation.core.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { AlienCore } from "../core.js";
+import { getDeploymentPreparation } from "../funcs/getDeploymentPreparation.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type GetDeploymentPreparationQueryData =
+  models.DeploymentPreparationResponse;
+
+export function prefetchGetDeploymentPreparation(
+  queryClient: QueryClient,
+  client$: AlienCore,
+  request: operations.GetDeploymentPreparationRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildGetDeploymentPreparationQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildGetDeploymentPreparationQuery(
+  client$: AlienCore,
+  request: operations.GetDeploymentPreparationRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<GetDeploymentPreparationQueryData>;
+} {
+  return {
+    queryKey: queryKeyGetDeploymentPreparation(request.reference),
+    queryFn: async function getDeploymentPreparationQueryFn(
+      ctx,
+    ): Promise<GetDeploymentPreparationQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(getDeploymentPreparation(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyGetDeploymentPreparation(reference: string): QueryKey {
+  return ["@alienplatform/platform-api", "getDeploymentPreparation", reference];
+}

package/src/react-query/getDeploymentPreparation.ts

@@ -0,0 +1,130 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+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 operations from "../models/operations/index.js";
+import { useAlienContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildGetDeploymentPreparationQuery,
+  GetDeploymentPreparationQueryData,
+  prefetchGetDeploymentPreparation,
+  queryKeyGetDeploymentPreparation,
+} from "./getDeploymentPreparation.core.js";
+export {
+  buildGetDeploymentPreparationQuery,
+  type GetDeploymentPreparationQueryData,
+  prefetchGetDeploymentPreparation,
+  queryKeyGetDeploymentPreparation,
+};
+
+export type GetDeploymentPreparationQueryError =
+  | errors.APIError
+  | AlienError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+export function useGetDeploymentPreparation(
+  request: operations.GetDeploymentPreparationRequest,
+  options?: QueryHookOptions<
+    GetDeploymentPreparationQueryData,
+    GetDeploymentPreparationQueryError
+  >,
+): UseQueryResult<
+  GetDeploymentPreparationQueryData,
+  GetDeploymentPreparationQueryError
+> {
+  const client = useAlienContext();
+  return useQuery({
+    ...buildGetDeploymentPreparationQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function useGetDeploymentPreparationSuspense(
+  request: operations.GetDeploymentPreparationRequest,
+  options?: SuspenseQueryHookOptions<
+    GetDeploymentPreparationQueryData,
+    GetDeploymentPreparationQueryError
+  >,
+): UseSuspenseQueryResult<
+  GetDeploymentPreparationQueryData,
+  GetDeploymentPreparationQueryError
+> {
+  const client = useAlienContext();
+  return useSuspenseQuery({
+    ...buildGetDeploymentPreparationQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setGetDeploymentPreparationData(
+  client: QueryClient,
+  queryKeyBase: [reference: string],
+  data: GetDeploymentPreparationQueryData,
+): GetDeploymentPreparationQueryData | undefined {
+  const key = queryKeyGetDeploymentPreparation(...queryKeyBase);
+
+  return client.setQueryData<GetDeploymentPreparationQueryData>(key, data);
+}
+
+export function invalidateGetDeploymentPreparation(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[reference: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@alienplatform/platform-api",
+      "getDeploymentPreparation",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllGetDeploymentPreparation(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@alienplatform/platform-api", "getDeploymentPreparation"],
+  });
+}

package/src/react-query/getInstallationDeployment.core.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { AlienCore } from "../core.js";
+import { getInstallationDeployment } from "../funcs/getInstallationDeployment.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type GetInstallationDeploymentQueryData =
+  models.InstallationDeploymentResponse;
+
+export function prefetchGetInstallationDeployment(
+  queryClient: QueryClient,
+  client$: AlienCore,
+  request: operations.GetInstallationDeploymentRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildGetInstallationDeploymentQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildGetInstallationDeploymentQuery(
+  client$: AlienCore,
+  request: operations.GetInstallationDeploymentRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<GetInstallationDeploymentQueryData>;
+} {
+  return {
+    queryKey: queryKeyGetInstallationDeployment(request.reference),
+    queryFn: async function getInstallationDeploymentQueryFn(
+      ctx,
+    ): Promise<GetInstallationDeploymentQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(getInstallationDeployment(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyGetInstallationDeployment(reference: string): QueryKey {
+  return [
+    "@alienplatform/platform-api",
+    "getInstallationDeployment",
+    reference,
+  ];
+}

package/src/react-query/getInstallationDeployment.ts

@@ -0,0 +1,130 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+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 operations from "../models/operations/index.js";
+import { useAlienContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildGetInstallationDeploymentQuery,
+  GetInstallationDeploymentQueryData,
+  prefetchGetInstallationDeployment,
+  queryKeyGetInstallationDeployment,
+} from "./getInstallationDeployment.core.js";
+export {
+  buildGetInstallationDeploymentQuery,
+  type GetInstallationDeploymentQueryData,
+  prefetchGetInstallationDeployment,
+  queryKeyGetInstallationDeployment,
+};
+
+export type GetInstallationDeploymentQueryError =
+  | errors.APIError
+  | AlienError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+export function useGetInstallationDeployment(
+  request: operations.GetInstallationDeploymentRequest,
+  options?: QueryHookOptions<
+    GetInstallationDeploymentQueryData,
+    GetInstallationDeploymentQueryError
+  >,
+): UseQueryResult<
+  GetInstallationDeploymentQueryData,
+  GetInstallationDeploymentQueryError
+> {
+  const client = useAlienContext();
+  return useQuery({
+    ...buildGetInstallationDeploymentQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function useGetInstallationDeploymentSuspense(
+  request: operations.GetInstallationDeploymentRequest,
+  options?: SuspenseQueryHookOptions<
+    GetInstallationDeploymentQueryData,
+    GetInstallationDeploymentQueryError
+  >,
+): UseSuspenseQueryResult<
+  GetInstallationDeploymentQueryData,
+  GetInstallationDeploymentQueryError
+> {
+  const client = useAlienContext();
+  return useSuspenseQuery({
+    ...buildGetInstallationDeploymentQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setGetInstallationDeploymentData(
+  client: QueryClient,
+  queryKeyBase: [reference: string],
+  data: GetInstallationDeploymentQueryData,
+): GetInstallationDeploymentQueryData | undefined {
+  const key = queryKeyGetInstallationDeployment(...queryKeyBase);
+
+  return client.setQueryData<GetInstallationDeploymentQueryData>(key, data);
+}
+
+export function invalidateGetInstallationDeployment(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[reference: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@alienplatform/platform-api",
+      "getInstallationDeployment",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllGetInstallationDeployment(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@alienplatform/platform-api", "getInstallationDeployment"],
+  });
+}