vellum-ai 0.12.16 → 0.13.0

package/.mock/definition/__package__.yml

@@ -933,27 +933,6 @@ types:
       value: list<VellumValue>
     source:
       openapi: openapi/openapi.yml
-  ArrayVariableValue:
-    properties:
-      type: literal<"ARRAY">
-      value: optional<list<ArrayVariableValueItem>>
-    source:
-      openapi: openapi/openapi.yml
-  ArrayVariableValueItem:
-    discriminated: false
-    union:
-      - StringVariableValue
-      - NumberVariableValue
-      - JsonVariableValue
-      - ErrorVariableValue
-      - FunctionCallVariableValue
-      - ImageVariableValue
-      - AudioVariableValue
-      - ChatHistoryVariableValue
-      - SearchResultsVariableValue
-      - ArrayVariableValue
-    source:
-      openapi: openapi/openapi.yml
   ArrayVellumValue:
     docs: A value representing an array of Vellum variable values.
     properties:
@@ -996,13 +975,6 @@ types:
       metadata: optional<map<string, unknown>>
     source:
       openapi: openapi/openapi.yml
-  AudioVariableValue:
-    docs: A base Vellum primitive value representing audio.
-    properties:
-      type: literal<"AUDIO">
-      value: optional<VellumAudio>
-    source:
-      openapi: openapi/openapi.yml
   AudioVellumValue:
     docs: A base Vellum primitive value representing audio.
     properties:
@@ -1084,12 +1056,6 @@ types:
       value: list<ChatMessageRequest>
     source:
       openapi: openapi/openapi.yml
-  ChatHistoryVariableValue:
-    properties:
-      type: literal<"CHAT_HISTORY">
-      value: optional<list<ChatMessage>>
-    source:
-      openapi: openapi/openapi.yml
   ChatHistoryVellumValue:
     docs: A value representing Chat History.
     properties:
@@ -1794,12 +1760,6 @@ types:
       value: VellumError
     source:
       openapi: openapi/openapi.yml
-  ErrorVariableValue:
-    properties:
-      type: literal<"ERROR">
-      value: optional<VellumError>
-    source:
-      openapi: openapi/openapi.yml
   ErrorVellumValue:
     docs: A value representing an Error.
     properties:
@@ -2306,12 +2266,6 @@ types:
           minLength: 1
     source:
       openapi: openapi/openapi.yml
-  FunctionCallVariableValue:
-    properties:
-      type: literal<"FUNCTION_CALL">
-      value: optional<FunctionCall>
-    source:
-      openapi: openapi/openapi.yml
   FunctionCallVellumValue:
     docs: A value representing a Function Call.
     properties:
@@ -2535,13 +2489,6 @@ types:
       metadata: optional<map<string, unknown>>
     source:
       openapi: openapi/openapi.yml
-  ImageVariableValue:
-    docs: A base Vellum primitive value representing an image.
-    properties:
-      type: literal<"IMAGE">
-      value: optional<VellumImage>
-    source:
-      openapi: openapi/openapi.yml
   ImageVellumValue:
     docs: A base Vellum primitive value representing an image.
     properties:
@@ -2715,12 +2662,6 @@ types:
     source:
       openapi: openapi/openapi.yml
   JsonEnum: literal<"JSON">
-  JsonVariableValue:
-    properties:
-      type: literal<"JSON">
-      value: unknown
-    source:
-      openapi: openapi/openapi.yml
   JsonVellumValue:
     docs: A value representing a JSON object.
     properties:
@@ -3193,6 +3134,20 @@ types:
       - NamedTestCaseArrayVariableValueRequest
     source:
       openapi: openapi/openapi.yml
