vellum-ai 0.11.8 → 0.11.10

package/.mock/definition/workflowDeployments.yml

@@ -0,0 +1,299 @@
+types:
+  WorkflowDeploymentsListRequestStatus:
+    enum:
+      - ACTIVE
+      - ARCHIVED
+    source:
+      openapi: openapi/openapi.yml
+  ListWorkflowReleaseTagsRequestSource:
+    enum:
+      - SYSTEM
+      - USER
+    source:
+      openapi: openapi/openapi.yml
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /v1/workflow-deployments
+      method: GET
+      auth: true
+      docs: Used to list all Workflow Deployments.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: WorkflowDeploymentsListRequest
+        query-parameters:
+          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.
+          status:
+            type: optional<WorkflowDeploymentsListRequestStatus>
+            docs: status
+      response:
+        docs: ''
+        type: root.PaginatedSlimWorkflowDeploymentList
+      url: Default
+      availability: pre-release
+      examples:
+        - 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
+                  name: name
+                  label: label
+                  status: ACTIVE
+                  environment: DEVELOPMENT
+                  created: '2024-01-15T09:30:00Z'
+                  last_deployed_on: '2024-01-15T09:30:00Z'
+                  input_variables:
+                    - id: id
+                      key: key
+                      type: STRING
+                  output_variables:
+                    - id: id
+                      key: key
+                      type: STRING
+                  description: description
+      audiences:
+        - customers
+    retrieve:
+      path: /v1/workflow-deployments/{id}
+      method: GET
+      auth: true
+      docs: Used to retrieve a workflow deployment given its ID or name.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id:
+          type: string
+          docs: Either the Workflow Deployment's ID or its unique name
+      response:
+        docs: ''
+        type: root.WorkflowDeploymentRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              id: id
+              name: name
+              label: label
+              status: ACTIVE
+              environment: DEVELOPMENT
+              created: '2024-01-15T09:30:00Z'
+              last_deployed_on: '2024-01-15T09:30:00Z'
+              last_deployed_history_item_id: last_deployed_history_item_id
+              input_variables:
+                - id: id
+                  key: key
+                  type: STRING
+                  required: true
+                  default:
+                    type: STRING
+              output_variables:
+                - id: id
+                  key: key
+                  type: STRING
+                  required: true
+                  default:
+                    type: STRING
+              description: description
+      audiences:
+        - customers
+    workflow_deployment_history_item_retrieve:
+      path: /v1/workflow-deployments/{id}/history/{history_id_or_release_tag}
+      method: GET
+      auth: true
+      docs: >-
+        Retrieve a specific Workflow Deployment History Item by either its UUID
+        or the name of a Release Tag that points to it.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        history_id_or_release_tag:
+          type: string
+          docs: >-
+            Either the UUID of Workflow Deployment History Item you'd like to
+            retrieve, or the name of a Release Tag that's pointing to the
+            Workflow Deployment History Item you'd like to retrieve.
+        id:
+          type: string
+          docs: A UUID string identifying this workflow deployment.
+      response:
+        docs: ''
+        type: root.WorkflowDeploymentHistoryItem
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            history_id_or_release_tag: history_id_or_release_tag
+            id: id
+          response:
+            body:
+              id: id
+              workflow_deployment_id: workflow_deployment_id
+              timestamp: '2024-01-15T09:30:00Z'
+              label: label
+              name: name
+              input_variables:
+                - id: id
+                  key: key
+                  type: STRING
+                  required: true
+                  default:
+                    type: STRING
+              output_variables:
+                - id: id
+                  key: key
+                  type: STRING
+                  required: true
+                  default:
+                    type: STRING
+              description: description
+      audiences:
+        - customers
+    list_workflow_release_tags:
+      path: /v1/workflow-deployments/{id}/release-tags
+      method: GET
+      auth: true
+      docs: List Release Tags associated with the specified Workflow Deployment
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id:
+          type: string
+          docs: Either the Workflow Deployment's ID or its unique name
+      request:
+        name: ListWorkflowReleaseTagsRequest
+        query-parameters:
+          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.
+          source: optional<ListWorkflowReleaseTagsRequestSource>
+      response:
+        docs: ''
+        type: root.PaginatedWorkflowReleaseTagReadList
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: 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:
+                - name: name
+                  source: SYSTEM
+                  history_item:
+                    id: id
+                    timestamp: '2024-01-15T09:30:00Z'
+      audiences:
+        - customers
+    retrieve_workflow_release_tag:
+      path: /v1/workflow-deployments/{id}/release-tags/{name}
+      method: GET
+      auth: true
+      docs: >-
+        Retrieve a Workflow Release Tag by tag name, associated with a specified
+        Workflow Deployment.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this workflow deployment.
+        name:
+          type: string
+          docs: >-
+            The name of the Release Tag associated with this Workflow Deployment
+            that you'd like to retrieve.
+      response:
+        docs: ''
+        type: root.WorkflowReleaseTagRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+            name: name
+          response:
+            body:
+              name: name
+              source: SYSTEM
+              history_item:
+                id: id
+                timestamp: '2024-01-15T09:30:00Z'
+      audiences:
+        - customers
+    update_workflow_release_tag:
+      path: /v1/workflow-deployments/{id}/release-tags/{name}
+      method: PATCH
+      auth: true
+      docs: >-
+        Updates an existing Release Tag associated with the specified Workflow
+        Deployment.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this workflow deployment.
+        name:
+          type: string
+          docs: >-
+            The name of the Release Tag associated with this Workflow Deployment
+            that you'd like to update.
+      request:
+        name: PatchedWorkflowReleaseTagUpdateRequest
+        body:
+          properties:
+            history_item_id:
+              type: optional<string>
+              docs: The ID of the Workflow Deployment History Item to tag
+              validation:
+                format: uuid
+        content-type: application/json
+      response:
+        docs: ''
+        type: root.WorkflowReleaseTagRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+            name: name
+          request: {}
+          response:
+            body:
+              name: name
+              source: SYSTEM
+              history_item:
+                id: id
+                timestamp: '2024-01-15T09:30:00Z'
+      audiences:
+        - customers
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/workflowSandboxes.yml

