vellum-ai 0.9.4 → 0.9.5

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 (153) hide show
  1. package/.mock/definition/__package__.yml +28 -0
  2. package/.mock/definition/deployments.yml +50 -1
  3. package/.mock/definition/workflowDeployments.yml +49 -0
  4. package/.mock/definition/workflows.yml +15 -2
  5. package/.mock/openapi/openapi.yml +156 -1
  6. package/Client.js +10 -10
  7. package/api/resources/adHoc/client/Client.js +1 -1
  8. package/api/resources/containerImages/client/Client.js +4 -4
  9. package/api/resources/deployments/client/Client.d.ts +12 -1
  10. package/api/resources/deployments/client/Client.js +74 -6
  11. package/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.d.ts +23 -0
  12. package/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.js +5 -0
  13. package/api/resources/deployments/client/requests/index.d.ts +1 -0
  14. package/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +8 -0
  15. package/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +10 -0
  16. package/api/resources/deployments/types/index.d.ts +1 -0
  17. package/api/resources/deployments/types/index.js +1 -0
  18. package/api/resources/documentIndexes/client/Client.js +8 -8
  19. package/api/resources/documents/client/Client.js +5 -5
  20. package/api/resources/folderEntities/client/Client.js +2 -2
  21. package/api/resources/index.d.ts +2 -1
  22. package/api/resources/index.js +3 -2
  23. package/api/resources/metricDefinitions/client/Client.js +1 -1
  24. package/api/resources/sandboxes/client/Client.js +3 -3
  25. package/api/resources/testSuiteRuns/client/Client.js +3 -3
  26. package/api/resources/testSuites/client/Client.js +4 -4
  27. package/api/resources/workflowDeployments/client/Client.d.ts +11 -0
  28. package/api/resources/workflowDeployments/client/Client.js +72 -4
  29. package/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.d.ts +23 -0
  30. package/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.js +5 -0
  31. package/api/resources/workflowDeployments/client/requests/index.d.ts +1 -0
  32. package/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +8 -0
  33. package/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +10 -0
  34. package/api/resources/workflowDeployments/types/index.d.ts +1 -0
  35. package/api/resources/workflowDeployments/types/index.js +1 -0
  36. package/api/resources/workflowSandboxes/client/Client.js +1 -1
  37. package/api/resources/workflows/client/Client.d.ts +3 -2
  38. package/api/resources/workflows/client/Client.js +20 -7
  39. package/api/resources/workflows/client/requests/WorkflowsPullRequest.d.ts +13 -0
  40. package/api/resources/workflows/client/requests/WorkflowsPullRequest.js +5 -0
  41. package/api/resources/workflows/client/requests/index.d.ts +1 -0
  42. package/api/resources/workflows/index.d.ts +1 -0
  43. package/api/resources/workflows/index.js +1 -0
  44. package/api/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +8 -0
  45. package/api/resources/workflows/types/WorkflowsPullRequestFormat.js +10 -0
  46. package/api/resources/workflows/types/index.d.ts +1 -0
  47. package/api/resources/workflows/types/index.js +17 -0
  48. package/api/resources/workspaceSecrets/client/Client.js +2 -2
  49. package/api/types/PaginatedDeploymentReleaseTagReadList.d.ts +10 -0
  50. package/api/types/PaginatedDeploymentReleaseTagReadList.js +5 -0
  51. package/api/types/PaginatedWorkflowReleaseTagReadList.d.ts +10 -0
  52. package/api/types/PaginatedWorkflowReleaseTagReadList.js +5 -0
  53. package/api/types/index.d.ts +2 -0
  54. package/api/types/index.js +2 -0
  55. package/dist/Client.js +10 -10
  56. package/dist/api/resources/adHoc/client/Client.js +1 -1
  57. package/dist/api/resources/containerImages/client/Client.js +4 -4
  58. package/dist/api/resources/deployments/client/Client.d.ts +12 -1
  59. package/dist/api/resources/deployments/client/Client.js +74 -6
  60. package/dist/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.d.ts +23 -0
  61. package/dist/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.js +5 -0
  62. package/dist/api/resources/deployments/client/requests/index.d.ts +1 -0
  63. package/dist/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +8 -0
  64. package/dist/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +10 -0
  65. package/dist/api/resources/deployments/types/index.d.ts +1 -0
  66. package/dist/api/resources/deployments/types/index.js +1 -0
  67. package/dist/api/resources/documentIndexes/client/Client.js +8 -8
  68. package/dist/api/resources/documents/client/Client.js +5 -5
  69. package/dist/api/resources/folderEntities/client/Client.js +2 -2
  70. package/dist/api/resources/index.d.ts +2 -1
  71. package/dist/api/resources/index.js +3 -2
  72. package/dist/api/resources/metricDefinitions/client/Client.js +1 -1
  73. package/dist/api/resources/sandboxes/client/Client.js +3 -3
  74. package/dist/api/resources/testSuiteRuns/client/Client.js +3 -3
  75. package/dist/api/resources/testSuites/client/Client.js +4 -4
  76. package/dist/api/resources/workflowDeployments/client/Client.d.ts +11 -0
  77. package/dist/api/resources/workflowDeployments/client/Client.js +72 -4
  78. package/dist/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.d.ts +23 -0
  79. package/dist/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.js +5 -0
  80. package/dist/api/resources/workflowDeployments/client/requests/index.d.ts +1 -0
  81. package/dist/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +8 -0
  82. package/dist/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +10 -0
  83. package/dist/api/resources/workflowDeployments/types/index.d.ts +1 -0
  84. package/dist/api/resources/workflowDeployments/types/index.js +1 -0
  85. package/dist/api/resources/workflowSandboxes/client/Client.js +1 -1
  86. package/dist/api/resources/workflows/client/Client.d.ts +3 -2
  87. package/dist/api/resources/workflows/client/Client.js +20 -7
  88. package/dist/api/resources/workflows/client/requests/WorkflowsPullRequest.d.ts +13 -0
  89. package/dist/api/resources/workflows/client/requests/WorkflowsPullRequest.js +5 -0
  90. package/dist/api/resources/workflows/client/requests/index.d.ts +1 -0
  91. package/dist/api/resources/workflows/index.d.ts +1 -0
  92. package/dist/api/resources/workflows/index.js +1 -0
  93. package/dist/api/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +8 -0
  94. package/dist/api/resources/workflows/types/WorkflowsPullRequestFormat.js +10 -0
  95. package/dist/api/resources/workflows/types/index.d.ts +1 -0
  96. package/dist/api/resources/workflows/types/index.js +17 -0
  97. package/dist/api/resources/workspaceSecrets/client/Client.js +2 -2
  98. package/dist/api/types/PaginatedDeploymentReleaseTagReadList.d.ts +10 -0
  99. package/dist/api/types/PaginatedDeploymentReleaseTagReadList.js +5 -0
  100. package/dist/api/types/PaginatedWorkflowReleaseTagReadList.d.ts +10 -0
  101. package/dist/api/types/PaginatedWorkflowReleaseTagReadList.js +5 -0
  102. package/dist/api/types/index.d.ts +2 -0
  103. package/dist/api/types/index.js +2 -0
  104. package/dist/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +10 -0
  105. package/dist/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +31 -0
  106. package/dist/serialization/resources/deployments/types/index.d.ts +1 -0
  107. package/dist/serialization/resources/deployments/types/index.js +1 -0
  108. package/dist/serialization/resources/index.d.ts +2 -1
  109. package/dist/serialization/resources/index.js +3 -2
  110. package/dist/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +10 -0
  111. package/dist/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +31 -0
  112. package/dist/serialization/resources/workflowDeployments/types/index.d.ts +1 -0
  113. package/dist/serialization/resources/workflowDeployments/types/index.js +1 -0
  114. package/dist/serialization/resources/workflows/index.d.ts +1 -0
  115. package/dist/serialization/resources/workflows/index.js +1 -0
  116. package/dist/serialization/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +10 -0
  117. package/dist/serialization/resources/workflows/types/WorkflowsPullRequestFormat.js +31 -0
  118. package/dist/serialization/resources/workflows/types/index.d.ts +1 -0
  119. package/dist/serialization/resources/workflows/types/index.js +17 -0
  120. package/dist/serialization/types/PaginatedDeploymentReleaseTagReadList.d.ts +16 -0
  121. package/dist/serialization/types/PaginatedDeploymentReleaseTagReadList.js +37 -0
  122. package/dist/serialization/types/PaginatedWorkflowReleaseTagReadList.d.ts +16 -0
  123. package/dist/serialization/types/PaginatedWorkflowReleaseTagReadList.js +37 -0
  124. package/dist/serialization/types/index.d.ts +2 -0
  125. package/dist/serialization/types/index.js +2 -0
  126. package/dist/version.d.ts +1 -1
  127. package/dist/version.js +1 -1
  128. package/package.json +1 -1
  129. package/reference.md +155 -3
  130. package/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +10 -0
  131. package/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +31 -0
  132. package/serialization/resources/deployments/types/index.d.ts +1 -0
  133. package/serialization/resources/deployments/types/index.js +1 -0
  134. package/serialization/resources/index.d.ts +2 -1
  135. package/serialization/resources/index.js +3 -2
  136. package/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +10 -0
  137. package/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +31 -0
  138. package/serialization/resources/workflowDeployments/types/index.d.ts +1 -0
  139. package/serialization/resources/workflowDeployments/types/index.js +1 -0
  140. package/serialization/resources/workflows/index.d.ts +1 -0
  141. package/serialization/resources/workflows/index.js +1 -0
  142. package/serialization/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +10 -0
  143. package/serialization/resources/workflows/types/WorkflowsPullRequestFormat.js +31 -0
  144. package/serialization/resources/workflows/types/index.d.ts +1 -0
  145. package/serialization/resources/workflows/types/index.js +17 -0
  146. package/serialization/types/PaginatedDeploymentReleaseTagReadList.d.ts +16 -0
  147. package/serialization/types/PaginatedDeploymentReleaseTagReadList.js +37 -0
  148. package/serialization/types/PaginatedWorkflowReleaseTagReadList.d.ts +16 -0
  149. package/serialization/types/PaginatedWorkflowReleaseTagReadList.js +37 -0
  150. package/serialization/types/index.d.ts +2 -0
  151. package/serialization/types/index.js +2 -0
  152. package/version.d.ts +1 -1
  153. package/version.js +1 -1