+  NewMemberJoinBehaviorEnum:
+    enum:
+      - AUTO_ACCEPT_FROM_SHARED_DOMAIN
+      - ALLOW_REQUESTS_FROM_SHARED_DOMAIN
+      - REQUIRE_EXPLICIT_INVITE
+    docs: >-
+      * `AUTO_ACCEPT_FROM_SHARED_DOMAIN` - Auto-Accept from Shared Domain
+
+      * `ALLOW_REQUESTS_FROM_SHARED_DOMAIN` - Allows Requests from Shared
+      Domains
+
+      * `REQUIRE_EXPLICIT_INVITE` - Require Explicit Invite
+    source:
+      openapi: openapi/openapi.yml
   NodeInputCompiledArrayValue:
     properties:
       node_input_id: string
@@ -3382,12 +3337,6 @@ types:
       value: double
     source:
       openapi: openapi/openapi.yml
-  NumberVariableValue:
-    properties:
-      type: literal<"NUMBER">
-      value: optional<double>
-    source:
-      openapi: openapi/openapi.yml
   NumberVellumValue:
     docs: A value representing a number.
     properties:
@@ -3456,6 +3405,20 @@ types:
       model_name: literal<"text-embedding-ada-002">
     source:
       openapi: openapi/openapi.yml
+  OrganizationRead:
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      name:
+        type: string
+        validation:
+          maxLength: 150
+      allow_staff_access: optional<boolean>
+      new_member_join_behavior: NewMemberJoinBehaviorEnum
+    source:
+      openapi: openapi/openapi.yml
   PaginatedContainerImageReadList:
     properties:
       count: optional<integer>
@@ -4237,12 +4200,6 @@ types:
       value: list<SearchResult>
     source:
       openapi: openapi/openapi.yml
-  SearchResultsVariableValue:
-    properties:
-      type: literal<"SEARCH_RESULTS">
-      value: optional<list<SearchResult>>
-    source:
-      openapi: openapi/openapi.yml
   SearchResultsVellumValue:
     docs: A value representing Search Results.
     properties:
@@ -4603,12 +4560,6 @@ types:
       value: string
     source:
       openapi: openapi/openapi.yml
-  StringVariableValue:
-    properties:
-      type: literal<"STRING">
-      value: optional<string>
-    source:
-      openapi: openapi/openapi.yml
   StringVellumValue:
     docs: A value representing a string.
     properties:
@@ -6652,7 +6603,7 @@ types:
           The newly output string value. Only relevant for string outputs with a
           state of STREAMING.
       type: literal<"ARRAY">
-      value: optional<list<ArrayVariableValueItem>>
+      value: optional<list<VellumValue>>
     source:
       openapi: openapi/openapi.yml
   WorkflowResultEventOutputDataChatHistory:
@@ -6799,6 +6750,21 @@ types:
       - WorkflowExecutionNodeResultEvent
     source:
       openapi: openapi/openapi.yml
+  WorkspaceRead:
+    properties:
+      id:
+        type: string
+        validation:
+          format: uuid
+      name:
+        type: string
+        docs: The name of the Workspace.
+        validation:
+          maxLength: 150
+      label: string
+      created: datetime
+    source:
+      openapi: openapi/openapi.yml
   WorkspaceSecretRead:
     properties:
       id:

package/.mock/definition/organizations.yml

@@ -0,0 +1,29 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    organization_identity:
+      path: /v1/organizations/identity
+      method: GET
+      auth: false
+      docs: Retrieves information about the active Organization
+      source:
+        openapi: openapi/openapi.yml
+      response:
+        docs: ''
+        type: root.OrganizationRead
+      url: Default
+      availability: pre-release
+      examples:
+        - response:
+            body:
+              id: id
+              name: name
+              allow_staff_access: true
+              new_member_join_behavior: AUTO_ACCEPT_FROM_SHARED_DOMAIN
+      audiences:
+        - internal
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/workspaces.yml

