vellum-ai 0.8.24 → 0.8.25

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 (199) hide show
  1. package/.mock/definition/__package__.yml +141 -0
  2. package/.mock/definition/folderEntities.yml +91 -2
  3. package/.mock/openapi/openapi.yml +300 -2
  4. package/Client.d.ts +3 -3
  5. package/Client.js +11 -11
  6. package/api/resources/adHoc/client/Client.d.ts +3 -3
  7. package/api/resources/adHoc/client/Client.js +2 -2
  8. package/api/resources/deployments/client/Client.d.ts +3 -3
  9. package/api/resources/deployments/client/Client.js +6 -6
  10. package/api/resources/documentIndexes/client/Client.d.ts +3 -3
  11. package/api/resources/documentIndexes/client/Client.js +9 -9
  12. package/api/resources/documents/client/Client.d.ts +3 -3
  13. package/api/resources/documents/client/Client.js +6 -6
  14. package/api/resources/folderEntities/client/Client.d.ts +22 -4
  15. package/api/resources/folderEntities/client/Client.js +80 -4
  16. package/api/resources/folderEntities/client/requests/FolderEntitiesListRequest.d.ts +43 -0
  17. package/api/resources/folderEntities/client/requests/FolderEntitiesListRequest.js +5 -0
  18. package/api/resources/folderEntities/client/requests/index.d.ts +1 -0
  19. package/api/resources/folderEntities/index.d.ts +1 -0
  20. package/api/resources/folderEntities/index.js +1 -0
  21. package/api/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.d.ts +8 -0
  22. package/api/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.js +10 -0
  23. package/api/resources/folderEntities/types/index.d.ts +1 -0
  24. package/api/resources/folderEntities/types/index.js +17 -0
  25. package/api/resources/index.d.ts +2 -1
  26. package/api/resources/index.js +3 -2
  27. package/api/resources/metricDefinitions/client/Client.d.ts +3 -3
  28. package/api/resources/metricDefinitions/client/Client.js +2 -2
  29. package/api/resources/sandboxes/client/Client.d.ts +3 -3
  30. package/api/resources/sandboxes/client/Client.js +4 -4
  31. package/api/resources/testSuiteRuns/client/Client.d.ts +3 -3
  32. package/api/resources/testSuiteRuns/client/Client.js +4 -4
  33. package/api/resources/testSuites/client/Client.d.ts +3 -3
  34. package/api/resources/testSuites/client/Client.js +5 -5
  35. package/api/resources/workflowDeployments/client/Client.d.ts +3 -3
  36. package/api/resources/workflowDeployments/client/Client.js +5 -5
  37. package/api/resources/workflowSandboxes/client/Client.d.ts +3 -3
  38. package/api/resources/workflowSandboxes/client/Client.js +2 -2
  39. package/api/types/FolderEntity.d.ts +5 -0
  40. package/api/types/FolderEntity.js +5 -0
  41. package/api/types/FolderEntityDocumentIndex.d.ts +12 -0
  42. package/api/types/FolderEntityDocumentIndex.js +5 -0
  43. package/api/types/FolderEntityDocumentIndexData.d.ts +11 -0
  44. package/api/types/FolderEntityDocumentIndexData.js +5 -0
  45. package/api/types/FolderEntityFolder.d.ts +12 -0
  46. package/api/types/FolderEntityFolder.js +5 -0
  47. package/api/types/FolderEntityFolderData.d.ts +10 -0
  48. package/api/types/FolderEntityFolderData.js +5 -0
  49. package/api/types/FolderEntityPromptSandbox.d.ts +12 -0
  50. package/api/types/FolderEntityPromptSandbox.js +5 -0
  51. package/api/types/FolderEntityPromptSandboxData.d.ts +12 -0
  52. package/api/types/FolderEntityPromptSandboxData.js +5 -0
  53. package/api/types/FolderEntityTestSuite.d.ts +12 -0
  54. package/api/types/FolderEntityTestSuite.js +5 -0
  55. package/api/types/FolderEntityTestSuiteData.d.ts +11 -0
  56. package/api/types/FolderEntityTestSuiteData.js +5 -0
  57. package/api/types/FolderEntityWorkflowSandbox.d.ts +12 -0
  58. package/api/types/FolderEntityWorkflowSandbox.js +5 -0
  59. package/api/types/FolderEntityWorkflowSandboxData.d.ts +12 -0
  60. package/api/types/FolderEntityWorkflowSandboxData.js +5 -0
  61. package/api/types/PaginatedFolderEntityList.d.ts +10 -0
  62. package/api/types/PaginatedFolderEntityList.js +5 -0
  63. package/api/types/index.d.ts +12 -0
  64. package/api/types/index.js +12 -0
  65. package/dist/Client.d.ts +3 -3
  66. package/dist/Client.js +11 -11
  67. package/dist/api/resources/adHoc/client/Client.d.ts +3 -3
  68. package/dist/api/resources/adHoc/client/Client.js +2 -2
  69. package/dist/api/resources/deployments/client/Client.d.ts +3 -3
  70. package/dist/api/resources/deployments/client/Client.js +6 -6
  71. package/dist/api/resources/documentIndexes/client/Client.d.ts +3 -3
  72. package/dist/api/resources/documentIndexes/client/Client.js +9 -9
  73. package/dist/api/resources/documents/client/Client.d.ts +3 -3
  74. package/dist/api/resources/documents/client/Client.js +6 -6
  75. package/dist/api/resources/folderEntities/client/Client.d.ts +22 -4
  76. package/dist/api/resources/folderEntities/client/Client.js +80 -4
  77. package/dist/api/resources/folderEntities/client/requests/FolderEntitiesListRequest.d.ts +43 -0
  78. package/dist/api/resources/folderEntities/client/requests/FolderEntitiesListRequest.js +5 -0
  79. package/dist/api/resources/folderEntities/client/requests/index.d.ts +1 -0
  80. package/dist/api/resources/folderEntities/index.d.ts +1 -0
  81. package/dist/api/resources/folderEntities/index.js +1 -0
  82. package/dist/api/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.d.ts +8 -0
  83. package/dist/api/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.js +10 -0
  84. package/dist/api/resources/folderEntities/types/index.d.ts +1 -0
  85. package/dist/api/resources/folderEntities/types/index.js +17 -0
  86. package/dist/api/resources/index.d.ts +2 -1
  87. package/dist/api/resources/index.js +3 -2
  88. package/dist/api/resources/metricDefinitions/client/Client.d.ts +3 -3
  89. package/dist/api/resources/metricDefinitions/client/Client.js +2 -2
  90. package/dist/api/resources/sandboxes/client/Client.d.ts +3 -3
  91. package/dist/api/resources/sandboxes/client/Client.js +4 -4
  92. package/dist/api/resources/testSuiteRuns/client/Client.d.ts +3 -3
  93. package/dist/api/resources/testSuiteRuns/client/Client.js +4 -4
  94. package/dist/api/resources/testSuites/client/Client.d.ts +3 -3
  95. package/dist/api/resources/testSuites/client/Client.js +5 -5
  96. package/dist/api/resources/workflowDeployments/client/Client.d.ts +3 -3
  97. package/dist/api/resources/workflowDeployments/client/Client.js +5 -5
  98. package/dist/api/resources/workflowSandboxes/client/Client.d.ts +3 -3
  99. package/dist/api/resources/workflowSandboxes/client/Client.js +2 -2
  100. package/dist/api/types/FolderEntity.d.ts +5 -0
  101. package/dist/api/types/FolderEntity.js +5 -0
  102. package/dist/api/types/FolderEntityDocumentIndex.d.ts +12 -0
  103. package/dist/api/types/FolderEntityDocumentIndex.js +5 -0
  104. package/dist/api/types/FolderEntityDocumentIndexData.d.ts +11 -0
  105. package/dist/api/types/FolderEntityDocumentIndexData.js +5 -0
  106. package/dist/api/types/FolderEntityFolder.d.ts +12 -0
  107. package/dist/api/types/FolderEntityFolder.js +5 -0
  108. package/dist/api/types/FolderEntityFolderData.d.ts +10 -0
  109. package/dist/api/types/FolderEntityFolderData.js +5 -0
  110. package/dist/api/types/FolderEntityPromptSandbox.d.ts +12 -0
  111. package/dist/api/types/FolderEntityPromptSandbox.js +5 -0
  112. package/dist/api/types/FolderEntityPromptSandboxData.d.ts +12 -0
  113. package/dist/api/types/FolderEntityPromptSandboxData.js +5 -0
  114. package/dist/api/types/FolderEntityTestSuite.d.ts +12 -0
  115. package/dist/api/types/FolderEntityTestSuite.js +5 -0
  116. package/dist/api/types/FolderEntityTestSuiteData.d.ts +11 -0
  117. package/dist/api/types/FolderEntityTestSuiteData.js +5 -0
  118. package/dist/api/types/FolderEntityWorkflowSandbox.d.ts +12 -0
  119. package/dist/api/types/FolderEntityWorkflowSandbox.js +5 -0
  120. package/dist/api/types/FolderEntityWorkflowSandboxData.d.ts +12 -0
  121. package/dist/api/types/FolderEntityWorkflowSandboxData.js +5 -0
  122. package/dist/api/types/PaginatedFolderEntityList.d.ts +10 -0
  123. package/dist/api/types/PaginatedFolderEntityList.js +5 -0
  124. package/dist/api/types/index.d.ts +12 -0
  125. package/dist/api/types/index.js +12 -0
  126. package/dist/serialization/resources/folderEntities/index.d.ts +1 -0
  127. package/dist/serialization/resources/folderEntities/index.js +1 -0
  128. package/dist/serialization/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.d.ts +10 -0
  129. package/dist/serialization/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.js +31 -0
  130. package/dist/serialization/resources/folderEntities/types/index.d.ts +1 -0
  131. package/dist/serialization/resources/folderEntities/types/index.js +17 -0
  132. package/dist/serialization/resources/index.d.ts +2 -1
  133. package/dist/serialization/resources/index.js +3 -2
  134. package/dist/serialization/types/FolderEntity.d.ts +15 -0
  135. package/dist/serialization/types/FolderEntity.js +42 -0
  136. package/dist/serialization/types/FolderEntityDocumentIndex.d.ts +15 -0
  137. package/dist/serialization/types/FolderEntityDocumentIndex.js +36 -0
  138. package/dist/serialization/types/FolderEntityDocumentIndexData.d.ts +17 -0
  139. package/dist/serialization/types/FolderEntityDocumentIndexData.js +38 -0
  140. package/dist/serialization/types/FolderEntityFolder.d.ts +15 -0
  141. package/dist/serialization/types/FolderEntityFolder.js +36 -0
  142. package/dist/serialization/types/FolderEntityFolderData.d.ts +16 -0
  143. package/dist/serialization/types/FolderEntityFolderData.js +37 -0
  144. package/dist/serialization/types/FolderEntityPromptSandbox.d.ts +15 -0
  145. package/dist/serialization/types/FolderEntityPromptSandbox.js +36 -0
  146. package/dist/serialization/types/FolderEntityPromptSandboxData.d.ts +18 -0
  147. package/dist/serialization/types/FolderEntityPromptSandboxData.js +39 -0
  148. package/dist/serialization/types/FolderEntityTestSuite.d.ts +15 -0
  149. package/dist/serialization/types/FolderEntityTestSuite.js +36 -0
  150. package/dist/serialization/types/FolderEntityTestSuiteData.d.ts +17 -0
  151. package/dist/serialization/types/FolderEntityTestSuiteData.js +38 -0
  152. package/dist/serialization/types/FolderEntityWorkflowSandbox.d.ts +15 -0
  153. package/dist/serialization/types/FolderEntityWorkflowSandbox.js +36 -0
  154. package/dist/serialization/types/FolderEntityWorkflowSandboxData.d.ts +18 -0
  155. package/dist/serialization/types/FolderEntityWorkflowSandboxData.js +39 -0
  156. package/dist/serialization/types/PaginatedFolderEntityList.d.ts +16 -0
  157. package/dist/serialization/types/PaginatedFolderEntityList.js +37 -0
  158. package/dist/serialization/types/index.d.ts +12 -0
  159. package/dist/serialization/types/index.js +12 -0
  160. package/dist/version.d.ts +1 -1
  161. package/dist/version.js +1 -1
  162. package/package.json +1 -1
  163. package/reference.md +74 -1
  164. package/serialization/resources/folderEntities/index.d.ts +1 -0
  165. package/serialization/resources/folderEntities/index.js +1 -0
  166. package/serialization/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.d.ts +10 -0
  167. package/serialization/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.js +31 -0
  168. package/serialization/resources/folderEntities/types/index.d.ts +1 -0
  169. package/serialization/resources/folderEntities/types/index.js +17 -0
  170. package/serialization/resources/index.d.ts +2 -1
  171. package/serialization/resources/index.js +3 -2
  172. package/serialization/types/FolderEntity.d.ts +15 -0
  173. package/serialization/types/FolderEntity.js +42 -0
  174. package/serialization/types/FolderEntityDocumentIndex.d.ts +15 -0
  175. package/serialization/types/FolderEntityDocumentIndex.js +36 -0
  176. package/serialization/types/FolderEntityDocumentIndexData.d.ts +17 -0
  177. package/serialization/types/FolderEntityDocumentIndexData.js +38 -0
  178. package/serialization/types/FolderEntityFolder.d.ts +15 -0
  179. package/serialization/types/FolderEntityFolder.js +36 -0
  180. package/serialization/types/FolderEntityFolderData.d.ts +16 -0
  181. package/serialization/types/FolderEntityFolderData.js +37 -0
  182. package/serialization/types/FolderEntityPromptSandbox.d.ts +15 -0
  183. package/serialization/types/FolderEntityPromptSandbox.js +36 -0
  184. package/serialization/types/FolderEntityPromptSandboxData.d.ts +18 -0
  185. package/serialization/types/FolderEntityPromptSandboxData.js +39 -0
  186. package/serialization/types/FolderEntityTestSuite.d.ts +15 -0
  187. package/serialization/types/FolderEntityTestSuite.js +36 -0
  188. package/serialization/types/FolderEntityTestSuiteData.d.ts +17 -0
  189. package/serialization/types/FolderEntityTestSuiteData.js +38 -0
  190. package/serialization/types/FolderEntityWorkflowSandbox.d.ts +15 -0
  191. package/serialization/types/FolderEntityWorkflowSandbox.js +36 -0
  192. package/serialization/types/FolderEntityWorkflowSandboxData.d.ts +18 -0
  193. package/serialization/types/FolderEntityWorkflowSandboxData.js +39 -0
  194. package/serialization/types/PaginatedFolderEntityList.d.ts +16 -0
  195. package/serialization/types/PaginatedFolderEntityList.js +37 -0
  196. package/serialization/types/index.d.ts +12 -0
  197. package/serialization/types/index.js +12 -0
  198. package/version.d.ts +1 -1
  199. package/version.js +1 -1
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../index";
5
+ /**
6
+ * A slim representation of a Prompt Sandbox, as it exists within a Folder.
7
+ */
8
+ export interface FolderEntityPromptSandbox {
9
+ id: string;
10
+ type: "PROMPT_SANDBOX";
11
+ data: Vellum.FolderEntityPromptSandboxData;
12
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../index";
5
+ export interface FolderEntityPromptSandboxData {
6
+ id: string;
7
+ label: string;
8
+ created: Date;
9
+ modified: Date;
10
+ status: Vellum.EntityStatus;
11
+ lastDeployedOn?: Date;
12
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../index";
5
+ /**
6
+ * A slim representation of a Test Suite, as it exists within a Folder.
7
+ */
8
+ export interface FolderEntityTestSuite {
9
+ id: string;
10
+ type: "TEST_SUITE";
11
+ data: Vellum.FolderEntityTestSuiteData;
12
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../index";
5
+ export interface FolderEntityTestSuiteData {
6
+ id: string;
7
+ label: string;
8
+ created: Date;
9
+ modified: Date;
10
+ status: Vellum.EntityStatus;
11
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../index";
5
+ /**
6
+ * A slim representation of a Workflow Sandbox, as it exists within a Folder.
7
+ */
8
+ export interface FolderEntityWorkflowSandbox {
9
+ id: string;
10
+ type: "WORKFLOW_SANDBOX";
11
+ data: Vellum.FolderEntityWorkflowSandboxData;
12
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../index";
5
+ export interface FolderEntityWorkflowSandboxData {
6
+ id: string;
7
+ label: string;
8
+ created: Date;
9
+ modified: Date;
10
+ status: Vellum.EntityStatus;
11
+ lastDeployedOn?: Date;
12
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../index";
5
+ export interface PaginatedFolderEntityList {
6
+ count?: number;
7
+ next?: string;
8
+ previous?: string;
9
+ results?: Vellum.FolderEntity[];
10
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -94,6 +94,17 @@ export * from "./ExecutionVellumValue";
94
94
  export * from "./ExternalTestCaseExecution";
95
95
  export * from "./ExternalTestCaseExecutionRequest";
96
96
  export * from "./FinishReasonEnum";
97
+ export * from "./FolderEntity";
98
+ export * from "./FolderEntityDocumentIndex";
99
+ export * from "./FolderEntityDocumentIndexData";
100
+ export * from "./FolderEntityFolder";
101
+ export * from "./FolderEntityFolderData";
102
+ export * from "./FolderEntityPromptSandbox";
103
+ export * from "./FolderEntityPromptSandboxData";
104
+ export * from "./FolderEntityTestSuite";
105
+ export * from "./FolderEntityTestSuiteData";
106
+ export * from "./FolderEntityWorkflowSandbox";
107
+ export * from "./FolderEntityWorkflowSandboxData";
97
108
  export * from "./FulfilledAdHocExecutePromptEvent";
98
109
  export * from "./FulfilledEnum";
99
110
  export * from "./FulfilledExecutePromptEvent";
@@ -220,6 +231,7 @@ export * from "./OpenAiVectorizerTextEmbedding3SmallRequest";
220
231
  export * from "./OpenAiVectorizerTextEmbeddingAda002";
221
232
  export * from "./OpenAiVectorizerTextEmbeddingAda002Request";
222
233
  export * from "./PaginatedDocumentIndexReadList";
234
+ export * from "./PaginatedFolderEntityList";
223
235
  export * from "./PaginatedSlimDeploymentReadList";
224
236
  export * from "./PaginatedSlimDocumentList";
225
237
  export * from "./PaginatedSlimWorkflowDeploymentList";
@@ -110,6 +110,17 @@ __exportStar(require("./ExecutionVellumValue"), exports);
110
110
  __exportStar(require("./ExternalTestCaseExecution"), exports);
111
111
  __exportStar(require("./ExternalTestCaseExecutionRequest"), exports);
112
112
  __exportStar(require("./FinishReasonEnum"), exports);
113
+ __exportStar(require("./FolderEntity"), exports);
114
+ __exportStar(require("./FolderEntityDocumentIndex"), exports);
115
+ __exportStar(require("./FolderEntityDocumentIndexData"), exports);
116
+ __exportStar(require("./FolderEntityFolder"), exports);
117
+ __exportStar(require("./FolderEntityFolderData"), exports);
118
+ __exportStar(require("./FolderEntityPromptSandbox"), exports);
119
+ __exportStar(require("./FolderEntityPromptSandboxData"), exports);
120
+ __exportStar(require("./FolderEntityTestSuite"), exports);
121
+ __exportStar(require("./FolderEntityTestSuiteData"), exports);
122
+ __exportStar(require("./FolderEntityWorkflowSandbox"), exports);
123
+ __exportStar(require("./FolderEntityWorkflowSandboxData"), exports);
113
124
  __exportStar(require("./FulfilledAdHocExecutePromptEvent"), exports);
114
125
  __exportStar(require("./FulfilledEnum"), exports);
115
126
  __exportStar(require("./FulfilledExecutePromptEvent"), exports);
@@ -236,6 +247,7 @@ __exportStar(require("./OpenAiVectorizerTextEmbedding3SmallRequest"), exports);
236
247
  __exportStar(require("./OpenAiVectorizerTextEmbeddingAda002"), exports);
237
248
  __exportStar(require("./OpenAiVectorizerTextEmbeddingAda002Request"), exports);
238
249
  __exportStar(require("./PaginatedDocumentIndexReadList"), exports);
250
+ __exportStar(require("./PaginatedFolderEntityList"), exports);
239
251
  __exportStar(require("./PaginatedSlimDeploymentReadList"), exports);
240
252
  __exportStar(require("./PaginatedSlimDocumentList"), exports);
241
253
  __exportStar(require("./PaginatedSlimWorkflowDeploymentList"), exports);
package/dist/Client.d.ts CHANGED
@@ -18,7 +18,7 @@ import { WorkflowSandboxes } from "./api/resources/workflowSandboxes/client/Clie
18
18
  export declare namespace VellumClient {
19
19
  interface Options {
20
20
  environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
21
- apiKey: core.Supplier<string>;
21
+ apiKey?: core.Supplier<string | undefined>;
22
22
  }
23
23
  interface RequestOptions {
24
24
  /** The maximum time to wait for a response in seconds. */
@@ -31,7 +31,7 @@ export declare namespace VellumClient {
31
31
  }
32
32
  export declare class VellumClient {
33
33
  protected readonly _options: VellumClient.Options;
34
- constructor(_options: VellumClient.Options);
34
+ constructor(_options?: VellumClient.Options);
35
35
  /**
36
36
  * An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
37
37
  *
@@ -208,6 +208,6 @@ export declare class VellumClient {
208
208
  protected _workflowSandboxes: WorkflowSandboxes | undefined;
209
209
  get workflowSandboxes(): WorkflowSandboxes;
210
210
  protected _getCustomAuthorizationHeaders(): Promise<{
211
- X_API_KEY: string;
211
+ X_API_KEY: string | undefined;
212
212
  }>;
213
213
  }
package/dist/Client.js CHANGED
@@ -57,7 +57,7 @@ const Client_9 = require("./api/resources/testSuites/client/Client");
57
57
  const Client_10 = require("./api/resources/workflowDeployments/client/Client");
58
58
  const Client_11 = require("./api/resources/workflowSandboxes/client/Client");
59
59
  class VellumClient {
60
- constructor(_options) {
60
+ constructor(_options = {}) {
61
61
  this._options = _options;
62
62
  }
63
63
  /**
@@ -91,7 +91,7 @@ class VellumClient {
91
91
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
92
92
  .default, "v1/execute-code"),
93
93
  method: "POST",
94
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
94
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
95
95
  contentType: "application/json",
96
96
  requestType: "json",
97
97
  body: serializers.CodeExecutorRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -160,7 +160,7 @@ class VellumClient {
160
160
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
161
161
  .predict, "v1/execute-prompt"),
162
162
  method: "POST",
163
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
163
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
164
164
  contentType: "application/json",
165
165
  requestType: "json",
166
166
  body: serializers.ExecutePromptRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -218,7 +218,7 @@ class VellumClient {
218
218
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
219
219
  .predict, "v1/execute-prompt-stream"),
220
220
  method: "POST",
221
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
221
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
222
222
  contentType: "application/json",
223
223
  requestType: "json",
224
224
  body: serializers.ExecutePromptStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -303,7 +303,7 @@ class VellumClient {
303
303
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
304
304
  .predict, "v1/execute-workflow"),
305
305
  method: "POST",
306
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
306
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
307
307
  contentType: "application/json",
308
308
  requestType: "json",
309
309
  body: serializers.ExecuteWorkflowRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -359,7 +359,7 @@ class VellumClient {
359
359
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
360
360
  .predict, "v1/execute-workflow-stream"),
361
361
  method: "POST",
362
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
362
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
363
363
  contentType: "application/json",
364
364
  requestType: "json",
365
365
  body: serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -446,7 +446,7 @@ class VellumClient {
446
446
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
447
447
  .predict, "v1/generate"),
448
448
  method: "POST",
449
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
449
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
450
450
  contentType: "application/json",
451
451
  requestType: "json",
452
452
  body: serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -507,7 +507,7 @@ class VellumClient {
507
507
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
508
508
  .predict, "v1/generate-stream"),
509
509
  method: "POST",
510
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
510
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
511
511
  contentType: "application/json",
512
512
  requestType: "json",
513
513
  body: serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -588,7 +588,7 @@ class VellumClient {
588
588
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
589
589
  .predict, "v1/search"),
590
590
  method: "POST",
591
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
591
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
592
592
  contentType: "application/json",
593
593
  requestType: "json",
594
594
  body: serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -656,7 +656,7 @@ class VellumClient {
656
656
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
657
657
  .predict, "v1/submit-completion-actuals"),
658
658
  method: "POST",
659
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
659
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
660
660
  contentType: "application/json",
661
661
  requestType: "json",
662
662
  body: serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -719,7 +719,7 @@ class VellumClient {
719
719
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
720
720
  .predict, "v1/submit-workflow-execution-actuals"),
721
721
  method: "POST",
722
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
722
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
723
723
  contentType: "application/json",
724
724
  requestType: "json",
725
725
  body: serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
7
7
  export declare namespace AdHoc {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
10
- apiKey: core.Supplier<string>;
10
+ apiKey?: core.Supplier<string | undefined>;
11
11
  }
12
12
  interface RequestOptions {
13
13
  /** The maximum time to wait for a response in seconds. */
@@ -20,12 +20,12 @@ export declare namespace AdHoc {
20
20
  }
21
21
  export declare class AdHoc {
22
22
  protected readonly _options: AdHoc.Options;
23
- constructor(_options: AdHoc.Options);
23
+ constructor(_options?: AdHoc.Options);
24
24
  /**
25
25
  * An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
26
26
  */
27
27
  adhocExecutePromptStream(request: Vellum.AdHocExecutePromptStreamRequest, requestOptions?: AdHoc.RequestOptions): Promise<core.Stream<Vellum.AdHocExecutePromptEvent>>;
28
28
  protected _getCustomAuthorizationHeaders(): Promise<{
29
- X_API_KEY: string;
29
+ X_API_KEY: string | undefined;
30
30
  }>;
31
31
  }
@@ -46,7 +46,7 @@ const serializers = __importStar(require("../../../../serialization/index"));
46
46
  const url_join_1 = __importDefault(require("url-join"));
47
47
  const errors = __importStar(require("../../../../errors/index"));
48
48
  class AdHoc {
49
- constructor(_options) {
49
+ constructor(_options = {}) {
50
50
  this._options = _options;
51
51
  }
52
52
  /**
@@ -59,7 +59,7 @@ class AdHoc {
59
59
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
60
60
  .default, "v1/ad-hoc/execute-prompt-stream"),
61
61
  method: "POST",
62
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
62
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
63
63
  contentType: "application/json",
64
64
  requestType: "json",
65
65
  body: serializers.AdHocExecutePromptStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
7
7
  export declare namespace Deployments {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
10
- apiKey: core.Supplier<string>;
10
+ apiKey?: core.Supplier<string | undefined>;
11
11
  }
12
12
  interface RequestOptions {
13
13
  /** The maximum time to wait for a response in seconds. */
@@ -20,7 +20,7 @@ export declare namespace Deployments {
20
20
  }
21
21
  export declare class Deployments {
22
22
  protected readonly _options: Deployments.Options;
23
- constructor(_options: Deployments.Options);
23
+ constructor(_options?: Deployments.Options);
24
24
  /**
25
25
  * Used to list all Prompt Deployments.
26
26
  *
@@ -95,6 +95,6 @@ export declare class Deployments {
95
95
  */
96
96
  retrieveProviderPayload(request: Vellum.DeploymentProviderPayloadRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentProviderPayloadResponse>;
97
97
  protected _getCustomAuthorizationHeaders(): Promise<{
98
- X_API_KEY: string;
98
+ X_API_KEY: string | undefined;
99
99
  }>;
100
100
  }
@@ -46,7 +46,7 @@ const url_join_1 = __importDefault(require("url-join"));
46
46
  const serializers = __importStar(require("../../../../serialization/index"));
47
47
  const errors = __importStar(require("../../../../errors/index"));
48
48
  class Deployments {
49
- constructor(_options) {
49
+ constructor(_options = {}) {
50
50
  this._options = _options;
51
51
  }
52
52
  /**
@@ -79,7 +79,7 @@ class Deployments {
79
79
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
80
80
  .default, "v1/deployments"),
81
81
  method: "GET",
82
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
82
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
83
83
  contentType: "application/json",
84
84
  queryParameters: _queryParams,
85
85
  requestType: "json",
@@ -132,7 +132,7 @@ class Deployments {
132
132
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
133
133
  .default, `v1/deployments/${encodeURIComponent(id)}`),
134
134
  method: "GET",
135
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
135
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
136
136
  contentType: "application/json",
137
137
  requestType: "json",
138
138
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -185,7 +185,7 @@ class Deployments {
185
185
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
186
186
  .default, `v1/deployments/${encodeURIComponent(id)}/release-tags/${encodeURIComponent(name)}`),
187
187
  method: "GET",
188
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
188
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
189
189
  contentType: "application/json",
190
190
  requestType: "json",
191
191
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -239,7 +239,7 @@ class Deployments {
239
239
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
240
240
  .default, `v1/deployments/${encodeURIComponent(id)}/release-tags/${encodeURIComponent(name)}`),
241
241
  method: "PATCH",
242
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
242
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
243
243
  contentType: "application/json",
244
244
  requestType: "json",
245
245
  body: serializers.PatchedDeploymentReleaseTagUpdateRequest.jsonOrThrow(request, {
@@ -314,7 +314,7 @@ class Deployments {
314
314
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
315
315
  .default, "v1/deployments/provider-payload"),
316
316
  method: "POST",
317
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
317
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
318
318
  contentType: "application/json",
319
319
  requestType: "json",
320
320
  body: serializers.DeploymentProviderPayloadRequest.jsonOrThrow(request, {
@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
7
7
  export declare namespace DocumentIndexes {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
10
- apiKey: core.Supplier<string>;
10
+ apiKey?: core.Supplier<string | undefined>;
11
11
  }
12
12
  interface RequestOptions {
13
13
  /** The maximum time to wait for a response in seconds. */
@@ -20,7 +20,7 @@ export declare namespace DocumentIndexes {
20
20
  }
21
21
  export declare class DocumentIndexes {
22
22
  protected readonly _options: DocumentIndexes.Options;
23
- constructor(_options: DocumentIndexes.Options);
23
+ constructor(_options?: DocumentIndexes.Options);
24
24
  /**
25
25
  * Used to retrieve a list of Document Indexes.
26
26
  *
@@ -170,6 +170,6 @@ export declare class DocumentIndexes {
170
170
  */
171
171
  removeDocument(documentId: string, id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<void>;
172
172
  protected _getCustomAuthorizationHeaders(): Promise<{
173
- X_API_KEY: string;
173
+ X_API_KEY: string | undefined;
174
174
  }>;
175
175
  }
@@ -45,7 +45,7 @@ const url_join_1 = __importDefault(require("url-join"));
45
45
  const serializers = __importStar(require("../../../../serialization/index"));
46
46
  const errors = __importStar(require("../../../../errors/index"));
47
47
  class DocumentIndexes {
48
- constructor(_options) {
48
+ constructor(_options = {}) {
49
49
  this._options = _options;
50
50
  }
51
51
  /**
@@ -81,7 +81,7 @@ class DocumentIndexes {
81
81
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
82
82
  .default, "v1/document-indexes"),
83
83
  method: "GET",
84
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
84
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
85
85
  contentType: "application/json",
86
86
  queryParameters: _queryParams,
87
87
  requestType: "json",
@@ -196,7 +196,7 @@ class DocumentIndexes {
196
196
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
197
197
  .default, "v1/document-indexes"),
198
198
  method: "POST",
199
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
199
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
200
200
  contentType: "application/json",
201
201
  requestType: "json",
202
202
  body: serializers.DocumentIndexCreateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -249,7 +249,7 @@ class DocumentIndexes {
249
249
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
250
250
  .default, `v1/document-indexes/${encodeURIComponent(id)}`),
251
251
  method: "GET",
252
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
252
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
253
253
  contentType: "application/json",
254
254
  requestType: "json",
255
255
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -304,7 +304,7 @@ class DocumentIndexes {
304
304
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
305
305
  .default, `v1/document-indexes/${encodeURIComponent(id)}`),
306
306
  method: "PUT",
307
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
307
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
308
308
  contentType: "application/json",
309
309
  requestType: "json",
310
310
  body: serializers.DocumentIndexUpdateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -357,7 +357,7 @@ class DocumentIndexes {
357
357
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
358
358
  .documents, `v1/document-indexes/${encodeURIComponent(id)}`),
359
359
  method: "DELETE",
360
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
360
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
361
361
  contentType: "application/json",
362
362
  requestType: "json",
363
363
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -405,7 +405,7 @@ class DocumentIndexes {
405
405
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
406
406
  .default, `v1/document-indexes/${encodeURIComponent(id)}`),
407
407
  method: "PATCH",
408
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
408
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
409
409
  contentType: "application/json",
410
410
  requestType: "json",
411
411
  body: serializers.PatchedDocumentIndexUpdateRequest.jsonOrThrow(request, {
@@ -461,7 +461,7 @@ class DocumentIndexes {
461
461
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
462
462
  .default, `v1/document-indexes/${encodeURIComponent(id)}/documents/${encodeURIComponent(documentId)}`),
463
463
  method: "POST",
464
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
464
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
465
465
  contentType: "application/json",
466
466
  requestType: "json",
467
467
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -509,7 +509,7 @@ class DocumentIndexes {
509
509
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
510
510
  .documents, `v1/document-indexes/${encodeURIComponent(id)}/documents/${encodeURIComponent(documentId)}`),
511
511
  method: "DELETE",
512
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.24", "User-Agent": "vellum-ai/0.8.24", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
512
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.25", "User-Agent": "vellum-ai/0.8.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
513
513
  contentType: "application/json",
514
514
  requestType: "json",
515
515
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -10,7 +10,7 @@ import { Blob } from "buffer";
10
10
  export declare namespace Documents {
11
11
  interface Options {
12
12
  environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
13
- apiKey: core.Supplier<string>;
13
+ apiKey?: core.Supplier<string | undefined>;
14
14
  }
15
15
  interface RequestOptions {
16
16
  /** The maximum time to wait for a response in seconds. */
@@ -23,7 +23,7 @@ export declare namespace Documents {
23
23
  }
24
24
  export declare class Documents {
25
25
  protected readonly _options: Documents.Options;
26
- constructor(_options: Documents.Options);
26
+ constructor(_options?: Documents.Options);
27
27
  /**
28
28
  * Used to list documents. Optionally filter on supported fields.
29
29
  *
@@ -93,6 +93,6 @@ export declare class Documents {
93
93
  */
94
94
  upload(contents: File | fs.ReadStream | Blob, request: Vellum.UploadDocumentBodyRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.UploadDocumentResponse>;
95
95
  protected _getCustomAuthorizationHeaders(): Promise<{
96
- X_API_KEY: string;
96
+ X_API_KEY: string | undefined;
97
97
  }>;
98
98
  }