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.



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/purecloud/models/flow.rb', line 107

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[:'publishStatus']
    self.publish_status = attributes[:'publishStatus']
  end
  
  if attributes[:'publishedBy']
    self.published_by = attributes[:'publishedBy']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



32
33
34
 
# File 'lib/purecloud/models/flow.rb', line 32

def active
  @active
end

#checked_in_version ⇒ Object

Returns the value of attribute checked_in_version.



38
39
40
 
# File 'lib/purecloud/models/flow.rb', line 38

def checked_in_version
  @checked_in_version
end

#deleted ⇒ Object

Returns the value of attribute deleted.



34
35
36
 
# File 'lib/purecloud/models/flow.rb', line 34

def deleted
  @deleted
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#locked_user ⇒ Object

Returns the value of attribute locked_user.



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

def locked_user
  @locked_user
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#publish_status ⇒ Object

Returns the value of attribute publish_status.



44
45
46
 
# File 'lib/purecloud/models/flow.rb', line 44

def publish_status
  @publish_status
end

#published_by ⇒ Object

Returns the value of attribute published_by.



46
47
48
 
# File 'lib/purecloud/models/flow.rb', line 46

def published_by
  @published_by
end

#published_version ⇒ Object

Returns the value of attribute published_version.



36
37
38
 
# File 'lib/purecloud/models/flow.rb', line 36

def published_version
  @published_version
end

#saved_version ⇒ Object

Returns the value of attribute saved_version.



40
41
42
 
# File 'lib/purecloud/models/flow.rb', line 40

def saved_version
  @saved_version
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#system ⇒ Object

Returns the value of attribute system.



42
43
44
 
# File 'lib/purecloud/models/flow.rb', line 42

def system
  @system
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/purecloud/models/flow.rb', line 52

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',
    
    :'publish_status' => :'publishStatus',
    
    :'published_by' => :'publishedBy',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/purecloud/models/flow.rb', line 87

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',
    :'publish_status' => :'String',
    :'published_by' => :'UriReference',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/purecloud/models/flow.rb', line 197

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 &&
      publish_status == o.publish_status &&
      published_by == o.published_by &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/purecloud/models/flow.rb', line 246

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

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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/purecloud/models/flow.rb', line 306

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/purecloud/models/flow.rb', line 227

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


217
218
219
 
# File 'lib/purecloud/models/flow.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



222
223
224
 
# File 'lib/purecloud/models/flow.rb', line 222

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



289
290
291
 
# File 'lib/purecloud/models/flow.rb', line 289

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



294
295
296
297
298
299
300
301
302
 
# File 'lib/purecloud/models/flow.rb', line 294

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 



284
285
286
 
# File 'lib/purecloud/models/flow.rb', line 284

def to_s
  to_hash.to_s
end