Class: PureCloud::Flow

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Flow

Returns a new instance of Flow.



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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/purecloud/models/flow.rb', line 81

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']
  else
    self.active = false
  end
  
  if attributes[:'deleted']
    self.deleted = attributes[:'deleted']
  else
    self.deleted = false
  end
  
  if attributes[:'publishedVersion']
    self.published_version = attributes[:'publishedVersion']
  end
  
  if attributes[:'checkedInVersion']
    self.checked_in_version = attributes[:'checkedInVersion']
  end
  
  if attributes[:'savedVersion']
    self.saved_version = attributes[:'savedVersion']
  end
  
  if attributes[:'system']
    self.system = attributes[:'system']
  else
    self.system = false
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



16
17
18
 
# File 'lib/purecloud/models/flow.rb', line 16

def active
  @active
end

#checked_in_version ⇒ Object

Returns the value of attribute checked_in_version.



22
23
24
 
# File 'lib/purecloud/models/flow.rb', line 22

def checked_in_version
  @checked_in_version
end

#deleted ⇒ Object

Returns the value of attribute deleted.



18
19
20
 
# File 'lib/purecloud/models/flow.rb', line 18

def deleted
  @deleted
end

#description ⇒ Object

Returns the value of attribute description.



10
11
12
 
# File 'lib/purecloud/models/flow.rb', line 10

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/flow.rb', line 6

def id
  @id
end

#locked_user ⇒ Object

Returns the value of attribute locked_user.



14
15
16
 
# File 'lib/purecloud/models/flow.rb', line 14

def locked_user
  @locked_user
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/flow.rb', line 8

def name
  @name
end

#published_version ⇒ Object

Returns the value of attribute published_version.



20
21
22
 
# File 'lib/purecloud/models/flow.rb', line 20

def published_version
  @published_version
end

#saved_version ⇒ Object

Returns the value of attribute saved_version.



24
25
26
 
# File 'lib/purecloud/models/flow.rb', line 24

def saved_version
  @saved_version
end

#self_uri ⇒ Object

The URI for this object



29
30
31
 
# File 'lib/purecloud/models/flow.rb', line 29

def self_uri
  @self_uri
end

#system ⇒ Object

Returns the value of attribute system.



26
27
28
 
# File 'lib/purecloud/models/flow.rb', line 26

def system
  @system
end

#type ⇒ Object

Returns the value of attribute type.



12
13
14
 
# File 'lib/purecloud/models/flow.rb', line 12

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/purecloud/models/flow.rb', line 32

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'type' => :'type',
    
    :'locked_user' => :'lockedUser',
    
    :'active' => :'active',
    
    :'deleted' => :'deleted',
    
    :'published_version' => :'publishedVersion',
    
    :'checked_in_version' => :'checkedInVersion',
    
    :'saved_version' => :'savedVersion',
    
    :'system' => :'system',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/purecloud/models/flow.rb', line 63

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'locked_user' => :'UriReference',
    :'active' => :'BOOLEAN',
    :'deleted' => :'BOOLEAN',
    :'published_version' => :'FlowVersion',
    :'checked_in_version' => :'FlowVersion',
    :'saved_version' => :'FlowVersion',
    :'system' => :'BOOLEAN',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/purecloud/models/flow.rb', line 154

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 &&
      deleted == o.deleted &&
      published_version == o.published_version &&
      checked_in_version == o.checked_in_version &&
      saved_version == o.saved_version &&
      system == o.system &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/purecloud/models/flow.rb', line 201

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/purecloud/models/flow.rb', line 258

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/purecloud/models/flow.rb', line 182

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


172
173
174
 
# File 'lib/purecloud/models/flow.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



177
178
179
 
# File 'lib/purecloud/models/flow.rb', line 177

def hash
  [id, name, description, type, locked_user, active, deleted, published_version, checked_in_version, saved_version, system, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



241
242
243
 
# File 'lib/purecloud/models/flow.rb', line 241

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



246
247
248
249
250
251
252
253
254
 
# File 'lib/purecloud/models/flow.rb', line 246

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 



236
237
238
 
# File 'lib/purecloud/models/flow.rb', line 236

def to_s
  to_hash.to_s
end