Class: PureCloud::Control

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Control

Returns a new instance of Control.



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
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/purecloud/models/control.rb', line 54

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[:'label']
    self.label = attributes[:'label']
  end
  
  if attributes[:'options']
    if (value = attributes[:'options']).is_a?(Array)
      self.options = value
    end
  end
  
  if attributes[:'required']
    self.required = attributes[:'required']
  else
    self.required = false
  end
  
  if attributes[:'readOnly']
    self.read_only = attributes[:'readOnly']
  else
    self.read_only = false
  end
  
  if attributes[:'variableBindingId']
    self.variable_binding_id = attributes[:'variableBindingId']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
end

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id.



5
6
7
 
# File 'lib/purecloud/models/control.rb', line 5

def id
  @id
end

#label ⇒ Object

Returns the value of attribute label.



7
8
9
 
# File 'lib/purecloud/models/control.rb', line 7

def label
  @label
end

#options ⇒ Object

Returns the value of attribute options.



9
10
11
 
# File 'lib/purecloud/models/control.rb', line 9

def options
  @options
end

#read_only ⇒ Object

Returns the value of attribute read_only.



13
14
15
 
# File 'lib/purecloud/models/control.rb', line 13

def read_only
  @read_only
end

#required ⇒ Object

Returns the value of attribute required.



11
12
13
 
# File 'lib/purecloud/models/control.rb', line 11

def required
  @required
end

#type ⇒ Object

Returns the value of attribute type.



17
18
19
 
# File 'lib/purecloud/models/control.rb', line 17

def type
  @type
end

#variable_binding_id ⇒ Object

Returns the value of attribute variable_binding_id.



15
16
17
 
# File 'lib/purecloud/models/control.rb', line 15

def variable_binding_id
  @variable_binding_id
end

Class Method Details

.attribute_map ⇒ Object

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



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/purecloud/models/control.rb', line 20

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'label' => :'label',
    
    :'options' => :'options',
    
    :'required' => :'required',
    
    :'read_only' => :'readOnly',
    
    :'variable_binding_id' => :'variableBindingId',
    
    :'type' => :'type'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/purecloud/models/control.rb', line 41

def self.swagger_types
  {
    :'id' => :'String',
    :'label' => :'String',
    :'options' => :'Array<ControlOptions>',
    :'required' => :'BOOLEAN',
    :'read_only' => :'BOOLEAN',
    :'variable_binding_id' => :'String',
    :'type' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/purecloud/models/control.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      label == o.label &&
      options == o.options &&
      required == o.required &&
      read_only == o.read_only &&
      variable_binding_id == o.variable_binding_id &&
      type == o.type
end

#_deserialize(type, value) ⇒ Object 



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

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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/purecloud/models/control.rb', line 206

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/purecloud/models/control.rb', line 130

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


120
121
122
 
# File 'lib/purecloud/models/control.rb', line 120

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



125
126
127
 
# File 'lib/purecloud/models/control.rb', line 125

def hash
  [id, label, options, required, read_only, variable_binding_id, type].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



189
190
191
 
# File 'lib/purecloud/models/control.rb', line 189

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



194
195
196
197
198
199
200
201
202
 
# File 'lib/purecloud/models/control.rb', line 194

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 



184
185
186
 
# File 'lib/purecloud/models/control.rb', line 184

def to_s
  to_hash.to_s
end