data-contracts.ts

/* eslint-disable */
/* tslint:disable */
// @ts-nocheck
/*
 * ---------------------------------------------------------------
 * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
 * ##                                                           ##
 * ## AUTHOR: acacode                                           ##
 * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
 * ---------------------------------------------------------------
 */

/** SHARED when the shard is in the general pool; DEDICATED when it is pinned to specific organizations. */
export enum OrganizationAvailableShardClass {
  SHARED = "SHARED",
  DEDICATED = "DEDICATED",
}

export enum OrganizationInviteStatus {
  PENDING = "PENDING",
  ACCEPTED = "ACCEPTED",
  REJECTED = "REJECTED",
  EXPIRED = "EXPIRED",
}

export enum ManagementTokenDuration {
  Value30D = "30D",
  Value60D = "60D",
  Value90D = "90D",
}

export enum TenantStatusType {
  ACTIVE = "ACTIVE",
  ARCHIVED = "ARCHIVED",
}

export enum OrganizationMemberRoleType {
  OWNER = "OWNER",
}

export interface APIControlPlaneMetadata {
  /**
   * the inactivity timeout to log out for user sessions in milliseconds
   * @example 3600000
   */
  inactivityLogoutMs?: number;
  auth?: APIMetaAuth;
  /**
   * the Pylon app ID for usepylon.com chat support
   * @example "12345678-1234-1234-1234-123456789012"
   */
  pylonAppId?: string;
  posthog?: APIMetaPosthog;
  /**
   * whether or not users can sign up for this instance
   * @example true
   */
  allowSignup?: boolean;
  /**
   * whether or not users can invite other users to this instance
   * @example true
   */
  allowInvites?: boolean;
  /**
   * whether or not users can create new tenants
   * @example true
   */
  allowCreateTenant?: boolean;
  /**
   * whether or not users can change their password
   * @example true
   */
  allowChangePassword?: boolean;
  /**
   * whether or not observability (trace collection) is enabled on this instance
   * @example false
   */
  observabilityEnabled?: boolean;
}

import type { APIMetaAuth } from '@/lib/api/generated/data-contracts';

import type { APIMetaPosthog } from '@/lib/api/generated/data-contracts';

import type { APIErrors } from '@/lib/api/generated/data-contracts';

import type { APIError } from '@/lib/api/generated/data-contracts';

import type { PaginationResponse } from '@/lib/api/generated/data-contracts';

import type { APIResourceMeta } from '@/lib/api/generated/data-contracts';

export type ListAPIMetaIntegration = APIMetaIntegration[];

import type { APIMetaIntegration } from '@/lib/api/generated/data-contracts';

import type { User } from '@/lib/api/generated/data-contracts';

import type { UserLoginRequest } from '@/lib/api/generated/data-contracts';

import type { UserChangePasswordRequest } from '@/lib/api/generated/data-contracts';

import type { UserRegisterRequest } from '@/lib/api/generated/data-contracts';

export interface Organization {
  metadata: APIResourceMeta;
  /** Name of the organization */
  name: string;
  tenants?: OrganizationTenant[];
  members?: OrganizationMember[];
  /**
   * Time of inactivity to force log out a user (ms)
   * @format int64
   */
  inactivity_timeout?: number;
}

export interface OrganizationForUser {
  metadata: APIResourceMeta;
  /** Name of the organization */
  name: string;
  tenants: OrganizationTenant[];
  /** Whether the user is the owner of the organization */
  isOwner: boolean;
}

export interface OrganizationForUserList {
  rows: OrganizationForUser[];
  pagination: PaginationResponse;
}

export interface CreateOrganizationRequest {
  /**
   * Name of the organization
   * @minLength 1
   * @maxLength 256
   */
  name: string;
}

export interface UpdateOrganizationRequest {
  /**
   * Name of the organization
   * @minLength 1
   * @maxLength 256
   */
  name?: string;
  /** Inactivity timeout */
  inactivity_timeout?: string;
}

export interface OrganizationMember {
  metadata: APIResourceMeta;
  /** Type/role of the member in the organization */
  role: OrganizationMemberRoleType;
  /**
   * Email of the user
   * @format email
   */
  email: string;
}

export interface OrganizationMemberList {
  rows: OrganizationMember[];
  pagination: PaginationResponse;
}

export interface RemoveOrganizationMembersRequest {
  /**
   * Array of user emails to remove from the organization
   * @minItems 1
   */
  emails: string[];
}

export interface OrganizationTenant {
  /**
   * ID of the tenant
   * @format uuid
   */
  id: string;
  /** Name of the tenant */
  name?: string;
  /** Slug of the tenant */
  slug?: string;
  /** Status of the tenant */
  status: TenantStatusType;
  /**
   * The timestamp at which the tenant was archived
   * @format date-time
   */
  archivedAt?: string;
  /** Control-plane shard region for the tenant (e.g. aws:us-west-2). */
  region?: string;
}

