@zitadel/api 0.1.0-alpha.11 → 0.1.0-alpha.13

package/src/generated/endpoints/zitadelNextGen.ts

@@ -8,6 +8,7 @@
 import { getProxyPath } from "../../runtime/base-url";
 import { customFetch } from "../../runtime/fetch";
 import type {
+  ActivateFlowDefinitionParams,
   AuthorizeDevice200,
   AuthorizeDeviceParams,
   AuthorizeGetDefault,
@@ -32,6 +33,7 @@ import type {
   CreateUser201,
   CreateUserBody,
   CreateUserParams,
+  DeactivateFlowDefinitionParams,
   DeleteFlowDefinitionParams,
   EndSessionParams,
   ExchangeHandoff200,
@@ -1099,7 +1101,7 @@ export const getCreateFlowDefinitionUrl = () => {
 Flow definitions are templates that define the sequence of steps (capabilities)
 for a particular user journey (e.g., registration, login, password reset).
 
-Flow definitions are created based on the flow meta schema, which includes the flow's purpose, audience, and the steps involved.
+Flow definitions are created based on the flow definition schema, which includes the flow's purpose, audience, and the steps involved.
 
  * @summary Create a new flow definition
  */
@@ -1195,7 +1197,9 @@ export const getUpdateFlowDefinitionUrl = (id: string, params: UpdateFlowDefinit
 };
 
 /**
- * Update a flow definition by id
+ * Update a flow definition by id. This endpoint replaces the existing flow definition.
+If `flow_definition.status` is omitted, the current status is preserved
+
  * @summary Update a flow definition by id
  */
 export const updateFlowDefinition = async (
@@ -1206,7 +1210,7 @@ export const updateFlowDefinition = async (
 ): Promise<UpdateFlowDefinition200> => {
   return customFetch<UpdateFlowDefinition200>(getUpdateFlowDefinitionUrl(id, params), {
     ...options,
-    method: "PATCH",
+    method: "PUT",
     headers: { "Content-Type": "application/json", ...options?.headers },
     body: JSON.stringify(updateFlowDefinitionBody),
   });
@@ -1229,7 +1233,10 @@ export const getDeleteFlowDefinitionUrl = (id: string, params: DeleteFlowDefinit
 };
 
 /**
- * Delete a flow definition by id
+ * Delete a flow definition by id.
+If the flow definition is currently being used by a flow, the deletion will fail.
+If the flow definition is the last active flow definition for a given purpose, the deletion will fail to prevent disruption of new flows being started for that purpose.
+
  * @summary Delete a flow definition by id
  */
 export const deleteFlowDefinition = async (
@@ -1243,6 +1250,76 @@ export const deleteFlowDefinition = async (
   });
 };
 
+export const getActivateFlowDefinitionUrl = (id: string, params: ActivateFlowDefinitionParams) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? "null" : value.toString());
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0
+    ? `${getProxyPath()}/flow_definitions/${id}/activate?${stringifiedParams}`
+    : `${getProxyPath()}/flow_definitions/${id}/activate`;
+};
+
+/**
+ * Activate a flow definition by transitioning it from a `draft` state to an `active` state.
+Alternatively, the status of a flow definition can also be set via the `POST /flow_definitions` and `PUT /flow_definitions/{id}` endpoints by setting the `status` attribute in the flow definition payload.
+
+ * @summary Activate a flow definition by ID.
+ */
+export const activateFlowDefinition = async (
+  id: string,
+  params: ActivateFlowDefinitionParams,
+  options?: RequestInit,
+): Promise<void> => {
+  return customFetch<void>(getActivateFlowDefinitionUrl(id, params), {
+    ...options,
+    method: "POST",
+  });
+};
+
+export const getDeactivateFlowDefinitionUrl = (
+  id: string,
+  params: DeactivateFlowDefinitionParams,
+) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? "null" : value.toString());
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0
+    ? `${getProxyPath()}/flow_definitions/${id}/deactivate?${stringifiedParams}`
+    : `${getProxyPath()}/flow_definitions/${id}/deactivate`;
+};
+
+/**
+ * Deactivates a flow definition in the `active` state by transitioning it to the `draft` state.
+Flow definitions in `draft` state cannot be used to start new flows. Existing flows that use the deactivated flow definition must gracefully handle this.
+Alternatively, the status of a flow definition can also be set via the `POST /flow_definitions` and `PUT /flow_definitions/{id}` endpoints by setting the `status` attribute in the flow definition payload.
+
+ * @summary Deactivate a flow definition by ID.
+ */
+export const deactivateFlowDefinition = async (
+  id: string,
+  params: DeactivateFlowDefinitionParams,
+  options?: RequestInit,
+): Promise<void> => {
+  return customFetch<void>(getDeactivateFlowDefinitionUrl(id, params), {
+    ...options,
+    method: "POST",
+  });
+};
+
 export const getCreateTeamUrl = (params: CreateTeamParams) => {
   const normalizedParams = new URLSearchParams();