Class: ProtonApi::FinancialPictureRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FinancialPictureRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
116
117
118
119
120
121
122
123
124
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 71

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

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

  if attributes.has_key?(:'show_history')
    self.show_history = attributes[:'show_history']
  else
    self.show_history = false
  end

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

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

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

  if attributes.has_key?(:'show_category_breakdown')
    self.show_category_breakdown = attributes[:'show_category_breakdown']
  else
    self.show_category_breakdown = true
  end

  if attributes.has_key?(:'show_change')
    self.show_change = attributes[:'show_change']
  else
    self.show_change = false
  end

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

  if attributes.has_key?(:'create_log')
    self.create_log = attributes[:'create_log']
  else
    self.create_log = false
  end
end

Instance Attribute Details

#client_id ⇒ Object

Returns the value of attribute client_id.



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

def client_id
  @client_id
end

#create_log ⇒ Object

Returns the value of attribute create_log.



35
36
37
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 35

def create_log
  @create_log
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



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

def currency_code
  @currency_code
end

#currency_conversion ⇒ Object

Returns the value of attribute currency_conversion.



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

def currency_conversion
  @currency_conversion
end

#end_date ⇒ Object

Returns the value of attribute end_date.



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

def end_date
  @end_date
end

#household_id ⇒ Object

Returns the value of attribute household_id.



33
34
35
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 33

def household_id
  @household_id
end

#show_category_breakdown ⇒ Object

Returns the value of attribute show_category_breakdown.



29
30
31
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 29

def show_category_breakdown
  @show_category_breakdown
end

#show_change ⇒ Object

Returns the value of attribute show_change.



31
32
33
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 31

def show_change
  @show_change
end

#show_history ⇒ Object

Returns the value of attribute show_history.



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

def show_history
  @show_history
end

#start_date ⇒ Object

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 38

def self.attribute_map
  {
    :'currency_code' => :'currency_code',
    :'client_id' => :'client_id',
    :'show_history' => :'show_history',
    :'end_date' => :'end_date',
    :'currency_conversion' => :'currency_conversion',
    :'start_date' => :'start_date',
    :'show_category_breakdown' => :'show_category_breakdown',
    :'show_change' => :'show_change',
    :'household_id' => :'household_id',
    :'create_log' => :'create_log'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 54

def self.swagger_types
  {
    :'currency_code' => :'String',
    :'client_id' => :'String',
    :'show_history' => :'BOOLEAN',
    :'end_date' => :'Date',
    :'currency_conversion' => :'String',
    :'start_date' => :'Date',
    :'show_category_breakdown' => :'BOOLEAN',
    :'show_change' => :'BOOLEAN',
    :'household_id' => :'String',
    :'create_log' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      currency_code == o.currency_code &&
      client_id == o.client_id &&
      show_history == o.show_history &&
      end_date == o.end_date &&
      currency_conversion == o.currency_conversion &&
      start_date == o.start_date &&
      show_category_breakdown == o.show_category_breakdown &&
      show_change == o.show_change &&
      household_id == o.household_id &&
      create_log == o.create_log
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 191

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 255

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 171

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


158
159
160
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 158

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 164

def hash
  [currency_code, client_id, show_history, end_date, currency_conversion, start_date, show_category_breakdown, show_change, household_id, create_log].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



128
129
130
131
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 128

def list_invalid_properties
  invalid_properties = Array.new
  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



236
237
238
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 236

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



242
243
244
245
246
247
248
249
250
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 242

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



230
231
232
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 230

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



135
136
137
 
# File 'lib/proton_api/models/financial_picture_request.rb', line 135

def valid?
  true
end