Class: Supportify::Faq

Inherits:
Object
  • Object
show all
Defined in:
lib/supportify_client/models/faq.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Faq

Returns a new instance of Faq.



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
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/supportify_client/models/faq.rb', line 111

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[:'answer']
    self.answer = attributes[:'answer']
  end
  
  if attributes[:'categories']
    if (value = attributes[:'categories']).is_a?(Array)
      self.categories = value
    end
  end
  
  if attributes[:'controversy_score']
    self.controversy_score = attributes[:'controversy_score']
  end
  
  if attributes[:'date_created']
    self.date_created = attributes[:'date_created']
  end
  
  if attributes[:'date_last_modified']
    self.date_last_modified = attributes[:'date_last_modified']
  end
  
  if attributes[:'direct_views']
    self.direct_views = attributes[:'direct_views']
  end
  
  if attributes[:'question']
    self.question = attributes[:'question']
  end
  
  if attributes[:'rating']
    self.rating = attributes[:'rating']
  end
  
  if attributes[:'raw_score']
    self.raw_score = attributes[:'raw_score']
  end
  
  if attributes[:'search_views']
    self.search_views = attributes[:'search_views']
  end
  
  if attributes[:'tags']
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end
  
  if attributes[:'total_views']
    self.total_views = attributes[:'total_views']
  end
  
  if attributes[:'votes']
    self.votes = attributes[:'votes']
  end
  
  if attributes[:'was_created_by']
    self.was_created_by = attributes[:'was_created_by']
  end
  
  if attributes[:'was_last_modified_by']
    self.was_last_modified_by = attributes[:'was_last_modified_by']
  end
  
end

Instance Attribute Details

#answer ⇒ Object

The body of the content entry. Can be an answer to a FAQ, a knowledge base entry, or any other type of string. This is a non-encoded string and may contain HTML.



9
10
11
 
# File 'lib/supportify_client/models/faq.rb', line 9

def answer
  @answer
end

#categories ⇒ Object

Returns the value of attribute categories.



11
12
13
 
# File 'lib/supportify_client/models/faq.rb', line 11

def categories
  @categories
end

#controversy_score ⇒ Object

A score that measures the disparity between positive and negative votes for the content entry.



14
15
16
 
# File 'lib/supportify_client/models/faq.rb', line 14

def controversy_score
  @controversy_score
end

#date_created ⇒ Object

The date and time that the content entry was created.



17
18
19
 
# File 'lib/supportify_client/models/faq.rb', line 17

def date_created
  @date_created
end

#date_last_modified ⇒ Object

The date and time that the content entry was last modified.



20
21
22
 
# File 'lib/supportify_client/models/faq.rb', line 20

def date_last_modified
  @date_last_modified
end

#direct_views ⇒ Object