@@ -3215,6 +3215,20 @@ types:
3215
3215
  results: optional<list<ContainerImageRead>>
3216
3216
  source:
3217
3217
  openapi: openapi/openapi.yml
3218
+ PaginatedDeploymentReleaseTagReadList:
3219
+ properties:
3220
+ count: optional<integer>
3221
+ next:
3222
+ type: optional<string>
3223
+ validation:
3224
+ format: uri
3225
+ previous:
3226
+ type: optional<string>
3227
+ validation:
3228
+ format: uri
3229
+ results: optional<list<DeploymentReleaseTagRead>>
3230
+ source:
3231
+ openapi: openapi/openapi.yml
3218
3232
  PaginatedDocumentIndexReadList:
3219
3233
  properties:
3220
3234
  count: optional<integer>
@@ -3313,6 +3327,20 @@ types:
3313
3327
  results: list<TestSuiteTestCase>
3314
3328
  source:
3315
3329
  openapi: openapi/openapi.yml
3330
+ PaginatedWorkflowReleaseTagReadList:
3331
+ properties:
3332
+ count: optional<integer>
3333
+ next:
3334
+ type: optional<string>
3335
+ validation:
3336
+ format: uri
3337
+ previous:
3338
+ type: optional<string>
3339
+ validation:
3340
+ format: uri
3341
+ results: optional<list<WorkflowReleaseTagRead>>
3342
+ source:
3343
+ openapi: openapi/openapi.yml
3316
3344
  PdfEnum: literal<"PDF">