@@ -0,0 +1,29 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    workspace_identity:
+      path: /v1/workspaces/identity
+      method: GET
+      auth: false
+      docs: Retrieves information about the active Workspace
+      source:
+        openapi: openapi/openapi.yml
+      response:
+        docs: ''
+        type: root.WorkspaceRead
+      url: Default
+      availability: pre-release
+      examples:
+        - response:
+            body:
+              id: id
+              name: name
+              label: label
+              created: '2024-01-15T09:30:00Z'
+      audiences:
+        - internal
+  source:
+    openapi: openapi/openapi.yml

package/.mock/openapi/openapi.yml

@@ -1447,6 +1447,22 @@ paths:
       x-fern-availability: beta
       x-fern-audiences:
       - internal
+  /v1/organizations/identity:
+    get:
+      operationId: organization_identity
+      description: Retrieves information about the active Organization
+      tags:
+      - organizations
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OrganizationRead'
+          description: ''
+      x-fern-availability: beta
+      x-fern-audiences:
+      - internal
   /v1/sandboxes/{id}/prompts/{prompt_variant_id}/deploy:
     post:
       operationId: deploy_prompt
@@ -2406,6 +2422,22 @@ paths:
       x-fern-availability: beta
       x-fern-audiences:
       - customers
+  /v1/workspaces/identity:
+    get:
+      operationId: workspace_identity
+      description: Retrieves information about the active Workspace
+      tags:
+      - workspaces
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WorkspaceRead'
+          description: ''
+      x-fern-availability: beta
+      x-fern-audiences:
+      - internal
 components:
   schemas:
     AdHocExecutePromptEvent:
@@ -2652,44 +2684,6 @@ components:
       - name
       - type
       - value
-    ArrayVariableValue:
-      type: object
-      properties:
-        type:
-          type: string
-        value:
-          type: array
-          items:
-            $ref: '#/components/schemas/ArrayVariableValueItem'
-          nullable: true
-      required:
-      - type
-      - value
-    ArrayVariableValueItem:
-      oneOf:
-      - $ref: '#/components/schemas/StringVariableValue'
-      - $ref: '#/components/schemas/NumberVariableValue'
-      - $ref: '#/components/schemas/JsonVariableValue'
-      - $ref: '#/components/schemas/ErrorVariableValue'
-      - $ref: '#/components/schemas/FunctionCallVariableValue'
-      - $ref: '#/components/schemas/ImageVariableValue'
-      - $ref: '#/components/schemas/AudioVariableValue'
-      - $ref: '#/components/schemas/ChatHistoryVariableValue'
-      - $ref: '#/components/schemas/SearchResultsVariableValue'
-      - $ref: '#/components/schemas/ArrayVariableValue'
-      discriminator:
-        propertyName: type
-        mapping:
-          STRING: '#/components/schemas/StringVariableValue'
-          NUMBER: '#/components/schemas/NumberVariableValue'
-          JSON: '#/components/schemas/JsonVariableValue'
-          ERROR: '#/components/schemas/ErrorVariableValue'
-          FUNCTION_CALL: '#/components/schemas/FunctionCallVariableValue'
-          IMAGE: '#/components/schemas/ImageVariableValue'
-          AUDIO: '#/components/schemas/AudioVariableValue'
-          CHAT_HISTORY: '#/components/schemas/ChatHistoryVariableValue'
-          SEARCH_RESULTS: '#/components/schemas/SearchResultsVariableValue'
-          ARRAY: '#/components/schemas/ArrayVariableValue'
     ArrayVellumValue:
       type: object
       description: A value representing an array of Vellum variable values.
@@ -2768,19 +2762,6 @@ components:
       required:
       - block_type
       - src
-    AudioVariableValue:
-      type: object
-      description: A base Vellum primitive value representing audio.
-      properties:
-        type:
-          $ref: '#/components/schemas/AudioEnum'
-        value:
-          allOf:
-          - $ref: '#/components/schemas/VellumAudio'
-          nullable: true
-      required:
-      - type
-      - value
     AudioVellumValue:
       type: object
       description: A base Vellum primitive value representing audio.
@@ -2919,19 +2900,6 @@ components:
       - name
       - type
       - value
