vellum_ai 1.8.1 → 1.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1c580b8f225b2a2768a4bc6a90a3d153045a79c1acff4158e7318087dd8dc1e4
4
- data.tar.gz: f2eea19fedefd011bea32a282586d6dbc4fe3592ac36949b45a67d6c99d06f29
3
+ metadata.gz: ace2ed6fd8e5651c9363138be55afcc2a0ddd3cb0023966631c123aaa1589816
4
+ data.tar.gz: 7117459a797e1d5261c6cd63018a2f4481f4cb4d582ff46e1c2379c6226cd7d9
5
5
  SHA512:
6
- metadata.gz: 54e023eb2a41b10e5153bcb63c4fb1bda84159437ec6cbf569bc4e3f20d2c7f11e083c3fcccea2d263bdab8c611f74572d9e0a8ae2b3faa88430f0f07028f94d
7
- data.tar.gz: e53358a1eba32901993b29254146c7fb742d5eefebd3c7528e3a7f54989b529a3baa0fc6ae1c91806c3e81d0709c1e2d907c3c56eeb1b62d03636dbb8b778149
6
+ metadata.gz: d53a04d047058e023c1172f1d4c9f0c6f2b787b8ab961447e0721ebb4941bca4209117203c01ac49bdb7fc115c4af04ceb642dea830e681af4b67c5788293413
7
+ data.tar.gz: 2fee8b745cf64595fcb1207b81ec5997f2c731ea5e8ac24412670da90023ce480b001bb64512cfcbb411d3111b70db742d53e32e41e13a52c7ae9b31b6c65610
data/lib/requests.rb CHANGED
@@ -56,7 +56,7 @@ end
56
56
  end
57
57
  # @return [Hash{String => String}]
58
58
  def get_headers
59
- headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.8.1' }
59
+ headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.9.5' }
60
60
  headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
61
61
  headers
62
62
  end
@@ -107,7 +107,7 @@ end
107
107
  end
108
108
  # @return [Hash{String => String}]
109
109
  def get_headers
110
- headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.8.1' }
110
+ headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.9.5' }
111
111
  headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
112
112
  headers
113
113
  end
data/lib/types_export.rb CHANGED
@@ -21,6 +21,7 @@ require_relative "vellum_ai/types/ad_hoc_fulfilled_prompt_execution_meta"
21
21
  require_relative "vellum_ai/types/ad_hoc_initiated_prompt_execution_meta"
22
22
  require_relative "vellum_ai/types/ad_hoc_rejected_prompt_execution_meta"
23
23
  require_relative "vellum_ai/types/ad_hoc_streaming_prompt_execution_meta"
24
+ require_relative "vellum_ai/types/api_actor_type_enum"
24
25
  require_relative "vellum_ai/types/api_node_result"
25
26
  require_relative "vellum_ai/types/api_node_result_data"
26
27
  require_relative "vellum_ai/types/api_version_enum"
@@ -280,6 +281,7 @@ require_relative "vellum_ai/types/components_schemas_composio_integration_exec_c
280
281
  require_relative "vellum_ai/types/integration_name"
281
282
  require_relative "vellum_ai/types/integration_provider"
282
283
  require_relative "vellum_ai/types/integration_read"
284
+ require_relative "vellum_ai/types/integration_trigger_context"
283
285
  require_relative "vellum_ai/types/invoked_port"
284
286
  require_relative "vellum_ai/types/iteration_state_enum"
285
287
  require_relative "vellum_ai/types/json_input_request"
@@ -401,6 +403,7 @@ require_relative "vellum_ai/types/workflow_parent_context"
401
403
  require_relative "vellum_ai/types/workflow_deployment_parent_context"
402
404
  require_relative "vellum_ai/types/workflow_sandbox_parent_context"
403
405
  require_relative "vellum_ai/types/prompt_deployment_parent_context"
406
+ require_relative "vellum_ai/types/scheduled_trigger_context"
404
407
  require_relative "vellum_ai/types/parent_context"
405
408
  require_relative "vellum_ai/types/pdf_search_result_meta_source"
406
409
  require_relative "vellum_ai/types/pdf_search_result_meta_source_request"
@@ -627,12 +630,14 @@ require_relative "vellum_ai/types/vellum_variable_type"
627
630
  require_relative "vellum_ai/types/vellum_video"
628
631
  require_relative "vellum_ai/types/vellum_video_request"
629
632
  require_relative "vellum_ai/types/vellum_workflow_execution_event"
633
+ require_relative "vellum_ai/types/workflow_deployment_display_data"
630
634
  require_relative "vellum_ai/types/workflow_deployment_event_executions_response"
631
635
  require_relative "vellum_ai/types/workflow_deployment_history_item"
632
636
  require_relative "vellum_ai/types/workflow_deployment_read"
633
637
  require_relative "vellum_ai/types/workflow_deployment_release"
634
638
  require_relative "vellum_ai/types/workflow_deployment_release_workflow_deployment"
635
639
  require_relative "vellum_ai/types/workflow_deployment_release_workflow_version"
640
+ require_relative "vellum_ai/types/workflow_display_icon"
636
641
  require_relative "vellum_ai/types/workflow_event_error"
637
642
  require_relative "vellum_ai/types/workflow_initialization_error"
638
643
  require_relative "vellum_ai/types/workflow_error"
@@ -694,6 +699,7 @@ require_relative "vellum_ai/types/workflow_result_event_output_data_array"
694
699
  require_relative "vellum_ai/types/workflow_result_event_output_data_function_call"
695
700
  require_relative "vellum_ai/types/workflow_result_event_output_data_error"
696
701
  require_relative "vellum_ai/types/workflow_result_event_output_data"