3317
3345
  PdfSearchResultMetaSource:
3318
3346
  docs: The source of a search result from a PDF document.
@@ -5,6 +5,12 @@ types:
5
5
  - ARCHIVED
6
6
  source:
7
7
  openapi: openapi/openapi.yml
8
+ ListDeploymentReleaseTagsRequestSource:
9
+ enum:
10
+ - SYSTEM
11
+ - USER
12
+ source:
13
+ openapi: openapi/openapi.yml
8
14
  imports:
9
15
  root: __package__.yml
10
16
  service:
@@ -96,6 +102,49 @@ service:
96
102
  last_deployed_history_item_id: last_deployed_history_item_id
97
103
  audiences:
98
104
  - customers
105
+ list_deployment_release_tags:
106
+ path: /v1/deployments/{id}/release-tags
107
+ method: GET
108
+ auth: true
109
+ docs: List Release Tags associated with the specified Prompt Deployment
110
+ path-parameters:
111
+ id:
112
+ type: string
113
+ docs: Either the Prompt Deployment's ID or its unique name
114
+ request:
115
+ name: ListDeploymentReleaseTagsRequest
116
+ query-parameters:
117
+ limit:
118
+ type: optional<integer>
119
+ docs: Number of results to return per page.
120
+ offset:
121
+ type: optional<integer>
122
+ docs: The initial index from which to return the results.
123
+ ordering:
124
+ type: optional<string>
125
+ docs: Which field to use when ordering the results.
126
+ source: optional<ListDeploymentReleaseTagsRequestSource>
127
+ response:
128
+ docs: ''
129
+ type: root.PaginatedDeploymentReleaseTagReadList
130
+ url: Default
131
+ availability: pre-release
132
+ examples:
133
+ - path-parameters:
134
+ id: id
135
+ response:
136
+ body:
137
+ count: 123
138
+ next: http://api.example.org/accounts/?offset=400&limit=100
139
+ previous: http://api.example.org/accounts/?offset=200&limit=100
140
+ results:
141
+ - name: name
142
+ source: SYSTEM
143
+ history_item:
144
+ id: id
145
+ timestamp: '2024-01-15T09:30:00Z'
146
+ audiences:
147
+ - customers
99
148
  retrieve_deployment_release_tag:
100
149
  path: /v1/deployments/{id}/release-tags/{name}
101
150
  method: GET
@@ -135,7 +184,7 @@ service:
135
184
  method: PATCH
136
185
  auth: true
137
186
  docs: >-
138
- Updates an existing Release Tag associated with the specified
187
+ Updates an existing Release Tag associated with the specified Prompt
139
188
  Deployment.
140
189
  path-parameters:
141
190
  id:
@@ -5,6 +5,12 @@ types:
5
5
  - ARCHIVED
6
6
  source:
7
7
  openapi: openapi/openapi.yml
8
+ ListWorkflowReleaseTagsRequestSource:
9
+ enum:
10
+ - SYSTEM
11
+ - USER
12
+ source:
13
+ openapi: openapi/openapi.yml
8
14
  imports:
9
15
  root: __package__.yml
10
16
  service:
@@ -105,6 +111,49 @@ service:
105
111
  description: description
106
112
  audiences:
107
113
  - customers
114
+ list_workflow_release_tags:
115
+ path: /v1/workflow-deployments/{id}/release-tags
116
+ method: GET
117
+ auth: true
118
+ docs: List Release Tags associated with the specified Workflow Deployment
119
+ path-parameters:
120
+ id:
121
+ type: string
122
+ docs: Either the Workflow Deployment's ID or its unique name
123
+ request:
124
+ name: ListWorkflowReleaseTagsRequest
125
+ query-parameters:
126
+ limit:
127
+ type: optional<integer>
128
+ docs: Number of results to return per page.
129
+ offset:
130
+ type: optional<integer>
131
+ docs: The initial index from which to return the results.
132
+ ordering:
133
+ type: optional<string>
134
+ docs: Which field to use when ordering the results.
135
+ source: optional<ListWorkflowReleaseTagsRequestSource>
136
+ response:
137
+ docs: ''
138
+ type: root.PaginatedWorkflowReleaseTagReadList
139
+ url: Default
140
+ availability: pre-release
141
+ examples:
142
+ - path-parameters:
143
+ id: id
144
+ response:
145
+ body:
146
+ count: 123
147
+ next: http://api.example.org/accounts/?offset=400&limit=100
148
+ previous: http://api.example.org/accounts/?offset=200&limit=100
149
+ results:
150
+ - name: name
151
+ source: SYSTEM
152
+ history_item:
153
+ id: id
154
+ timestamp: '2024-01-15T09:30:00Z'
155
+ audiences:
156
+ - customers
108
157
  retrieve_workflow_release_tag:
109
158
  path: /v1/workflow-deployments/{id}/release-tags/{name}
110
159
  method: GET
@@ -1,3 +1,12 @@
1
+ types:
2
+ WorkflowsPullRequestFormat:
3
+ enum:
4
+ - json
5
+ - zip
6
+ source:
7
+ openapi: openapi/openapi.yml
8
+ imports:
9
+ root: __package__.yml
1
10
  service:
2
11
  auth: false
3
12
  base-path: ''
@@ -13,11 +22,17 @@ service:
13
22
  id:
14
23
  type: string
