casedev 0.23.0 → 0.24.0

package/src/resources/applications/v1/index.ts

@@ -13,6 +13,7 @@ export {
   Projects,
   type ProjectListResponse,
   type ProjectCreateParams,
+  type ProjectListParams,
   type ProjectDeleteParams,
   type ProjectCreateDeploymentParams,
   type ProjectCreateDomainParams,

package/src/resources/applications/v1/projects.ts

@@ -8,7 +8,9 @@ import { path } from '../../../internal/utils/path';
 
 export class Projects extends APIResource {
   /**
-   * Create a new web application project
+   * Creates a new application project, validates GitHub access, provisions a default
+   * case.dev domain, and starts the deployment workflow. The initial response
+   * returns as soon as the workflow is queued so clients can poll for progress.
    */
   create(body: ProjectCreateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/applications/v1/projects', {
@@ -19,7 +21,9 @@ export class Projects extends APIResource {
   }
 
   /**
-   * Get details of a specific web application project
+   * Returns project details, domains, and recent deployment information for one
+   * application project or deployed Thurgood app. Use this endpoint when you need a
+   * single record with hosting metadata for a details view.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/applications/v1/projects/${id}`, {
@@ -29,14 +33,21 @@ export class Projects extends APIResource {
   }
 
   /**
-   * List all web application projects
+   * Lists application projects and deployed Thurgood apps for the authenticated
+   * organization. Use enrich=true to include additional hosting metadata for
+   * projects linked to Vercel.
    */
-  list(options?: RequestOptions): APIPromise<ProjectListResponse> {
-    return this._client.get('/applications/v1/projects', options);
+  list(
+    query: ProjectListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProjectListResponse> {
+    return this._client.get('/applications/v1/projects', { query, ...options });
   }
 
   /**
-   * Delete a web application project
+   * Soft-deletes an application project or deployed Thurgood app from Case.dev. By
+   * default it also removes the linked hosting project; set deleteFromHosting=false
+   * to keep the external hosting resources intact.
    */
   delete(
     id: string,
@@ -52,7 +63,9 @@ export class Projects extends APIResource {
   }
 
   /**
-   * Trigger a new deployment for a project.
+   * Starts a new deployment for an existing project using its saved repository and
+   * hosting configuration. Any environment variables passed in the request are
+   * merged into the deployment workflow before the build starts.
    */
   createDeployment(
     id: string,
@@ -130,7 +143,9 @@ export class Projects extends APIResource {
   }
 
   /**
-   * List deployments for a specific project
+   * Lists deployments for one project in the authenticated organization. If the
+   * hosting project has not been created yet, this endpoint returns an empty list
+   * with a progress message instead of failing.
    */
   listDeployments(
     id: string,
@@ -172,40 +187,85 @@ export class Projects extends APIResource {
 }
 
 export interface ProjectListResponse {
+  /**
+   * Projects and deployed apps visible to the organization
+   */
   projects?: Array<ProjectListResponse.Project>;
 }
 
 export namespace ProjectListResponse {
   export interface Project {
+    /**
+     * Project identifier
+     */
     id?: string;
 
+    /**
+     * When the project record was created
+     */
     createdAt?: string;
 
+    /**
+     * Custom or generated domains assigned to the project
+     */
     domains?: Array<Project.Domain>;
 
+    /**
+     * Detected or configured application framework
+     */
     framework?: string;
 
+    /**
+     * Default Git branch used for deployments
+     */
     gitBranch?: string;
 
+    /**
+     * Connected Git repository in owner/repo format
+     */
     gitRepo?: string;
 
+    /**
+     * Project display name
+     */
     name?: string;
 
+    /**
+     * Current project deployment status
+     */
     status?: string;
 
+    /**
+     * When the project record was last updated
+     */
     updatedAt?: string;
 
+    /**
+     * Hosting provider project ID, when linked
+     */
     vercelProjectId?: string;
   }
 
   export namespace Project {
     export interface Domain {
+      /**
+       * Domain record identifier
+       */
       id?: string;
 
+      /**
+       * Hostname assigned to the project
+       */
       domain?: string;
 
+      /**
+       * Whether this is the primary project domain
+       */
       isPrimary?: boolean;
 
+      /**
+       * Whether the domain has been verified by the hosting provider
+       */
       isVerified?: boolean;
     }
   }
@@ -213,47 +273,47 @@ export namespace ProjectListResponse {
 
 export interface ProjectCreateParams {
   /**
-   * GitHub repository URL or "owner/repo"
+   * GitHub repository URL or owner/repo identifier
    */
   gitRepo: string;
 
   /**
-   * Project name
+   * Human-readable project name
    */
   name: string;
 
   /**
-   * Custom build command
+   * Custom build command to override the framework default
    */
   buildCommand?: string;
 
   /**
-   * Environment variables to set on the project
+   * Environment variables to create before the first deployment
    */
   environmentVariables?: Array<ProjectCreateParams.EnvironmentVariable>;
 
   /**
-   * Framework (e.g., "nextjs", "remix", "astro")
+   * Framework preset for the hosting project, such as nextjs or remix
    */
   framework?: string;
 
   /**
-   * Git branch to deploy
+   * Git branch to deploy. Defaults to main.
    */
   gitBranch?: string;
 
   /**
-   * Custom install command
+   * Custom install command to override the framework default
    */
   installCommand?: string;
 
   /**
-   * Build output directory
+   * Build output directory relative to the project root
    */
   outputDirectory?: string;
 
   /**
-   * Root directory of the project
+   * Repository subdirectory that contains the app to deploy
    */
   rootDirectory?: string;
 }
@@ -266,7 +326,7 @@ export namespace ProjectCreateParams {
     key: string;
 
     /**
-     * Deployment targets for this variable
+     * Deployment targets that should receive this variable
      */
     target: Array<'production' | 'preview' | 'development'>;
 
@@ -276,15 +336,27 @@ export namespace ProjectCreateParams {
     value: string;
 
     /**
-     * Variable type
+     * Storage mode for the environment variable value
      */
     type?: 'plain' | 'encrypted' | 'secret';
   }
 }
 
+export interface ProjectListParams {
+  /**
+   * Whether to include additional hosting metadata from Vercel
+   */
+  enrich?: boolean;
+
+  /**
+   * Maximum number of projects to return from each backing source
+   */
+  limit?: number;
+}
+
 export interface ProjectDeleteParams {
   /**
-   * Also delete the project from hosting (default: true)
+   * Whether to also delete the linked hosting project. Defaults to true.
    */
   deleteFromHosting?: boolean;
 }
@@ -304,7 +376,7 @@ export namespace ProjectCreateDeploymentParams {
     key: string;
 
     /**
-     * Deployment targets for this variable
+     * Deployment targets that should receive this variable
      */
     target: Array<'production' | 'preview' | 'development'>;
 
@@ -314,7 +386,7 @@ export namespace ProjectCreateDeploymentParams {
     value: string;
 
     /**
-     * Variable type
+     * Storage mode for the environment variable value
      */
     type?: 'plain' | 'encrypted' | 'secret';
   }
@@ -387,12 +459,12 @@ export interface ProjectListDeploymentsParams {
   limit?: number;
 
   /**
-   * Filter by deployment state
+   * Deployment state to filter by
    */
   state?: string;
 
   /**
-   * Filter by deployment target
+   * Deployment target to filter by
    */
   target?: 'production' | 'staging';
 }
@@ -408,6 +480,7 @@ export declare namespace Projects {
   export {
     type ProjectListResponse as ProjectListResponse,
     type ProjectCreateParams as ProjectCreateParams,
+    type ProjectListParams as ProjectListParams,
     type ProjectDeleteParams as ProjectDeleteParams,
     type ProjectCreateDeploymentParams as ProjectCreateDeploymentParams,
     type ProjectCreateDomainParams as ProjectCreateDomainParams,

package/src/resources/applications/v1/v1.ts

@@ -23,6 +23,7 @@ import {
   ProjectGetRuntimeLogsParams,
   ProjectListDeploymentsParams,
   ProjectListEnvParams,
+  ProjectListParams,
   ProjectListResponse,
   Projects,
 } from './projects';
@@ -54,6 +55,7 @@ export declare namespace V1 {
     Projects as Projects,
     type ProjectListResponse as ProjectListResponse,
     type ProjectCreateParams as ProjectCreateParams,
+    type ProjectListParams as ProjectListParams,
     type ProjectDeleteParams as ProjectDeleteParams,
     type ProjectCreateDeploymentParams as ProjectCreateDeploymentParams,
     type ProjectCreateDomainParams as ProjectCreateDomainParams,

package/src/resources/format/v1/v1.ts

@@ -51,10 +51,18 @@ export interface V1CreateDocumentParams {
    */
   input_format?: 'md' | 'json' | 'text';
 
+  /**
+   * Optional template composition and styling settings used during document
+   * generation
+   */
   options?: V1CreateDocumentParams.Options;
 }
 
 export namespace V1CreateDocumentParams {
+  /**
+   * Optional template composition and styling settings used during document
+   * generation
+   */
   export interface Options {
     /**
      * Template components with variables

package/src/resources/legal/v1.ts

@@ -1156,6 +1156,9 @@ export namespace V1DraftParams {
      */
     target?: number;
 
+    /**
+     * Whether the target length is measured in words or pages
+     */
     unit?: 'words' | 'pages';
   }
 }
@@ -1226,8 +1229,14 @@ export interface V1ListCourtsParams {
    */
   jurisdiction?: string;
 
+  /**
+   * Maximum number of courts to return
+   */
   limit?: number;
 
+  /**
+   * Number of courts to skip before returning results
+   */
   offset?: number;
 
   /**

package/src/resources/vault/events/subscriptions.ts

@@ -115,12 +115,25 @@ export class Subscriptions extends APIResource {
 }
 
 export interface SubscriptionCreateParams {
+  /**
+   * Webhook endpoint URL that will receive vault event deliveries
+   */
   callbackUrl: string;
 
+  /**
+   * Vault event types to deliver. Omit to receive the default supported set.
+   */
   eventTypes?: Array<string>;
 
+  /**
+   * Vault object IDs to limit notifications to. Omit to receive events for all
+   * objects in the vault.
+   */
   objectIds?: Array<string>;
 
+  /**
+   * Optional secret used to sign outbound webhook deliveries
+   */
   signingSecret?: string;
 }
 
@@ -131,32 +144,33 @@ export interface SubscriptionUpdateParams {
   id: string;
 
   /**
-   * Body param
+   * Body param: Updated webhook endpoint URL for deliveries
    */
   callbackUrl?: string;
 
   /**
-   * Body param
+   * Body param: Whether to remove the existing signing secret
    */
   clearSigningSecret?: boolean;
 
   /**
-   * Body param
+   * Body param: Updated event types to deliver for this subscription
    */
   eventTypes?: Array<string>;
 
   /**
-   * Body param
+   * Body param: Whether the subscription should continue delivering events
    */
   isActive?: boolean;
 
   /**
-   * Body param
+   * Body param: Updated vault object IDs to limit notifications to. Pass an empty
+   * array to remove the filter.
    */
   objectIds?: Array<string>;
 
   /**
-   * Body param
+   * Body param: Replacement secret used to sign webhook deliveries
    */
   signingSecret?: string;
 }

package/src/resources/vault/groups.ts

@@ -11,37 +11,42 @@ import { path } from '../../internal/utils/path';
  */
 export class Groups extends APIResource {
   /**
-   * Create vault group
+   * Creates a vault group for organizing vaults and applying group-scoped access
+   * controls. Group-scoped API keys cannot create or manage vault groups.
    *
    * @example
    * ```ts
-   * await client.vault.groups.create();
+   * await client.vault.groups.create({ name: 'name' });
    * ```
    */
-  create(options?: RequestOptions): APIPromise<void> {
+  create(body: GroupCreateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/vault/groups', {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
   /**
-   * Update vault group
+   * Updates a vault group for the authenticated organization. Only provided fields
+   * are changed, and setting description to null removes the current description.
    *
    * @example
    * ```ts
    * await client.vault.groups.update('groupId');
    * ```
    */
-  update(groupID: string, options?: RequestOptions): APIPromise<void> {
+  update(groupID: string, body: GroupUpdateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.patch(path`/vault/groups/${groupID}`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
   /**
-   * List vault groups
+   * Lists vault groups visible to the authenticated organization. Group-scoped API
+   * keys only receive groups within their allowed scope.
    *
    * @example
    * ```ts
@@ -56,7 +61,8 @@ export class Groups extends APIResource {
   }
 
   /**
-   * Delete vault group
+   * Soft-deletes a vault group that no longer has any active vaults assigned. This
+   * operation is blocked when the group still contains vaults.
    *
    * @example
    * ```ts
@@ -70,3 +76,31 @@ export class Groups extends APIResource {
     });
   }
 }
+
+export interface GroupCreateParams {
+  /**
+   * Human-readable name for the vault group
+   */
+  name: string;
+
+  /**
+   * Optional description of the vault group purpose
+   */
+  description?: string;
+}
+
+export interface GroupUpdateParams {
+  /**
+   * Updated vault group description. Pass null to remove the current description.
+   */
+  description?: string | null;
+
+  /**
+   * New human-readable name for the vault group
+   */
+  name?: string;
+}
+
+export declare namespace Groups {
+  export { type GroupCreateParams as GroupCreateParams, type GroupUpdateParams as GroupUpdateParams };
+}

package/src/resources/vault/index.ts

@@ -8,7 +8,7 @@ export {
   type GraphragProcessObjectResponse,
   type GraphragProcessObjectParams,
 } from './graphrag';
-export { Groups } from './groups';
+export { Groups, type GroupCreateParams, type GroupUpdateParams } from './groups';
 export {
   Multipart,
   type MultipartGetPartURLsResponse,

package/src/resources/vault/multipart.ts

@@ -66,21 +66,39 @@ export namespace MultipartGetPartURLsResponse {
 }
 
 export interface MultipartAbortParams {
+  /**
+   * Vault object ID associated with the multipart upload
+   */
   objectId: string;
 
+  /**
+   * Multipart upload ID returned when the upload was initialized
+   */
   uploadId: string;
 }
 
 export interface MultipartGetPartURLsParams {
+  /**
+   * Vault object ID associated with the multipart upload
+   */
   objectId: string;
 
+  /**
+   * Multipart parts that need presigned upload URLs
+   */
   parts: Array<MultipartGetPartURLsParams.Part>;
 
+  /**
+   * Multipart upload ID returned when the upload was initialized
+   */
   uploadId: string;
 }
 
 export namespace MultipartGetPartURLsParams {
   export interface Part {
+    /**
+     * 1-based multipart part number
+     */
     partNumber: number;
 
     /**

package/src/resources/vault/vault.ts

@@ -10,7 +10,7 @@ import {
   GraphragProcessObjectResponse,
 } from './graphrag';
 import * as GroupsAPI from './groups';
-import { Groups } from './groups';
+import { GroupCreateParams, GroupUpdateParams, Groups } from './groups';
 import * as MultipartAPI from './multipart';
 import {
   Multipart,
@@ -963,7 +963,11 @@ export declare namespace Vault {
     type GraphragProcessObjectParams as GraphragProcessObjectParams,
   };
 
-  export { Groups as Groups };
+  export {
+    Groups as Groups,
+    type GroupCreateParams as GroupCreateParams,
+    type GroupUpdateParams as GroupUpdateParams,
+  };
 
   export {
     Multipart as Multipart,