@fzgame/sdk 0.0.0-stage → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,981 @@
+import { Client } from 'openapi-fetch';
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+
+interface paths {
+  "/sdk/app/current": {
+    /** Resolve current SDK app */
+    get: {
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["App"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sdk/game-instances": {
+    /** List published game instances for SDK / iframe */
+    get: {
+      parameters: {
+        query?: {
+          page?: string;
+          cursor?: string;
+          limit?: string;
+          order?: string;
+          sortBy?: string;
+          cursorField?: string;
+          search?: string;
+          filter?: string;
+          include?: string;
+          searchField?: string;
+        };
+      };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["PagedGameInstance"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sdk/game-instances/{id}": {
+    /** Get published game instance (SDK) */
+    get: {
+      parameters: {
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["AppGameInstance"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/pub/game-instances/{id}": {
+    /** Public game instance detail */
+    get: {
+      parameters: {
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["AppGameInstance"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sdk/login": {
+    /** Identify or create a player (SDK) */
+    post: {
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["IdentifyPlayerDto"];
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sdk/players/{id}": {
+    /** Get player by id (SDK) */
+    get: {
+      parameters: {
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+    /** Update the profile of a player (SDK) */
+    put: {
+      parameters: {
+        path: {
+          id: string;
+        };
+      };
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["UpdatePlayerDto"];
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+    /** Delete a player (SDK) */
+    delete: {
+      parameters: {
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sdk/players/{id}/logout": {
+    /** End every live play session of a player (SDK) */
+    post: {
+      parameters: {
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sessions": {
+    /** Create a play session (SDK) */
+    post: {
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["CreatePlaySessionDto"];
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sessions/{token}": {
+    /** Get play session by token (SDK / iframe) */
+    get: {
+      parameters: {
+        path: {
+          token: string;
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+    /** Update play session (SDK) */
+    put: {
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["UpdatePlaySessionDto"];
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sessions/{token}/pause": {
+    /** Pause a playing session */
+    post: {
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sessions/{token}/resume": {
+    /** Resume a paused session */
+    post: {
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sessions/{token}/start": {
+    /** Start play session */
+    post: {
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sessions/{token}/finish": {
+    /** Finish play session */
+    post: {
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["UpdateScoreDto"];
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sessions/{token}/abort": {
+    /** Abort play session */
+    post: {
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sessions/{token}/score": {
+    /** Update session score */
+    post: {
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["UpdateScoreDto"];
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/games/runtime/sessions": {
+    /** Fetch or create a play session from gameInstanceId + player token */
+    post: {
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["CreateRuntimeSessionDto"];
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/games/runtime/sessions/{token}": {
+    /** Get a play session by token */
+    get: {
+      parameters: {
+        path: {
+          token: string;
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/games/runtime/sessions/{token}/emit": {
+    /** Emit a lifecycle event against a play session */
+    post: {
+      parameters: {
+        path: {
+          token: string;
+        };
+      };
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["RuntimeEmitDto"];
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/games/runtime/sessions/{token}/snapshot": {
+    /** Persist a local game snapshot on the play session */
+    put: {
+      parameters: {
+        path: {
+          token: string;
+        };
+      };
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["RuntimeSnapshotDto"];
+        };
+      };
+      responses: {
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+}
+
+interface components {
+  schemas: {
+    App: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      spaceId: string;
+      space?: components["schemas"]["Space"];
+      name: string;
+      /** @enum {string} */
+      status: "ACTIVE" | "DISABLED" | "ARCHIVED";
+      clientId: string;
+      description: string | null;
+      logoUrl: string | null;
+      settings: Record<string, unknown> | null;
+      ownerId: string;
+      owner?: components["schemas"]["Users"];
+      credentials?: components["schemas"]["AppCredential"][];
+      players?: components["schemas"]["AppPlayer"][];
+      playSessions?: components["schemas"]["AppPlaySession"][];
+      gameInstances?: components["schemas"]["AppGameInstance"][];
+      webhooks?: components["schemas"]["Webhook"][];
+    };
+    Space: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      name: string;
+      spaceKey: string;
+      image: string | null;
+      description: string | null;
+      ownerId: string | null;
+      owner?: components["schemas"]["Users"];
+      userSpaces?: components["schemas"]["UserSpace"][];
+      invites?: components["schemas"]["SpaceInvite"][];
+      app?: components["schemas"]["App"][];
+      appCredentials?: components["schemas"]["AppCredential"][];
+      appPlaySessions?: components["schemas"]["AppPlaySession"][];
+      appGameInstances?: components["schemas"]["AppGameInstance"][];
+      appPlayers?: components["schemas"]["AppPlayer"][];
+      privateGames?: components["schemas"]["Game"][];
+      webhooks?: components["schemas"]["Webhook"][];
+      webhookDeliveries?: components["schemas"]["WebhookDelivery"][];
+      gitConnectors?: components["schemas"]["GitConnector"][];
+      gitSources?: components["schemas"]["GitSource"][];
+      deployments?: components["schemas"]["Deployment"][];
+    };
+    Users: {
+      id: string;
+      name: string;
+      email: string;
+      emailVerified: boolean;
+      image: string | null;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      twoFactorEnabled: boolean | null;
+      sessions?: components["schemas"]["Session"][];
+      accounts?: components["schemas"]["Account"][];
+      twofactors?: components["schemas"]["TwoFactor"][];
+      /** Format: date-time */
+      birthDate: string | null;
+    };
+    Session: {
+      id: string;
+      /** Format: date-time */
+      expiresAt: string;
+      token: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      ipAddress: string | null;
+      userAgent: string | null;
+      userId: string;
+      users?: components["schemas"]["Users"];
+    };
+    Account: {
+      id: string;
+      accountId: string;
+      providerId: string;
+      userId: string;
+      users?: components["schemas"]["Users"];
+      accessToken: string | null;
+      refreshToken: string | null;
+      idToken: string | null;
+      /** Format: date-time */
+      accessTokenExpiresAt: string | null;
+      /** Format: date-time */
+      refreshTokenExpiresAt: string | null;
+      scope: string | null;
+      password: string | null;
+      issuer: string | null;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+    };
+    TwoFactor: {
+      id: string;
+      secret: string;
+      backupCodes: string;
+      userId: string;
+      users?: components["schemas"]["Users"];
+    };
+    UserSpace: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      spaceId: string;
+      space?: components["schemas"]["Space"];
+      userId: string;
+      user?: components["schemas"]["Users"];
+      /** @enum {string} */
+      role: "ADMIN" | "DEVELOPER" | "EDITOR";
+      /** @enum {string} */
+      auth: "OWNER" | "MEMBER";
+    };
+    SpaceInvite: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      email: string;
+      token: string;
+      /** @enum {string} */
+      role: "ADMIN" | "DEVELOPER" | "EDITOR";
+      /** Format: date-time */
+      expiresAt: string;
+      /** Format: date-time */
+      acceptedAt: string | null;
+      /** Format: date-time */
+      revokedAt: string | null;
+      spaceId: string;
+      space?: components["schemas"]["Space"];
+      inviterId: string | null;
+      inviter?: components["schemas"]["Users"];
+    };
+    AppCredential: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      spaceId: string;
+      space?: components["schemas"]["Space"];
+      appId: string;
+      app?: components["schemas"]["App"];
+      clientSecret: string;
+      /** Format: date-time */
+      expiresAt: string | null;
+      /** @enum {string} */
+      role: "ADMIN" | "DEVELOPER" | "EDITOR";
+      creatorId: string | null;
+      creator?: components["schemas"]["Users"];
+    };
+    AppPlaySession: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      spaceId: string;
+      space?: components["schemas"]["Space"];
+      appId: string;
+      app?: components["schemas"]["App"];
+      /** @enum {string} */
+      status: "CREATED" | "READY" | "PLAYING" | "PAUSED" | "FINISHED" | "ABORTED" | "EXPIRED";
+      token: string;
+      playerId: string;
+      player?: components["schemas"]["AppPlayer"];
+      gameInstanceId: string;
+      gameInstance?: components["schemas"]["AppGameInstance"];
+      /** Format: date-time */
+      startedAt: string | null;
+      /** Format: date-time */
+      finishedAt: string | null;
+      /** Format: date-time */
+      abortedAt: string | null;
+      /** Format: date-time */
+      expiresAt: string | null;
+      /** Format: float */
+      score: number | null;
+      result: Record<string, unknown> | null;
+      metadata: Record<string, unknown> | null;
+    };
+    AppPlayer: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      spaceId: string;
+      space?: components["schemas"]["Space"];
+      appId: string;
+      app?: components["schemas"]["App"];
+      identity: string;
+      /** @enum {string} */
+      type: "ANONYMOUS" | "IDENTIFIED";
+      externalId: string | null;
+      displayName: string | null;
+      avatarUrl: string | null;
+      metadata: Record<string, unknown> | null;
+      /** Format: date-time */
+      bannedAt: string | null;
+      playSessions?: components["schemas"]["AppPlaySession"][];
+    };
+    AppGameInstance: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      spaceId: string;
+      space?: components["schemas"]["Space"];
+      appId: string;
+      app?: components["schemas"]["App"];
+      name: string;
+      /** @enum {string} */
+      status: "DRAFT" | "PUBLISHED" | "ARCHIVED";
+      resolvedUrl: string | null;
+      /** Format: date-time */
+      resolvedAt: string | null;
+      unlockToken: string | null;
+      overrides: Record<string, unknown> | null;
+      gameId: string;
+      game?: components["schemas"]["Game"];
+      playSessions?: components["schemas"]["AppPlaySession"][];
+    };
+    Game: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      name: string;
+      slug: string;
+      /** Format: int32 */
+      version: number;
+      /** @enum {string} */
+      status: "DRAFT" | "ACTIVED" | "ARCHIVED";
+      description: string | null;
+      coverImageUrl: string | null;
+      screenshots: Record<string, unknown>;
+      entryPointUrl: string | null;
+      backendUrl: string | null;
+      /** @enum {string} */
+      origin: "OFFICAL" | "DEVELOPER" | "SPACE_PRIVATE";
+      configSchema: Record<string, unknown> | null;
+      creatorId: string | null;
+      creator?: components["schemas"]["Users"];
+      spaceId: string | null;
+      space?: components["schemas"]["Space"];
+      productionDeploymentId: string | null;
+      productionDeployment?: components["schemas"]["Deployment"];
+      deployments?: components["schemas"]["Deployment"][];
+      instances?: components["schemas"]["AppGameInstance"][];
+      gitSources?: components["schemas"]["GitSource"][];
+    };
+    Deployment: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      gitSourceId: string | null;
+      gitSource?: components["schemas"]["GitSource"];
+      gameId: string;
+      game?: components["schemas"]["Game"];
+      productionFor?: components["schemas"]["Game"];
+      spaceId: string | null;
+      space?: components["schemas"]["Space"];
+      /** @enum {string} */
+      status: "QUEUED" | "BUILDING" | "READY" | "ERROR" | "CANCELED";
+      commitSha: string;
+      commitMessage: string | null;
+      branch: string | null;
+      authorName: string | null;
+      authorEmail: string | null;
+      version: string;
+      versionLabel: string | null;
+      manifest: Record<string, unknown> | null;
+      entryPointUrl: string | null;
+      backendUrl: string | null;
+      assetBaseUrl: string | null;
+      configSchema: Record<string, unknown> | null;
+      buildMeta: Record<string, unknown> | null;
+      registryLinks: Record<string, unknown> | null;
+      errorMessage: string | null;
+      logsUrl: string | null;
+      triggeredById: string | null;
+      triggeredBy?: components["schemas"]["Users"];
+      /** @enum {string|null} */
+      triggerSource: "GIT_PUSH" | "MANUAL" | "API" | "ROLLBACK" | "MANIFEST_SYNC" | null;
+      ciRunnerId: string | null;
+      ciRunner?: components["schemas"]["CiRunner"];
+      /** Format: date-time */
+      startedAt: string | null;
+      /** Format: date-time */
+      finishedAt: string | null;
+    };
+    GitSource: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      /** @enum {string} */
+      provider: "GITHUB" | "GITLAB" | "BITBUCKET" | "GITEA" | "GENERIC";
+      repoUrl: string;
+      /** @enum {string} */
+      status: "UNKNOWN" | "AVAILABLE" | "NOT_FOUND" | "UNAUTHORIZED" | "UNREACHABLE";
+      owner: string | null;
+      repo: string | null;
+      defaultBranch: string;
+      rootDirectory: string;
+      manifestPath: string;
+      autoDeployEnabled: boolean;
+      productionBranch: string;
+      authType: string | null;
+      authSecretId: string | null;
+      webhookId: string | null;
+      lastCommitSha: string | null;
+      lastCommitMessage: string | null;
+      /** Format: date-time */
+      lastCommitAt: string | null;
+      /** Format: date-time */
+      installedAt: string;
+      /** Format: date-time */
+      lastSyncedAt: string | null;
+      /** Format: date-time */
+      lastManifestAt: string | null;
+      lastManifest: Record<string, unknown> | null;
+      connectorId: string | null;
+      connector?: components["schemas"]["GitConnector"];
+      gameId: string | null;
+      game?: components["schemas"]["Game"];
+      creatorId: string | null;
+      creator?: components["schemas"]["Users"];
+      deployments?: components["schemas"]["Deployment"][];
+      spaceId: string | null;
+      space?: components["schemas"]["Space"];
+    };
+    GitConnector: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      /** @enum {string} */
+      provider: "GITHUB" | "GITLAB" | "BITBUCKET" | "GITEA" | "GENERIC";
+      /** @enum {string} */
+      status: "UNKNOWN" | "AVAILABLE" | "NOT_FOUND" | "UNAUTHORIZED" | "UNREACHABLE";
+      accountLogin: string;
+      accountId: string;
+      accountAvatarUrl: string | null;
+      accountType: string | null;
+      installationId: string | null;
+      /** Format: date-time */
+      tokenExpiresAt: string | null;
+      scopes: string | null;
+      /** Format: date-time */
+      lastSyncedAt: string | null;
+      creatorId: string | null;
+      creator?: components["schemas"]["Users"];
+      gitSources?: components["schemas"]["GitSource"][];
+      spaceId: string | null;
+      space?: components["schemas"]["Space"];
+    };
+    CiRunner: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      name: string;
+      runnerKey: string;
+      /** @enum {string} */
+      status: "DISCONNECTED" | "CONNECTED" | "BUSY";
+      /** Format: date-time */
+      lastSeenAt: string | null;
+      lastError: string | null;
+      hostname: string | null;
+      version: string | null;
+      creatorId: string | null;
+      creator?: components["schemas"]["Users"];
+      deployments?: components["schemas"]["Deployment"][];
+    };
+    Webhook: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      spaceId: string;
+      space?: components["schemas"]["Space"];
+      appId: string | null;
+      app?: components["schemas"]["App"];
+      creatorId: string | null;
+      creator?: components["schemas"]["Users"];
+      url: string;
+      secret: string | null;
+      enabled: boolean;
+      /** @enum {string} */
+      events: "SESSION_CREATED" | "SESSION_STARTED" | "SESSION_FINISHED" | "SESSION_ABORTED" | "SCORE_UPDATED" | "CUSTOM";
+      headers: Record<string, unknown> | null;
+      /** Format: date-time */
+      lastDeliveryAt: string | null;
+      /** Format: int32 */
+      lastStatus: number | null;
+      deliveries?: components["schemas"]["WebhookDelivery"][];
+    };
+    WebhookDelivery: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      spaceId: string;
+      space?: components["schemas"]["Space"];
+      webhookId: string;
+      webhook?: components["schemas"]["Webhook"];
+      /** @enum {string} */
+      event: "SESSION_CREATED" | "SESSION_STARTED" | "SESSION_FINISHED" | "SESSION_ABORTED" | "SCORE_UPDATED" | "CUSTOM";
+      /** @enum {string} */
+      status: "PENDING" | "SUCCESS" | "FAILED";
+      payload: Record<string, unknown>;
+      /** Format: int32 */
+      attempts: number;
+      /** Format: int32 */
+      maxAttempts: number;
+      /** Format: date-time */
+      nextAttemptAt: string | null;
+      /** Format: date-time */
+      deliveredAt: string | null;
+      /** Format: int32 */
+      statusCode: number | null;
+      /** Format: int32 */
+      durationMs: number | null;
+      error: string | null;
+      responseBody: string | null;
+    };
+    PagedGameInstance: {
+      /** @description Page info */
+      pageInfo: components["schemas"]["PageInfo"];
+      /** @description Array of resource items for the current page */
+      data: components["schemas"]["AppGameInstance"][];
+    };
+    PageInfo: {
+      /**
+       * @description Cursor for the next page (cursor-based pagination)
+       * @example eyJpZCI6IjEyMyJ9
+       */
+      endCursor?: string;
+      /**
+       * @description Current page number (offset-based pagination)
+       * @example 1
+       */
+      page?: number;
+      /**
+       * @description Number of items per page
+       * @example 20
+       */
+      limit: number;
+      /**
+       * @description Total number of items across all pages
+       * @example 145
+       */
+      total?: number;
+      /**
+       * @description Total number of pages
+       * @example 8
+       */
+      totalPages?: number;
+      /**
+       * @description Whether there is a next page
+       * @example true
+       */
+      hasNextPage: boolean;
+      /**
+       * @description Whether there is a previous page
+       * @example false
+       */
+      hasPreviousPage: boolean;
+    };
+    IdentifyPlayerDto: {
+      identity?: string;
+      /** @enum {string} */
+      type?: "ANONYMOUS" | "IDENTIFIED";
+      externalId?: string;
+      displayName?: string;
+      avatarUrl?: string;
+      metadata?: Record<string, unknown>;
+    };
+    UpdatePlayerDto: {
+      externalId?: string;
+      displayName?: string;
+      avatarUrl?: string;
+      metadata?: Record<string, unknown>;
+    };
+    CreatePlaySessionDto: {
+      playerId: string;
+      gameInstanceId: string;
+      metadata?: Record<string, unknown>;
+      /**
+       * Format: date-time
+       * @description Session lifetime deadline (ISO 8601). Defaults to the server TTL.
+       */
+      expiresAt?: string;
+    };
+    UpdatePlaySessionDto: {
+      /**
+       * @description Only transitions allowed by the session lifecycle are accepted
+       * @enum {string}
+       */
+      status?: "CREATED" | "READY" | "PLAYING" | "PAUSED" | "FINISHED" | "ABORTED" | "EXPIRED";
+      score?: number;
+      result?: Record<string, unknown>;
+      metadata?: Record<string, unknown>;
+    };
+    UpdateScoreDto: {
+      score: number;
+      result?: Record<string, unknown>;
+    };
+    CreateRuntimeSessionDto: {
+      gameInstanceId: string;
+      playerToken: string;
+    };
+    RuntimeEmitDto: {
+      /** @description Session event. The lifecycle names (`LIFECYCLE_EVENTS` in `src/game/lifecycle.ts`: ready, start, pause, finish, abort, score, snapshot) move the session status; any other string is accepted as a custom event, leaves the status alone, and is stored as the session `lastEvent`. */
+      type: string;
+      payload?: Record<string, unknown>;
+    };
+    RuntimeSnapshotDto: {
+      state: Record<string, unknown>;
+    };
+  };
+  responses: {
+    /** @description Unauthorized access */
+    Unauthorized: {
+      content: {
+        "application/json": {
+          /** @example 401 */
+          statusCode?: number;
+          /** @example Unauthorized */
+          message?: string;
+        };
+      };
+    };
+    /** @description Forbidden */
+    Forbidden: {
+      content: {
+        "application/json": {
+          /** @example 403 */
+          statusCode?: number;
+          /** @example Forbidden */
+          message?: string;
+        };
+      };
+    };
+  };
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+}
+
+type operations = Record<string, never>;
+
+/** Header names the server reads app credentials from (`apps/server/src/auth/auth.guard.ts`). */
+declare const APP_KEY_HEADER = "x-app-key";
+declare const APP_SECRET_HEADER = "x-app-secret";
+type InitOptions = {
+    /** Base URL of the API, without a trailing slash. */
+    apiUrl: string;
+    /** Sent as `x-app-key`: the app's `id`, which the auth guard looks the app up by. */
+    appKey?: string;
+    /** Sent as `x-app-secret`: one of the app's credential `clientSecret` values. */
+    appSecret?: string;
+    /** Abort a request after this many milliseconds. `0` or unset means no timeout. */
+    timeoutMs?: number;
+    /** Override the fetch implementation, for a Node polyfill or a test. */
+    fetch?: typeof globalThis.fetch;
+};
+/** Thrown when a request is made before any credentials were configured. */
+declare class SdkNotInitializedError extends Error {
+    constructor();
+}
+declare class SdkConfigError extends Error {
+    constructor(message: string);
+}
+/**
+ * A client with its own base URL and credentials. Use this when a process serves
+ * more than one app: each client is independent, so one tenant's configuration
+ * cannot overwrite another's.
+ */
+declare function createSdkClient(options: InitOptions): Client<paths>;
+/**
+ * Process-wide client configured by `initializeSDK` or `<SDKInitializer>`.
+ *
+ * Before the first initialization every access throws `SdkNotInitializedError`,
+ * so a mis-ordered import fails where it happens instead of sending a request to
+ * a placeholder origin.
+ */
+declare const fetchClient: Client<paths>;
+/** Configure the process-wide client and return it. */
+declare function initializeSDK(options: InitOptions): Client<paths>;
+
+export { APP_KEY_HEADER, APP_SECRET_HEADER, type InitOptions, SdkConfigError, SdkNotInitializedError, type components, createSdkClient, fetchClient, initializeSDK, type operations, type paths };