15
24
  docs: The ID of the Workflow to pull from
25
+ request:
26
+ name: WorkflowsPullRequest
27
+ query-parameters:
28
+ format: optional<WorkflowsPullRequestFormat>
16
29
  response:
17
30
  docs: ''
18
31
  type: file
19
32
  url: Default
20
33
  availability: pre-release
34
+ errors:
35
+ - root.BadRequestError
21
36
  audiences:
22
37
  - internal
23
38
  push:
@@ -59,5 +74,3 @@ service:
59
74
  - internal
60
75
  source:
61
76
  openapi: openapi/openapi.yml
62
- imports:
63
- root: __package__.yml
@@ -260,6 +260,56 @@ paths:
260
260
  x-fern-availability: beta
261
261
  x-fern-audiences:
262
262
  - customers
263
+ /v1/deployments/{id}/release-tags:
264
+ get:
265
+ operationId: list_deployment_release_tags
266
+ description: List Release Tags associated with the specified Prompt Deployment
267
+ parameters:
268
+ - in: path
269
+ name: id
270
+ schema:
271
+ type: string
272
+ description: Either the Prompt Deployment's ID or its unique name
273
+ required: true
274
+ - name: limit
275
+ required: false
276
+ in: query
277
+ description: Number of results to return per page.
278
+ schema:
279
+ type: integer
280
+ - name: offset
281
+ required: false
282
+ in: query
283
+ description: The initial index from which to return the results.
284
+ schema:
285
+ type: integer
286
+ - name: ordering
287
+ required: false
288
+ in: query
289
+ description: Which field to use when ordering the results.
290
+ schema:
291
+ type: string
292
+ - in: query
293
+ name: source
294
+ schema:
295
+ type: string
296
+ enum:
297
+ - SYSTEM
298
+ - USER
299
+ tags:
300
+ - deployments
301
+ security:
302
+ - apiKeyAuth: []
303
+ responses:
304
+ '200':
305
+ content:
306
+ application/json:
307
+ schema:
308
+ $ref: '#/components/schemas/PaginatedDeploymentReleaseTagReadList'
309
+ description: ''
310
+ x-fern-availability: beta
311
+ x-fern-audiences:
312
+ - customers
263
313
  /v1/deployments/{id}/release-tags/{name}:
264
314
  get:
265
315
  operationId: retrieve_deployment_release_tag
@@ -296,7 +346,8 @@ paths:
296
346
  - customers
297
347
  patch:
298
348
  operationId: update_deployment_release_tag
299
- description: Updates an existing Release Tag associated with the specified Deployment.
349
+ description: Updates an existing Release Tag associated with the specified Prompt
350
+ Deployment.
300
351
  parameters:
301
352
  - in: path
302
353
  name: id
@@ -1924,6 +1975,56 @@ paths:
1924
1975
  x-fern-availability: beta
1925
1976
  x-fern-audiences:
1926
1977
  - customers
1978
+ /v1/workflow-deployments/{id}/release-tags:
1979
+ get:
1980
+ operationId: list_workflow_release_tags
1981
+ description: List Release Tags associated with the specified Workflow Deployment
1982
+ parameters:
1983
+ - in: path
1984
+ name: id
1985
+ schema:
1986
+ type: string
1987
+ description: Either the Workflow Deployment's ID or its unique name
1988
+ required: true
1989
+ - name: limit
1990
+ required: false
1991
+ in: query
1992
+ description: Number of results to return per page.
1993
+ schema:
1994
+ type: integer
1995
+ - name: offset
1996
+ required: false
1997
+ in: query
1998
+ description: The initial index from which to return the results.
1999
+ schema:
2000
+ type: integer
2001
+ - name: ordering
2002
+ required: false
2003
+ in: query
2004
+ description: Which field to use when ordering the results.
2005
+ schema:
2006
+ type: string
2007
+ - in: query
2008
+ name: source
2009
+ schema:
2010
+ type: string
2011
+ enum:
2012
+ - SYSTEM
2013
+ - USER
2014
+ tags:
2015
+ - workflow-deployments
2016
+ security:
2017
+ - apiKeyAuth: []
2018
+ responses:
2019
+ '200':
2020
+ content:
2021
+ application/json:
2022
+ schema:
2023
+ $ref: '#/components/schemas/PaginatedWorkflowReleaseTagReadList'
2024
+ description: ''
2025
+ x-fern-availability: beta
2026
+ x-fern-audiences:
2027
+ - customers
1927
2028
  /v1/workflow-deployments/{id}/release-tags/{name}:
