vellum-ai 0.8.24 → 0.8.25

package/.mock/definition/__package__.yml

@@ -1751,6 +1751,133 @@ types:
       * `UNKNOWN` - UNKNOWN
     source:
       openapi: openapi/openapi.yml
+  FolderEntity:
+    discriminated: false
+    union:
+      - FolderEntityFolder
+      - FolderEntityPromptSandbox
+      - FolderEntityWorkflowSandbox
+      - FolderEntityDocumentIndex
+      - FolderEntityTestSuite
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityDocumentIndex:
+    docs: A slim representation of a Document Index, as it exists within a Folder.
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      type: literal<"DOCUMENT_INDEX">
+      data: FolderEntityDocumentIndexData
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityDocumentIndexData:
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      label: string
+      created: datetime
+      modified: datetime
+      status: EntityStatus
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityFolder:
+    docs: A slim representation of a Folder, as it exists within another Folder.
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      type: literal<"FOLDER">
+      data: FolderEntityFolderData
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityFolderData:
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      label: string
+      created: datetime
+      modified: datetime
+      has_contents: boolean
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityPromptSandbox:
+    docs: A slim representation of a Prompt Sandbox, as it exists within a Folder.
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      type: literal<"PROMPT_SANDBOX">
+      data: FolderEntityPromptSandboxData
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityPromptSandboxData:
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      label: string
+      created: datetime
+      modified: datetime
+      status: EntityStatus
+      last_deployed_on: optional<datetime>
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityTestSuite:
+    docs: A slim representation of a Test Suite, as it exists within a Folder.
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      type: literal<"TEST_SUITE">
+      data: FolderEntityTestSuiteData
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityTestSuiteData:
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      label: string
+      created: datetime
+      modified: datetime
+      status: EntityStatus
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityWorkflowSandbox:
+    docs: A slim representation of a Workflow Sandbox, as it exists within a Folder.
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      type: literal<"WORKFLOW_SANDBOX">
+      data: FolderEntityWorkflowSandboxData
+    source:
+      openapi: openapi/openapi.yml
+  FolderEntityWorkflowSandboxData:
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      label: string
+      created: datetime
+      modified: datetime
+      status: EntityStatus
+      last_deployed_on: optional<datetime>
+    source:
+      openapi: openapi/openapi.yml
   FulfilledAdHocExecutePromptEvent:
     docs: >-
       The final data event returned indicating that the stream has ended and all
@@ -3016,6 +3143,20 @@ types:
       results: optional<list<DocumentIndexRead>>
     source:
       openapi: openapi/openapi.yml
+  PaginatedFolderEntityList:
+    properties:
+      count: optional<integer>
+      next:
+        type: optional<string>
+        validation:
+          format: uri
+      previous:
+        type: optional<string>
+        validation:
+          format: uri
+      results: optional<list<FolderEntity>>
+    source:
+      openapi: openapi/openapi.yml
   PaginatedSlimDeploymentReadList:
     properties:
       count: optional<integer>

package/.mock/definition/folderEntities.yml

@@ -1,7 +1,87 @@
+types:
+  FolderEntitiesListRequestEntityStatus:
+    enum:
+      - ACTIVE
+      - ARCHIVED
+    source:
+      openapi: openapi/openapi.yml
+imports:
+  root: __package__.yml
 service:
   auth: false
   base-path: ''
   endpoints:
+    list:
+      path: /v1/folder-entities
+      method: GET
+      auth: false
+      docs: List all folder entities within a specified folder.
+      request:
+        name: FolderEntitiesListRequest
+        query-parameters:
+          entity_status:
+            type: optional<FolderEntitiesListRequestEntityStatus>
+            docs: >-
+              Filter down to only those objects whose entities have a status
+              matching the status specified.
+
+
+              * `ACTIVE` - Active
+
+              * `ARCHIVED` - Archived
+          limit:
+            type: optional<integer>
+            docs: Number of results to return per page.
+          offset:
+            type: optional<integer>
+            docs: The initial index from which to return the results.
+          ordering:
+            type: optional<string>
+            docs: Which field to use when ordering the results.
+          parent_folder_id:
+            type: string
+            docs: >-
+              Filter down to only those entities whose parent folder has the
+              specified ID.
+
+
+              To filter by an entity's parent folder, provide the ID of the
+              parent folder. To filter by the root directory, provide
+
+              a string representing the entity type of the root directory.
+              Supported root directories include:
+
+              - PROMPT_SANDBOX
+
+              - WORKFLOW_SANDBOX
+
+              - DOCUMENT_INDEX
+
+              - TEST_SUITE
+      response:
+        docs: ''
+        type: root.PaginatedFolderEntityList
+      url: Default
+      availability: pre-release
+      examples:
+        - query-parameters:
+            parent_folder_id: parent_folder_id
+          response:
+            body:
+              count: 123
+              next: http://api.example.org/accounts/?offset=400&limit=100
+              previous: http://api.example.org/accounts/?offset=200&limit=100
+              results:
+                - id: id
+                  type: FOLDER
+                  data:
+                    id: id
+                    label: label
+                    created: '2024-01-15T09:30:00Z'
+                    modified: '2024-01-15T09:30:00Z'
+                    has_contents: true
+      audiences:
+        - customers
     add_entity_to_folder:
       path: /v1/folders/{folder_id}/add-entity
       method: POST
