Class: PureCloud::ReportMetaData

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportMetaData

Returns a new instance of ReportMetaData.



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/purecloud/models/report_meta_data.rb', line 66

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[:'title']
    self.title = attributes[:'title']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'keywords']
    if (value = attributes[:'keywords']).is_a?(Array)
      self.keywords = value
    end
  end
  
  if attributes[:'availableLocales']
    if (value = attributes[:'availableLocales']).is_a?(Array)
      self.available_locales = value
    end
  end
  
  if attributes[:'parameters']
    if (value = attributes[:'parameters']).is_a?(Array)
      self.parameters = value
    end
  end
  
  if attributes[:'exampleUrl']
    self.example_url = attributes[:'exampleUrl']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#available_locales ⇒ Object

Returns the value of attribute available_locales.



16
17
18
 
# File 'lib/purecloud/models/report_meta_data.rb', line 16

def available_locales
  @available_locales
end

#description ⇒ Object

Returns the value of attribute description.



12
13
14
 
# File 'lib/purecloud/models/report_meta_data.rb', line 12

def description
  @description
end

#example_url ⇒ Object

Returns the value of attribute example_url.



20
21
22
 
# File 'lib/purecloud/models/report_meta_data.rb', line 20

def example_url
  @example_url
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/report_meta_data.rb', line 6

def id
  @id
end

#keywords ⇒ Object

Returns the value of attribute keywords.



14
15
16
 
# File 'lib/purecloud/models/report_meta_data.rb', line 14

def keywords
  @keywords
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/report_meta_data.rb', line 8

def name
  @name
end

#parameters ⇒ Object

Returns the value of attribute parameters.



18
19
20
 
# File 'lib/purecloud/models/report_meta_data.rb', line 18

def parameters
  @parameters
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#title ⇒ Object

Returns the value of attribute title.



10
11
12
 
# File 'lib/purecloud/models/report_meta_data.rb', line 10

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/purecloud/models/report_meta_data.rb', line 26

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'title' => :'title',
    
    :'description' => :'description',
    
    :'keywords' => :'keywords',
    
    :'available_locales' => :'availableLocales',
    
    :'parameters' => :'parameters',
    
    :'example_url' => :'exampleUrl',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/purecloud/models/report_meta_data.rb', line 51

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'title' => :'String',
    :'description' => :'String',
    :'keywords' => :'Array<String>',
    :'available_locales' => :'Array<String>',
    :'parameters' => :'Array<Parameter>',
    :'example_url' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/purecloud/models/report_meta_data.rb', line 118

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      title == o.title &&
      description == o.description &&
      keywords == o.keywords &&
      available_locales == o.available_locales &&
      parameters == o.parameters &&
      example_url == o.example_url &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/purecloud/models/report_meta_data.rb', line 219

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/purecloud/models/report_meta_data.rb', line 143

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


133
134
135
 
# File 'lib/purecloud/models/report_meta_data.rb', line 133

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



138
139
140
 
# File 'lib/purecloud/models/report_meta_data.rb', line 138

def hash
  [id, name, title, description, keywords, available_locales, parameters, example_url, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



202
203
204
 
# File 'lib/purecloud/models/report_meta_data.rb', line 202

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



207
208
209
210
211
212
213
214
215
 
# File 'lib/purecloud/models/report_meta_data.rb', line 207

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 



197
198
199
 
# File 'lib/purecloud/models/report_meta_data.rb', line 197

def to_s
  to_hash.to_s
end