feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 115
+configured_endpoints: 116
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-d854bc81e0a99171716893e6790a87ba350bb6fc778f8e3244abdd47d5c252c3.yml
 openapi_spec_hash: 5189220e4712a7b0cdd35beba2ebb47d
-config_hash: 981e43e8b1e3ddabd435d350aeeed417
+config_hash: 60929489bdc1eaf979e7ef74fdd17b94

api.md

@@ -484,6 +484,16 @@ Methods:
 - <code title="post /gitpod.v1.SecretService/GetSecretValue">client.secrets.<a href="./src/resources/secrets.ts">getValue</a>({ ...params }) -> SecretGetValueResponse</code>
 - <code title="post /gitpod.v1.SecretService/UpdateSecretValue">client.secrets.<a href="./src/resources/secrets.ts">updateValue</a>({ ...params }) -> unknown</code>
 
+# Usage
+
+Types:
+
+- <code><a href="./src/resources/usage.ts">EnvironmentSession</a></code>
+
+Methods:
+
+- <code title="post /gitpod.v1.UsageService/ListEnvironmentSessions">client.usage.<a href="./src/resources/usage.ts">listEnvironmentSessions</a>({ ...params }) -> EnvironmentSessionsSessionsPage</code>
+
 # Users
 
 Types:

src/client.ts