export interface OrganizationTenantList {
  rows: OrganizationTenant[];
}

export interface CreateNewTenantForOrganizationRequest {
  /** The name of the tenant. */
  name: string;
  /** The slug of the tenant. */
  slug: string;
  /**
   * Optional shard region (e.g. aws:us-east-1). When omitted, the server picks one.
   * @example "aws:us-east-1"
   */
  region?: string;
}

export interface CreateManagementTokenRequest {
  /** The name of the management token. */
  name: string;
  /** @default "30D" */
  duration?: ManagementTokenDuration;
}

export interface CreateManagementTokenResponse {
  /** The token of the management token. */
  token: string;
}

export interface ManagementToken {
  /**
   * The ID of the management token.
   * @format uuid
   */
  id: string;
  /** The name of the management token. */
  name: string;
  /**
   * The timestamp at which the management token expires
   * @format date-time
   */
  expiresAt?: string;
}

export interface CreateOrganizationSsoDomainRequest {
  /** @format uri */
  ssoDomain: string;
}

export interface ManagementTokenList {
  rows: ManagementToken[];
}

export interface OrganizationInvite {
  metadata: APIResourceMeta;
  /**
   * The ID of the organization
   * @format uuid
   */
  organizationId: string;
  /**
   * The email of the inviter
   * @format email
   */
  inviterEmail: string;
  /**
   * The email of the invitee
   * @format email
   */
  inviteeEmail: string;
  /**
   * The timestamp at which the invite expires
   * @format date-time
   */
  expires: string;
  /** The status of the invite */
  status: OrganizationInviteStatus;
  /** The role of the invitee */
  role: OrganizationMemberRoleType;
}

export interface OrganizationInviteList {
  rows: OrganizationInvite[];
}

export interface CreateOrganizationInviteRequest {
  /**
   * The email of the invitee
   * @format email
   */
  inviteeEmail: string;
  /** The role of the invitee */
  role: OrganizationMemberRoleType;
}

export interface AcceptOrganizationInviteRequest {
  /**
   * The ID of the organization invite
   * @format uuid
   */
  id: string;
}

export interface RejectOrganizationInviteRequest {
  /**
   * The ID of the organization invite
   * @format uuid
   */
  id: string;
}

import type { TenantMemberRole } from '@/lib/api/generated/data-contracts';

import type { UserTenantPublic } from '@/lib/api/generated/data-contracts';

import type { TenantMember } from '@/lib/api/generated/data-contracts';

import type { TenantMemberList } from '@/lib/api/generated/data-contracts';

import type { UpdateTenantMemberRequest } from '@/lib/api/generated/data-contracts';

import type { TenantInvite } from '@/lib/api/generated/data-contracts';

import type { TenantInviteList } from '@/lib/api/generated/data-contracts';

import type { CreateTenantInviteRequest } from '@/lib/api/generated/data-contracts';

import type { UpdateTenantInviteRequest } from '@/lib/api/generated/data-contracts';

import type { AcceptInviteRequest as AcceptTenantInviteRequest } from '@/lib/api/generated/data-contracts';

import type { RejectInviteRequest as RejectTenantInviteRequest } from '@/lib/api/generated/data-contracts';

import type { UserTenantMembershipsList } from '@/lib/api/generated/data-contracts';

export interface TenantExchangeToken {
  /** The signed exchange token for the tenant */
  token: string;
  /** The API URL embedded in the token claims */
  apiUrl: string;
  /**
   * Timestamp at which the token expires
   * @format date-time
   */
  expiresAt: string;
}

export interface APIToken {
  metadata: APIResourceMeta;
  /** The name of the API token */
  name: string;
  /**
   * The timestamp at which the token expires
   * @format date-time
   */
  expiresAt: string;
}

export interface APITokenList {
  rows: APIToken[];
  pagination?: PaginationResponse;
}

export interface CreateTenantAPITokenRequest {
  /** The name of the API token */
  name: string;
  /** The duration for which the token should be valid (e.g., "30d", "90d") */
  expiresIn?: string;
}

export interface CreateTenantAPITokenResponse {
  /** The generated API token */
  token: string;
}

export interface OrganizationAvailableShard {
  /** Cloud provider for this deployment target (e.g. aws). */
  provider: string;
  /** Region within the provider (e.g. us-east-1). */
  region: string;
  /** SHARED when the shard is in the general pool; DEDICATED when it is pinned to specific organizations. */
  shardClass: OrganizationAvailableShardClass;
}

export interface OrganizationAvailableShardList {
  rows: OrganizationAvailableShard[];
}

export interface SsoDomain {
  /**
   * @format uri
   * @example "acme.com"
   */
  ssoDomain: string;
  /** @example false */
  verified: boolean;
  /** @format uuid */
  verificationToken: string;
}

export type SsoDomainArray = SsoDomain[];

export interface SsoConfig {
  /** @example false */
  forceSSO: boolean;
}

export interface OrganizationEntitlements {
  /** @example false */
  canSSO: boolean;
}