Class: TripletexRubyClient::Addon

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Addon

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_consumer_id ⇒ Object

Returns the value of attribute api_consumer_id.



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

def api_consumer_id
  @api_consumer_id
end

#categories ⇒ Object

Returns the value of attribute categories.



47
48
49
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 47

def categories
  @categories
end

#changes ⇒ Object

Returns the value of attribute changes.



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

def changes
  @changes
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#is_public ⇒ Object

Returns the value of attribute is_public.



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

def is_public
  @is_public
end

#link_to_info ⇒ Object

Returns the value of attribute link_to_info.



41
42
43
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 41

def link_to_info
  @link_to_info
end

#logo ⇒ Object

Returns the value of attribute logo.



49
50
51
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 49

def 
  @logo
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#partner_name ⇒ Object

Returns the value of attribute partner_name.



43
44
45
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 43

def partner_name
  @partner_name
end

#redirect_url ⇒ Object

Returns the value of attribute redirect_url.



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

def redirect_url
  @redirect_url
end

#short_description ⇒ Object

Returns the value of attribute short_description.



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

def short_description
  @short_description
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#target_system_name ⇒ Object

Returns the value of attribute target_system_name.



45
46
47
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 45

def target_system_name
  @target_system_name
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

#visibility ⇒ Object

Returns the value of attribute visibility.



39
40
41
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 39

def visibility
  @visibility
end

#wizard_step ⇒ Object

Returns the value of attribute wizard_step.



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

def wizard_step
  @wizard_step
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'name' => :'name',
    :'description' => :'description',
    :'short_description' => :'shortDescription',
    :'redirect_url' => :'redirectUrl',
    :'status' => :'status',
    :'wizard_step' => :'wizardStep',
    :'is_public' => :'isPublic',
    :'api_consumer_id' => :'apiConsumerId',
    :'visibility' => :'visibility',
    :'link_to_info' => :'linkToInfo',
    :'partner_name' => :'partnerName',
    :'target_system_name' => :'targetSystemName',
    :'categories' => :'categories',
    :'logo' => :'logo'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 98

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'short_description' => :'String',
    :'redirect_url' => :'String',
    :'status' => :'String',
    :'wizard_step' => :'Integer',
    :'is_public' => :'BOOLEAN',
    :'api_consumer_id' => :'Integer',
    :'visibility' => :'String',
    :'link_to_info' => :'String',
    :'partner_name' => :'String',
    :'target_system_name' => :'String',
    :'categories' => :'Array<String>',
    :'logo' => :'AddonLogoDTO'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 335

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      name == o.name &&
      description == o.description &&
      short_description == o.short_description &&
      redirect_url == o.redirect_url &&
      status == o.status &&
      wizard_step == o.wizard_step &&
      is_public == o.is_public &&
      api_consumer_id == o.api_consumer_id &&
      visibility == o.visibility &&
      link_to_info == o.link_to_info &&
      partner_name == o.partner_name &&
      target_system_name == o.target_system_name &&
      categories == o.categories &&
       == o.
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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 394

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



460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 460

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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 373

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


360
361
362
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 360

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



366
367
368
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 366

def hash
  [id, version, changes, url, name, description, short_description, redirect_url, status, wizard_step, is_public, api_consumer_id, visibility, link_to_info, partner_name, target_system_name, categories, ].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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 208

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

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

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

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

  if !@wizard_step.nil? && @wizard_step < 1
    invalid_properties.push('invalid value for "wizard_step", must be greater than or equal to 1.')
  end

  if !@link_to_info.nil? && @link_to_info.to_s.length > 1024
    invalid_properties.push('invalid value for "link_to_info", the character length must be smaller than or equal to 1024.')
  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



440
441
442
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 440

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



446
447
448
449
450
451
452
453
454
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 446

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



434
435
436
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 434

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/tripletex_ruby_client/models/addon.rb', line 239

def valid?
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@description.nil? && @description.to_s.length > 1024
  return false if !@short_description.nil? && @short_description.to_s.length > 1024
  return false if !@redirect_url.nil? && @redirect_url.to_s.length > 1024
  status_validator = EnumAttributeValidator.new('String', ['IN_DEVELOPMENT', 'PENDING', 'REJECTED', 'APPROVED'])
  return false unless status_validator.valid?(@status)
  return false if !@wizard_step.nil? && @wizard_step < 1
  visibility_validator = EnumAttributeValidator.new('String', ['COMPANY_WIDE', 'PERSONAL'])
  return false unless visibility_validator.valid?(@visibility)
  return false if !@link_to_info.nil? && @link_to_info.to_s.length > 1024
  true
end