Class: Zernio::WorkflowNode

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/workflow_node.rb

Overview

A node in a workflow graph. config shape depends on type.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowNode

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::WorkflowNode` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::WorkflowNode`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'config')
    if (value = attributes[:'config']).is_a?(Hash)
      self.config = value
    end
  end

  if attributes.key?(:'position')
    self.position = attributes[:'position']
  end
end

Instance Attribute Details

#config ⇒ Object

Type-specific settings. All string fields support {{variable}} interpolation against the run's variable bag (resolved at execution time). trigger: { triggerType: inbound_message|api_call|whatsapp_event, keywords:[string], matchType: any|contains|exact|regex, onlyFirstMessage:boolean, eventType: message_sent|message_delivered|message_read|message_failed|reaction }. Default triggerType is inbound_message for legacy nodes. eventType is only honored when triggerType is whatsapp_event (WhatsApp-only). send_message: { messageType: text|template|media|interactive, text, template:{name,language,variableMapping}, media:{mediaType:image|video|audio|document, url,caption}, interactive }. template and interactive are WhatsApp-only. interactive.type is inferred from the payload shape when omitted; payloads with neither type nor an inferable shape are rejected. wait_for_reply: { timeoutMinutes:int (max 43200), saveAs:string }. Resume via the 'reply' edge on inbound, or 'timeout' edge after timeoutMinutes of silence. condition: { rules:[{ id, variable, operator: equals|not_equals|contains|not_contains|starts_with|ends_with|exists|not_exists|matches, value }] }. First matching rule takes its id as the sourceHandle; otherwise 'default'. set_variable: { assignments:[{ name, value }] }. Run-scoped (lives only for this execution; use set_field for persistent values). delay: { delayMinutes:int (max 43200) }. Suspends the run, resumes via timer. webhook: { url, method: GET|POST|PUT|PATCH|DELETE, headers, bodyTemplate, saveAs }. SSRF-guarded (private/loopback/metadata IPs rejected). Response saved as { status, ok, body } to vars[saveAs]. Edge: 'success' on 2xx, 'error' otherwise. ai: { provider: anthropic|openai|google|mistral|groq, model, preset: smart|tools|cheap, systemPrompt, userPromptTemplate, saveAs, temperature, maxTokens, outputType: text|json, tools:[{ name, description, parameters }] }. Set provider + model for BYOK (uses your stored API key); omit provider for the legacy Telnyx path. Edges: 'success', 'tool:<name>' (model picked a tool), 'error'. handoff: { note, assignTo }. Terminates the run as exited, flags the conversation for a human operator. start_call: { to, forwardTo, requirePermissionFirst, recordingEnabled, saveAs }. WhatsApp-only. forwardTo can be tel:+E164, sip:user@host, or wss://… (AI voice agent). Edges: 'success', 'permission_required', 'failed'. a_b_split: { percentage: number 0-100 (default 50) }. Random branch picker. Edges: 'a' (with probability percentage/100), 'b'. set_field: { field, value }. Persistent custom field on the Contact (vs set_variable which is run-scoped). Field name is sanitized to [A-Za-z0-9_]. No-op on api_call runs (no contact). enroll_sequence: { sequenceId, saveAs }. Enrolls the run's contact into a Sequence. Edges: 'success', 'error'. add_tag / remove_tag: { tag }. Push or pull a tag on the Contact. No-op on api_call runs. end: no config. Terminates the run as completed.



26
27
28
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 26

def config
  @config
end

#id ⇒ Object

Stable node id referenced by edges



20
21
22
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 20

def id
  @id
end

#position ⇒ Object

Returns the value of attribute position.



28
29
30
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 28

def position
  @position
end

#type ⇒ Object

Node kind. The 16 supported types break into four groups: messaging (send_message), control flow (trigger, condition, delay, wait_for_reply, a_b_split, end), data ops (set_variable, set_field, add_tag, remove_tag, enroll_sequence), integrations (webhook, ai, handoff, start_call).



23
24
25
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 23

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



63
64
65
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 63

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 68

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



53
54
55
56
57
58
59
60
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 53

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'config' => :'config',
    :'position' => :'position'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 200

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 83

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 73

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'config' => :'Hash<String, Object>',
    :'position' => :'WorkflowNodePosition'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      config == o.config &&
      position == o.position
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


187
188
189
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



193
194
195
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 193

def hash
  [id, type, config, position].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 129

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 222

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



145
146
147
148
149
150
151
152
 
# File 'lib/zernio-sdk/models/workflow_node.rb', line 145

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["trigger", "send_message", "wait_for_reply", "condition", "set_variable", "delay", "webhook", "ai", "handoff", "start_call", "a_b_split", "set_field", "enroll_sequence", "add_tag", "remove_tag", "end"])
  return false unless type_validator.valid?(@type)
  true
end