The total number of views that the content entry has received individually (i.e., access via the ‘/faqs/<id>’ path.



23
24
25
 
# File 'lib/supportify_client/models/faq.rb', line 23

def direct_views
  @direct_views
end

#id ⇒ Object

Unique identifier representing a specific content entry within an application.



6
7
8
 
# File 'lib/supportify_client/models/faq.rb', line 6

def id
  @id
end

#question ⇒ Object

The title of the content entry. Can be a question, a title, or any other type of string. This is a non-encoded string and may contain HTML.



26
27
28
 
# File 'lib/supportify_client/models/faq.rb', line 26

def question
  @question
end

#rating ⇒ Object

The score for the content entry within the application. This is weighted score tabulated based on a total of up and down votes and compared against other votes for content entries in the application.



29
30
31
 
# File 'lib/supportify_client/models/faq.rb', line 29

def rating
  @rating
end

#raw_score ⇒ Object

The total number of positive votes minus the number of negative votes for the content entry.



32
33
34
 
# File 'lib/supportify_client/models/faq.rb', line 32

def raw_score
  @raw_score
end

#search_views ⇒ Object

The total number of views that the content entry has received as part of a set of search results (i.e., access via the ‘/search’ path.



35
36
37
 
# File 'lib/supportify_client/models/faq.rb', line 35

def search_views
  @search_views
end

#tags ⇒ Object

Returns the value of attribute tags.



37
38
39
 
# File 'lib/supportify_client/models/faq.rb', line 37

def tags
  @tags
end

#total_views ⇒ Object

The total number of views that the content entry has received as part of a whole collection, individually, or as part of a set of search results.



40
41
42
 
# File 'lib/supportify_client/models/faq.rb', line 40

def total_views
  @total_views
end

#votes ⇒ Object

The total number of votes that the content entry has received since it was created.



43
44
45
 
# File 'lib/supportify_client/models/faq.rb', line 43

def votes
  @votes
end

#was_created_by ⇒ Object

Returns the value of attribute was_created_by.



45
46
47
 
# File 'lib/supportify_client/models/faq.rb', line 45

def was_created_by
  @was_created_by
end

#was_last_modified_by ⇒ Object

Returns the value of attribute was_last_modified_by.



47
48
49
 
# File 'lib/supportify_client/models/faq.rb', line 47

def was_last_modified_by
  @was_last_modified_by
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
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
 
# File 'lib/supportify_client/models/faq.rb', line 50

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'answer' => :'answer',
    
    :'categories' => :'categories',
    
    :'controversy_score' => :'controversy_score',
    
    :'date_created' => :'date_created',
    
    :'date_last_modified' => :'date_last_modified',
    
    :'direct_views' => :'direct_views',
    
    :'question' => :'question',
    
    :'rating' => :'rating',
    
    :'raw_score' => :'raw_score',
    
    :'search_views' => :'search_views',
    
    :'tags' => :'tags',
    
    :'total_views' => :'total_views',
    
    :'votes' => :'votes',
    
    :'was_created_by' => :'was_created_by',
    
    :'was_last_modified_by' => :'was_last_modified_by'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/supportify_client/models/faq.rb', line 89

def self.swagger_types
  {
    :'id' => :'Integer',
    :'answer' => :'String',
    :'categories' => :'Array<Category>',
    :'controversy_score' => :'Integer',
    :'date_created' => :'DateTime',
    :'date_last_modified' => :'DateTime',
    :'direct_views' => :'Integer',
    :'question' => :'String',
    :'rating' => :'Float',
    :'raw_score' => :'Integer',
    :'search_views' => :'Integer',
    :'tags' => :'Array<Tag>',
    :'total_views' => :'Integer',
    :'votes' => :'Integer',
    :'was_created_by' => :'User',
    :'was_last_modified_by' => :'User'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/supportify_client/models/faq.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      answer == o.answer &&
      categories == o.categories &&
      controversy_score == o.controversy_score &&
      date_created == o.date_created &&
      date_last_modified == o.date_last_modified &&
      direct_views == o.direct_views &&
      question == o.question &&
      rating == o.rating &&
      raw_score == o.raw_score &&
      search_views == o.search_views &&
      tags == o.tags &&
      total_views == o.total_views &&
      votes == o.votes &&
      was_created_by == o.was_created_by &&
      was_last_modified_by == o.was_last_modified_by
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/supportify_client/models/faq.rb', line 240

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 = Supportify.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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/supportify_client/models/faq.rb', line 297

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/supportify_client/models/faq.rb', line 221

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


211
212
213
 
# File 'lib/supportify_client/models/faq.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



216
217
218
 
# File 'lib/supportify_client/models/faq.rb', line 216

def hash
  [id, answer, categories, controversy_score, date_created, date_last_modified, direct_views, question, rating, raw_score, search_views, tags, total_views, votes, was_created_by, was_last_modified_by].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



280
281
282
 
# File 'lib/supportify_client/models/faq.rb', line 280

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



285
286
287
288
289
290
291
292
293
 
# File 'lib/supportify_client/models/faq.rb', line 285

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 



275
276
277
 
# File 'lib/supportify_client/models/faq.rb', line 275

def to_s
  to_hash.to_s
end