@@ -0,0 +1,94 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    deploy_workflow:
+      path: /v1/workflow-sandboxes/{id}/workflows/{workflow_id}/deploy
+      method: POST
+      auth: true
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this workflow sandbox.
+        workflow_id:
+          type: string
+          docs: An ID identifying the Workflow you'd like to deploy.
+      request:
+        name: DeploySandboxWorkflowRequest
+        body:
+          properties:
+            workflow_deployment_id:
+              type: optional<string>
+              docs: >-
+                The Vellum-generated ID of the Workflow Deployment you'd like to
+                update. Cannot specify both this and workflow_deployment_name.
+                Leave null to create a new Workflow Deployment.
+              validation:
+                format: uuid
+            workflow_deployment_name:
+              type: optional<string>
+              docs: >-
+                The unique name of the Workflow Deployment you'd like to either
+                create or update. Cannot specify both this and
+                workflow_deployment_id. If provided and matches an existing
+                Workflow Deployment, that Workflow Deployment will be updated.
+                Otherwise, a new Prompt Deployment will be created.
+              validation:
+                minLength: 1
+            label:
+              type: optional<string>
+              docs: >-
+                In the event that a new Workflow Deployment is created, this
+                will be the label it's given.
+              validation:
+                minLength: 1
+            release_tags:
+              type: optional<list<string>>
+              docs: >-
+                Optionally provide the release tags that you'd like to be
+                associated with the latest release of the created/updated Prompt
+                Deployment.
+        content-type: application/json
+      response:
+        docs: ''
+        type: root.WorkflowDeploymentRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+            workflow_id: workflow_id
+          request: {}
+          response:
+            body:
+              id: id
+              name: name
+              label: label
+              status: ACTIVE
+              environment: DEVELOPMENT
+              created: '2024-01-15T09:30:00Z'
+              last_deployed_on: '2024-01-15T09:30:00Z'
+              last_deployed_history_item_id: last_deployed_history_item_id
+              input_variables:
+                - id: id
+                  key: key
+                  type: STRING
+                  required: true
+                  default:
+                    type: STRING
+              output_variables:
+                - id: id
+                  key: key
+                  type: STRING
+                  required: true
+                  default:
+                    type: STRING
+              description: description
+      audiences:
+        - customers
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/workflows.yml