702
+ require_relative "vellum_ai/types/workflow_sandbox_display_data"
697
703
  require_relative "vellum_ai/types/workflow_sandbox_example"
698
704
  require_relative "vellum_ai/types/workflow_stream_event"
699
705
  require_relative "vellum_ai/types/workspace_read"
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Vellum
4
+ # * `WORKSPACE_API_KEY` - WORKSPACE_API_KEY
5
+ # * `ENVIRONMENT_API_KEY` - ENVIRONMENT_API_KEY
6
+ # * `JWT` - JWT
7
+ # * `SERVICE_TOKEN` - SERVICE_TOKEN
8
+ class ApiActorTypeEnum
9
+
10
+ WORKSPACE_API_KEY = "WORKSPACE_API_KEY"
11
+ ENVIRONMENT_API_KEY = "ENVIRONMENT_API_KEY"
12
+ JWT = "JWT"
13
+ SERVICE_TOKEN = "SERVICE_TOKEN"
14
+
15
+ end
16
+ end
@@ -1,6 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  require_relative "parent_context"
3
3
  require_relative "span_link"
4
+ require_relative "api_actor_type_enum"
4
5
  require "ostruct"
5
6
  require "json"
6
7
 
@@ -14,6 +15,12 @@ module Vellum
14
15
  attr_reader :type
15
16
  # @return [String]
16
17
  attr_reader :span_id
18
+ # @return [String]
19
+ attr_reader :api_actor_id
20
+ # @return [Vellum::ApiActorTypeEnum]
21
+ attr_reader :api_actor_type
22
+ # @return [String]
23
+ attr_reader :api_actor_label
17
24
  # @return [OpenStruct] Additional properties unmapped to the current class definition
18
25
  attr_reader :additional_properties
19
26
  # @return [Object]
@@ -26,15 +33,21 @@ module Vellum
26
33
  # @param links [Array<Vellum::SpanLink>]
27
34
  # @param type [String]
28
35
  # @param span_id [String]
36
+ # @param api_actor_id [String]
37
+ # @param api_actor_type [Vellum::ApiActorTypeEnum]
38
+ # @param api_actor_label [String]
29
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
30
40
  # @return [Vellum::ApiRequestParentContext]
31
- def initialize(parent: OMIT, links: OMIT, type:, span_id:, additional_properties: nil)
41
+ def initialize(parent: OMIT, links: OMIT, type:, span_id:, api_actor_id: OMIT, api_actor_type: OMIT, api_actor_label: OMIT, additional_properties: nil)
32
42
  @parent = parent if parent != OMIT
33
43
  @links = links if links != OMIT
34
44
  @type = type
35
45
  @span_id = span_id
46
+ @api_actor_id = api_actor_id if api_actor_id != OMIT
47
+ @api_actor_type = api_actor_type if api_actor_type != OMIT
48
+ @api_actor_label = api_actor_label if api_actor_label != OMIT
36
49
  @additional_properties = additional_properties
37
- @_field_set = { "parent": parent, "links": links, "type": type, "span_id": span_id }.reject do | _k, v |
50
+ @_field_set = { "parent": parent, "links": links, "type": type, "span_id": span_id, "api_actor_id": api_actor_id, "api_actor_type": api_actor_type, "api_actor_label": api_actor_label }.reject do | _k, v |
38
51
  v == OMIT
39
52
  end
40
53
  end
@@ -57,11 +70,17 @@ end
57
70
  end
58
71
  type = parsed_json["type"]
59
72
  span_id = parsed_json["span_id"]
73
+ api_actor_id = parsed_json["api_actor_id"]
74
+ api_actor_type = parsed_json["api_actor_type"]
75
+ api_actor_label = parsed_json["api_actor_label"]
60
76
  new(
61
77
  parent: parent,
62
78
  links: links,
63
79
  type: type,
64
80
  span_id: span_id,
81
+ api_actor_id: api_actor_id,
82
+ api_actor_type: api_actor_type,
83
+ api_actor_label: api_actor_label,
65
84
  additional_properties: struct
66
85
  )
67
86
  end
@@ -82,6 +101,9 @@ end
82
101
  obj.links&.is_a?(Array) != false || raise("Passed value for field obj.links is not the expected type, validation failed.")
83
102
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
84
103
  obj.span_id.is_a?(String) != false || raise("Passed value for field obj.span_id is not the expected type, validation failed.")
104
+ obj.api_actor_id&.is_a?(String) != false || raise("Passed value for field obj.api_actor_id is not the expected type, validation failed.")
105
+ obj.api_actor_type&.is_a?(Vellum::ApiActorTypeEnum) != false || raise("Passed value for field obj.api_actor_type is not the expected type, validation failed.")
106
+ obj.api_actor_label&.is_a?(String) != false || raise("Passed value for field obj.api_actor_label is not the expected type, validation failed.")
85
107
  end
86
108
  end
87
109
  end
@@ -3,6 +3,7 @@ require "date"
3
3
  require "date"
4
4
  require_relative "entity_status"
5
5
  require "date"
6
+ require_relative "workflow_sandbox_display_data"
6
7
  require "ostruct"
7
8
  require "json"
8
9
 
@@ -22,6 +23,8 @@ module Vellum
22
23
  attr_reader :description
23
24
  # @return [DateTime]
24
25
  attr_reader :last_deployed_on
26
+ # @return [Vellum::WorkflowSandboxDisplayData]
27
+ attr_reader :display_data
25
28
  # @return [OpenStruct] Additional properties unmapped to the current class definition
26
29
  attr_reader :additional_properties
27
30
  # @return [Object]
@@ -37,9 +40,10 @@ module Vellum
37
40
  # @param status [Vellum::EntityStatus]