@@ -17,8 +97,17 @@ service:
           type: string
           docs: >-
             The ID of the folder to which the entity should be added. This can
-            be a UUID of a folder, or the name of a root directory (e.g.
-            "PROMPT_SANDBOX").
+            be a UUID of a folder, or the name of a root
+
+            directory. Supported root directories include:
+
+            - PROMPT_SANDBOX
+
+            - WORKFLOW_SANDBOX
+
+            - DOCUMENT_INDEX
+
+            - TEST_SUITE
       request:
         name: AddEntityToFolderRequest
         body:

package/.mock/openapi/openapi.yml

@@ -949,6 +949,67 @@ paths:
       servers:
       - url: https://predict.vellum.ai
         x-name: Predict
+  /v1/folder-entities:
+    get:
+      operationId: folder_entities_list
+      description: List all folder entities within a specified folder.
+      parameters:
+      - in: query
+        name: entity_status
+        schema:
+          type: string
+          enum:
+          - ACTIVE
+          - ARCHIVED
+        description: |-
+          Filter down to only those objects whose entities have a status matching the status specified.
+
+          * `ACTIVE` - Active
+          * `ARCHIVED` - Archived
+      - name: limit
+        required: false
+        in: query
+        description: Number of results to return per page.
+        schema:
+          type: integer
+      - name: offset
+        required: false
+        in: query
+        description: The initial index from which to return the results.
+        schema:
+          type: integer
+      - name: ordering
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
+      - in: query
+        name: parent_folder_id
+        schema:
+          type: string
+        description: |-
+          Filter down to only those entities whose parent folder has the specified ID.
+
+          To filter by an entity's parent folder, provide the ID of the parent folder. To filter by the root directory, provide
+          a string representing the entity type of the root directory. Supported root directories include:
+          - PROMPT_SANDBOX
+          - WORKFLOW_SANDBOX
+          - DOCUMENT_INDEX
+          - TEST_SUITE
+        required: true
+      tags:
+      - folder-entities
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedFolderEntityList'
+          description: ''
+      x-fern-availability: beta
+      x-fern-audiences:
+      - customers
   /v1/folders/{folder_id}/add-entity:
     post:
       operationId: add_entity_to_folder
@@ -961,8 +1022,13 @@ paths:
         name: folder_id
         schema:
           type: string
-        description: The ID of the folder to which the entity should be added. This
-          can be a UUID of a folder, or the name of a root directory (e.g. "PROMPT_SANDBOX").
+        description: |-
+          The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root
+          directory. Supported root directories include:
+          - PROMPT_SANDBOX
+          - WORKFLOW_SANDBOX
+          - DOCUMENT_INDEX
+          - TEST_SUITE
         required: true
       tags:
       - folder-entities
@@ -3966,6 +4032,218 @@ components:
         * `LENGTH` - LENGTH
         * `STOP` - STOP
         * `UNKNOWN` - UNKNOWN
