apps.ts

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import * as DeploymentsAPI from './deployments';
import {
  DeploymentCreateParams,
  DeploymentCreateResponse,
  DeploymentFollowResponse,
  Deployments,
} from './deployments';
import * as InvocationsAPI from './invocations';
import {
  InvocationCreateParams,
  InvocationCreateResponse,
  InvocationRetrieveResponse,
  InvocationUpdateParams,
  InvocationUpdateResponse,
  Invocations,
} from './invocations';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';

export class Apps extends APIResource {
  deployments: DeploymentsAPI.Deployments = new DeploymentsAPI.Deployments(this._client);
  invocations: InvocationsAPI.Invocations = new InvocationsAPI.Invocations(this._client);

  /**
   * List application versions for the authenticated user. Optionally filter by app
   * name and/or version label.
   *
   * @example
   * ```ts
   * const apps = await client.apps.list();
   * ```
   */
  list(query: AppListParams | null | undefined = {}, options?: RequestOptions): APIPromise<AppListResponse> {
    return this._client.get('/apps', { query, ...options });
  }
}

export type AppListResponse = Array<AppListResponse.AppListResponseItem>;

export namespace AppListResponse {
  /**
   * Summary of an application version.
   */
  export interface AppListResponseItem {
    /**
     * Unique identifier for the app version
     */
    id: string;

    /**
     * Name of the application
     */
    app_name: string;

    /**
     * Deployment region code
     */
    region: string;

    /**
     * Version label for the application
     */
    version: string;

    /**
     * Environment variables configured for this app version
     */
    env_vars?: Record<string, string>;
  }
}

export interface AppListParams {
  /**
   * Filter results by application name.
   */
  app_name?: string;

  /**
   * Filter results by version label.
   */
  version?: string;
}

Apps.Deployments = Deployments;
Apps.Invocations = Invocations;

export declare namespace Apps {
  export { type AppListResponse as AppListResponse, type AppListParams as AppListParams };

  export {
    Deployments as Deployments,
    type DeploymentCreateResponse as DeploymentCreateResponse,
    type DeploymentFollowResponse as DeploymentFollowResponse,
    type DeploymentCreateParams as DeploymentCreateParams,
  };

  export {
    Invocations as Invocations,
    type InvocationCreateResponse as InvocationCreateResponse,
    type InvocationRetrieveResponse as InvocationRetrieveResponse,
    type InvocationUpdateResponse as InvocationUpdateResponse,
    type InvocationCreateParams as InvocationCreateParams,
    type InvocationUpdateParams as InvocationUpdateParams,
  };
}