@zitadel/api 0.1.0-alpha.9 → 1.0.0-alpha.21

package/src/generated/model/querySessionsDefault.ts

@@ -0,0 +1,79 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+export type QuerySessionsDefault =
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "auth.unauthorized";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "internal";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "not_implemented";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "proj.missing_id";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "req.invalid";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "sess.not_found";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "sess.permission_denied";
+    });

package/src/generated/model/querySessionsParams.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+export type QuerySessionsParams = {
+  /**
+   * The unique identifier of the project
+   * @pattern ^[a-zA-Z0-9_-]+$
+   */
+  project_id: string;
+};

package/src/generated/model/queryTeams200.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeams200TeamsItem } from "./queryTeams200TeamsItem";
+
+/**
+ * Paginated list of teams.
+ */
+export type QueryTeams200 = {
+  teams: QueryTeams200TeamsItem[];
+  /** Token to pass as `page_token` in the next request to fetch the following page.
+  Absent when there are no more results. The follow-up request must repeat the
+  same `sorting` that produced this token (omit only when both pages use the default).
+   */
+  next_page_token?: string | null;
+};

package/src/generated/model/queryTeams200TeamsItem.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeams200TeamsItemStatus } from "./queryTeams200TeamsItemStatus";
+
+/**
+ * Details of a team.
+ */
+export type QueryTeams200TeamsItem = {
+  /** The unique identifier of the team. */
+  id: string;
+  /** The name of the team. */
+  name: string;
+  /** The lifecycle state of a team.
+
+  active: The team is available for use.
+  deactivated: The team is no longer active but is retained for historical and audit purposes.
+   */
+  status: QueryTeams200TeamsItemStatus;
+  /** The time when the team was created. */
+  created_at: string;
+  /** The time when the team was last updated. */
+  updated_at: string;
+};

package/src/generated/model/queryTeams200TeamsItemStatus.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * The lifecycle state of a team.
+
+active: The team is available for use.
+deactivated: The team is no longer active but is retained for historical and audit purposes.
+
+ */
+export type QueryTeams200TeamsItemStatus =
+  (typeof QueryTeams200TeamsItemStatus)[keyof typeof QueryTeams200TeamsItemStatus];
+
+export const QueryTeams200TeamsItemStatus = {
+  active: "active",
+  deactivated: "deactivated",
+} as const;

package/src/generated/model/queryTeams400.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeams400Details } from "./queryTeams400Details";
+
+/**
+ * Standard error payload returned for failed API requests.
+ */
+export type QueryTeams400 = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: QueryTeams400Details;
+};

package/src/generated/model/queryTeams400Details.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Additional error-specific context.
+ */
+export type QueryTeams400Details = { [key: string]: unknown };

package/src/generated/model/queryTeams401.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeams401Details } from "./queryTeams401Details";
+
+/**
+ * Standard error payload returned for failed API requests.
+ */
+export type QueryTeams401 = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: QueryTeams401Details;
+};

package/src/generated/model/queryTeams401Details.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Additional error-specific context.
+ */
+export type QueryTeams401Details = { [key: string]: unknown };

package/src/generated/model/queryTeams403.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeams403Details } from "./queryTeams403Details";
+
+/**
+ * Standard error payload returned for failed API requests.
+ */
+export type QueryTeams403 = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: QueryTeams403Details;
+};

package/src/generated/model/queryTeams403Details.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Additional error-specific context.
+ */
+export type QueryTeams403Details = { [key: string]: unknown };

package/src/generated/model/queryTeams404.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeams404Details } from "./queryTeams404Details";
+
+/**
+ * Standard error payload returned for failed API requests.
+ */
+export type QueryTeams404 = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: QueryTeams404Details;
+};

package/src/generated/model/queryTeams404Details.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Additional error-specific context.
+ */
+export type QueryTeams404Details = { [key: string]: unknown };

package/src/generated/model/queryTeams429.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeams429Details } from "./queryTeams429Details";
+
+/**
+ * Standard error payload returned for failed API requests.
+ */
+export type QueryTeams429 = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: QueryTeams429Details;
+};

package/src/generated/model/queryTeams429Details.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Additional error-specific context.
+ */
+export type QueryTeams429Details = { [key: string]: unknown };