38
41
  # @param description [String]
39
42
  # @param last_deployed_on [DateTime]
43
+ # @param display_data [Vellum::WorkflowSandboxDisplayData]
40
44
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
41
45
  # @return [Vellum::FolderEntityWorkflowSandboxData]
42
- def initialize(id:, label:, created:, modified:, status:, description: OMIT, last_deployed_on: OMIT, additional_properties: nil)
46
+ def initialize(id:, label:, created:, modified:, status:, description: OMIT, last_deployed_on: OMIT, display_data: OMIT, additional_properties: nil)
43
47
  @id = id
44
48
  @label = label
45
49
  @created = created
@@ -47,8 +51,9 @@ module Vellum
47
51
  @status = status
48
52
  @description = description if description != OMIT
49
53
  @last_deployed_on = last_deployed_on if last_deployed_on != OMIT
54
+ @display_data = display_data if display_data != OMIT
50
55
  @additional_properties = additional_properties
51
- @_field_set = { "id": id, "label": label, "created": created, "modified": modified, "status": status, "description": description, "last_deployed_on": last_deployed_on }.reject do | _k, v |
56
+ @_field_set = { "id": id, "label": label, "created": created, "modified": modified, "status": status, "description": description, "last_deployed_on": last_deployed_on, "display_data": display_data }.reject do | _k, v |
52
57
  v == OMIT
53
58
  end
54
59
  end
@@ -78,6 +83,12 @@ end
78
83
  else
79
84
  nil
80
85
  end
86
+ unless parsed_json["display_data"].nil?
87
+ display_data = parsed_json["display_data"].to_json
88
+ display_data = Vellum::WorkflowSandboxDisplayData.from_json(json_object: display_data)
89
+ else
90
+ display_data = nil
91
+ end
81
92
  new(
82
93
  id: id,
83
94
  label: label,
@@ -86,6 +97,7 @@ end
86
97
  status: status,
87
98
  description: description,
88
99
  last_deployed_on: last_deployed_on,
100
+ display_data: display_data,
89
101
  additional_properties: struct
90
102
  )
91
103
  end
