Class: ProtonApi::CashAnalysisRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CashAnalysisRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 101

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

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

  if attributes.has_key?(:'history_frequency_interval')
    self.history_frequency_interval = attributes[:'history_frequency_interval']
  else
    self.history_frequency_interval = 'month'
  end

  if attributes.has_key?(:'show_inflow_details')
    self.show_inflow_details = attributes[:'show_inflow_details']
  else
    self.show_inflow_details = false
  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?(:'transaction_status_scope')
    if (value = attributes[:'transaction_status_scope']).is_a?(Array)
      self.transaction_status_scope = value
    end
  end

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

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

Instance Attribute Details

#client_id ⇒ Object

Returns the value of attribute client_id.



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

def client_id
  @client_id
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



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

def currency_code
  @currency_code
end

#currency_conversion ⇒ Object

Returns the value of attribute currency_conversion.



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

def currency_conversion
  @currency_conversion
end

#end_date ⇒ Object

Returns the value of attribute end_date.



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

def end_date
  @end_date
end

#history_frequency_interval ⇒ Object

Returns the value of attribute history_frequency_interval.



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

def history_frequency_interval
  @history_frequency_interval
end

#only_cleansed ⇒ Object

Returns the value of attribute only_cleansed.



39
40
41
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 39

def only_cleansed
  @only_cleansed
end

#scope ⇒ Object

Returns the value of attribute scope.



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

def scope
  @scope
end

#show_history ⇒ Object

Returns the value of attribute show_history.



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

def show_history
  @show_history
end

#show_inflow_details ⇒ Object

Returns the value of attribute show_inflow_details.



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

def show_inflow_details
  @show_inflow_details
end

#show_outflow_details ⇒ Object

Returns the value of attribute show_outflow_details.



37
38
39
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 37

def show_outflow_details
  @show_outflow_details
end

#start_date ⇒ Object

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

#transaction_status_scope ⇒ Object

Returns the value of attribute transaction_status_scope.



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

def transaction_status_scope
  @transaction_status_scope
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 64

def self.attribute_map
  {
    :'currency_code' => :'currency_code',
    :'client_id' => :'client_id',
    :'show_history' => :'show_history',
    :'scope' => :'scope',
    :'end_date' => :'end_date',
    :'history_frequency_interval' => :'history_frequency_interval',
    :'show_inflow_details' => :'show_inflow_details',
    :'currency_conversion' => :'currency_conversion',
    :'start_date' => :'start_date',
    :'transaction_status_scope' => :'transaction_status_scope',
    :'show_outflow_details' => :'show_outflow_details',
    :'only_cleansed' => :'only_cleansed'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 82

def self.swagger_types
  {
    :'currency_code' => :'String',
    :'client_id' => :'String',
    :'show_history' => :'BOOLEAN',
    :'scope' => :'String',
    :'end_date' => :'Date',
    :'history_frequency_interval' => :'String',
    :'show_inflow_details' => :'BOOLEAN',
    :'currency_conversion' => :'String',
    :'start_date' => :'Date',
    :'transaction_status_scope' => :'Array<String>',
    :'show_outflow_details' => :'BOOLEAN',
    :'only_cleansed' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 209

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 &&
      scope == o.scope &&
      end_date == o.end_date &&
      history_frequency_interval == o.history_frequency_interval &&
      show_inflow_details == o.show_inflow_details &&
      currency_conversion == o.currency_conversion &&
      start_date == o.start_date &&
      transaction_status_scope == o.transaction_status_scope &&
      show_outflow_details == o.show_outflow_details &&
      only_cleansed == o.only_cleansed
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 261

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 325

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 241

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


228
229
230
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 234

def hash
  [currency_code, client_id, show_history, scope, end_date, history_frequency_interval, show_inflow_details, currency_conversion, start_date, transaction_status_scope, show_outflow_details, only_cleansed].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



172
173
174
175
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 172

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



306
307
308
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 306

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



312
313
314
315
316
317
318
319
320
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 312

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



300
301
302
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 300

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



179
180
181
182
183
184
185
 
# File 'lib/proton_api/models/cash_analysis_request.rb', line 179

def valid?
  scope_validator = EnumAttributeValidator.new('String', ['all', 'external', 'internal'])
  return false unless scope_validator.valid?(@scope)
  history_frequency_interval_validator = EnumAttributeValidator.new('String', ['day', 'week', 'month', 'quarter', 'year'])
  return false unless history_frequency_interval_validator.valid?(@history_frequency_interval)
  true
end