1928
2029
  get:
1929
2030
  operationId: retrieve_workflow_release_tag
@@ -2041,6 +2142,13 @@ paths:
2041
2142
  description: An internal-only endpoint that's subject to breaking changes without
2042
2143
  notice. Not intended for public use.
2043
2144
  parameters:
2145
+ - in: query
2146
+ name: format
2147
+ schema:
2148
+ type: string
2149
+ enum:
2150
+ - json
2151
+ - zip
2044
2152
  - in: path
2045
2153
  name: id
2046
2154
  schema:
@@ -2059,6 +2167,13 @@ paths:
2059
2167
  type: string
2060
2168
  format: binary
2061
2169
  description: ''
2170
+ '400':
2171
+ content:
2172
+ application/json:
2173
+ schema:
2174
+ type: object
2175
+ additionalProperties: {}
2176
+ description: ''
2062
2177
  x-fern-availability: beta
2063
2178
  x-fern-audiences:
2064
2179
  - internal
@@ -6684,6 +6799,26 @@ components:
6684
6799
  type: array
6685
6800
  items:
6686
6801
  $ref: '#/components/schemas/ContainerImageRead'
6802
+ PaginatedDeploymentReleaseTagReadList:
6803
+ type: object
6804
+ properties:
6805
+ count:
6806
+ type: integer
6807
+ example: 123
6808
+ next:
6809
+ type: string
6810
+ nullable: true
6811
+ format: uri
6812
+ example: http://api.example.org/accounts/?offset=400&limit=100
6813
+ previous:
6814
+ type: string
6815
+ nullable: true
6816
+ format: uri
6817
+ example: http://api.example.org/accounts/?offset=200&limit=100
6818
+ results:
6819
+ type: array
6820
+ items:
6821
+ $ref: '#/components/schemas/DeploymentReleaseTagRead'
6687
6822
  PaginatedDocumentIndexReadList:
6688
6823
  type: object
6689
6824
  properties:
@@ -6834,6 +6969,26 @@ components:
6834
6969
  - next
6835
6970
  - previous
6836
6971
  - results
6972
+ PaginatedWorkflowReleaseTagReadList:
6973
+ type: object
6974
+ properties:
6975
+ count:
6976
+ type: integer
6977
+ example: 123
6978
+ next:
6979
+ type: string
6980
+ nullable: true
6981
+ format: uri
6982
+ example: http://api.example.org/accounts/?offset=400&limit=100
6983
+ previous:
6984
+ type: string
6985
+ nullable: true
6986
+ format: uri
6987
+ example: http://api.example.org/accounts/?offset=200&limit=100
6988
+ results:
6989
+ type: array
6990
+ items:
6991
+ $ref: '#/components/schemas/WorkflowReleaseTagRead'
6837
6992
  PatchedDeploymentReleaseTagUpdateRequest:
6838
6993
  type: object
6839
6994
  properties:
package/Client.js CHANGED
@@ -94,7 +94,7 @@ class VellumClient {
94
94
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
95
95
  .default, "v1/execute-code"),
96
96
  method: "POST",
97
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
97
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
98
98
  contentType: "application/json",
99
99
  requestType: "json",
100
100
  body: serializers.CodeExecutorRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -163,7 +163,7 @@ class VellumClient {
163
163
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
164
164
  .predict, "v1/execute-prompt"),
165
165
  method: "POST",
166
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
166
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
167
167
  contentType: "application/json",
168
168
  requestType: "json",
169
169
  body: serializers.ExecutePromptRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -221,7 +221,7 @@ class VellumClient {
221
221
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
222
222
  .predict, "v1/execute-prompt-stream"),
223
223
  method: "POST",
224
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
224
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
225
225
  contentType: "application/json",
226
226
  requestType: "json",
227
227
  body: serializers.ExecutePromptStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -306,7 +306,7 @@ class VellumClient {
306
306
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
307
307
  .predict, "v1/execute-workflow"),
308
308
  method: "POST",
309
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
309
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
310
310
  contentType: "application/json",
311
311
  requestType: "json",
312
312
  body: serializers.ExecuteWorkflowRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -362,7 +362,7 @@ class VellumClient {
362
362
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
363
363
  .predict, "v1/execute-workflow-stream"),