-    ChatHistoryVariableValue:
-      type: object
-      properties:
-        type:
-          type: string
-        value:
-          type: array
-          items:
-            $ref: '#/components/schemas/ChatMessage'
-          nullable: true
-      required:
-      - type
-      - value
     ChatHistoryVellumValue:
       type: object
       description: A value representing Chat History.
@@ -4134,18 +4102,6 @@ components:
       - name
       - type
       - value
-    ErrorVariableValue:
-      type: object
-      properties:
-        type:
-          type: string
-        value:
-          allOf:
-          - $ref: '#/components/schemas/VellumError'
-          nullable: true
-      required:
-      - type
-      - value
     ErrorVellumValue:
       type: object
       description: A value representing an Error.
@@ -5203,18 +5159,6 @@ components:
       required:
       - arguments
       - name
-    FunctionCallVariableValue:
-      type: object
-      properties:
-        type:
-          type: string
-        value:
-          allOf:
-          - $ref: '#/components/schemas/FunctionCall'
-          nullable: true
-      required:
-      - type
-      - value
     FunctionCallVellumValue:
       type: object
       description: A value representing a Function Call.
@@ -5582,19 +5526,6 @@ components:
       required:
       - block_type
       - src
-    ImageVariableValue:
-      type: object
-      description: A base Vellum primitive value representing an image.
-      properties:
-        type:
-          $ref: '#/components/schemas/ImageEnum'
-        value:
-          allOf:
-          - $ref: '#/components/schemas/VellumImage'
-          nullable: true
-      required:
-      - type
-      - value
     ImageVellumValue:
       type: object
       description: A base Vellum primitive value representing an image.
@@ -5862,16 +5793,6 @@ components:
       type: string
       enum:
       - JSON
-    JsonVariableValue:
-      type: object
-      properties:
-        type:
-          type: string
-        value:
-          nullable: true
-      required:
-      - type
-      - value
     JsonVellumValue:
       type: object
       description: A value representing a JSON object.
@@ -6602,6 +6523,16 @@ components:
           ERROR: '#/components/schemas/NamedTestCaseErrorVariableValueRequest'
           FUNCTION_CALL: '#/components/schemas/NamedTestCaseFunctionCallVariableValueRequest'
           ARRAY: '#/components/schemas/NamedTestCaseArrayVariableValueRequest'
+    NewMemberJoinBehaviorEnum:
+      enum:
+      - AUTO_ACCEPT_FROM_SHARED_DOMAIN
+      - ALLOW_REQUESTS_FROM_SHARED_DOMAIN
+      - REQUIRE_EXPLICIT_INVITE
+      type: string
+      description: |-
+        * `AUTO_ACCEPT_FROM_SHARED_DOMAIN` - Auto-Accept from Shared Domain
+        * `ALLOW_REQUESTS_FROM_SHARED_DOMAIN` - Allows Requests from Shared Domains
+        * `REQUIRE_EXPLICIT_INVITE` - Require Explicit Invite
     NodeInputCompiledArrayValue:
       type: object
       properties:
@@ -6989,18 +6920,6 @@ components:
       - name
       - type
       - value
-    NumberVariableValue:
-      type: object
-      properties:
-        type:
-          type: string
-        value:
-          type: number
-          format: double
-          nullable: true
-      required:
-      - type
-      - value
     NumberVellumValue:
       type: object
       description: A value representing a number.
@@ -7109,6 +7028,24 @@ components:
       required:
       - config
       - model_name
+    OrganizationRead:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+          readOnly: true
+        name:
+          type: string
+          maxLength: 150
+        allow_staff_access:
+          type: boolean
+        new_member_join_behavior:
+          $ref: '#/components/schemas/NewMemberJoinBehaviorEnum'
+      required:
+      - id
+      - name
+      - new_member_join_behavior
     PaginatedContainerImageReadList:
       type: object
       properties:
