Class: TripletexRubyClient::Banner

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/banner.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Banner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 77

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

  if attributes.has_key?(:'changes')
    if (value = attributes[:'changes']).is_a?(Array)
      self.changes = value
    end
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

Returns the value of attribute banner_type.



23
24
25
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 23

def banner_type
  @banner_type
end

#button ⇒ Object

Returns the value of attribute button.



29
30
31
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 29

def button
  @button
end

#cancellable ⇒ Object

Returns the value of attribute cancellable.



37
38
39
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 37

def cancellable
  @cancellable
end

#changes ⇒ Object

Returns the value of attribute changes.



19
20
21
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 19

def changes
  @changes
end

#done ⇒ Object

Returns the value of attribute done.



35
36
37
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 35

def done
  @done
end

#id ⇒ Object

Returns the value of attribute id.



15
16
17
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 15

def id
  @id
end

#link ⇒ Object

Returns the value of attribute link.



31
32
33
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 31

def link
  @link
end

#message ⇒ Object

Returns the value of attribute message.



27
28
29
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 27

def message
  @message
end

#tag ⇒ Object

Returns the value of attribute tag.



33
34
35
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 33

def tag
  @tag
end

#title ⇒ Object

Returns the value of attribute title.



25
26
27
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 25

def title
  @title
end

#url ⇒ Object

Returns the value of attribute url.



21
22
23
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 21

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



17
18
19
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 17

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 40

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'banner_type' => :'bannerType',
    :'title' => :'title',
    :'message' => :'message',
    :'button' => :'button',
    :'link' => :'link',
    :'tag' => :'tag',
    :'done' => :'done',
    :'cancellable' => :'cancellable'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 58

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'banner_type' => :'String',
    :'title' => :'String',
    :'message' => :'String',
    :'button' => :'String',
    :'link' => :'String',
    :'tag' => :'String',
    :'done' => :'BOOLEAN',
    :'cancellable' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      banner_type == o.banner_type &&
      title == o.title &&
      message == o.message &&
      button == o.button &&
      link == o.link &&
      tag == o.tag &&
      done == o.done &&
      cancellable == o.cancellable
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 247

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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = TripletexRubyClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 313

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 226

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


213
214
215
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 219

def hash
  [id, version, changes, url, banner_type, title, message, button, link, tag, done, cancellable].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  if !@title.nil? && @title.to_s.length > 255
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.')
  end

  if !@button.nil? && @button.to_s.length > 255
    invalid_properties.push('invalid value for "button", the character length must be smaller than or equal to 255.')
  end

  if !@tag.nil? && @tag.to_s.length > 255
    invalid_properties.push('invalid value for "tag", the character length must be smaller than or equal to 255.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



293
294
295
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 293

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 299

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



287
288
289
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 287

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



155
156
157
158
159
160
 
# File 'lib/tripletex_ruby_client/models/banner.rb', line 155

def valid?
  return false if !@title.nil? && @title.to_s.length > 255
  return false if !@button.nil? && @button.to_s.length > 255
  return false if !@tag.nil? && @tag.to_s.length > 255
  true
end