package/src/generated/model/queryTeamsBody.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeamsBodyFilterItem } from "./queryTeamsBodyFilterItem";
+import type { QueryTeamsBodySorting } from "./queryTeamsBodySorting";
+
+/**
+ * Request to query the teams of a project.
+ */
+export type QueryTeamsBody = {
+  /**
+   * @minimum 1
+   * @maximum 100
+   */
+  limit?: number;
+  /** Token to retrieve the next page of results. Must be sent with the same
+  `sorting` as the request that issued the token. Omitting `sorting` reuses
+  the default sort and only succeeds when that default matches the token.
+   */
+  page_token?: string | null;
+  sorting?: QueryTeamsBodySorting;
+  /** Filter criteria for querying teams. */
+  filter?: QueryTeamsBodyFilterItem[];
+};

package/src/generated/model/queryTeamsBodyFilterItem.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeamsBodyFilterItemField } from "./queryTeamsBodyFilterItemField";
+import type { QueryTeamsBodyFilterItemOperation } from "./queryTeamsBodyFilterItemOperation";
+
+export type QueryTeamsBodyFilterItem = {
+  /** Field to filter or sort teams by.
+
+  Team names are unique per project case-insensitively, so `name` is matched
+  case-insensitively by `equals` as well as by `contains`.
+   */
+  field: QueryTeamsBodyFilterItemField;
+  /** Filter-value specifies which values can be filtered by a query endpoint. This
+  is a union of types. When a value is specified which is not assignable to the
+  field which is being filtered, a 400 error will be returned.
+   */
+  value?: string | number | boolean | null;
+  /** Filter operation defines the operations which can be used when filtering on a
+  query endpoint.
+
+  On text fields, `contains` is a case-insensitive substring match. `equals`
+  compares the whole value and is case-sensitive unless the field documents
+  otherwise.
+   */
+  operation: QueryTeamsBodyFilterItemOperation;
+};

package/src/generated/model/queryTeamsBodyFilterItemField.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Field to filter or sort teams by.
+
+Team names are unique per project case-insensitively, so `name` is matched
+case-insensitively by `equals` as well as by `contains`.
+
+ */
+export type QueryTeamsBodyFilterItemField =
+  (typeof QueryTeamsBodyFilterItemField)[keyof typeof QueryTeamsBodyFilterItemField];
+
+export const QueryTeamsBodyFilterItemField = {
+  created_at: "created_at",
+  name: "name",
+  status: "status",
+} as const;

package/src/generated/model/queryTeamsBodyFilterItemOperation.ts

@@ -0,0 +1,30 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Filter operation defines the operations which can be used when filtering on a
+query endpoint.
+
+On text fields, `contains` is a case-insensitive substring match. `equals`
+compares the whole value and is case-sensitive unless the field documents
+otherwise.
+
+ */
+export type QueryTeamsBodyFilterItemOperation =
+  (typeof QueryTeamsBodyFilterItemOperation)[keyof typeof QueryTeamsBodyFilterItemOperation];
+
+export const QueryTeamsBodyFilterItemOperation = {
+  equals: "equals",
+  not_equals: "not_equals",
+  contains: "contains",
+  not_contains: "not_contains",
+  less_than: "less_than",
+  less_than_or_equal: "less_than_or_equal",
+  greater_than: "greater_than",
+  greater_than_or_equal: "greater_than_or_equal",
+} as const;

package/src/generated/model/queryTeamsBodySorting.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeamsBodySortingDirection } from "./queryTeamsBodySortingDirection";
+import type { QueryTeamsBodySortingField } from "./queryTeamsBodySortingField";
+
+export type QueryTeamsBodySorting = {
+  /** Field to filter or sort teams by.
+
+  Team names are unique per project case-insensitively, so `name` is matched
+  case-insensitively by `equals` as well as by `contains`.
+   */
+  field: QueryTeamsBodySortingField;
+  direction: QueryTeamsBodySortingDirection;
+};

package/src/generated/model/queryTeamsBodySortingDirection.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+export type QueryTeamsBodySortingDirection =
+  (typeof QueryTeamsBodySortingDirection)[keyof typeof QueryTeamsBodySortingDirection];
+
+export const QueryTeamsBodySortingDirection = {
+  asc: "asc",
+  desc: "desc",
+} as const;

package/src/generated/model/queryTeamsBodySortingField.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Field to filter or sort teams by.
+
+Team names are unique per project case-insensitively, so `name` is matched
+case-insensitively by `equals` as well as by `contains`.
+
+ */
+export type QueryTeamsBodySortingField =
+  (typeof QueryTeamsBodySortingField)[keyof typeof QueryTeamsBodySortingField];
+
+export const QueryTeamsBodySortingField = {
+  created_at: "created_at",
+  name: "name",
+  status: "status",
+} as const;

