casedev 0.23.0 → 0.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +1 -1
  3. package/resources/agent/v1/agents.d.mts +22 -1
  4. package/resources/agent/v1/agents.d.mts.map +1 -1
  5. package/resources/agent/v1/agents.d.ts +22 -1
  6. package/resources/agent/v1/agents.d.ts.map +1 -1
  7. package/resources/agent/v1/chat.d.mts +1 -1
  8. package/resources/agent/v1/chat.d.ts +1 -1
  9. package/resources/applications/v1/deployments.d.mts +26 -16
  10. package/resources/applications/v1/deployments.d.mts.map +1 -1
  11. package/resources/applications/v1/deployments.d.ts +26 -16
  12. package/resources/applications/v1/deployments.d.ts.map +1 -1
  13. package/resources/applications/v1/deployments.js +16 -6
  14. package/resources/applications/v1/deployments.js.map +1 -1
  15. package/resources/applications/v1/deployments.mjs +16 -6
  16. package/resources/applications/v1/deployments.mjs.map +1 -1
  17. package/resources/applications/v1/index.d.mts +1 -1
  18. package/resources/applications/v1/index.d.mts.map +1 -1
  19. package/resources/applications/v1/index.d.ts +1 -1
  20. package/resources/applications/v1/index.d.ts.map +1 -1
  21. package/resources/applications/v1/index.js.map +1 -1
  22. package/resources/applications/v1/index.mjs.map +1 -1
  23. package/resources/applications/v1/projects.d.mts +91 -24
  24. package/resources/applications/v1/projects.d.mts.map +1 -1
  25. package/resources/applications/v1/projects.d.ts +91 -24
  26. package/resources/applications/v1/projects.d.ts.map +1 -1
  27. package/resources/applications/v1/projects.js +20 -8
  28. package/resources/applications/v1/projects.js.map +1 -1
  29. package/resources/applications/v1/projects.mjs +20 -8
  30. package/resources/applications/v1/projects.mjs.map +1 -1
  31. package/resources/applications/v1/v1.d.mts +2 -2
  32. package/resources/applications/v1/v1.d.mts.map +1 -1
  33. package/resources/applications/v1/v1.d.ts +2 -2
  34. package/resources/applications/v1/v1.d.ts.map +1 -1
  35. package/resources/applications/v1/v1.js.map +1 -1
  36. package/resources/applications/v1/v1.mjs.map +1 -1
  37. package/resources/format/v1/v1.d.mts +8 -0
  38. package/resources/format/v1/v1.d.mts.map +1 -1
  39. package/resources/format/v1/v1.d.ts +8 -0
  40. package/resources/format/v1/v1.d.ts.map +1 -1
  41. package/resources/format/v1/v1.js.map +1 -1
  42. package/resources/format/v1/v1.mjs.map +1 -1
  43. package/resources/legal/v1.d.mts +55 -11
  44. package/resources/legal/v1.d.mts.map +1 -1
  45. package/resources/legal/v1.d.ts +55 -11
  46. package/resources/legal/v1.d.ts.map +1 -1
  47. package/resources/legal/v1.js +3 -3
  48. package/resources/legal/v1.mjs +3 -3
  49. package/resources/vault/events/subscriptions.d.mts +20 -6
  50. package/resources/vault/events/subscriptions.d.mts.map +1 -1
  51. package/resources/vault/events/subscriptions.d.ts +20 -6
  52. package/resources/vault/events/subscriptions.d.ts.map +1 -1
  53. package/resources/vault/groups.d.mts +34 -7
  54. package/resources/vault/groups.d.mts.map +1 -1
  55. package/resources/vault/groups.d.ts +34 -7
  56. package/resources/vault/groups.d.ts.map +1 -1
  57. package/resources/vault/groups.js +13 -7
  58. package/resources/vault/groups.js.map +1 -1
  59. package/resources/vault/groups.mjs +13 -7
  60. package/resources/vault/groups.mjs.map +1 -1
  61. package/resources/vault/index.d.mts +1 -1
  62. package/resources/vault/index.d.mts.map +1 -1
  63. package/resources/vault/index.d.ts +1 -1
  64. package/resources/vault/index.d.ts.map +1 -1
  65. package/resources/vault/index.js.map +1 -1
  66. package/resources/vault/index.mjs.map +1 -1
  67. package/resources/vault/multipart.d.mts +18 -0
  68. package/resources/vault/multipart.d.mts.map +1 -1
  69. package/resources/vault/multipart.d.ts +18 -0
  70. package/resources/vault/multipart.d.ts.map +1 -1
  71. package/resources/vault/vault.d.mts +2 -2
  72. package/resources/vault/vault.d.mts.map +1 -1
  73. package/resources/vault/vault.d.ts +2 -2
  74. package/resources/vault/vault.d.ts.map +1 -1
  75. package/resources/vault/vault.js.map +1 -1
  76. package/resources/vault/vault.mjs.map +1 -1
  77. package/resources/voice/boost-list.d.mts +88 -0
  78. package/resources/voice/boost-list.d.mts.map +1 -0
  79. package/resources/voice/boost-list.d.ts +88 -0
  80. package/resources/voice/boost-list.d.ts.map +1 -0
  81. package/resources/voice/boost-list.js +40 -0
  82. package/resources/voice/boost-list.js.map +1 -0
  83. package/resources/voice/boost-list.mjs +36 -0
  84. package/resources/voice/boost-list.mjs.map +1 -0
  85. package/resources/voice/index.d.mts +1 -0
  86. package/resources/voice/index.d.mts.map +1 -1
  87. package/resources/voice/index.d.ts +1 -0
  88. package/resources/voice/index.d.ts.map +1 -1
  89. package/resources/voice/index.js +3 -1
  90. package/resources/voice/index.js.map +1 -1
  91. package/resources/voice/index.mjs +1 -0
  92. package/resources/voice/index.mjs.map +1 -1
  93. package/resources/voice/voice.d.mts +4 -0
  94. package/resources/voice/voice.d.mts.map +1 -1
  95. package/resources/voice/voice.d.ts +4 -0
  96. package/resources/voice/voice.d.ts.map +1 -1
  97. package/resources/voice/voice.js +4 -0
  98. package/resources/voice/voice.js.map +1 -1
  99. package/resources/voice/voice.mjs +4 -0
  100. package/resources/voice/voice.mjs.map +1 -1
  101. package/src/resources/agent/v1/agents.ts +22 -1
  102. package/src/resources/agent/v1/chat.ts +1 -1
  103. package/src/resources/applications/v1/deployments.ts +26 -16
  104. package/src/resources/applications/v1/index.ts +1 -0
  105. package/src/resources/applications/v1/projects.ts +97 -24
  106. package/src/resources/applications/v1/v1.ts +2 -0
  107. package/src/resources/format/v1/v1.ts +8 -0
  108. package/src/resources/legal/v1.ts +62 -11
  109. package/src/resources/vault/events/subscriptions.ts +20 -6
  110. package/src/resources/vault/groups.ts +41 -7
  111. package/src/resources/vault/index.ts +1 -1
  112. package/src/resources/vault/multipart.ts +18 -0
  113. package/src/resources/vault/vault.ts +6 -2
  114. package/src/resources/voice/boost-list.ts +119 -0
  115. package/src/resources/voice/index.ts +7 -0
  116. package/src/resources/voice/voice.ts +18 -0
  117. package/src/version.ts +1 -1
  118. package/version.d.mts +1 -1
  119. package/version.d.ts +1 -1
  120. package/version.js +1 -1
  121. package/version.mjs +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"voice.d.ts","sourceRoot":"","sources":["../../src/resources/voice/voice.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,SAAS,EAAE,uBAAuB,EAAE;OACtC,KAAK,gBAAgB;OACrB,EACL,aAAa,EACb,yBAAyB,EACzB,2BAA2B,EAC3B,6BAA6B,EAC9B;OACM,KAAK,KAAK;OACV,EAAE,EAAE,EAAE,kBAAkB,EAAE,oBAAoB,EAAE;AAEvD,qBAAa,KAAM,SAAQ,WAAW;IACpC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,EAAE,EAAE,KAAK,CAAC,EAAE,CAA8B;CAC3C;AAMD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,SAAS,IAAI,SAAS,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;IAE3F,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,EAAE,IAAI,EAAE,EACR,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"voice.d.ts","sourceRoot":"","sources":["../../src/resources/voice/voice.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EACL,SAAS,EACT,sBAAsB,EACtB,wBAAwB,EACxB,uBAAuB,EACvB,yBAAyB,EAC1B;OACM,KAAK,YAAY;OACjB,EAAE,SAAS,EAAE,uBAAuB,EAAE;OACtC,KAAK,gBAAgB;OACrB,EACL,aAAa,EACb,yBAAyB,EACzB,2BAA2B,EAC3B,6BAA6B,EAC9B;OACM,KAAK,KAAK;OACV,EAAE,EAAE,EAAE,kBAAkB,EAAE,oBAAoB,EAAE;AAEvD,qBAAa,KAAM,SAAQ,WAAW;IACpC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,EAAE,EAAE,KAAK,CAAC,EAAE,CAA8B;CAC3C;AAOD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,SAAS,IAAI,SAAS,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;IAE3F,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,EAAE,IAAI,EAAE,EACR,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -4,6 +4,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Voice = void 0;
5
5
  const tslib_1 = require("../../internal/tslib.js");
6
6
  const resource_1 = require("../../core/resource.js");
7
+ const BoostListAPI = tslib_1.__importStar(require("./boost-list.js"));
8
+ const boost_list_1 = require("./boost-list.js");
7
9
  const StreamingAPI = tslib_1.__importStar(require("./streaming.js"));
8
10
  const streaming_1 = require("./streaming.js");
9
11
  const TranscriptionAPI = tslib_1.__importStar(require("./transcription.js"));
@@ -14,12 +16,14 @@ class Voice extends resource_1.APIResource {
14
16
  constructor() {
15
17
  super(...arguments);
16
18
  this.streaming = new StreamingAPI.Streaming(this._client);
19
+ this.boostList = new BoostListAPI.BoostList(this._client);
17
20
  this.transcription = new TranscriptionAPI.Transcription(this._client);
18
21
  this.v1 = new V1API.V1(this._client);
19
22
  }
20
23
  }
21
24
  exports.Voice = Voice;
22
25
  Voice.Streaming = streaming_1.Streaming;
26
+ Voice.BoostList = boost_list_1.BoostList;
23
27
  Voice.Transcription = transcription_1.Transcription;
24
28
  Voice.V1 = v1_1.V1;
25
29
  //# sourceMappingURL=voice.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"voice.js","sourceRoot":"","sources":["../../src/resources/voice/voice.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,qEAA4C;AAC5C,8CAAiE;AACjE,6EAAoD;AACpD,sDAKyB;AACzB,0DAAiC;AACjC,mCAAuE;AAEvE,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,OAAE,GAAa,IAAI,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;CAAA;AAJD,sBAIC;AAED,KAAK,CAAC,SAAS,GAAG,qBAAS,CAAC;AAC5B,KAAK,CAAC,aAAa,GAAG,6BAAa,CAAC;AACpC,KAAK,CAAC,EAAE,GAAG,OAAE,CAAC"}
1
+ {"version":3,"file":"voice.js","sourceRoot":"","sources":["../../src/resources/voice/voice.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,sEAA6C;AAC7C,gDAMsB;AACtB,qEAA4C;AAC5C,8CAAiE;AACjE,6EAAoD;AACpD,sDAKyB;AACzB,0DAAiC;AACjC,mCAAuE;AAEvE,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,OAAE,GAAa,IAAI,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;CAAA;AALD,sBAKC;AAED,KAAK,CAAC,SAAS,GAAG,qBAAS,CAAC;AAC5B,KAAK,CAAC,SAAS,GAAG,sBAAS,CAAC;AAC5B,KAAK,CAAC,aAAa,GAAG,6BAAa,CAAC;AACpC,KAAK,CAAC,EAAE,GAAG,OAAE,CAAC"}
@@ -1,5 +1,7 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../../core/resource.mjs";
3
+ import * as BoostListAPI from "./boost-list.mjs";
4
+ import { BoostList, } from "./boost-list.mjs";
3
5
  import * as StreamingAPI from "./streaming.mjs";
4
6
  import { Streaming } from "./streaming.mjs";
5
7
  import * as TranscriptionAPI from "./transcription.mjs";
@@ -10,11 +12,13 @@ export class Voice extends APIResource {
10
12
  constructor() {
11
13
  super(...arguments);
12
14
  this.streaming = new StreamingAPI.Streaming(this._client);
15
+ this.boostList = new BoostListAPI.BoostList(this._client);
13
16
  this.transcription = new TranscriptionAPI.Transcription(this._client);
14
17
  this.v1 = new V1API.V1(this._client);
15
18
  }
16
19
  }
17
20
  Voice.Streaming = Streaming;
21
+ Voice.BoostList = BoostList;
18
22
  Voice.Transcription = Transcription;
19
23
  Voice.V1 = V1;
20
24
  //# sourceMappingURL=voice.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"voice.mjs","sourceRoot":"","sources":["../../src/resources/voice/voice.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,SAAS,EAA2B;OACtC,KAAK,gBAAgB;OACrB,EACL,aAAa,GAId;OACM,KAAK,KAAK;OACV,EAAE,EAAE,EAA4C;AAEvD,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,OAAE,GAAa,IAAI,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;CAAA;AAED,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;AAC5B,KAAK,CAAC,aAAa,GAAG,aAAa,CAAC;AACpC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC"}
1
+ {"version":3,"file":"voice.mjs","sourceRoot":"","sources":["../../src/resources/voice/voice.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EACL,SAAS,GAKV;OACM,KAAK,YAAY;OACjB,EAAE,SAAS,EAA2B;OACtC,KAAK,gBAAgB;OACrB,EACL,aAAa,GAId;OACM,KAAK,KAAK;OACV,EAAE,EAAE,EAA4C;AAEvD,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,OAAE,GAAa,IAAI,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;CAAA;AAED,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;AAC5B,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;AAC5B,KAAK,CAAC,aAAa,GAAG,aAAa,CAAC;AACpC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC"}
@@ -230,7 +230,10 @@ export namespace AgentCreateParams {
230
230
  }
231
231
 
232
232
  export interface AgentUpdateParams {
233
- description?: string;
233
+ /**
234
+ * Updated agent description. Pass null to clear if supported by the client.
235
+ */
236
+ description?: string | null;
234
237
 
235
238
  /**
236
239
  * Denylist of tools the agent cannot use. Mutually exclusive with enabledTools —
@@ -244,16 +247,34 @@ export interface AgentUpdateParams {
244
247
  */
245
248
  enabledTools?: Array<string> | null;
246
249
 
250
+ /**
251
+ * Updated system instructions that guide agent behavior
252
+ */
247
253
  instructions?: string;
248
254
 
255
+ /**
256
+ * Model identifier the agent should use for future runs
257
+ */
249
258
  model?: string;
250
259
 
260
+ /**
261
+ * Updated agent display name
262
+ */
251
263
  name?: string;
252
264
 
265
+ /**
266
+ * Sandbox configuration override for future agent runs. Pass null to clear.
267
+ */
253
268
  sandbox?: unknown | null;
254
269
 
270
+ /**
271
+ * Vault group IDs the agent can access. Pass null to clear.
272
+ */
255
273
  vaultGroups?: Array<string> | null;
256
274
 
275
+ /**
276
+ * Vault IDs the agent can access directly. Pass null to clear.
277
+ */
257
278
  vaultIds?: Array<string> | null;
258
279
  }
259
280
 
@@ -183,7 +183,7 @@ export interface ChatReplyToQuestionParams {
183
183
  id: string;
184
184
 
185
185
  /**
186
- * Body param
186
+ * Body param: Answer selections for each prompt element in the pending question
187
187
  */
188
188
  answers: Array<Array<string>>;
189
189
  }
@@ -11,7 +11,9 @@ import { path } from '../../../internal/utils/path';
11
11
  */
12
12
  export class Deployments extends APIResource {
13
13
  /**
14
- * Trigger a new deployment for a project
14
+ * Creates a deployment for an existing project by fetching repository files from
15
+ * GitHub and uploading them to the hosting provider. Use ref to deploy a branch,
16
+ * tag, or commit other than the project default branch.
15
17
  */
16
18
  create(body: DeploymentCreateParams, options?: RequestOptions): APIPromise<void> {
17
19
  return this._client.post('/applications/v1/deployments', {
@@ -22,7 +24,8 @@ export class Deployments extends APIResource {
22
24
  }
23
25
 
24
26
  /**
25
- * Get details of a specific deployment including build logs
27
+ * Returns deployment details for one project in the authenticated organization.
28
+ * Set includeLogs=true to include recent build output in the response.
26
29
  */
27
30
  retrieve(id: string, query: DeploymentRetrieveParams, options?: RequestOptions): APIPromise<void> {
28
31
  return this._client.get(path`/applications/v1/deployments/${id}`, {
@@ -33,7 +36,8 @@ export class Deployments extends APIResource {
33
36
  }
34
37
 
35
38
  /**
36
- * List deployments for a project
39
+ * Lists recent deployments for one project in the authenticated organization. Use
40
+ * the optional filters to narrow results by target or deployment state.
37
41
  */
38
42
  list(query: DeploymentListParams, options?: RequestOptions): APIPromise<void> {
39
43
  return this._client.get('/applications/v1/deployments', {
@@ -44,7 +48,9 @@ export class Deployments extends APIResource {
44
48
  }
45
49
 
46
50
  /**
47
- * Cancel a running deployment
51
+ * Cancels a running deployment after verifying that the referenced project belongs
52
+ * to the authenticated organization. Use this when a build is stuck,
53
+ * misconfigured, or no longer needed.
48
54
  */
49
55
  cancel(id: string, body: DeploymentCancelParams, options?: RequestOptions): APIPromise<void> {
50
56
  return this._client.post(path`/applications/v1/deployments/${id}/cancel`, {
@@ -65,7 +71,9 @@ export class Deployments extends APIResource {
65
71
  }
66
72
 
67
73
  /**
68
- * Get build logs for a specific deployment
74
+ * Returns build and runtime log events for a deployment after verifying access to
75
+ * the owning project. Use this when you need detailed output for a failed or
76
+ * in-progress build.
69
77
  */
70
78
  getLogs(id: string, query: DeploymentGetLogsParams, options?: RequestOptions): APIPromise<void> {
71
79
  return this._client.get(path`/applications/v1/deployments/${id}/logs`, {
@@ -76,7 +84,9 @@ export class Deployments extends APIResource {
76
84
  }
77
85
 
78
86
  /**
79
- * Get the current status of a deployment
87
+ * Returns the current status of a deployment without fetching full build logs. Use
88
+ * this endpoint for lightweight polling while a deployment is building or waiting
89
+ * to become ready.
80
90
  */
81
91
  getStatus(id: string, options?: RequestOptions): APIPromise<void> {
82
92
  return this._client.get(path`/applications/v1/deployments/${id}/status`, {
@@ -99,36 +109,36 @@ export class Deployments extends APIResource {
99
109
 
100
110
  export interface DeploymentCreateParams {
101
111
  /**
102
- * Project ID
112
+ * Project ID to deploy
103
113
  */
104
114
  projectId: string;
105
115
 
106
116
  /**
107
- * Git ref (branch, tag, or commit) to deploy
117
+ * Git branch, tag, or commit to deploy. Defaults to the project branch.
108
118
  */
109
119
  ref?: string;
110
120
 
111
121
  /**
112
- * Deployment target
122
+ * Deployment target environment
113
123
  */
114
124
  target?: 'production' | 'preview';
115
125
  }
116
126
 
117
127
  export interface DeploymentRetrieveParams {
118
128
  /**
119
- * Project ID (for authorization)
129
+ * Project ID used to verify access to the deployment
120
130
  */
121
131
  projectId: string;
122
132
 
123
133
  /**
124
- * Include build logs
134
+ * Whether to include build logs in the response
125
135
  */
126
136
  includeLogs?: boolean;
127
137
  }
128
138
 
129
139
  export interface DeploymentListParams {
130
140
  /**
131
- * Project ID
141
+ * Project ID to list deployments for
132
142
  */
133
143
  projectId: string;
134
144
 
@@ -138,26 +148,26 @@ export interface DeploymentListParams {
138
148
  limit?: number;
139
149
 
140
150
  /**
141
- * Filter by deployment state
151
+ * Deployment state to filter by
142
152
  */
143
153
  state?: string;
144
154
 
145
155
  /**
146
- * Filter by deployment target
156
+ * Deployment target to filter by
147
157
  */
148
158
  target?: 'production' | 'staging';
149
159
  }
150
160
 
151
161
  export interface DeploymentCancelParams {
152
162
  /**
153
- * Project ID (for authorization)
163
+ * Project ID used to verify access to the deployment
154
164
  */
155
165
  projectId: string;
156
166
  }
157
167
 
158
168
  export interface DeploymentGetLogsParams {
159
169
  /**
160
- * Project ID (for authorization)
170
+ * Project ID used to verify access to the deployment
161
171
  */
162
172
  projectId: string;
163
173
  }
@@ -13,6 +13,7 @@ export {
13
13
  Projects,
14
14
  type ProjectListResponse,
15
15
  type ProjectCreateParams,
16
+ type ProjectListParams,
16
17
  type ProjectDeleteParams,
17
18
  type ProjectCreateDeploymentParams,
18
19
  type ProjectCreateDomainParams,
@@ -8,7 +8,9 @@ import { path } from '../../../internal/utils/path';
8
8
 
9
9
  export class Projects extends APIResource {
10
10
  /**
11
- * Create a new web application project
11
+ * Creates a new application project, validates GitHub access, provisions a default
12
+ * case.dev domain, and starts the deployment workflow. The initial response
13
+ * returns as soon as the workflow is queued so clients can poll for progress.
12
14
  */
13
15
  create(body: ProjectCreateParams, options?: RequestOptions): APIPromise<void> {
14
16
  return this._client.post('/applications/v1/projects', {
@@ -19,7 +21,9 @@ export class Projects extends APIResource {
19
21
  }
20
22
 
21
23
  /**
22
- * Get details of a specific web application project
24
+ * Returns project details, domains, and recent deployment information for one
25
+ * application project or deployed Thurgood app. Use this endpoint when you need a
26
+ * single record with hosting metadata for a details view.
23
27
  */
24
28
  retrieve(id: string, options?: RequestOptions): APIPromise<void> {
25
29
  return this._client.get(path`/applications/v1/projects/${id}`, {
@@ -29,14 +33,21 @@ export class Projects extends APIResource {
29
33
  }
30
34
 
31
35
  /**
32
- * List all web application projects
36
+ * Lists application projects and deployed Thurgood apps for the authenticated
37
+ * organization. Use enrich=true to include additional hosting metadata for
38
+ * projects linked to Vercel.
33
39
  */
34
- list(options?: RequestOptions): APIPromise<ProjectListResponse> {
35
- return this._client.get('/applications/v1/projects', options);
40
+ list(
41
+ query: ProjectListParams | null | undefined = {},
42
+ options?: RequestOptions,
43
+ ): APIPromise<ProjectListResponse> {
44
+ return this._client.get('/applications/v1/projects', { query, ...options });
36
45
  }
37
46
 
38
47
  /**
39
- * Delete a web application project
48
+ * Soft-deletes an application project or deployed Thurgood app from Case.dev. By
49
+ * default it also removes the linked hosting project; set deleteFromHosting=false
50
+ * to keep the external hosting resources intact.
40
51
  */
41
52
  delete(
42
53
  id: string,
@@ -52,7 +63,9 @@ export class Projects extends APIResource {
52
63
  }
53
64
 
54
65
  /**
55
- * Trigger a new deployment for a project.
66
+ * Starts a new deployment for an existing project using its saved repository and
67
+ * hosting configuration. Any environment variables passed in the request are
68
+ * merged into the deployment workflow before the build starts.
56
69
  */
57
70
  createDeployment(
58
71
  id: string,
@@ -130,7 +143,9 @@ export class Projects extends APIResource {
130
143
  }
131
144
 
132
145
  /**
133
- * List deployments for a specific project
146
+ * Lists deployments for one project in the authenticated organization. If the
147
+ * hosting project has not been created yet, this endpoint returns an empty list
148
+ * with a progress message instead of failing.
134
149
  */
135
150
  listDeployments(
136
151
  id: string,
@@ -172,40 +187,85 @@ export class Projects extends APIResource {
172
187
  }
173
188
 
174
189
  export interface ProjectListResponse {
190
+ /**
191
+ * Projects and deployed apps visible to the organization
192
+ */
175
193
  projects?: Array<ProjectListResponse.Project>;
176
194
  }
177
195
 
178
196
  export namespace ProjectListResponse {
179
197
  export interface Project {
198
+ /**
199
+ * Project identifier
200
+ */
180
201
  id?: string;
181
202
 
203
+ /**
204
+ * When the project record was created
205
+ */
182
206
  createdAt?: string;
183
207
 
208
+ /**
209
+ * Custom or generated domains assigned to the project
210
+ */
184
211
  domains?: Array<Project.Domain>;
185
212
 
213
+ /**
214
+ * Detected or configured application framework
215
+ */
186
216
  framework?: string;
187
217
 
218
+ /**
219
+ * Default Git branch used for deployments
220
+ */
188
221
  gitBranch?: string;
189
222
 
223
+ /**
224
+ * Connected Git repository in owner/repo format
225
+ */
190
226
  gitRepo?: string;
191
227
 
228
+ /**
229
+ * Project display name
230
+ */
192
231
  name?: string;
193
232
 
233
+ /**
234
+ * Current project deployment status
235
+ */
194
236
  status?: string;
195
237
 
238
+ /**
239
+ * When the project record was last updated
240
+ */
196
241
  updatedAt?: string;
197
242
 
243
+ /**
244
+ * Hosting provider project ID, when linked
245
+ */
198
246
  vercelProjectId?: string;
199
247
  }
200
248
 
201
249
  export namespace Project {
202
250
  export interface Domain {
251
+ /**
252
+ * Domain record identifier
253
+ */
203
254
  id?: string;
204
255
 
256
+ /**
257
+ * Hostname assigned to the project
258
+ */
205
259
  domain?: string;
206
260
 
261
+ /**
262
+ * Whether this is the primary project domain
263
+ */
207
264
  isPrimary?: boolean;
208
265
 
266
+ /**
267
+ * Whether the domain has been verified by the hosting provider
268
+ */
209
269
  isVerified?: boolean;
210
270
  }
211
271
  }
@@ -213,47 +273,47 @@ export namespace ProjectListResponse {
213
273
 
214
274
  export interface ProjectCreateParams {
215
275
  /**
216
- * GitHub repository URL or "owner/repo"
276
+ * GitHub repository URL or owner/repo identifier
217
277
  */
218
278
  gitRepo: string;
219
279
 
220
280
  /**
221
- * Project name
281
+ * Human-readable project name
222
282
  */
223
283
  name: string;
224
284
 
225
285
  /**
226
- * Custom build command
286
+ * Custom build command to override the framework default
227
287
  */
228
288
  buildCommand?: string;
229
289
 
230
290
  /**
231
- * Environment variables to set on the project
291
+ * Environment variables to create before the first deployment
232
292
  */
233
293
  environmentVariables?: Array<ProjectCreateParams.EnvironmentVariable>;
234
294
 
235
295
  /**
236
- * Framework (e.g., "nextjs", "remix", "astro")
296
+ * Framework preset for the hosting project, such as nextjs or remix
237
297
  */
238
298
  framework?: string;
239
299
 
240
300
  /**
241
- * Git branch to deploy
301
+ * Git branch to deploy. Defaults to main.
242
302
  */
243
303
  gitBranch?: string;
244
304
 
245
305
  /**
246
- * Custom install command
306
+ * Custom install command to override the framework default
247
307
  */
248
308
  installCommand?: string;
249
309
 
250
310
  /**
251
- * Build output directory
311
+ * Build output directory relative to the project root
252
312
  */
253
313
  outputDirectory?: string;
254
314
 
255
315
  /**
256
- * Root directory of the project
316
+ * Repository subdirectory that contains the app to deploy
257
317
  */
258
318
  rootDirectory?: string;
259
319
  }
@@ -266,7 +326,7 @@ export namespace ProjectCreateParams {
266
326
  key: string;
267
327
 
268
328
  /**
269
- * Deployment targets for this variable
329
+ * Deployment targets that should receive this variable
270
330
  */
271
331
  target: Array<'production' | 'preview' | 'development'>;
272
332
 
@@ -276,15 +336,27 @@ export namespace ProjectCreateParams {
276
336
  value: string;
277
337
 
278
338
  /**
279
- * Variable type
339
+ * Storage mode for the environment variable value
280
340
  */
281
341
  type?: 'plain' | 'encrypted' | 'secret';
282
342
  }
283
343
  }
284
344
 
345
+ export interface ProjectListParams {
346
+ /**
347
+ * Whether to include additional hosting metadata from Vercel
348
+ */
349
+ enrich?: boolean;
350
+
351
+ /**
352
+ * Maximum number of projects to return from each backing source
353
+ */
354
+ limit?: number;
355
+ }
356
+
285
357
  export interface ProjectDeleteParams {
286
358
  /**
287
- * Also delete the project from hosting (default: true)
359
+ * Whether to also delete the linked hosting project. Defaults to true.
288
360
  */
289
361
  deleteFromHosting?: boolean;
290
362
  }
@@ -304,7 +376,7 @@ export namespace ProjectCreateDeploymentParams {
304
376
  key: string;
305
377
 
306
378
  /**
307
- * Deployment targets for this variable
379
+ * Deployment targets that should receive this variable
308
380
  */
309
381
  target: Array<'production' | 'preview' | 'development'>;
310
382
 
@@ -314,7 +386,7 @@ export namespace ProjectCreateDeploymentParams {
314
386
  value: string;
315
387
 
316
388
  /**
317
- * Variable type
389
+ * Storage mode for the environment variable value
318
390
  */
319
391
  type?: 'plain' | 'encrypted' | 'secret';
320
392
  }
@@ -387,12 +459,12 @@ export interface ProjectListDeploymentsParams {
387
459
  limit?: number;
388
460
 
389
461
  /**
390
- * Filter by deployment state
462
+ * Deployment state to filter by
391
463
  */
392
464
  state?: string;
393
465
 
394
466
  /**
395
- * Filter by deployment target
467
+ * Deployment target to filter by
396
468
  */
397
469
  target?: 'production' | 'staging';
398
470
  }
@@ -408,6 +480,7 @@ export declare namespace Projects {
408
480
  export {
409
481
  type ProjectListResponse as ProjectListResponse,
410
482
  type ProjectCreateParams as ProjectCreateParams,
483
+ type ProjectListParams as ProjectListParams,
411
484
  type ProjectDeleteParams as ProjectDeleteParams,
412
485
  type ProjectCreateDeploymentParams as ProjectCreateDeploymentParams,
413
486
  type ProjectCreateDomainParams as ProjectCreateDomainParams,
@@ -23,6 +23,7 @@ import {
23
23
  ProjectGetRuntimeLogsParams,
24
24
  ProjectListDeploymentsParams,
25
25
  ProjectListEnvParams,
26
+ ProjectListParams,
26
27
  ProjectListResponse,
27
28
  Projects,
28
29
  } from './projects';
@@ -54,6 +55,7 @@ export declare namespace V1 {
54
55
  Projects as Projects,
55
56
  type ProjectListResponse as ProjectListResponse,
56
57
  type ProjectCreateParams as ProjectCreateParams,
58
+ type ProjectListParams as ProjectListParams,
57
59
  type ProjectDeleteParams as ProjectDeleteParams,
58
60
  type ProjectCreateDeploymentParams as ProjectCreateDeploymentParams,
59
61
  type ProjectCreateDomainParams as ProjectCreateDomainParams,
@@ -51,10 +51,18 @@ export interface V1CreateDocumentParams {
51
51
  */
52
52
  input_format?: 'md' | 'json' | 'text';
53
53
 
54
+ /**
55
+ * Optional template composition and styling settings used during document
56
+ * generation
57
+ */
54
58
  options?: V1CreateDocumentParams.Options;
55
59
  }
56
60
 
57
61
  export namespace V1CreateDocumentParams {
62
+ /**
63
+ * Optional template composition and styling settings used during document
64
+ * generation
65
+ */
58
66
  export interface Options {
59
67
  /**
60
68
  * Template components with variables