Class: PureCloud::FlowConfigMetaData

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

Overview

Details about the current state of a Flow Definition

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowConfigMetaData

Returns a new instance of FlowConfigMetaData.



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 101

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[:'configState']
    self.config_state = attributes[:'configState']
  end
  
  if attributes[:'flowType']
    self.flow_type = attributes[:'flowType']
  end
  
  if attributes[:'lockedByUser']
    self.locked_by_user = attributes[:'lockedByUser']
  end
  
  if attributes[:'newestPublishedVersion']
    self.newest_published_version = attributes[:'newestPublishedVersion']
  end
  
  if attributes[:'newestVersion']
    self.newest_version = attributes[:'newestVersion']
  end
  
  if attributes[:'associatedWorkspaces']
    if (value = attributes[:'associatedWorkspaces']).is_a?(Array)
      self.associated_workspaces = value
    end
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'hasDraft']
    self.has_draft = attributes[:'hasDraft']
  else
    self.has_draft = false
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#associated_workspaces ⇒ Object

Workspaces associated with this flow.



43
44
45
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 43

def associated_workspaces
  @associated_workspaces
end

#config_state ⇒ Object

Usability of this flow definition. (output only)



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

def config_state
  @config_state
end

#description ⇒ Object

User notes describing the flow definition.



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

def description
  @description
end

#flow_type ⇒ Object

Type of flow this definition describes



31
32
33
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 31

def flow_type
  @flow_type
end

#has_draft ⇒ Object

Flag if this definition has a draft populated.



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

def has_draft
  @has_draft
end

#id ⇒ Object

The globally unique identifier for the object.



23
24
25
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 23

def id
  @id
end

#locked_by_user ⇒ Object

If locked for editing, the user who locked this definition, otherwise null



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

def locked_by_user
  @locked_by_user
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 25

def name
  @name
end

#newest_published_version ⇒ Object

The most recently published version (output only)



37
38
39
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 37

def newest_published_version
  @newest_published_version
end

#newest_version ⇒ Object

The most recent version, regardless of published state (output only)



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

def newest_version
  @newest_version
end

#self_uri ⇒ Object

The URI for this object



52
53
54
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 52

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 55

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'config_state' => :'configState',
    
    :'flow_type' => :'flowType',
    
    :'locked_by_user' => :'lockedByUser',
    
    :'newest_published_version' => :'newestPublishedVersion',
    
    :'newest_version' => :'newestVersion',
    
    :'associated_workspaces' => :'associatedWorkspaces',
    
    :'description' => :'description',
    
    :'has_draft' => :'hasDraft',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 84

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'config_state' => :'String',
    :'flow_type' => :'String',
    :'locked_by_user' => :'User',
    :'newest_published_version' => :'String',
    :'newest_version' => :'String',
    :'associated_workspaces' => :'Array<Workspace>',
    :'description' => :'String',
    :'has_draft' => :'BOOLEAN',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      config_state == o.config_state &&
      flow_type == o.flow_type &&
      locked_by_user == o.locked_by_user &&
      newest_published_version == o.newest_published_version &&
      newest_version == o.newest_version &&
      associated_workspaces == o.associated_workspaces &&
      description == o.description &&
      has_draft == o.has_draft &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 223

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 283

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 204

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


194
195
196
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



199
200
201
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 199

def hash
  [id, name, config_state, flow_type, locked_by_user, newest_published_version, newest_version, associated_workspaces, description, has_draft, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



266
267
268
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 266

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



271
272
273
274
275
276
277
278
279
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 271

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 



261
262
263
 
# File 'lib/purecloud/models/flow_config_meta_data.rb', line 261

def to_s
  to_hash.to_s
end