Class: ProtonApi::Settings

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/settings.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Settings

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
 
# File 'lib/proton_api/models/settings.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?(:'default_drift_factor')
    self.default_drift_factor = attributes[:'default_drift_factor']
  end

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

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

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

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

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

Instance Attribute Details

#default_drift_factor ⇒ Object

Returns the value of attribute default_drift_factor.



17
18
19
 
# File 'lib/proton_api/models/settings.rb', line 17

def default_drift_factor
  @default_drift_factor
end

#downside ⇒ Object

Returns the value of attribute downside.



21
22
23
 
# File 'lib/proton_api/models/settings.rb', line 21

def downside
  @downside
end

#drift_rebal ⇒ Object

Returns the value of attribute drift_rebal.



19
20
21
 
# File 'lib/proton_api/models/settings.rb', line 19

def drift_rebal
  @drift_rebal
end

#period_rebal ⇒ Object

Returns the value of attribute period_rebal.



25
26
27
 
# File 'lib/proton_api/models/settings.rb', line 25

def period_rebal
  @period_rebal
end

#rebalance_period ⇒ Object

Returns the value of attribute rebalance_period.



27
28
29
 
# File 'lib/proton_api/models/settings.rb', line 27

def rebalance_period
  @rebalance_period
end

#tax_efficiency_id ⇒ Object

Returns the value of attribute tax_efficiency_id.



23
24
25
 
# File 'lib/proton_api/models/settings.rb', line 23

def tax_efficiency_id
  @tax_efficiency_id
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/proton_api/models/settings.rb', line 52

def self.attribute_map
  {
    :'default_drift_factor' => :'default_drift_factor',
    :'drift_rebal' => :'drift_rebal',
    :'downside' => :'downside',
    :'tax_efficiency_id' => :'tax_efficiency_id',
    :'period_rebal' => :'period_rebal',
    :'rebalance_period' => :'rebalance_period'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/proton_api/models/settings.rb', line 64

def self.swagger_types
  {
    :'default_drift_factor' => :'Float',
    :'drift_rebal' => :'BOOLEAN',
    :'downside' => :'BOOLEAN',
    :'tax_efficiency_id' => :'Integer',
    :'period_rebal' => :'BOOLEAN',
    :'rebalance_period' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/proton_api/models/settings.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_drift_factor == o.default_drift_factor &&
      drift_rebal == o.drift_rebal &&
      downside == o.downside &&
      tax_efficiency_id == o.tax_efficiency_id &&
      period_rebal == o.period_rebal &&
      rebalance_period == o.rebalance_period
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
236
237
238
239
240
241
242
243
244
 
# File 'lib/proton_api/models/settings.rb', line 208

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    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 = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ 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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/proton_api/models/settings.rb', line 272

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/proton_api/models/settings.rb', line 188

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


175
176
177
 
# File 'lib/proton_api/models/settings.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/proton_api/models/settings.rb', line 181

def hash
  [default_drift_factor, drift_rebal, downside, tax_efficiency_id, period_rebal, rebalance_period].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



110
111
112
113
114
115
116
117
 
# File 'lib/proton_api/models/settings.rb', line 110

def list_invalid_properties
  invalid_properties = Array.new
  if !@default_drift_factor.nil? && @default_drift_factor < 0
    invalid_properties.push('invalid value for "default_drift_factor", must be greater than or equal to 0.')
  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



253
254
255
 
# File 'lib/proton_api/models/settings.rb', line 253

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



259
260
261
262
263
264
265
266
267
 
# File 'lib/proton_api/models/settings.rb', line 259

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 String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



247
248
249
 
# File 'lib/proton_api/models/settings.rb', line 247

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



121
122
123
124
125
126
127
128
 
# File 'lib/proton_api/models/settings.rb', line 121

def valid?
  return false if !@default_drift_factor.nil? && @default_drift_factor < 0
  tax_efficiency_id_validator = EnumAttributeValidator.new('Integer', ['0', '1', '2', '3', '4'])
  return false unless tax_efficiency_id_validator.valid?(@tax_efficiency_id)
  rebalance_period_validator = EnumAttributeValidator.new('Integer', ['0', '1', '2', '3', '4'])
  return false unless rebalance_period_validator.valid?(@rebalance_period)
  true
end