@@ -8402,19 +8339,6 @@ components:
       - name
       - type
       - value
-    SearchResultsVariableValue:
-      type: object
-      properties:
-        type:
-          type: string
-        value:
-          type: array
-          items:
-            $ref: '#/components/schemas/SearchResult'
-          nullable: true
-      required:
-      - type
-      - value
     SearchResultsVellumValue:
       type: object
       description: A value representing Search Results.
@@ -8896,17 +8820,6 @@ components:
       - name
       - type
       - value
-    StringVariableValue:
-      type: object
-      properties:
-        type:
-          type: string
-        value:
-          type: string
-          nullable: true
-      required:
-      - type
-      - value
     StringVellumValue:
       type: object
       description: A value representing a string.
@@ -11941,7 +11854,7 @@ components:
         value:
           type: array
           items:
-            $ref: '#/components/schemas/ArrayVariableValueItem'
+            $ref: '#/components/schemas/VellumValue'
           nullable: true
       required:
       - delta
@@ -12190,6 +12103,29 @@ components:
         mapping:
           WORKFLOW: '#/components/schemas/WorkflowExecutionWorkflowResultEvent'
           NODE: '#/components/schemas/WorkflowExecutionNodeResultEvent'
+    WorkspaceRead:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+          readOnly: true
+        name:
+          type: string
+          description: The name of the Workspace.
+          maxLength: 150
+        label:
+          type: string
+          readOnly: true
+        created:
+          type: string
+          format: date-time
+          readOnly: true
+      required:
+      - created
+      - id
+      - label
+      - name
     WorkspaceSecretRead:
       type: object
       properties:

package/Client.d.ts

@@ -12,6 +12,7 @@ import { Documents } from "./api/resources/documents/client/Client";
 import { FolderEntities } from "./api/resources/folderEntities/client/Client";
 import { MetricDefinitions } from "./api/resources/metricDefinitions/client/Client";
 import { MlModels } from "./api/resources/mlModels/client/Client";
+import { Organizations } from "./api/resources/organizations/client/Client";
 import { Sandboxes } from "./api/resources/sandboxes/client/Client";
 import { TestSuiteRuns } from "./api/resources/testSuiteRuns/client/Client";
 import { TestSuites } from "./api/resources/testSuites/client/Client";
@@ -19,10 +20,11 @@ import { WorkflowDeployments } from "./api/resources/workflowDeployments/client/
 import { WorkflowSandboxes } from "./api/resources/workflowSandboxes/client/Client";
 import { Workflows } from "./api/resources/workflows/client/Client";
 import { WorkspaceSecrets } from "./api/resources/workspaceSecrets/client/Client";
+import { Workspaces } from "./api/resources/workspaces/client/Client";
 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. */
@@ -35,7 +37,7 @@ export declare namespace VellumClient {
 }
 export declare class VellumClient {
     protected readonly _options: VellumClient.Options;
-    constructor(_options: VellumClient.Options);
+    constructor(_options?: VellumClient.Options);
     /**
      * @param {Vellum.CodeExecutor} request
      * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -203,6 +205,8 @@ export declare class VellumClient {
     get metricDefinitions(): MetricDefinitions;
     protected _mlModels: MlModels | undefined;
     get mlModels(): MlModels;
+    protected _organizations: Organizations | undefined;
+    get organizations(): Organizations;
     protected _sandboxes: Sandboxes | undefined;
     get sandboxes(): Sandboxes;
     protected _testSuiteRuns: TestSuiteRuns | undefined;
@@ -217,7 +221,9 @@ export declare class VellumClient {
     get workflows(): Workflows;
     protected _workspaceSecrets: WorkspaceSecrets | undefined;
     get workspaceSecrets(): WorkspaceSecrets;
+    protected _workspaces: Workspaces | undefined;
+    get workspaces(): Workspaces;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        X_API_KEY: string;
+        X_API_KEY: string | undefined;
     }>;
 }