package/src/generated/model/queryTeamsDefault.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryTeamsDefaultDetails } from "./queryTeamsDefaultDetails";
+
+/**
+ * Standard error payload returned for failed API requests.
+ */
+export type QueryTeamsDefault = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: QueryTeamsDefaultDetails;
+};

package/src/generated/model/queryTeamsDefaultDetails.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Additional error-specific context.
+ */
+export type QueryTeamsDefaultDetails = { [key: string]: unknown };

package/src/generated/model/queryTeamsParams.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+export type QueryTeamsParams = {
+  /**
+   * The unique identifier of the project
+   * @pattern ^[a-zA-Z0-9_-]+$
+   */
+  project_id: string;
+};

package/src/generated/model/queryUsers200.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryUsers200UsersItem } from "./queryUsers200UsersItem";
+
+/**
+ * Paginated list of users.
+ */
+export type QueryUsers200 = {
+  users: QueryUsers200UsersItem[];
+  /** Token to pass as `page_token` in the next request to fetch the following page.
+  Absent when there are no more results.
+   */
+  next_page_token?: string | null;
+};

package/src/generated/model/queryUsers200UsersItem.ts

@@ -0,0 +1,71 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { QueryUsers200UsersItemAttributes } from "./queryUsers200UsersItemAttributes";
+import type { QueryUsers200UsersItemMetadata } from "./queryUsers200UsersItemMetadata";
+import type { QueryUsers200UsersItemTeamsItem } from "./queryUsers200UsersItemTeamsItem";
+
+/**
+ * A user represents an individual identity in the system. It can be used to
+represent a human user, but also a service account or any other type of
+identity.
+
+`attributes` is the document that satisfies the user schema named by
+`schema`: its property names and types are defined entirely by that schema,
+and it is what the schema validates. The rest of the object — `id`,
+`schema`, `metadata` — is the server-owned envelope. Keeping the two apart
+means a schema may name a property `id` or `metadata` without colliding with
+the envelope, and closed-world keywords (`additionalProperties: false`,
+`propertyNames`, `unevaluatedProperties`) behave as their author expects.
+
+ */
+export type QueryUsers200UsersItem = {
+  /** @pattern ^user_[a-zA-Z0-9_-]+$ */
+  id: string;
+  /** The schema that defines the content of `attributes`. These schemas can be
+  created using the `/schemas` endpoint. A default schema is provided.
+  This schema can be retrieved using the same endpoint.
+   */
+  schema: string;
+  /** The user's content, satisfying the schema named by `schema`. Property
+  names and types are determined entirely by that schema.
+   */
+  attributes: QueryUsers200UsersItemAttributes;
+  metadata: QueryUsers200UsersItemMetadata;
+  /** The current value of the user schema's designated identifier
+  (`x-identifier`), resolved live at read time. Absent when the schema
+  designates no identifier or the user carries no value for it.
+   */
+  readonly identifier?: string;
+  /** The schema property `identifier` came from, so clients can reach the
+  property's schema for semantics (a mailto link, a field label)
+  instead of guessing from the value. Present exactly when
+  `identifier` is.
+   */
+  readonly identifier_property?: string;
+  /** The `x-display` rendering — the designated properties' values joined
+  in list order, resolved live at read time. Purely presentational.
+  Absent when the schema designates no display properties or the user
+  carries no values for them. Clients render `display`, falling back
+  to `identifier`, then `id`.
+   */
+  readonly display?: string;
+  /** The user's team memberships, present only when the request asked for them with
+  `expand: ["teams"]` (ADR 059). Absent means it was not requested; `[]`
+  means the user has none.
+
+  Deliberately outside `metadata`: memberships are a related collection, not
+  part of the server-owned envelope, and it is a different concept from
+  `metadata.lifecycle_owner_team_id` (ADR 024).
+   */
+  readonly teams?: readonly QueryUsers200UsersItemTeamsItem[];
+  /** True when the user is on more teams than the embedded list carries. The
+  embedded list is capped and cannot be paged; read them all at
+  `GET /users/{user_id}/teams`. Present only alongside `teams`.
+   */
+  readonly teams_truncated?: boolean;
+};