364
364
  method: "POST",
365
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
365
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
366
366
  contentType: "application/json",
367
367
  requestType: "json",
368
368
  body: serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -449,7 +449,7 @@ class VellumClient {
449
449
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
450
450
  .predict, "v1/generate"),
451
451
  method: "POST",
452
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
452
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
453
453
  contentType: "application/json",
454
454
  requestType: "json",
455
455
  body: serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -510,7 +510,7 @@ class VellumClient {
510
510
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
511
511
  .predict, "v1/generate-stream"),
512
512
  method: "POST",
513
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
513
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
514
514
  contentType: "application/json",
515
515
  requestType: "json",
516
516
  body: serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -591,7 +591,7 @@ class VellumClient {
591
591
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
592
592
  .predict, "v1/search"),
593
593
  method: "POST",
594
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
594
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
595
595
  contentType: "application/json",
596
596
  requestType: "json",
597
597
  body: serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -659,7 +659,7 @@ class VellumClient {
659
659
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
660
660
  .predict, "v1/submit-completion-actuals"),
661
661
  method: "POST",
662
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
662
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
663
663
  contentType: "application/json",
664
664
  requestType: "json",
665
665
  body: serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -722,7 +722,7 @@ class VellumClient {
722
722
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
723
723
  .predict, "v1/submit-workflow-execution-actuals"),
724
724
  method: "POST",
725
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
725
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
726
726
  contentType: "application/json",
727
727
  requestType: "json",
728
728
  body: serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
@@ -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.9.4", "User-Agent": "vellum-ai/0.9.4", "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.9.5", "User-Agent": "vellum-ai/0.9.5", "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" }),
@@ -75,7 +75,7 @@ class ContainerImages {
75
75
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
76
76
  .default, "v1/container-images"),
77
77
  method: "GET",
78
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
79
79
  contentType: "application/json",
80
80
  queryParameters: _queryParams,
81
81
  requestType: "json",
@@ -128,7 +128,7 @@ class ContainerImages {
128
128
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
129
129
  .default, `v1/container-images/${encodeURIComponent(id)}`),
130
130
  method: "GET",
131
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
131
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
132
132
  contentType: "application/json",
133
133
  requestType: "json",
134
134
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -179,7 +179,7 @@ class ContainerImages {
179
179
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
180
180
  .default, "v1/container-images/docker-service-token"),
181
181
  method: "GET",
182
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
182
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
183
183
  contentType: "application/json",
184
184
  requestType: "json",
185
185
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -235,7 +235,7 @@ class ContainerImages {
235
235
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
236
236
  .default, "v1/container-images/push"),
237
237
  method: "POST",
238
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "vellum-ai/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
238
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.9.5", "User-Agent": "vellum-ai/0.9.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
239
239
  contentType: "application/json",
240
240
  requestType: "json",
241
241
  body: serializers.PushContainerImageRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -41,6 +41,17 @@ export declare class Deployments {
41
41
  * await client.deployments.retrieve("id")
42
42
  */
43
43
  retrieve(id: string, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentRead>;
44
+ /**
45
+ * List Release Tags associated with the specified Prompt Deployment
46
+ *
47
+ * @param {string} id - Either the Prompt Deployment's ID or its unique name
48
+ * @param {Vellum.ListDeploymentReleaseTagsRequest} request
49
+ * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
50
+ *
51
+ * @example
52
+ * await client.deployments.listDeploymentReleaseTags("id")
53
+ */
54
+ listDeploymentReleaseTags(id: string, request?: Vellum.ListDeploymentReleaseTagsRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.PaginatedDeploymentReleaseTagReadList>;
44
55
  /**
45
56
  * Retrieve a Deployment Release Tag by tag name, associated with a specified Deployment.
46
57
  *
@@ -53,7 +64,7 @@ export declare class Deployments {
53
64
  */
54
65
  retrieveDeploymentReleaseTag(id: string, name: string, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentReleaseTagRead>;
55
66
  /**
56
- * Updates an existing Release Tag associated with the specified Deployment.
67
+ * Updates an existing Release Tag associated with the specified Prompt Deployment.
57
68
  *
58
69
  * @param {string} id - A UUID string identifying this deployment.
59
70
  * @param {string} name - The name of the Release Tag associated with this Deployment that you'd like to update.