vellum_ai 1.2.3 → 1.2.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 +4 -4
- data/lib/requests.rb +2 -2
- data/lib/types_export.rb +24 -0
- data/lib/vellum_ai/types/audio_input.rb +75 -0
- data/lib/vellum_ai/types/code_executor_input.rb +64 -0
- data/lib/vellum_ai/types/document_input.rb +75 -0
- data/lib/vellum_ai/types/image_input.rb +75 -0
- data/lib/vellum_ai/types/named_scenario_input_audio_variable_value_request.rb +76 -0
- data/lib/vellum_ai/types/named_scenario_input_document_variable_value_request.rb +76 -0
- data/lib/vellum_ai/types/named_scenario_input_image_variable_value_request.rb +76 -0
- data/lib/vellum_ai/types/named_scenario_input_request.rb +64 -0
- data/lib/vellum_ai/types/named_scenario_input_video_variable_value_request.rb +76 -0
- data/lib/vellum_ai/types/named_test_case_audio_variable_value.rb +75 -0
- data/lib/vellum_ai/types/named_test_case_audio_variable_value_request.rb +76 -0
- data/lib/vellum_ai/types/named_test_case_document_variable_value.rb +74 -0
- data/lib/vellum_ai/types/named_test_case_document_variable_value_request.rb +76 -0
- data/lib/vellum_ai/types/named_test_case_image_variable_value.rb +74 -0
- data/lib/vellum_ai/types/named_test_case_image_variable_value_request.rb +75 -0
- data/lib/vellum_ai/types/named_test_case_variable_value.rb +64 -0
- data/lib/vellum_ai/types/named_test_case_variable_value_request.rb +64 -0
- data/lib/vellum_ai/types/named_test_case_video_variable_value.rb +74 -0
- data/lib/vellum_ai/types/named_test_case_video_variable_value_request.rb +75 -0
- data/lib/vellum_ai/types/node_execution_span_attributes.rb +11 -2
- data/lib/vellum_ai/types/scenario_input.rb +64 -0
- data/lib/vellum_ai/types/scenario_input_audio_variable_value.rb +74 -0
- data/lib/vellum_ai/types/scenario_input_document_variable_value.rb +74 -0
- data/lib/vellum_ai/types/scenario_input_image_variable_value.rb +74 -0
- data/lib/vellum_ai/types/scenario_input_video_variable_value.rb +74 -0
- data/lib/vellum_ai/types/span_link.rb +3 -3
- data/lib/vellum_ai/types/span_link_type_enum.rb +10 -1
- data/lib/vellum_ai/types/test_case_audio_variable_value.rb +84 -0
- data/lib/vellum_ai/types/test_case_document_variable_value.rb +84 -0
- data/lib/vellum_ai/types/test_case_image_variable_value.rb +84 -0
- data/lib/vellum_ai/types/test_case_variable_value.rb +64 -0
- data/lib/vellum_ai/types/test_case_video_variable_value.rb +84 -0
- data/lib/vellum_ai/types/video_input.rb +75 -0
- data/lib/vellum_ai/types/workflow_push_deployment_config_request.rb +9 -2
- data/lib/vellum_ai/workflows/client.rb +12 -4
- metadata +26 -2
@@ -1,5 +1,14 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
module Vellum
|
4
|
-
|
4
|
+
# * `TRIGGERED_BY` - TRIGGERED_BY
|
5
|
+
# * `PREVIOUS_SPAN` - PREVIOUS_SPAN
|
6
|
+
# * `ROOT_SPAN` - ROOT_SPAN
|
7
|
+
class SpanLinkTypeEnum
|
8
|
+
|
9
|
+
TRIGGERED_BY = "TRIGGERED_BY"
|
10
|
+
PREVIOUS_SPAN = "PREVIOUS_SPAN"
|
11
|
+
ROOT_SPAN = "ROOT_SPAN"
|
12
|
+
|
13
|
+
end
|
5
14
|
end
|
@@ -0,0 +1,84 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require_relative "vellum_audio"
|
3
|
+
require "ostruct"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Vellum
|
7
|
+
# An audio value for a variable in a Test Case.
|
8
|
+
class TestCaseAudioVariableValue
|
9
|
+
# @return [String]
|
10
|
+
attr_reader :variable_id
|
11
|
+
# @return [String]
|
12
|
+
attr_reader :name
|
13
|
+
# @return [String]
|
14
|
+
attr_reader :type
|
15
|
+
# @return [Vellum::VellumAudio]
|
16
|
+
attr_reader :value
|
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 variable_id [String]
|
26
|
+
# @param name [String]
|
27
|
+
# @param type [String]
|
28
|
+
# @param value [Vellum::VellumAudio]
|
29
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
30
|
+
# @return [Vellum::TestCaseAudioVariableValue]
|
31
|
+
def initialize(variable_id:, name: OMIT, type:, value:, additional_properties: nil)
|
32
|
+
@variable_id = variable_id
|
33
|
+
@name = name if name != OMIT
|
34
|
+
@type = type
|
35
|
+
@value = value
|
36
|
+
@additional_properties = additional_properties
|
37
|
+
@_field_set = { "variable_id": variable_id, "name": name, "type": type, "value": value }.reject do | _k, v |
|
38
|
+
v == OMIT
|
39
|
+
end
|
40
|
+
end
|
41
|
+
# Deserialize a JSON object to an instance of TestCaseAudioVariableValue
|
42
|
+
#
|
43
|
+
# @param json_object [String]
|
44
|
+
# @return [Vellum::TestCaseAudioVariableValue]
|
45
|
+
def self.from_json(json_object:)
|
46
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
47
|
+
parsed_json = JSON.parse(json_object)
|
48
|
+
variable_id = parsed_json["variable_id"]
|
49
|
+
name = parsed_json["name"]
|
50
|
+
type = parsed_json["type"]
|
51
|
+
unless parsed_json["value"].nil?
|
52
|
+
value = parsed_json["value"].to_json
|
53
|
+
value = Vellum::VellumAudio.from_json(json_object: value)
|
54
|
+
else
|
55
|
+
value = nil
|
56
|
+
end
|
57
|
+
new(
|
58
|
+
variable_id: variable_id,
|
59
|
+
name: name,
|
60
|
+
type: type,
|
61
|
+
value: value,
|
62
|
+
additional_properties: struct
|
63
|
+
)
|
64
|
+
end
|
65
|
+
# Serialize an instance of TestCaseAudioVariableValue to a JSON object
|
66
|
+
#
|
67
|
+
# @return [String]
|
68
|
+
def to_json
|
69
|
+
@_field_set&.to_json
|
70
|
+
end
|
71
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
72
|
+
# hash and check each fields type against the current object's property
|
73
|
+
# definitions.
|
74
|
+
#
|
75
|
+
# @param obj [Object]
|
76
|
+
# @return [Void]
|
77
|
+
def self.validate_raw(obj:)
|
78
|
+
obj.variable_id.is_a?(String) != false || raise("Passed value for field obj.variable_id is not the expected type, validation failed.")
|
79
|
+
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
80
|
+
obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
|
81
|
+
Vellum::VellumAudio.validate_raw(obj: obj.value)
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
@@ -0,0 +1,84 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require_relative "vellum_document"
|
3
|
+
require "ostruct"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Vellum
|
7
|
+
# A document value for a variable in a Test Case.
|
8
|
+
class TestCaseDocumentVariableValue
|
9
|
+
# @return [String]
|
10
|
+
attr_reader :variable_id
|
11
|
+
# @return [String]
|
12
|
+
attr_reader :name
|
13
|
+
# @return [String]
|
14
|
+
attr_reader :type
|
15
|
+
# @return [Vellum::VellumDocument]
|
16
|
+
attr_reader :value
|
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 variable_id [String]
|
26
|
+
# @param name [String]
|
27
|
+
# @param type [String]
|
28
|
+
# @param value [Vellum::VellumDocument]
|
29
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
30
|
+
# @return [Vellum::TestCaseDocumentVariableValue]
|
31
|
+
def initialize(variable_id:, name: OMIT, type:, value:, additional_properties: nil)
|
32
|
+
@variable_id = variable_id
|
33
|
+
@name = name if name != OMIT
|
34
|
+
@type = type
|
35
|
+
@value = value
|
36
|
+
@additional_properties = additional_properties
|
37
|
+
@_field_set = { "variable_id": variable_id, "name": name, "type": type, "value": value }.reject do | _k, v |
|
38
|
+
v == OMIT
|
39
|
+
end
|
40
|
+
end
|
41
|
+
# Deserialize a JSON object to an instance of TestCaseDocumentVariableValue
|
42
|
+
#
|
43
|
+
# @param json_object [String]
|
44
|
+
# @return [Vellum::TestCaseDocumentVariableValue]
|
45
|
+
def self.from_json(json_object:)
|
46
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
47
|
+
parsed_json = JSON.parse(json_object)
|
48
|
+
variable_id = parsed_json["variable_id"]
|
49
|
+
name = parsed_json["name"]
|
50
|
+
type = parsed_json["type"]
|
51
|
+
unless parsed_json["value"].nil?
|
52
|
+
value = parsed_json["value"].to_json
|
53
|
+
value = Vellum::VellumDocument.from_json(json_object: value)
|
54
|
+
else
|
55
|
+
value = nil
|
56
|
+
end
|
57
|
+
new(
|
58
|
+
variable_id: variable_id,
|
59
|
+
name: name,
|
60
|
+
type: type,
|
61
|
+
value: value,
|
62
|
+
additional_properties: struct
|
63
|
+
)
|
64
|
+
end
|
65
|
+
# Serialize an instance of TestCaseDocumentVariableValue to a JSON object
|
66
|
+
#
|
67
|
+
# @return [String]
|
68
|
+
def to_json
|
69
|
+
@_field_set&.to_json
|
70
|
+
end
|
71
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
72
|
+
# hash and check each fields type against the current object's property
|
73
|
+
# definitions.
|
74
|
+
#
|
75
|
+
# @param obj [Object]
|
76
|
+
# @return [Void]
|
77
|
+
def self.validate_raw(obj:)
|
78
|
+
obj.variable_id.is_a?(String) != false || raise("Passed value for field obj.variable_id is not the expected type, validation failed.")
|
79
|
+
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
80
|
+
obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
|
81
|
+
Vellum::VellumDocument.validate_raw(obj: obj.value)
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
@@ -0,0 +1,84 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require_relative "vellum_image"
|
3
|
+
require "ostruct"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Vellum
|
7
|
+
# An image value for a variable in a Test Case.
|
8
|
+
class TestCaseImageVariableValue
|
9
|
+
# @return [String]
|
10
|
+
attr_reader :variable_id
|
11
|
+
# @return [String]
|
12
|
+
attr_reader :name
|
13
|
+
# @return [String]
|
14
|
+
attr_reader :type
|
15
|
+
# @return [Vellum::VellumImage]
|
16
|
+
attr_reader :value
|
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 variable_id [String]
|
26
|
+
# @param name [String]
|
27
|
+
# @param type [String]
|
28
|
+
# @param value [Vellum::VellumImage]
|
29
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
30
|
+
# @return [Vellum::TestCaseImageVariableValue]
|
31
|
+
def initialize(variable_id:, name: OMIT, type:, value:, additional_properties: nil)
|
32
|
+
@variable_id = variable_id
|
33
|
+
@name = name if name != OMIT
|
34
|
+
@type = type
|
35
|
+
@value = value
|
36
|
+
@additional_properties = additional_properties
|
37
|
+
@_field_set = { "variable_id": variable_id, "name": name, "type": type, "value": value }.reject do | _k, v |
|
38
|
+
v == OMIT
|
39
|
+
end
|
40
|
+
end
|
41
|
+
# Deserialize a JSON object to an instance of TestCaseImageVariableValue
|
42
|
+
#
|
43
|
+
# @param json_object [String]
|
44
|
+
# @return [Vellum::TestCaseImageVariableValue]
|
45
|
+
def self.from_json(json_object:)
|
46
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
47
|
+
parsed_json = JSON.parse(json_object)
|
48
|
+
variable_id = parsed_json["variable_id"]
|
49
|
+
name = parsed_json["name"]
|
50
|
+
type = parsed_json["type"]
|
51
|
+
unless parsed_json["value"].nil?
|
52
|
+
value = parsed_json["value"].to_json
|
53
|
+
value = Vellum::VellumImage.from_json(json_object: value)
|
54
|
+
else
|
55
|
+
value = nil
|
56
|
+
end
|
57
|
+
new(
|
58
|
+
variable_id: variable_id,
|
59
|
+
name: name,
|
60
|
+
type: type,
|
61
|
+
value: value,
|
62
|
+
additional_properties: struct
|
63
|
+
)
|
64
|
+
end
|
65
|
+
# Serialize an instance of TestCaseImageVariableValue to a JSON object
|
66
|
+
#
|
67
|
+
# @return [String]
|
68
|
+
def to_json
|
69
|
+
@_field_set&.to_json
|
70
|
+
end
|
71
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
72
|
+
# hash and check each fields type against the current object's property
|
73
|
+
# definitions.
|
74
|
+
#
|
75
|
+
# @param obj [Object]
|
76
|
+
# @return [Void]
|
77
|
+
def self.validate_raw(obj:)
|
78
|
+
obj.variable_id.is_a?(String) != false || raise("Passed value for field obj.variable_id is not the expected type, validation failed.")
|
79
|
+
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
80
|
+
obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
|
81
|
+
Vellum::VellumImage.validate_raw(obj: obj.value)
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
@@ -8,6 +8,10 @@ require_relative "test_case_search_results_variable_value"
|
|
8
8
|
require_relative "test_case_error_variable_value"
|
9
9
|
require_relative "test_case_function_call_variable_value"
|
10
10
|
require_relative "test_case_array_variable_value"
|
11
|
+
require_relative "test_case_audio_variable_value"
|
12
|
+
require_relative "test_case_image_variable_value"
|
13
|
+
require_relative "test_case_video_variable_value"
|
14
|
+
require_relative "test_case_document_variable_value"
|
11
15
|
|
12
16
|
module Vellum
|
13
17
|
class TestCaseVariableValue
|
@@ -95,6 +99,46 @@ end
|
|
95
99
|
return Vellum::TestCaseArrayVariableValue.from_json(json_object: struct)
|
96
100
|
else
|
97
101
|
return nil
|
102
|
+
end
|
103
|
+
rescue StandardError
|
104
|
+
# noop
|
105
|
+
end
|
106
|
+
begin
|
107
|
+
Vellum::TestCaseAudioVariableValue.validate_raw(obj: struct)
|
108
|
+
unless struct.nil?
|
109
|
+
return Vellum::TestCaseAudioVariableValue.from_json(json_object: struct)
|
110
|
+
else
|
111
|
+
return nil
|
112
|
+
end
|
113
|
+
rescue StandardError
|
114
|
+
# noop
|
115
|
+
end
|
116
|
+
begin
|
117
|
+
Vellum::TestCaseImageVariableValue.validate_raw(obj: struct)
|
118
|
+
unless struct.nil?
|
119
|
+
return Vellum::TestCaseImageVariableValue.from_json(json_object: struct)
|
120
|
+
else
|
121
|
+
return nil
|
122
|
+
end
|
123
|
+
rescue StandardError
|
124
|
+
# noop
|
125
|
+
end
|
126
|
+
begin
|
127
|
+
Vellum::TestCaseVideoVariableValue.validate_raw(obj: struct)
|
128
|
+
unless struct.nil?
|
129
|
+
return Vellum::TestCaseVideoVariableValue.from_json(json_object: struct)
|
130
|
+
else
|
131
|
+
return nil
|
132
|
+
end
|
133
|
+
rescue StandardError
|
134
|
+
# noop
|
135
|
+
end
|
136
|
+
begin
|
137
|
+
Vellum::TestCaseDocumentVariableValue.validate_raw(obj: struct)
|
138
|
+
unless struct.nil?
|
139
|
+
return Vellum::TestCaseDocumentVariableValue.from_json(json_object: struct)
|
140
|
+
else
|
141
|
+
return nil
|
98
142
|
end
|
99
143
|
rescue StandardError
|
100
144
|
# noop
|
@@ -148,6 +192,26 @@ end
|
|
148
192
|
rescue StandardError
|
149
193
|
# noop
|
150
194
|
end
|
195
|
+
begin
|
196
|
+
return Vellum::TestCaseAudioVariableValue.validate_raw(obj: obj)
|
197
|
+
rescue StandardError
|
198
|
+
# noop
|
199
|
+
end
|
200
|
+
begin
|
201
|
+
return Vellum::TestCaseImageVariableValue.validate_raw(obj: obj)
|
202
|
+
rescue StandardError
|
203
|
+
# noop
|
204
|
+
end
|
205
|
+
begin
|
206
|
+
return Vellum::TestCaseVideoVariableValue.validate_raw(obj: obj)
|
207
|
+
rescue StandardError
|
208
|
+
# noop
|
209
|
+
end
|
210
|
+
begin
|
211
|
+
return Vellum::TestCaseDocumentVariableValue.validate_raw(obj: obj)
|
212
|
+
rescue StandardError
|
213
|
+
# noop
|
214
|
+
end
|
151
215
|
raise("Passed value matched no type within the union, validation failed.")
|
152
216
|
end
|
153
217
|
end
|
@@ -0,0 +1,84 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require_relative "vellum_video"
|
3
|
+
require "ostruct"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Vellum
|
7
|
+
# A video value for a variable in a Test Case.
|
8
|
+
class TestCaseVideoVariableValue
|
9
|
+
# @return [String]
|
10
|
+
attr_reader :variable_id
|
11
|
+
# @return [String]
|
12
|
+
attr_reader :name
|
13
|
+
# @return [String]
|
14
|
+
attr_reader :type
|
15
|
+
# @return [Vellum::VellumVideo]
|
16
|
+
attr_reader :value
|
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 variable_id [String]
|
26
|
+
# @param name [String]
|
27
|
+
# @param type [String]
|
28
|
+
# @param value [Vellum::VellumVideo]
|
29
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
30
|
+
# @return [Vellum::TestCaseVideoVariableValue]
|
31
|
+
def initialize(variable_id:, name: OMIT, type:, value:, additional_properties: nil)
|
32
|
+
@variable_id = variable_id
|
33
|
+
@name = name if name != OMIT
|
34
|
+
@type = type
|
35
|
+
@value = value
|
36
|
+
@additional_properties = additional_properties
|
37
|
+
@_field_set = { "variable_id": variable_id, "name": name, "type": type, "value": value }.reject do | _k, v |
|
38
|
+
v == OMIT
|
39
|
+
end
|
40
|
+
end
|
41
|
+
# Deserialize a JSON object to an instance of TestCaseVideoVariableValue
|
42
|
+
#
|
43
|
+
# @param json_object [String]
|
44
|
+
# @return [Vellum::TestCaseVideoVariableValue]
|
45
|
+
def self.from_json(json_object:)
|
46
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
47
|
+
parsed_json = JSON.parse(json_object)
|
48
|
+
variable_id = parsed_json["variable_id"]
|
49
|
+
name = parsed_json["name"]
|
50
|
+
type = parsed_json["type"]
|
51
|
+
unless parsed_json["value"].nil?
|
52
|
+
value = parsed_json["value"].to_json
|
53
|
+
value = Vellum::VellumVideo.from_json(json_object: value)
|
54
|
+
else
|
55
|
+
value = nil
|
56
|
+
end
|
57
|
+
new(
|
58
|
+
variable_id: variable_id,
|
59
|
+
name: name,
|
60
|
+
type: type,
|
61
|
+
value: value,
|
62
|
+
additional_properties: struct
|
63
|
+
)
|
64
|
+
end
|
65
|
+
# Serialize an instance of TestCaseVideoVariableValue to a JSON object
|
66
|
+
#
|
67
|
+
# @return [String]
|
68
|
+
def to_json
|
69
|
+
@_field_set&.to_json
|
70
|
+
end
|
71
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
72
|
+
# hash and check each fields type against the current object's property
|
73
|
+
# definitions.
|
74
|
+
#
|
75
|
+
# @param obj [Object]
|
76
|
+
# @return [Void]
|
77
|
+
def self.validate_raw(obj:)
|
78
|
+
obj.variable_id.is_a?(String) != false || raise("Passed value for field obj.variable_id is not the expected type, validation failed.")
|
79
|
+
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
80
|
+
obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
|
81
|
+
Vellum::VellumVideo.validate_raw(obj: obj.value)
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
@@ -0,0 +1,75 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require_relative "vellum_video"
|
3
|
+
require "ostruct"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Vellum
|
7
|
+
# A user input representing a Vellum Video value
|
8
|
+
class VideoInput
|
9
|
+
# @return [String] The variable's name
|
10
|
+
attr_reader :name
|
11
|
+
# @return [String]
|
12
|
+
attr_reader :type
|
13
|
+
# @return [Vellum::VellumVideo]
|
14
|
+
attr_reader :value
|
15
|
+
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
16
|
+
attr_reader :additional_properties
|
17
|
+
# @return [Object]
|
18
|
+
attr_reader :_field_set
|
19
|
+
protected :_field_set
|
20
|
+
|
21
|
+
OMIT = Object.new
|
22
|
+
|
23
|
+
# @param name [String] The variable's name
|
24
|
+
# @param type [String]
|
25
|
+
# @param value [Vellum::VellumVideo]
|
26
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
27
|
+
# @return [Vellum::VideoInput]
|
28
|
+
def initialize(name:, type:, value:, additional_properties: nil)
|
29
|
+
@name = name
|
30
|
+
@type = type
|
31
|
+
@value = value
|
32
|
+
@additional_properties = additional_properties
|
33
|
+
@_field_set = { "name": name, "type": type, "value": value }
|
34
|
+
end
|
35
|
+
# Deserialize a JSON object to an instance of VideoInput
|
36
|
+
#
|
37
|
+
# @param json_object [String]
|
38
|
+
# @return [Vellum::VideoInput]
|
39
|
+
def self.from_json(json_object:)
|
40
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
41
|
+
parsed_json = JSON.parse(json_object)
|
42
|
+
name = parsed_json["name"]
|
43
|
+
type = parsed_json["type"]
|
44
|
+
unless parsed_json["value"].nil?
|
45
|
+
value = parsed_json["value"].to_json
|
46
|
+
value = Vellum::VellumVideo.from_json(json_object: value)
|
47
|
+
else
|
48
|
+
value = nil
|
49
|
+
end
|
50
|
+
new(
|
51
|
+
name: name,
|
52
|
+
type: type,
|
53
|
+
value: value,
|
54
|
+
additional_properties: struct
|
55
|
+
)
|
56
|
+
end
|
57
|
+
# Serialize an instance of VideoInput to a JSON object
|
58
|
+
#
|
59
|
+
# @return [String]
|
60
|
+
def to_json
|
61
|
+
@_field_set&.to_json
|
62
|
+
end
|
63
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
64
|
+
# hash and check each fields type against the current object's property
|
65
|
+
# definitions.
|
66
|
+
#
|
67
|
+
# @param obj [Object]
|
68
|
+
# @return [Void]
|
69
|
+
def self.validate_raw(obj:)
|
70
|
+
obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
71
|
+
obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
|
72
|
+
Vellum::VellumVideo.validate_raw(obj: obj.value)
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
@@ -12,6 +12,8 @@ module Vellum
|
|
12
12
|
attr_reader :description
|
13
13
|
# @return [Array<String>]
|
14
14
|
attr_reader :release_tags
|
15
|
+
# @return [String]
|
16
|
+
attr_reader :release_description
|
15
17
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
16
18
|
attr_reader :additional_properties
|
17
19
|
# @return [Object]
|
@@ -24,15 +26,17 @@ module Vellum
|
|
24
26
|
# @param name [String]
|
25
27
|
# @param description [String]
|
26
28
|
# @param release_tags [Array<String>]
|
29
|
+
# @param release_description [String]
|
27
30
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
28
31
|
# @return [Vellum::WorkflowPushDeploymentConfigRequest]
|
29
|
-
def initialize(label: OMIT, name: OMIT, description: OMIT, release_tags: OMIT, additional_properties: nil)
|
32
|
+
def initialize(label: OMIT, name: OMIT, description: OMIT, release_tags: OMIT, release_description: OMIT, additional_properties: nil)
|
30
33
|
@label = label if label != OMIT
|
31
34
|
@name = name if name != OMIT
|
32
35
|
@description = description if description != OMIT
|
33
36
|
@release_tags = release_tags if release_tags != OMIT
|
37
|
+
@release_description = release_description if release_description != OMIT
|
34
38
|
@additional_properties = additional_properties
|
35
|
-
@_field_set = { "label": label, "name": name, "description": description, "release_tags": release_tags }.reject do | _k, v |
|
39
|
+
@_field_set = { "label": label, "name": name, "description": description, "release_tags": release_tags, "release_description": release_description }.reject do | _k, v |
|
36
40
|
v == OMIT
|
37
41
|
end
|
38
42
|
end
|
@@ -47,11 +51,13 @@ end
|
|
47
51
|
name = parsed_json["name"]
|
48
52
|
description = parsed_json["description"]
|
49
53
|
release_tags = parsed_json["release_tags"]
|
54
|
+
release_description = parsed_json["release_description"]
|
50
55
|
new(
|
51
56
|
label: label,
|
52
57
|
name: name,
|
53
58
|
description: description,
|
54
59
|
release_tags: release_tags,
|
60
|
+
release_description: release_description,
|
55
61
|
additional_properties: struct
|
56
62
|
)
|
57
63
|
end
|
@@ -72,6 +78,7 @@ end
|
|
72
78
|
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
73
79
|
obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
|
74
80
|
obj.release_tags&.is_a?(Array) != false || raise("Passed value for field obj.release_tags is not the expected type, validation failed.")
|
81
|
+
obj.release_description&.is_a?(String) != false || raise("Passed value for field obj.release_description is not the expected type, validation failed.")
|
75
82
|
end
|
76
83
|
end
|
77
84
|
end
|
@@ -23,14 +23,17 @@ module Vellum
|
|
23
23
|
# @param exclude_display [Boolean]
|
24
24
|
# @param include_json [Boolean]
|
25
25
|
# @param include_sandbox [Boolean]
|
26
|
+
# @param release_tag [String] Release tag to use when pulling from deployment (implies deployment-only lookup)
|
26
27
|
# @param strict [Boolean]
|
28
|
+
# @param version [String] Semantic version range to validate against the Workflow SDK version (e.g.,
|
29
|
+
# '>=1.0.0,<1.2.3')
|
27
30
|
# @param request_options [Vellum::RequestOptions]
|
28
31
|
# @yield on_data[chunk, overall_received_bytes, env] Leverage the Faraday on_data callback which
|
29
32
|
# will receive tuples of strings, the sum of characters received so far, and the
|
30
33
|
# response environment. The latter will allow access to the response status,
|
31
34
|
# headers and reason, as well as the request info.
|
32
35
|
# @return [Void]
|
33
|
-
def pull(id:, exclude_code: nil, exclude_display: nil, include_json: nil, include_sandbox: nil, strict: nil, request_options: nil, &on_data)
|
36
|
+
def pull(id:, exclude_code: nil, exclude_display: nil, include_json: nil, include_sandbox: nil, release_tag: nil, strict: nil, version: nil, request_options: nil, &on_data)
|
34
37
|
response = @request_client.conn.get do | req |
|
35
38
|
unless request_options&.timeout_in_seconds.nil?
|
36
39
|
req.options.timeout = request_options.timeout_in_seconds
|
@@ -45,7 +48,7 @@ module Vellum
|
|
45
48
|
end
|
46
49
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
47
50
|
req.options.on_data = on_data
|
48
|
-
req.params = { **(request_options&.additional_query_parameters || {}), "exclude_code": exclude_code, "exclude_display": exclude_display, "include_json": include_json, "include_sandbox": include_sandbox, "strict": strict }.compact
|
51
|
+
req.params = { **(request_options&.additional_query_parameters || {}), "exclude_code": exclude_code, "exclude_display": exclude_display, "include_json": include_json, "include_sandbox": include_sandbox, "release_tag": release_tag, "strict": strict, "version": version }.compact
|
49
52
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
50
53
|
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
51
54
|
end
|
@@ -59,6 +62,7 @@ end
|
|
59
62
|
# * :name (String)
|
60
63
|
# * :description (String)
|
61
64
|
# * :release_tags (Array<String>)
|
65
|
+
# * :release_description (String)
|
62
66
|
# @param artifact [String, IO]
|
63
67
|
# @param dry_run [Boolean]
|
64
68
|
# @param strict [Boolean]
|
@@ -104,14 +108,17 @@ end
|
|
104
108
|
# @param exclude_display [Boolean]
|
105
109
|
# @param include_json [Boolean]
|
106
110
|
# @param include_sandbox [Boolean]
|
111
|
+
# @param release_tag [String] Release tag to use when pulling from deployment (implies deployment-only lookup)
|
107
112
|
# @param strict [Boolean]
|
113
|
+
# @param version [String] Semantic version range to validate against the Workflow SDK version (e.g.,
|
114
|
+
# '>=1.0.0,<1.2.3')
|
108
115
|
# @param request_options [Vellum::RequestOptions]
|
109
116
|
# @yield on_data[chunk, overall_received_bytes, env] Leverage the Faraday on_data callback which
|
110
117
|
# will receive tuples of strings, the sum of characters received so far, and the
|
111
118
|
# response environment. The latter will allow access to the response status,
|
112
119
|
# headers and reason, as well as the request info.
|
113
120
|
# @return [Void]
|
114
|
-
def pull(id:, exclude_code: nil, exclude_display: nil, include_json: nil, include_sandbox: nil, strict: nil, request_options: nil, &on_data)
|
121
|
+
def pull(id:, exclude_code: nil, exclude_display: nil, include_json: nil, include_sandbox: nil, release_tag: nil, strict: nil, version: nil, request_options: nil, &on_data)
|
115
122
|
Async do
|
116
123
|
response = @request_client.conn.get do | req |
|
117
124
|
unless request_options&.timeout_in_seconds.nil?
|
@@ -127,7 +134,7 @@ end
|
|
127
134
|
end
|
128
135
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
129
136
|
req.options.on_data = on_data
|
130
|
-
req.params = { **(request_options&.additional_query_parameters || {}), "exclude_code": exclude_code, "exclude_display": exclude_display, "include_json": include_json, "include_sandbox": include_sandbox, "strict": strict }.compact
|
137
|
+
req.params = { **(request_options&.additional_query_parameters || {}), "exclude_code": exclude_code, "exclude_display": exclude_display, "include_json": include_json, "include_sandbox": include_sandbox, "release_tag": release_tag, "strict": strict, "version": version }.compact
|
131
138
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
132
139
|
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
133
140
|
end
|
@@ -142,6 +149,7 @@ end
|
|
142
149
|
# * :name (String)
|
143
150
|
# * :description (String)
|
144
151
|
# * :release_tags (Array<String>)
|
152
|
+
# * :release_description (String)
|
145
153
|
# @param artifact [String, IO]
|
146
154
|
# @param dry_run [Boolean]
|
147
155
|
# @param strict [Boolean]
|