class PureCloud::Flow
Attributes
active[RW]
checked_in_version[RW]
current_operation[RW]
deleted[RW]
description[RW]
id[RW]
The globally unique identifier for the object.
input_schema[RW]
json schema describing the inputs for the flow
locked_user[RW]
name[RW]
The flow name
output_schema[RW]
json schema describing the outputs for the flow
published_by[RW]
published_version[RW]
saved_version[RW]
self_uri[RW]
The URI for this object
system[RW]
type[RW]
Public Class Methods
attribute_map()
click to toggle source
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/flow.rb, line 59 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'description' => :'description', :'type' => :'type', :'locked_user' => :'lockedUser', :'active' => :'active', :'system' => :'system', :'deleted' => :'deleted', :'published_version' => :'publishedVersion', :'saved_version' => :'savedVersion', :'input_schema' => :'inputSchema', :'output_schema' => :'outputSchema', :'checked_in_version' => :'checkedInVersion', :'published_by' => :'publishedBy', :'current_operation' => :'currentOperation', :'self_uri' => :'selfUri' } end
new(attributes = {})
click to toggle source
# File lib/purecloud/models/flow.rb, line 120 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'name'] self.name = attributes[:'name'] end if attributes[:'description'] self.description = attributes[:'description'] end if attributes[:'type'] self.type = attributes[:'type'] end if attributes[:'lockedUser'] self.locked_user = attributes[:'lockedUser'] end if attributes[:'active'] self.active = attributes[:'active'] end if attributes[:'system'] self.system = attributes[:'system'] end if attributes[:'deleted'] self.deleted = attributes[:'deleted'] end if attributes[:'publishedVersion'] self.published_version = attributes[:'publishedVersion'] end if attributes[:'savedVersion'] self.saved_version = attributes[:'savedVersion'] end if attributes[:'inputSchema'] self.input_schema = attributes[:'inputSchema'] end if attributes[:'outputSchema'] self.output_schema = attributes[:'outputSchema'] end if attributes[:'checkedInVersion'] self.checked_in_version = attributes[:'checkedInVersion'] end if attributes[:'publishedBy'] self.published_by = attributes[:'publishedBy'] end if attributes[:'currentOperation'] self.current_operation = attributes[:'currentOperation'] end if attributes[:'selfUri'] self.self_uri = attributes[:'selfUri'] end end
swagger_types()
click to toggle source
Attribute
type mapping.
# File lib/purecloud/models/flow.rb, line 98 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'description' => :'String', :'type' => :'String', :'locked_user' => :'UriReference', :'active' => :'BOOLEAN', :'system' => :'BOOLEAN', :'deleted' => :'BOOLEAN', :'published_version' => :'FlowVersion', :'saved_version' => :'FlowVersion', :'input_schema' => :'Object', :'output_schema' => :'Object', :'checked_in_version' => :'FlowVersion', :'published_by' => :'UriReference', :'current_operation' => :'Operation', :'self_uri' => :'String' } end
Public Instance Methods
==(o)
click to toggle source
Check equality by comparing each attribute.
# File lib/purecloud/models/flow.rb, line 203 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && description == o.description && type == o.type && locked_user == o.locked_user && active == o.active && system == o.system && deleted == o.deleted && published_version == o.published_version && saved_version == o.saved_version && input_schema == o.input_schema && output_schema == o.output_schema && checked_in_version == o.checked_in_version && published_by == o.published_by && current_operation == o.current_operation && self_uri == o.self_uri end
_deserialize(type, value)
click to toggle source
# File lib/purecloud/models/flow.rb, line 254 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /^(true|t|yes|y|1)$/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
_to_hash(value)
click to toggle source
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloud/models/flow.rb, line 314 def _to_hash(value) if value.is_a?(Array) value.compact.map{ |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
build_from_hash(attributes)
click to toggle source
build the object from hash
# File lib/purecloud/models/flow.rb, line 235 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
eql?(o)
click to toggle source
@see the `==` method
# File lib/purecloud/models/flow.rb, line 225 def eql?(o) self == o end
hash()
click to toggle source
Calculate hash code according to all attributes.
# File lib/purecloud/models/flow.rb, line 230 def hash [id, name, description, type, locked_user, active, system, deleted, published_version, saved_version, input_schema, output_schema, checked_in_version, published_by, current_operation, self_uri].hash end
to_body()
click to toggle source
to_hash()
click to toggle source
return the object in the form of hash
# File lib/purecloud/models/flow.rb, line 302 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
to_s()
click to toggle source
# File lib/purecloud/models/flow.rb, line 292 def to_s to_hash.to_s end
type=(type)
click to toggle source
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/flow.rb, line 194 def type=(type) allowed_values = ["INBOUNDCALL", "INBOUNDEMAIL", "INQUEUECALL", "OUTBOUNDCALL", "SECURECALL", "SPEECH", "WORKFLOW"] if type && !allowed_values.include?(type) fail "invalid value for 'type', must be one of #{allowed_values}" end @type = type end