Class: PureCloud::FlowVersion

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowVersion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
235
236
237
238
239
240
241
242
243
244
245
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
283
284
285
286
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 135

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?(:'commitVersion')
    
    
    self.commit_version = attributes[:'commitVersion']
    
  
  end

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'publishResultUri')
    
    
    self.publish_result_uri = attributes[:'publishResultUri']
    
  
  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?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end

Instance Attribute Details

#commit_versionObject

Returns the value of attribute commit_version.



26
27
28
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 26

def commit_version
  @commit_version
end

#configuration_uriObject

Returns the value of attribute configuration_uri.



40
41
42
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 40

def configuration_uri
  @configuration_uri
end

#configuration_versionObject

Returns the value of attribute configuration_version.



28
29
30
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 28

def configuration_version
  @configuration_version
end

#created_byObject

Returns the value of attribute created_by.



36
37
38
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 36

def created_by
  @created_by
end

#created_by_clientObject

Returns the value of attribute created_by_client.



38
39
40
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 38

def created_by_client
  @created_by_client
end

#date_createdObject

Returns the value of attribute date_created.



42
43
44
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 42

def date_created
  @date_created
end

#debugObject

Returns the value of attribute debug.



34
35
36
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 34

def debug
  @debug
end

#generation_idObject

Returns the value of attribute generation_id.



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

def generation_id
  @generation_id
end

#idObject

The flow version identifier



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

def id
  @id
end

#input_schemaObject

Returns the value of attribute input_schema.



48
49
50
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 48

def input_schema
  @input_schema
end

#nameObject

Returns the value of attribute name.



24
25
26
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 24

def name
  @name
end

#output_schemaObject

Returns the value of attribute output_schema.



50
51
52
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 50

def output_schema
  @output_schema
end

#publish_result_uriObject

Returns the value of attribute publish_result_uri.



46
47
48
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 46

def publish_result_uri
  @publish_result_uri
end

#secureObject

Returns the value of attribute secure.



32
33
34
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 32

def secure
  @secure
end

#self_uriObject

The URI for this object



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

def self_uri
  @self_uri
end

#typeObject

Returns the value of attribute type.



30
31
32
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 30

def type
  @type
end

Class Method Details

.attribute_mapObject

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



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
85
86
87
88
89
90
91
92
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 56

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'commit_version' => :'commitVersion',
    
    :'configuration_version' => :'configurationVersion',
    
    :'type' => :'type',
    
    :'secure' => :'secure',
    
    :'debug' => :'debug',
    
    :'created_by' => :'createdBy',
    
    :'created_by_client' => :'createdByClient',
    
    :'configuration_uri' => :'configurationUri',
    
    :'date_created' => :'dateCreated',
    
    :'generation_id' => :'generationId',
    
    :'publish_result_uri' => :'publishResultUri',
    
    :'input_schema' => :'inputSchema',
    
    :'output_schema' => :'outputSchema',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'commit_version' => :'String',
    
    :'configuration_version' => :'String',
    
    :'type' => :'String',
    
    :'secure' => :'BOOLEAN',
    
    :'debug' => :'BOOLEAN',
    
    :'created_by' => :'User',
    
    :'created_by_client' => :'DomainEntityRef',
    
    :'configuration_uri' => :'String',
    
    :'date_created' => :'Integer',
    
    :'generation_id' => :'String',
    
    :'publish_result_uri' => :'String',
    
    :'input_schema' => :'JsonSchemaDocument',
    
    :'output_schema' => :'JsonSchemaDocument',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 464

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      commit_version == o.commit_version &&
      configuration_version == o.configuration_version &&
      type == o.type &&
      secure == o.secure &&
      debug == o.debug &&
      created_by == o.created_by &&
      created_by_client == o.created_by_client &&
      configuration_uri == o.configuration_uri &&
      date_created == o.date_created &&
      generation_id == o.generation_id &&
      publish_result_uri == o.publish_result_uri &&
      input_schema == o.input_schema &&
      output_schema == o.output_schema &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 517

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



577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 577

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



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 498

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


487
488
489
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 487

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



493
494
495
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 493

def hash
  [id, name, commit_version, configuration_version, type, secure, debug, created_by, created_by_client, configuration_uri, date_created, generation_id, publish_result_uri, input_schema, output_schema, self_uri].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



290
291
292
293
294
295
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 290

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



560
561
562
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 560

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



565
566
567
568
569
570
571
572
573
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 565

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_sObject



555
556
557
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 555

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/purecloudplatformclientv2/models/flow_version.rb', line 299

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["PUBLISH", "CHECKIN", "SAVE"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end