Class: MoneyKit::TransactionsProductSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/moneykit/models/transactions_product_settings.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionsProductSettings

Initializes the object



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 55

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `MoneyKit::TransactionsProductSettings` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `MoneyKit::TransactionsProductSettings`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end

    h[k.to_sym] = v
  end

  self.required = if attributes.key?(:required)
                    attributes[:required]
                  else
                    false
                  end

  self.prefetch = if attributes.key?(:prefetch)
                    attributes[:prefetch]
                  else
                    false
                  end

  self.extend_history = if attributes.key?(:extend_history)
                          attributes[:extend_history]
                        else
                          false
                        end
end

Instance Attribute Details

#extend_history ⇒ Object

If true, MoneyKit will attempt to fetch as much transaction history as possible. Not all institutions supply the same extent of transaction history. Generally, however, at least the past 30 days of transactions are available.



23
24
25
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 23

def extend_history
  @extend_history
end

#prefetch ⇒ Object

If true, the data will be available as soon as possible after linking, even if ‘required` is false. If false, the data will be available after the first manual data refresh.



20
21
22
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 20

def prefetch
  @prefetch
end

#required ⇒ Object

If true, only institutions supporting this product will be available.



17
18
19
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 17

def required
  @required
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 157

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = MoneyKit.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



35
36
37
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 35

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 26

def self.attribute_map
  {
    'required': :required,
    'prefetch': :prefetch,
    'extend_history': :extend_history
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 130

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map do |v|
          _deserialize(::Regexp.last_match(1), v)
        end
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



49
50
51
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 49

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 40

def self.openapi_types
  {
    'required': :Boolean,
    'prefetch': :Boolean,
    'extend_history': :Boolean
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



106
107
108
109
110
111
112
113
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 106

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    required == other.required &&
    prefetch == other.prefetch &&
    extend_history == other.extend_history
end

#_to_hash(value) ⇒ Hash

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 228

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

#eql?(other) ⇒ Boolean

See Also:

  • `==` method


117
118
119
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



123
124
125
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 123

def hash
  [required, prefetch, extend_history].hash
end

#list_invalid_properties ⇒ Object

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



92
93
94
95
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 92

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



204
205
206
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 204

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 210

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



198
199
200
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 198

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



99
100
101
102
 
# File 'lib/moneykit/models/transactions_product_settings.rb', line 99

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end