+    FolderEntity:
+      oneOf:
+      - $ref: '#/components/schemas/FolderEntityFolder'
+      - $ref: '#/components/schemas/FolderEntityPromptSandbox'
+      - $ref: '#/components/schemas/FolderEntityWorkflowSandbox'
+      - $ref: '#/components/schemas/FolderEntityDocumentIndex'
+      - $ref: '#/components/schemas/FolderEntityTestSuite'
+      discriminator:
+        propertyName: type
+        mapping:
+          FOLDER: '#/components/schemas/FolderEntityFolder'
+          PROMPT_SANDBOX: '#/components/schemas/FolderEntityPromptSandbox'
+          WORKFLOW_SANDBOX: '#/components/schemas/FolderEntityWorkflowSandbox'
+          DOCUMENT_INDEX: '#/components/schemas/FolderEntityDocumentIndex'
+          TEST_SUITE: '#/components/schemas/FolderEntityTestSuite'
+    FolderEntityDocumentIndex:
+      type: object
+      description: A slim representation of a Document Index, as it exists within
+        a Folder.
+      properties:
+        id:
+          type: string
+          format: uuid
+        type:
+          type: string
+        data:
+          $ref: '#/components/schemas/FolderEntityDocumentIndexData'
+      required:
+      - data
+      - id
+      - type
+    FolderEntityDocumentIndexData:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        label:
+          type: string
+        created:
+          type: string
+          format: date-time
+        modified:
+          type: string
+          format: date-time
+        status:
+          $ref: '#/components/schemas/EntityStatus'
+      required:
+      - created
+      - id
+      - label
+      - modified
+      - status
+    FolderEntityFolder:
+      type: object
+      description: A slim representation of a Folder, as it exists within another
+        Folder.
+      properties:
+        id:
+          type: string
+          format: uuid
+        type:
+          type: string
+        data:
+          $ref: '#/components/schemas/FolderEntityFolderData'
+      required:
+      - data
+      - id
+      - type
+    FolderEntityFolderData:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        label:
+          type: string
+        created:
+          type: string
+          format: date-time
+        modified:
+          type: string
+          format: date-time
+        has_contents:
+          type: boolean
+      required:
+      - created
+      - has_contents
+      - id
+      - label
+      - modified
+    FolderEntityPromptSandbox:
+      type: object
+      description: A slim representation of a Prompt Sandbox, as it exists within
+        a Folder.
+      properties:
+        id:
+          type: string
+          format: uuid
+        type:
+          type: string
+        data:
+          $ref: '#/components/schemas/FolderEntityPromptSandboxData'
+      required:
+      - data
+      - id
+      - type
+    FolderEntityPromptSandboxData:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        label:
+          type: string
+        created:
+          type: string
+          format: date-time
+        modified:
+          type: string
+          format: date-time
+        status:
+          $ref: '#/components/schemas/EntityStatus'
+        last_deployed_on:
+          type: string
+          format: date-time
+          nullable: true
+      required:
+      - created
+      - id
+      - label
+      - modified
+      - status
+    FolderEntityTestSuite:
+      type: object
+      description: A slim representation of a Test Suite, as it exists within a Folder.
+      properties:
+        id:
+          type: string
+          format: uuid
+        type:
+          type: string
+        data:
+          $ref: '#/components/schemas/FolderEntityTestSuiteData'
+      required:
+      - data
+      - id
+      - type
+    FolderEntityTestSuiteData:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        label:
+          type: string
+        created:
+          type: string
+          format: date-time
+        modified:
+          type: string
+          format: date-time
+        status:
+          $ref: '#/components/schemas/EntityStatus'
+      required:
+      - created
+      - id
+      - label
+      - modified
+      - status
+    FolderEntityWorkflowSandbox:
+      type: object
+      description: A slim representation of a Workflow Sandbox, as it exists within
+        a Folder.
+      properties:
+        id:
+          type: string
+          format: uuid
+        type:
+          type: string
+        data:
+          $ref: '#/components/schemas/FolderEntityWorkflowSandboxData'
+      required:
+      - data
+      - id
+      - type
+    FolderEntityWorkflowSandboxData:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        label:
+          type: string
+        created:
+          type: string
+          format: date-time
+        modified:
+          type: string
+          format: date-time
+        status:
+          $ref: '#/components/schemas/EntityStatus'
+        last_deployed_on:
+          type: string
+          format: date-time
+          nullable: true
+      required:
+      - created
+      - id
+      - label
+      - modified
+      - status
     FulfilledAdHocExecutePromptEvent:
       type: object
       description: The final data event returned indicating that the stream has ended
@@ -6076,6 +6354,26 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/DocumentIndexRead'
+    PaginatedFolderEntityList:
+      type: object
+      properties:
+        count:
+          type: integer
+          example: 123
+        next:
+          type: string
+          nullable: true
+          format: uri
+          example: http://api.example.org/accounts/?offset=400&limit=100
+        previous:
+          type: string
+          nullable: true
+          format: uri
+          example: http://api.example.org/accounts/?offset=200&limit=100
+        results:
+          type: array
+          items:
+            $ref: '#/components/schemas/FolderEntity'
     PaginatedSlimDeploymentReadList:
       type: object
       properties:

package/Client.d.ts

@@ -18,7 +18,7 @@ import { WorkflowSandboxes } from "./api/resources/workflowSandboxes/client/Clie
 export declare namespace VellumClient {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -31,7 +31,7 @@ export declare namespace VellumClient {
 }
 export declare class VellumClient {
     protected readonly _options: VellumClient.Options;
-    constructor(_options: VellumClient.Options);
+    constructor(_options?: VellumClient.Options);
     /**
      * An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
      *
@@ -208,6 +208,6 @@ export declare class VellumClient {
     protected _workflowSandboxes: WorkflowSandboxes | undefined;
     get workflowSandboxes(): WorkflowSandboxes;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        X_API_KEY: string;
+        X_API_KEY: string | undefined;
     }>;
 }