Class: PureCloud::FlowInputData

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/flow_input_data.rb

Overview

launch parameters or initializations for variables in the flow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowInputData

Returns a new instance of FlowInputData.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/purecloud/models/flow_input_data.rb', line 26

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[:'linkedDocumentIds']
    if (value = attributes[:'linkedDocumentIds']).is_a?(Array)
      self.linked_document_ids = value
    end
  end
  
end

Instance Attribute Details

#linked_document_ids ⇒ Object

A list of document IDs to link with the new flow instance.



7
8
9
 
# File 'lib/purecloud/models/flow_input_data.rb', line 7

def linked_document_ids
  @linked_document_ids
end

Class Method Details

.attribute_map ⇒ Object

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



10
11
12
13
14
15
16
 
# File 'lib/purecloud/models/flow_input_data.rb', line 10

def self.attribute_map
  {
    
    :'linked_document_ids' => :'linkedDocumentIds'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



19
20
21
22
23
24
 
# File 'lib/purecloud/models/flow_input_data.rb', line 19

def self.swagger_types
  {
    :'linked_document_ids' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



42
43
44
45
46
 
# File 'lib/purecloud/models/flow_input_data.rb', line 42

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      linked_document_ids == o.linked_document_ids
end

#_deserialize(type, value) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/purecloud/models/flow_input_data.rb', line 78

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/purecloud/models/flow_input_data.rb', line 135

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) ⇒ Object

build the object from hash



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloud/models/flow_input_data.rb', line 59

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) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


49
50
51
 
# File 'lib/purecloud/models/flow_input_data.rb', line 49

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



54
55
56
 
# File 'lib/purecloud/models/flow_input_data.rb', line 54

def hash
  [linked_document_ids].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



118
119
120
 
# File 'lib/purecloud/models/flow_input_data.rb', line 118

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



123
124
125
126
127
128
129
130
131
 
# File 'lib/purecloud/models/flow_input_data.rb', line 123

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 ⇒ Object 



113
114
115
 
# File 'lib/purecloud/models/flow_input_data.rb', line 113

def to_s
  to_hash.to_s
end