Class: Vellum::AsyncWorkflowDeploymentsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/workflow_deployments/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vellum::AsyncWorkflowDeploymentsClient

Parameters:



432
433
434
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 432

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vellum::AsyncRequestClient (readonly)

Returns:



427
428
429
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 427

def request_client
  @request_client
end

Instance Method Details

#list(has_story_config: nil, is_public: nil, limit: nil, offset: nil, ordering: nil, owned_by: nil, status: nil, request_options: nil) ⇒ Object

api.workflow_deployments.list



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 459

def list(has_story_config: nil, is_public: nil, limit: nil, offset: nil, ordering: nil, owned_by: nil, status: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "has_story_config": has_story_config, "is_public": is_public, "limit": limit, "offset": offset, "ordering": ordering, "owned_by": owned_by, "status": status }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments"
end
    Vellum::PaginatedSlimWorkflowDeploymentList.from_json(json_object: response.body)
  end
end

#list_workflow_deployment_event_executions(id:, filters: nil, limit: nil, offset: nil, ordering: nil, request_options: nil) ⇒ Object

api.workflow_deployments.list_workflow_deployment_event_executions(id: "id")



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 535

def list_workflow_deployment_event_executions(id:, filters: nil, limit: nil, offset: nil, ordering: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "filters": filters, "limit": limit, "offset": offset, "ordering": ordering }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{id}/execution-events"
end
    Vellum::WorkflowDeploymentEventExecutionsResponse.from_json(json_object: response.body)
  end
end

#list_workflow_deployment_releases(id:, limit: nil, offset: nil, ordering: nil, request_options: nil) ⇒ Object

api.workflow_deployments.list_workflow_deployment_releases(id: "id")



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 776

def list_workflow_deployment_releases(id:, limit: nil, offset: nil, ordering: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{id}/releases"
end
    Vellum::PaginatedWorkflowDeploymentReleaseList.from_json(json_object: response.body)
  end
end

#list_workflow_release_tags(id:, limit: nil, offset: nil, ordering: nil, source: nil, request_options: nil) ⇒ Object

api.workflow_deployments.list_workflow_release_tags(id: "id")



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 655

def list_workflow_release_tags(id:, limit: nil, offset: nil, ordering: nil, source: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "source": source }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{id}/release-tags"
end
    Vellum::PaginatedWorkflowReleaseTagReadList.from_json(json_object: response.body)
  end
end

#retrieve(id:, request_options: nil) ⇒ Object

api.workflow_deployments.retrieve(id: "id")



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 495

def retrieve(id:, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{id}"
end
    Vellum::WorkflowDeploymentRead.from_json(json_object: response.body)
  end
end

#retrieve_workflow_deployment_release(id:, release_id_or_release_tag:, request_options: nil) ⇒ Object

api.workflow_deployments.retrieve_workflow_deployment_release(id: "id", release_id_or_release_tag: "release_id_or_release_tag")



816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 816

def retrieve_workflow_deployment_release(id:, release_id_or_release_tag:, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{id}/releases/#{release_id_or_release_tag}"
end
    Vellum::WorkflowDeploymentRelease.from_json(json_object: response.body)
  end
end

#retrieve_workflow_release_tag(id:, name:, request_options: nil) ⇒ Object

api.workflow_deployments.retrieve_workflow_release_tag(id: "id", name: "name")



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 694

def retrieve_workflow_release_tag(id:, name:, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{id}/release-tags/#{name}"
end
    Vellum::WorkflowReleaseTagRead.from_json(json_object: response.body)
  end
end

#update_workflow_release_tag(id:, name:, history_item_id: nil, request_options: nil) ⇒ Object

api.workflow_deployments.update_workflow_release_tag(id: "id", name: "name")



736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 736

def update_workflow_release_tag(id:, name:, history_item_id: nil, request_options: nil)
  Async do
    response = @request_client.conn.patch do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), history_item_id: history_item_id }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{id}/release-tags/#{name}"
end
    Vellum::WorkflowReleaseTagRead.from_json(json_object: response.body)
  end
end

#workflow_deployment_event_execution(execution_id:, id:, request_options: nil) ⇒ Object

api.workflow_deployments.workflow_deployment_event_execution(execution_id: "execution_id", id: "id")



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 570

def workflow_deployment_event_execution(execution_id:, id:, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{execution_id}/execution-events/#{id}"
end
    Vellum::WorkflowEventExecutionRead.from_json(json_object: response.body)
  end
end

#workflow_deployment_history_item_retrieve(history_id_or_release_tag:, id:, request_options: nil) ⇒ Object

api.workflow_deployments.workflow_deployment_history_item_retrieve(history_id_or_release_tag: "history_id_or_release_tag", id: "id")



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/vellum_ai/workflow_deployments/client.rb', line 613

def workflow_deployment_history_item_retrieve(history_id_or_release_tag:, id:, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{history_id_or_release_tag}/history/#{id}"
end
    Vellum::WorkflowDeploymentHistoryItem.from_json(json_object: response.body)
  end
end