@@ -49,6 +49,8 @@ import {
   SecretsPageResponse,
   type ServicesPageParams,
   ServicesPageResponse,
+  type SessionsPageParams,
+  SessionsPageResponse,
   type TaskExecutionsPageParams,
   TaskExecutionsPageResponse,
   type TasksPageParams,
@@ -123,6 +125,12 @@ import {
   Secrets,
   SecretsSecretsPage,
 } from './resources/secrets';
+import {
+  EnvironmentSession,
+  EnvironmentSessionsSessionsPage,
+  Usage,
+  UsageListEnvironmentSessionsParams,
+} from './resources/usage';
 import { readEnv } from './internal/utils/env';
 import { formatRequestDetails, loggerFor } from './internal/utils/log';
 import { isEmptyObj } from './internal/utils/values';
@@ -917,6 +925,7 @@ export class Gitpod {
   projects: API.Projects = new API.Projects(this);
   runners: API.Runners = new API.Runners(this);
   secrets: API.Secrets = new API.Secrets(this);
+  usage: API.Usage = new API.Usage(this);
   users: API.Users = new API.Users(this);
 }
 Gitpod.Accounts = Accounts;
@@ -929,6 +938,7 @@ Gitpod.Organizations = Organizations;
 Gitpod.Projects = Projects;
 Gitpod.Runners = Runners;
 Gitpod.Secrets = Secrets;
+Gitpod.Usage = Usage;
 Gitpod.Users = Users;
 export declare namespace Gitpod {
   export type RequestOptions = Opts.RequestOptions;
@@ -996,6 +1006,9 @@ export declare namespace Gitpod {
   export import ServicesPage = Pagination.ServicesPage;
   export { type ServicesPageParams as ServicesPageParams, type ServicesPageResponse as ServicesPageResponse };
 
+  export import SessionsPage = Pagination.SessionsPage;
+  export { type SessionsPageParams as SessionsPageParams, type SessionsPageResponse as SessionsPageResponse };
+
   export import SSOConfigurationsPage = Pagination.SSOConfigurationsPage;
   export {
     type SSOConfigurationsPageParams as SSOConfigurationsPageParams,
@@ -1194,6 +1207,13 @@ export declare namespace Gitpod {
     type SecretUpdateValueParams as SecretUpdateValueParams,
   };
 
+  export {
+    Usage as Usage,
+    type EnvironmentSession as EnvironmentSession,
+    type EnvironmentSessionsSessionsPage as EnvironmentSessionsSessionsPage,
+    type UsageListEnvironmentSessionsParams as UsageListEnvironmentSessionsParams,
+  };
+
   export {
     Users as Users,
     type User as User,

src/core/pagination.ts

@@ -941,6 +941,61 @@ export class ServicesPage<Item> extends AbstractPage<Item> implements ServicesPa
   }
 }
 
+export interface SessionsPageResponse<Item> {
+  pagination: SessionsPageResponse.Pagination;
+
+  sessions: Array<Item>;
+}
+
+export namespace SessionsPageResponse {
+  export interface Pagination {
+    nextToken?: string;
+  }
+}
+
+export interface SessionsPageParams {
+  pageSize?: number;
+
+  token?: string;
+}
+
+export class SessionsPage<Item> extends AbstractPage<Item> implements SessionsPageResponse<Item> {
+  pagination: SessionsPageResponse.Pagination;
+
+  sessions: Array<Item>;
+
+  constructor(
+    client: Gitpod,
+    response: Response,
+    body: SessionsPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.pagination = body.pagination || {};
+    this.sessions = body.sessions || [];
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.sessions ?? [];
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.pagination?.nextToken;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        token: cursor,
+      },
+    };
+  }
+}
+
 export interface SSOConfigurationsPageResponse<Item> {
   pagination: SSOConfigurationsPageResponse.Pagination;
 

src/resources/index.ts

@@ -166,6 +166,12 @@ export {
   type SecretUpdateValueParams,
   type SecretsSecretsPage,
 } from './secrets';
+export {
+  Usage,
+  type EnvironmentSession,
+  type UsageListEnvironmentSessionsParams,
+  type EnvironmentSessionsSessionsPage,
+} from './usage';
 export {
   Users,
   type User,

src/resources/usage.ts

@@ -0,0 +1,140 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { PagePromise, SessionsPage, type SessionsPageParams } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+export class Usage extends APIResource {
+  /**
+   * Lists environment sessions within a specified date range.
+   *
+   * Returns a list of environment sessions that were active within the specified
+   * date range.
+   */
+  listEnvironmentSessions(
+    params: UsageListEnvironmentSessionsParams,
+    options?: RequestOptions,
+  ): PagePromise<EnvironmentSessionsSessionsPage, EnvironmentSession> {
+    const { token, pageSize, ...body } = params;
+    return this._client.getAPIList(
+      '/gitpod.v1.UsageService/ListEnvironmentSessions',
+      SessionsPage<EnvironmentSession>,
+      { query: { token, pageSize }, body, method: 'post', ...options },
+    );
+  }
+}
+
+export type EnvironmentSessionsSessionsPage = SessionsPage<EnvironmentSession>;
+
+export interface EnvironmentSession {
+  /**
+   * Environment session ID.
+   */
+  id?: string;
+
+  /**
+   * Time when the session was created.
+   */
+  createdAt?: string;
+
+  /**
+   * Environment class ID associated with the session.
+   */
+  environmentClassId?: string;
+
+  /**
+   * Environment ID associated with the session.
+   */
+  environmentId?: string;
+
+  /**
+   * Project ID associated with the session.
+   */
+  projectId?: string;
+
+  /**
+   * Runner ID associated with the session.
+   */
+  runnerId?: string;
+
+  /**
+   * Time when the session was stopped.
+   */
+  stoppedAt?: string;
+
+  /**
+   * User ID who created the session.
+   */
+  userId?: string;
+}
+
+export interface UsageListEnvironmentSessionsParams extends SessionsPageParams {
+  /**
+   * Body param: Filter options.
+   */
+  filter?: UsageListEnvironmentSessionsParams.Filter;
+
+  /**
+   * Body param: Pagination options.
+   */
+  pagination?: UsageListEnvironmentSessionsParams.Pagination;
+}
+
+export namespace UsageListEnvironmentSessionsParams {
+  /**
+   * Filter options.
+   */
+  export interface Filter {
+    /**
+     * Date range to query sessions within.
+     */
+    dateRange: Filter.DateRange;
+
+    /**
+     * Optional project ID to filter sessions by.
+     */
+    projectId?: string;
+  }
+
+  export namespace Filter {
+    /**
+     * Date range to query sessions within.
+     */
+    export interface DateRange {
+      /**
+       * End time of the date range (exclusive).
+       */
+      endTime: string;
+
+      /**
+       * Start time of the date range (inclusive).
+       */
+      startTime: string;
+    }
+  }
+
+  /**
+   * Pagination options.
+   */
+  export interface Pagination {
+    /**
+     * Token for the next set of results that was returned as next_token of a
+     * PaginationResponse
+     */
+    token?: string;
+
+    /**
+     * Page size is the maximum number of results to retrieve per page. Defaults to 25.
+     * Maximum 100.
+     */
+    pageSize?: number;
+  }
+}
+
+export declare namespace Usage {
+  export {
+    type EnvironmentSession as EnvironmentSession,
+    type EnvironmentSessionsSessionsPage as EnvironmentSessionsSessionsPage,
+    type UsageListEnvironmentSessionsParams as UsageListEnvironmentSessionsParams,
+  };
+}

tests/api-resources/usage.test.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import Gitpod from '@gitpod/sdk';
+
+const client = new Gitpod({
+  bearerToken: 'My Bearer Token',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
+
+describe('resource usage', () => {
+  // skipped: tests are disabled for the time being
+  test.skip('listEnvironmentSessions', async () => {
+    const responsePromise = client.usage.listEnvironmentSessions({});
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+});