@@ -109,6 +121,7 @@ end
109
121
  obj.status.is_a?(Vellum::EntityStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
110
122
  obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
111
123
  obj.last_deployed_on&.is_a?(DateTime) != false || raise("Passed value for field obj.last_deployed_on is not the expected type, validation failed.")
124
+ obj.display_data.nil? || Vellum::WorkflowSandboxDisplayData.validate_raw(obj: obj.display_data)
112
125
  end
113
126
  end
114
127
  end
@@ -23,6 +23,7 @@ module Vellum
23
23
  # * `APOLLO` - Apollo
24
24
  # * `ASANA` - Asana
25
25
  # * `ATLASSIAN` - Atlassian
26
+ # * `BITBUCKET` - Bitbucket
26
27
  # * `BOX` - Box
27
28
  # * `BREVO` - Brevo
28
29
  # * `BROWSERBASE_TOOL` - Browserbase Tool
@@ -38,6 +39,7 @@ module Vellum
38
39
  # * `JIRA` - Jira
39
40
  # * `KLAVIYO` - Klaviyo
40
41
  # * `PAGERDUTY` - PagerDuty
42
+ # * `PARSERA` - Parsera
41
43
  # * `PEOPLEDATALABS` - People Data Labs
42
44
  # * `PERPLEXITY` - Perplexity
43
45
  # * `POSTHOG` - PostHog
@@ -79,6 +81,7 @@ module Vellum
79
81
  APOLLO = "APOLLO"
80
82
  ASANA = "ASANA"
81
83
  ATLASSIAN = "ATLASSIAN"
84
+ BITBUCKET = "BITBUCKET"
82
85
  BOX = "BOX"
83
86
  BREVO = "BREVO"
84
87
  BROWSERBASE_TOOL = "BROWSERBASE_TOOL"
@@ -94,6 +97,7 @@ module Vellum
94
97
  JIRA = "JIRA"
95
98
  KLAVIYO = "KLAVIYO"
96
99
  PAGERDUTY = "PAGERDUTY"
100
+ PARSERA = "PARSERA"
97
101
  PEOPLEDATALABS = "PEOPLEDATALABS"
98
102
  PERPLEXITY = "PERPLEXITY"
99
103
  POSTHOG = "POSTHOG"
@@ -0,0 +1,87 @@
1
+ # frozen_string_literal: true
2
+ require_relative "parent_context"
3
+ require_relative "span_link"
4
+ require "ostruct"
5
+ require "json"
6
+
7
+ module Vellum
8
+ class IntegrationTriggerContext
9
+ # @return [Vellum::ParentContext]
10
+ attr_reader :parent
11
+ # @return [Array<Vellum::SpanLink>]
12
+ attr_reader :links
13
+ # @return [String]
14
+ attr_reader :type
15
+ # @return [String]
16
+ attr_reader :span_id
17
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
18
+ attr_reader :additional_properties
19
+ # @return [Object]
20
+ attr_reader :_field_set
21
+ protected :_field_set
22
+
23
+ OMIT = Object.new
24
+
25
+ # @param parent [Vellum::ParentContext]
26
+ # @param links [Array<Vellum::SpanLink>]
27
+ # @param type [String]
28
+ # @param span_id [String]
29
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
30
+ # @return [Vellum::IntegrationTriggerContext]
31
+ def initialize(parent: OMIT, links: OMIT, type:, span_id:, additional_properties: nil)
32
+ @parent = parent if parent != OMIT
33
+ @links = links if links != OMIT
34
+ @type = type
35
+ @span_id = span_id
36
+ @additional_properties = additional_properties
37
+ @_field_set = { "parent": parent, "links": links, "type": type, "span_id": span_id }.reject do | _k, v |
38
+ v == OMIT
39
+ end
40
+ end
41
+ # Deserialize a JSON object to an instance of IntegrationTriggerContext
42
+ #
43
+ # @param json_object [String]
44
+ # @return [Vellum::IntegrationTriggerContext]
45
+ def self.from_json(json_object:)
46
+ struct = JSON.parse(json_object, object_class: OpenStruct)
47
+ parsed_json = JSON.parse(json_object)
48
+ unless parsed_json["parent"].nil?
49
+ parent = parsed_json["parent"].to_json
50
+ parent = Vellum::ParentContext.from_json(json_object: parent)
51
+ else
52
+ parent = nil
53
+ end
54
+ links = parsed_json["links"]&.map do | item |
55
+ item = item.to_json
56
+ Vellum::SpanLink.from_json(json_object: item)
57
+ end
58
+ type = parsed_json["type"]
59
+ span_id = parsed_json["span_id"]
60
+ new(
61
+ parent: parent,
62
+ links: links,
63
+ type: type,
64
+ span_id: span_id,
65
+ additional_properties: struct
66
+ )
67
+ end
68
+ # Serialize an instance of IntegrationTriggerContext to a JSON object
69
+ #
70
+ # @return [String]
71
+ def to_json
72
+ @_field_set&.to_json
73
+ end
74
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
75
+ # hash and check each fields type against the current object's property
76
+ # definitions.
77
+ #
78
+ # @param obj [Object]
79
+ # @return [Void]
80
+ def self.validate_raw(obj:)
81
+ obj.parent.nil? || Vellum::ParentContext.validate_raw(obj: obj.parent)
82
+ obj.links&.is_a?(Array) != false || raise("Passed value for field obj.links is not the expected type, validation failed.")
83
+ obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
84
+ obj.span_id.is_a?(String) != false || raise("Passed value for field obj.span_id is not the expected type, validation failed.")
85
+ end
86
+ end
87
+ end
@@ -20,6 +20,8 @@ module Vellum
20
20
  # * `between` - BETWEEN
21
21
  # * `notBetween` - NOT_BETWEEN
22
22
  # * `concat` - CONCAT
23
+ # * `+` - ADD
24
+ # * `-` - MINUS
23
25
  # * `blank` - BLANK
24
26
  # * `notBlank` - NOT_BLANK
25
27
  # * `coalesce` - COALESCE
@@ -50,6 +52,8 @@ module Vellum
50
52
  BETWEEN = "between"
51
53
  NOT_BETWEEN = "notBetween"
52
54
  CONCAT = "concat"
55
+ ADD = "+"
56
+ MINUS = "-"
53
57
  BLANK = "blank"
54
58
  NOT_BLANK = "notBlank"
55
59
  COALESCE = "coalesce"
@@ -7,6 +7,8 @@ require_relative "workflow_sandbox_parent_context"
7
7
  require_relative "prompt_deployment_parent_context"
8
8
  require_relative "api_request_parent_context"
9
9
  require_relative "external_parent_context"
10
+ require_relative "scheduled_trigger_context"
11
+ require_relative "integration_trigger_context"
10
12
 
11
13
  module Vellum
12
14
  class ParentContext
@@ -84,6 +86,26 @@ end
84
86
  return Vellum::ExternalParentContext.from_json(json_object: struct)
85
87
  else
86
88
  return nil
89
+ end
90
+ rescue StandardError
91
+ # noop
92
+ end
93
+ begin
94
+ Vellum::ScheduledTriggerContext.validate_raw(obj: struct)
95
+ unless struct.nil?
96
+ return Vellum::ScheduledTriggerContext.from_json(json_object: struct)
97
+ else
98
+ return nil
99
+ end
100
+ rescue StandardError
101
+ # noop
102
+ end
103
+ begin
104
+ Vellum::IntegrationTriggerContext.validate_raw(obj: struct)
105
+ unless struct.nil?
106
+ return Vellum::IntegrationTriggerContext.from_json(json_object: struct)
107
+ else
108
+ return nil
87
109
  end
88
110
  rescue StandardError
89
111
  # noop
@@ -132,6 +154,16 @@ end
132
154
  rescue StandardError
133
155
  # noop
134
156
  end
157
+ begin
158
+ return Vellum::ScheduledTriggerContext.validate_raw(obj: obj)
159
+ rescue StandardError
160
+ # noop
161
+ end
162
+ begin
163
+ return Vellum::IntegrationTriggerContext.validate_raw(obj: obj)
164
+ rescue StandardError
165
+ # noop
166
+ end
135
167
  raise("Passed value matched no type within the union, validation failed.")
136
168
  end
137
169
  end
@@ -0,0 +1,87 @@
1
+ # frozen_string_literal: true
2
+ require_relative "parent_context"
3
+ require_relative "span_link"
4
+ require "ostruct"
5
+ require "json"
6
+
7
+ module Vellum
8
+ class ScheduledTriggerContext
9
+ # @return [Vellum::ParentContext]
10
+ attr_reader :parent
11
+ # @return [Array<Vellum::SpanLink>]
12
+ attr_reader :links
13
+ # @return [String]
14
+ attr_reader :type
15
+ # @return [String]
16
+ attr_reader :span_id
17
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
18
+ attr_reader :additional_properties
19
+ # @return [Object]
20
+ attr_reader :_field_set
21
+ protected :_field_set
22
+
23
+ OMIT = Object.new
24
+
25
+ # @param parent [Vellum::ParentContext]
26
+ # @param links [Array<Vellum::SpanLink>]
27
+ # @param type [String]
28
+ # @param span_id [String]
29
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
30
+ # @return [Vellum::ScheduledTriggerContext]
31
+ def initialize(parent: OMIT, links: OMIT, type:, span_id:, additional_properties: nil)
32
+ @parent = parent if parent != OMIT
33
+ @links = links if links != OMIT
34
+ @type = type
35
+ @span_id = span_id
36
+ @additional_properties = additional_properties
37
+ @_field_set = { "parent": parent, "links": links, "type": type, "span_id": span_id }.reject do | _k, v |
38
+ v == OMIT
39
+ end
40
+ end
41
+ # Deserialize a JSON object to an instance of ScheduledTriggerContext
42
+ #
43
+ # @param json_object [String]
44
+ # @return [Vellum::ScheduledTriggerContext]
45
+ def self.from_json(json_object:)
46
+ struct = JSON.parse(json_object, object_class: OpenStruct)
47
+ parsed_json = JSON.parse(json_object)
48
+ unless parsed_json["parent"].nil?
49
+ parent = parsed_json["parent"].to_json
50
+ parent = Vellum::ParentContext.from_json(json_object: parent)
51
+ else
52
+ parent = nil
53
+ end
54
+ links = parsed_json["links"]&.map do | item |
55
+ item = item.to_json
56
+ Vellum::SpanLink.from_json(json_object: item)
57
+ end
58
+ type = parsed_json["type"]
59
+ span_id = parsed_json["span_id"]
60
+ new(
61
+ parent: parent,
62
+ links: links,
63
+ type: type,
64
+ span_id: span_id,
65
+ additional_properties: struct
66
+ )
67
+ end
68
+ # Serialize an instance of ScheduledTriggerContext to a JSON object
69
+ #
70
+ # @return [String]
71
+ def to_json
72
+ @_field_set&.to_json
73
+ end
74
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
75
+ # hash and check each fields type against the current object's property
76
+ # definitions.
77
+ #
78
+ # @param obj [Object]
79
+ # @return [Void]
80
+ def self.validate_raw(obj:)
81
+ obj.parent.nil? || Vellum::ParentContext.validate_raw(obj: obj.parent)
82
+ obj.links&.is_a?(Array) != false || raise("Passed value for field obj.links is not the expected type, validation failed.")
83
+ obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
84
+ obj.span_id.is_a?(String) != false || raise("Passed value for field obj.span_id is not the expected type, validation failed.")
85
+ end
86
+ end
87
+ end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  require_relative "integration_auth_config_integration"
3
- require_relative "integration_auth_config_integration_credential"
4
3
  require_relative "auth_type_enum"
4
+ require_relative "integration_auth_config_integration_credential"
5
5
  require_relative "integration_credential_access_type"
6
6
  require "ostruct"
7
7
  require "json"
@@ -13,10 +13,13 @@ module Vellum
13
13
  attr_reader :id
14
14
  # @return [Vellum::IntegrationAuthConfigIntegration]
15
15
  attr_reader :integration
16
- # @return [Array<Vellum::IntegrationAuthConfigIntegrationCredential>]
17
- attr_reader :integration_credentials
18
16
  # @return [Vellum::AuthTypeEnum]
19
17
  attr_reader :auth_type
18
+ # @return [Array<Vellum::IntegrationAuthConfigIntegrationCredential>]
19
+ attr_reader :integration_credentials
20
+ # @return [Boolean] Whether or not this auth config is eligible to use Vellum-managed system
21
+ # credentials to authenticate.
22
+ attr_reader :system_credential_eligible
20
23
  # @return [Vellum::IntegrationCredentialAccessType]
21
24
  attr_reader :default_access_type
22
25
  # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -29,19 +32,22 @@ module Vellum
29
32
 
30
33
  # @param id [String]
31
34
  # @param integration [Vellum::IntegrationAuthConfigIntegration]
32
- # @param integration_credentials [Array<Vellum::IntegrationAuthConfigIntegrationCredential>]
33
35
  # @param auth_type [Vellum::AuthTypeEnum]
36
+ # @param integration_credentials [Array<Vellum::IntegrationAuthConfigIntegrationCredential>]
37
+ # @param system_credential_eligible [Boolean] Whether or not this auth config is eligible to use Vellum-managed system
38
+ # credentials to authenticate.
34
39
  # @param default_access_type [Vellum::IntegrationCredentialAccessType]
35
40
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
36
41
  # @return [Vellum::SlimIntegrationAuthConfigRead]
37
- def initialize(id:, integration:, integration_credentials: OMIT, auth_type: OMIT, default_access_type: OMIT, additional_properties: nil)
42
+ def initialize(id:, integration:, auth_type: OMIT, integration_credentials: OMIT, system_credential_eligible: OMIT, default_access_type: OMIT, additional_properties: nil)
38
43
  @id = id
39
44
  @integration = integration
40
- @integration_credentials = integration_credentials if integration_credentials != OMIT
41
45
  @auth_type = auth_type if auth_type != OMIT
46
+ @integration_credentials = integration_credentials if integration_credentials != OMIT
47
+ @system_credential_eligible = system_credential_eligible if system_credential_eligible != OMIT
42
48
  @default_access_type = default_access_type if default_access_type != OMIT
43
49
  @additional_properties = additional_properties
44
- @_field_set = { "id": id, "integration": integration, "integration_credentials": integration_credentials, "auth_type": auth_type, "default_access_type": default_access_type }.reject do | _k, v |
50
+ @_field_set = { "id": id, "integration": integration, "auth_type": auth_type, "integration_credentials": integration_credentials, "system_credential_eligible": system_credential_eligible, "default_access_type": default_access_type }.reject do | _k, v |
45
51
  v == OMIT
46
52
  end
47
53
  end
@@ -59,17 +65,19 @@ end
59
65
  else
60
66
  integration = nil
61
67
  end
68
+ auth_type = parsed_json["auth_type"]
62
69
  integration_credentials = parsed_json["integration_credentials"]&.map do | item |
63
70
  item = item.to_json
64
71
  Vellum::IntegrationAuthConfigIntegrationCredential.from_json(json_object: item)
65
72
  end
66
- auth_type = parsed_json["auth_type"]
73
+ system_credential_eligible = parsed_json["system_credential_eligible"]
67
74
  default_access_type = parsed_json["default_access_type"]
68
75
  new(
69
76
  id: id,
70
77
  integration: integration,
71
- integration_credentials: integration_credentials,
72
78
  auth_type: auth_type,
79
+ integration_credentials: integration_credentials,
80
+ system_credential_eligible: system_credential_eligible,
73
81
  default_access_type: default_access_type,
74
82
  additional_properties: struct
75
83
  )
@@ -89,8 +97,9 @@ end
89
97
  def self.validate_raw(obj:)
90
98
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
91
99
  Vellum::IntegrationAuthConfigIntegration.validate_raw(obj: obj.integration)
92
- obj.integration_credentials&.is_a?(Array) != false || raise("Passed value for field obj.integration_credentials is not the expected type, validation failed.")
93
100
  obj.auth_type&.is_a?(Vellum::AuthTypeEnum) != false || raise("Passed value for field obj.auth_type is not the expected type, validation failed.")
101
+ obj.integration_credentials&.is_a?(Array) != false || raise("Passed value for field obj.integration_credentials is not the expected type, validation failed.")
102
+ obj.system_credential_eligible&.is_a?(Boolean) != false || raise("Passed value for field obj.system_credential_eligible is not the expected type, validation failed.")
94
103
  obj.default_access_type&.is_a?(Vellum::IntegrationCredentialAccessType) != false || raise("Passed value for field obj.default_access_type is not the expected type, validation failed.")
95
104
  end
96
105
  end
@@ -0,0 +1,60 @@
1
+ # frozen_string_literal: true
2
+ require_relative "workflow_display_icon"
3
+ require "ostruct"
4
+ require "json"
5
+
6
+ module Vellum
7
+ # Workflow Deployment display data
8
+ class WorkflowDeploymentDisplayData
9
+ # @return [Vellum::WorkflowDisplayIcon] The icon associated with this Workflow Deployment.
10
+ attr_reader :icon
11
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
12
+ attr_reader :additional_properties
13
+ # @return [Object]
14
+ attr_reader :_field_set
15
+ protected :_field_set
16
+
17
+ OMIT = Object.new
18
+
19
+ # @param icon [Vellum::WorkflowDisplayIcon] The icon associated with this Workflow Deployment.
20
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
21
+ # @return [Vellum::WorkflowDeploymentDisplayData]
22
+ def initialize(icon: OMIT, additional_properties: nil)
23
+ @icon = icon if icon != OMIT
24
+ @additional_properties = additional_properties
25
+ @_field_set = { "icon": icon }.reject do | _k, v |
26
+ v == OMIT
27
+ end
28
+ end
29
+ # Deserialize a JSON object to an instance of WorkflowDeploymentDisplayData
30
+ #
31
+ # @param json_object [String]
32
+ # @return [Vellum::WorkflowDeploymentDisplayData]
33
+ def self.from_json(json_object:)
34
+ struct = JSON.parse(json_object, object_class: OpenStruct)
35
+ parsed_json = JSON.parse(json_object)
36
+ unless parsed_json["icon"].nil?
37
+ icon = parsed_json["icon"].to_json
38
+ icon = Vellum::WorkflowDisplayIcon.from_json(json_object: icon)
39
+ else
40
+ icon = nil
41
+ end
42
+ new(icon: icon, additional_properties: struct)
43
+ end
44
+ # Serialize an instance of WorkflowDeploymentDisplayData to a JSON object
45
+ #
46
+ # @return [String]
47
+ def to_json
48
+ @_field_set&.to_json
49
+ end
50
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
51
+ # hash and check each fields type against the current object's property
52
+ # definitions.
53
+ #
54
+ # @param obj [Object]
55
+ # @return [Void]
56
+ def self.validate_raw(obj:)
57
+ obj.icon.nil? || Vellum::WorkflowDisplayIcon.validate_raw(obj: obj.icon)
58
+ end
59
+ end
60
+ end
@@ -4,6 +4,7 @@ require_relative "environment_enum"
4
4
  require "date"
5
5
  require "date"
6
6
  require_relative "vellum_variable"
7
+ require_relative "workflow_deployment_display_data"
7
8
  require "ostruct"
8
9
  require "json"
9
10
 
@@ -37,6 +38,8 @@ module Vellum
37
38
  attr_reader :output_variables
38
39
  # @return [String] A human-readable description of the workflow deployment
39
40
  attr_reader :description
41
+ # @return [Vellum::WorkflowDeploymentDisplayData] Information used to display this Workflow Deployment.
42
+ attr_reader :display_data
40
43
  # @return [OpenStruct] Additional properties unmapped to the current class definition
41
44
  attr_reader :additional_properties
42
45
  # @return [Object]
@@ -61,9 +64,10 @@ module Vellum
61
64
  # @param output_variables [Array<Vellum::VellumVariable>] The output variables this Workflow Deployment produces values for when it's
62
65
  # executed.
63
66
  # @param description [String] A human-readable description of the workflow deployment
67
+ # @param display_data [Vellum::WorkflowDeploymentDisplayData] Information used to display this Workflow Deployment.
64
68
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
65
69
  # @return [Vellum::WorkflowDeploymentRead]
66
- def initialize(id:, name:, label:, status: OMIT, environment: OMIT, created:, last_deployed_on:, last_deployed_history_item_id:, input_variables:, output_variables:, description: OMIT, additional_properties: nil)
70
+ def initialize(id:, name:, label:, status: OMIT, environment: OMIT, created:, last_deployed_on:, last_deployed_history_item_id:, input_variables:, output_variables:, description: OMIT, display_data: OMIT, additional_properties: nil)
67
71
  @id = id
68
72
  @name = name
69
73
  @label = label
@@ -75,8 +79,9 @@ module Vellum
75
79
  @input_variables = input_variables
76
80
  @output_variables = output_variables
77
81
  @description = description if description != OMIT
82
+ @display_data = display_data if display_data != OMIT
78
83
  @additional_properties = additional_properties
79
- @_field_set = { "id": id, "name": name, "label": label, "status": status, "environment": environment, "created": created, "last_deployed_on": last_deployed_on, "last_deployed_history_item_id": last_deployed_history_item_id, "input_variables": input_variables, "output_variables": output_variables, "description": description }.reject do | _k, v |
84
+ @_field_set = { "id": id, "name": name, "label": label, "status": status, "environment": environment, "created": created, "last_deployed_on": last_deployed_on, "last_deployed_history_item_id": last_deployed_history_item_id, "input_variables": input_variables, "output_variables": output_variables, "description": description, "display_data": display_data }.reject do | _k, v |
80
85
  v == OMIT
81
86
  end
82
87
  end
@@ -112,6 +117,12 @@ end
112
117
  Vellum::VellumVariable.from_json(json_object: item)
113
118
  end
114
119
  description = parsed_json["description"]
120
+ unless parsed_json["display_data"].nil?
121
+ display_data = parsed_json["display_data"].to_json
122
+ display_data = Vellum::WorkflowDeploymentDisplayData.from_json(json_object: display_data)
123
+ else
124
+ display_data = nil
125
+ end
115
126
  new(
116
127
  id: id,
117
128
  name: name,
@@ -124,6 +135,7 @@ end
124
135
  input_variables: input_variables,
125
136
  output_variables: output_variables,
126
137
  description: description,
138
+ display_data: display_data,
127
139
  additional_properties: struct
128
140
  )
129
141
  end
@@ -151,6 +163,7 @@ end
151
163
  obj.input_variables.is_a?(Array) != false || raise("Passed value for field obj.input_variables is not the expected type, validation failed.")
152
164
  obj.output_variables.is_a?(Array) != false || raise("Passed value for field obj.output_variables is not the expected type, validation failed.")
153
165
  obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
166
+ obj.display_data.nil? || Vellum::WorkflowDeploymentDisplayData.validate_raw(obj: obj.display_data)
154
167
  end
155
168
  end
156
169
  end
@@ -0,0 +1,64 @@
1
+ # frozen_string_literal: true
2
+ require "ostruct"
3
+ require "json"
4
+
5
+ module Vellum
6
+ # Icon to be used alongside a Workflow
7
+ class WorkflowDisplayIcon
8
+ # @return [String]
9
+ attr_reader :src
10
+ # @return [String]
11
+ attr_reader :color
12
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
13
+ attr_reader :additional_properties
14
+ # @return [Object]
15
+ attr_reader :_field_set
16
+ protected :_field_set
17
+
18
+ OMIT = Object.new
19
+
20
+ # @param src [String]
21
+ # @param color [String]
22
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
23
+ # @return [Vellum::WorkflowDisplayIcon]
24
+ def initialize(src: OMIT, color: OMIT, additional_properties: nil)
25
+ @src = src if src != OMIT
26
+ @color = color if color != OMIT
27
+ @additional_properties = additional_properties
28
+ @_field_set = { "src": src, "color": color }.reject do | _k, v |
29
+ v == OMIT
30
+ end
31
+ end
32
+ # Deserialize a JSON object to an instance of WorkflowDisplayIcon
33
+ #
34
+ # @param json_object [String]
35
+ # @return [Vellum::WorkflowDisplayIcon]
36
+ def self.from_json(json_object:)
37
+ struct = JSON.parse(json_object, object_class: OpenStruct)
38
+ parsed_json = JSON.parse(json_object)
39
+ src = parsed_json["src"]
40
+ color = parsed_json["color"]
41
+ new(
42
+ src: src,
43
+ color: color,
44
+ additional_properties: struct
45
+ )
46
+ end
47
+ # Serialize an instance of WorkflowDisplayIcon to a JSON object
48
+ #
49
+ # @return [String]
50
+ def to_json
51
+ @_field_set&.to_json
52
+ end
53
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
54
+ # hash and check each fields type against the current object's property
55
+ # definitions.
56
+ #
57
+ # @param obj [Object]
58
+ # @return [Void]
59
+ def self.validate_raw(obj:)
60
+ obj.src&.is_a?(String) != false || raise("Passed value for field obj.src is not the expected type, validation failed.")
61
+ obj.color&.is_a?(String) != false || raise("Passed value for field obj.color is not the expected type, validation failed.")
62
+ end
63
+ end
64
+ end
@@ -0,0 +1,60 @@
1
+ # frozen_string_literal: true
2
+ require_relative "workflow_display_icon"
3
+ require "ostruct"
4
+ require "json"
5
+
6
+ module Vellum
7
+ # Information used to display this Workflow Sandbox.
8
+ class WorkflowSandboxDisplayData
9
+ # @return [Vellum::WorkflowDisplayIcon] The icon associated with this Workflow Sandbox.
10
+ attr_reader :icon
11
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
12
+ attr_reader :additional_properties
13
+ # @return [Object]
14
+ attr_reader :_field_set
15
+ protected :_field_set
16
+
17
+ OMIT = Object.new
18
+
19
+ # @param icon [Vellum::WorkflowDisplayIcon] The icon associated with this Workflow Sandbox.
20
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
21
+ # @return [Vellum::WorkflowSandboxDisplayData]
22
+ def initialize(icon: OMIT, additional_properties: nil)
23
+ @icon = icon if icon != OMIT
24
+ @additional_properties = additional_properties
25
+ @_field_set = { "icon": icon }.reject do | _k, v |
26
+ v == OMIT
27
+ end
28
+ end
29
+ # Deserialize a JSON object to an instance of WorkflowSandboxDisplayData
30
+ #
31
+ # @param json_object [String]
32
+ # @return [Vellum::WorkflowSandboxDisplayData]
33
+ def self.from_json(json_object:)
34
+ struct = JSON.parse(json_object, object_class: OpenStruct)
35
+ parsed_json = JSON.parse(json_object)
36
+ unless parsed_json["icon"].nil?
37
+ icon = parsed_json["icon"].to_json
38
+ icon = Vellum::WorkflowDisplayIcon.from_json(json_object: icon)
39
+ else
40
+ icon = nil
41
+ end
42
+ new(icon: icon, additional_properties: struct)
43
+ end
44
+ # Serialize an instance of WorkflowSandboxDisplayData to a JSON object
45
+ #
46
+ # @return [String]
47
+ def to_json
48
+ @_field_set&.to_json
49
+ end
50
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
51
+ # hash and check each fields type against the current object's property
52
+ # definitions.
53
+ #
54
+ # @param obj [Object]
55
+ # @return [Void]
56
+ def self.validate_raw(obj:)
57
+ obj.icon.nil? || Vellum::WorkflowDisplayIcon.validate_raw(obj: obj.icon)
58
+ end
59
+ end
60
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: vellum_ai
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.8.1
4
+ version: 1.9.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vellum
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-10-26 00:00:00.000000000 Z
11
+ date: 2025-11-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -165,6 +165,7 @@ files:
165
165
  - lib/vellum_ai/types/ad_hoc_initiated_prompt_execution_meta.rb
166
166
  - lib/vellum_ai/types/ad_hoc_rejected_prompt_execution_meta.rb
167
167
  - lib/vellum_ai/types/ad_hoc_streaming_prompt_execution_meta.rb
168
+ - lib/vellum_ai/types/api_actor_type_enum.rb
168
169
  - lib/vellum_ai/types/api_node_result.rb
169
170
  - lib/vellum_ai/types/api_node_result_data.rb
170
171
  - lib/vellum_ai/types/api_request_parent_context.rb
@@ -385,6 +386,7 @@ files:
385
386
  - lib/vellum_ai/types/integration_name.rb
386
387
  - lib/vellum_ai/types/integration_provider.rb
387
388
  - lib/vellum_ai/types/integration_read.rb
389
+ - lib/vellum_ai/types/integration_trigger_context.rb
388
390
  - lib/vellum_ai/types/invoked_port.rb
389
391
  - lib/vellum_ai/types/iteration_state_enum.rb
390
392
  - lib/vellum_ai/types/jinja_prompt_block.rb
@@ -577,6 +579,7 @@ files:
577
579
  - lib/vellum_ai/types/scenario_input_json_variable_value.rb
578
580
  - lib/vellum_ai/types/scenario_input_string_variable_value.rb
579
581
  - lib/vellum_ai/types/scenario_input_video_variable_value.rb
582
+ - lib/vellum_ai/types/scheduled_trigger_context.rb
580
583
  - lib/vellum_ai/types/search_filters_request.rb
581
584
  - lib/vellum_ai/types/search_node_result.rb
582
585
  - lib/vellum_ai/types/search_node_result_data.rb
@@ -764,6 +767,7 @@ files:
764
767
  - lib/vellum_ai/types/video_prompt_block.rb
765
768
  - lib/vellum_ai/types/video_vellum_value.rb
766
769
  - lib/vellum_ai/types/video_vellum_value_request.rb
770
+ - lib/vellum_ai/types/workflow_deployment_display_data.rb
767
771
  - lib/vellum_ai/types/workflow_deployment_event_executions_response.rb
768
772
  - lib/vellum_ai/types/workflow_deployment_history_item.rb
769
773
  - lib/vellum_ai/types/workflow_deployment_parent_context.rb
@@ -771,6 +775,7 @@ files:
771
775
  - lib/vellum_ai/types/workflow_deployment_release.rb
772
776
  - lib/vellum_ai/types/workflow_deployment_release_workflow_deployment.rb
773
777
  - lib/vellum_ai/types/workflow_deployment_release_workflow_version.rb
778
+ - lib/vellum_ai/types/workflow_display_icon.rb
774
779
  - lib/vellum_ai/types/workflow_error.rb
775
780
  - lib/vellum_ai/types/workflow_event.rb
776
781
  - lib/vellum_ai/types/workflow_event_error.rb
@@ -846,6 +851,7 @@ files:
846
851
  - lib/vellum_ai/types/workflow_result_event_output_data_number.rb
847
852
  - lib/vellum_ai/types/workflow_result_event_output_data_search_results.rb
848
853
  - lib/vellum_ai/types/workflow_result_event_output_data_string.rb
854
+ - lib/vellum_ai/types/workflow_sandbox_display_data.rb
849
855
  - lib/vellum_ai/types/workflow_sandbox_example.rb
850
856
  - lib/vellum_ai/types/workflow_sandbox_parent_context.rb
851
857
  - lib/vellum_ai/types/workflow_stream_event.rb