Class: PureCloud::Flow

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Flow

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 104

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'lockedUser')
    self.locked_user = attributes[:'lockedUser']
  end

  if attributes.has_key?(:'active')
    self.active = attributes[:'active']
  end

  if attributes.has_key?(:'system')
    self.system = attributes[:'system']
  end

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.has_key?(:'publishedVersion')
    self.published_version = attributes[:'publishedVersion']
  end

  if attributes.has_key?(:'savedVersion')
    self.saved_version = attributes[:'savedVersion']
  end

  if attributes.has_key?(:'inputSchema')
    self.input_schema = attributes[:'inputSchema']
  end

  if attributes.has_key?(:'outputSchema')
    self.output_schema = attributes[:'outputSchema']
  end

  if attributes.has_key?(:'checkedInVersion')
    self.checked_in_version = attributes[:'checkedInVersion']
  end

  if attributes.has_key?(:'publishedBy')
    self.published_by = attributes[:'publishedBy']
  end

  if attributes.has_key?(:'currentOperation')
    self.current_operation = attributes[:'currentOperation']
  end

  if attributes.has_key?(:'selfUri')
    self.self_uri = attributes[:'selfUri']
  end

end

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 33

def active
  @active
end

#checked_in_version ⇒ Object

Returns the value of attribute checked_in_version.



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

def checked_in_version
  @checked_in_version
end

#current_operation ⇒ Object

Returns the value of attribute current_operation.



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 53

def current_operation
  @current_operation
end

#deleted ⇒ Object

Returns the value of attribute deleted.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 37

def deleted
  @deleted
end

#description ⇒ Object

Returns the value of attribute description.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 27

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#input_schema ⇒ Object

json schema describing the inputs for the flow



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

def input_schema
  @input_schema
end

#locked_user ⇒ Object

Returns the value of attribute locked_user.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 31

def locked_user
  @locked_user
end

#name ⇒ Object

The flow name



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 25

def name
  @name
end

#output_schema ⇒ Object

json schema describing the outputs for the flow



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 47

def output_schema
  @output_schema
end

#published_by ⇒ Object

Returns the value of attribute published_by.



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 51

def published_by
  @published_by
end

#published_version ⇒ Object

Returns the value of attribute published_version.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 39

def published_version
  @published_version
end

#saved_version ⇒ Object

Returns the value of attribute saved_version.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 41

def saved_version
  @saved_version
end

#self_uri ⇒ Object

The URI for this object



56
57
58
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 56

def self_uri
  @self_uri
end

#system ⇒ Object

Returns the value of attribute system.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 35

def system
  @system
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/purecloudplatformclientv2/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

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 81

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 208

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 261

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 321

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 242

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


231
232
233
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



237
238
239
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 237

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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



178
179
180
181
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 178

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



304
305
306
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 304

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



309
310
311
312
313
314
315
316
317
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 309

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 



299
300
301
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 299

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/purecloudplatformclientv2/models/flow.rb', line 185

def valid?
  if @name.nil?
    return false
  end

  allowed_values = ["INBOUNDCALL", "INBOUNDEMAIL", "INQUEUECALL", "OUTBOUNDCALL", "SECURECALL", "SPEECH", "WORKFLOW"]
  if @type && !allowed_values.include?(@type)
    return false
  end
end