@@ -0,0 +1,83 @@
+types:
+  WorkflowsPullRequestFormat:
+    enum:
+      - json
+      - zip
+    source:
+      openapi: openapi/openapi.yml
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    pull:
+      path: /v1/workflows/{id}/pull
+      method: GET
+      auth: true
+      docs: >-
+        An internal-only endpoint that's subject to breaking changes without
+        notice. Not intended for public use.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id:
+          type: string
+          docs: The ID of the Workflow to pull from
+      request:
+        name: WorkflowsPullRequest
+        query-parameters:
+          format: optional<WorkflowsPullRequestFormat>
+      response:
+        docs: ''
+        type: file
+      url: Default
+      availability: pre-release
+      errors:
+        - root.BadRequestError
+      audiences:
+        - internal
+    push:
+      path: /v1/workflows/push
+      method: POST
+      auth: true
+      docs: >-
+        An internal-only endpoint that's subject to breaking changes without
+        notice. Not intended for public use.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: WorkflowPushRequest
+        body:
+          properties:
+            exec_config:
+              type: root.WorkflowPushExecConfig
+              docs: The execution configuration of the workflow.
+            label:
+              type: string
+              validation:
+                minLength: 1
+            workflow_sandbox_id:
+              type: optional<string>
+              validation:
+                format: uuid
+            deployment_config: optional<root.WorkflowPushDeploymentConfigRequest>
+            artifact: optional<file>
+        content-type: multipart/form-data
+      response:
+        docs: ''
+        type: root.WorkflowPushResponse
+      url: Default
+      availability: pre-release
+      examples:
+        - request:
+            exec_config: exec_config
+            label: label
+          response:
+            body:
+              workflow_sandbox_id: workflow_sandbox_id
+              workflow_deployment_id: workflow_deployment_id
+      audiences:
+        - internal
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/workspaceSecrets.yml

@@ -0,0 +1,78 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    retrieve:
+      path: /v1/workspace-secrets/{id}
+      method: GET
+      auth: true
+      docs: Used to retrieve a Workspace Secret given its ID or name.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id:
+          type: string
+          docs: Either the Workspace Secret's ID or its unique name
+      response:
+        docs: ''
+        type: root.WorkspaceSecretRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              id: id
+              modified: '2024-01-15T09:30:00Z'
+              name: name
+              label: label
+              secret_type: USER_DEFINED
+      audiences:
+        - customers
+    partialUpdate:
+      path: /v1/workspace-secrets/{id}
+      method: PATCH
+      auth: true
+      docs: Used to update a Workspace Secret given its ID or name.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id:
+          type: string
+          docs: Either the Workspace Secret's ID or its unique name
+      request:
+        name: PatchedWorkspaceSecretUpdateRequest
+        body:
+          properties:
+            label:
+              type: optional<string>
+              validation:
+                minLength: 1
+            value:
+              type: optional<string>
+              validation:
+                minLength: 1
+        content-type: application/json
+      response:
+        docs: ''
+        type: root.WorkspaceSecretRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          request: {}
+          response:
+            body:
+              id: id
+              modified: '2024-01-15T09:30:00Z'
+              name: name
+              label: label
+              secret_type: USER_DEFINED
+      audiences:
+        - customers
+  source:
+    openapi: openapi/openapi.yml

package/.mock/fern.config.json

@@ -0,0 +1,4 @@
+{
+  "organization" : "vellum",
+  "version" : "0.45.2"
+}