Class: MoneyKit::CreateLinkSessionRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateLinkSessionRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `MoneyKit::CreateLinkSessionRequest` 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::CreateLinkSessionRequest`. 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.settings = attributes[:settings] if attributes.key?(:settings)

  self.customer_user = (attributes[:customer_user] if attributes.key?(:customer_user))

  self.existing_link_id = attributes[:existing_link_id] if attributes.key?(:existing_link_id)

  self.institution_id = attributes[:institution_id] if attributes.key?(:institution_id)

  self.redirect_uri = (attributes[:redirect_uri] if attributes.key?(:redirect_uri))

  self.webhook = attributes[:webhook] if attributes.key?(:webhook)

  if attributes.key?(:link_tags) && (value = attributes[:link_tags]).is_a?(Array)
    self.link_tags = value
  end

  return unless attributes.key?(:moneylink_features)

  self.moneylink_features = attributes[:moneylink_features]
end

Instance Attribute Details

#customer_user ⇒ Object

Returns the value of attribute customer_user.



16
17
18
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 16

def customer_user
  @customer_user
end

#existing_link_id ⇒ Object

Supply the existing ‘link_id` if you are asking the user to reconnect this link.



19
20
21
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 19

def existing_link_id
  @existing_link_id
end

#institution_id ⇒ Object

The ID of the institution you want to link to. Providing this will skip the institution selection step. ‘existing_link_id` will take precedence over this field if both are provided.



22
23
24
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 22

def institution_id
  @institution_id
end

#link_tags ⇒ Object

Returns the value of attribute link_tags.



16
17
18
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 16

def link_tags
  @link_tags
end

#moneylink_features ⇒ Object

Returns the value of attribute moneylink_features.



16
17
18
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 16

def moneylink_features
  @moneylink_features
end

#redirect_uri ⇒ Object

For Oauth linking, a URI indicating the destination, in your application, where the user should be sent after authenticating with the institution. The ‘redirect_uri` should not contain any query parameters, and it must be pre-approved by MoneyKit during the customer setup process.



25
26
27
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 25

def redirect_uri
  @redirect_uri
end

#settings ⇒ Object

Returns the value of attribute settings.



16
17
18
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 16

def settings
  @settings
end

#webhook ⇒ Object

The destination URL to which any webhooks should be sent.



28
29
30
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 28

def webhook
  @webhook
end

Class Method Details

._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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 241

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



45
46
47
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 31

def self.attribute_map
  {
    'settings': :settings,
    'customer_user': :customer_user,
    'existing_link_id': :existing_link_id,
    'institution_id': :institution_id,
    'redirect_uri': :redirect_uri,
    'webhook': :webhook,
    'link_tags': :link_tags,
    'moneylink_features': :moneylink_features
  }
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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 214

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



64
65
66
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 50

def self.openapi_types
  {
    'settings': :LinkSessionSettingOverrides,
    'customer_user': :LinkSessionCustomerUser,
    'existing_link_id': :String,
    'institution_id': :String,
    'redirect_uri': :String,
    'webhook': :String,
    'link_tags': :'Array<String>',
    'moneylink_features': :MoneyLinkFeatures
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 184

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

  self.class == other.class &&
    settings == other.settings &&
    customer_user == other.customer_user &&
    existing_link_id == other.existing_link_id &&
    institution_id == other.institution_id &&
    redirect_uri == other.redirect_uri &&
    webhook == other.webhook &&
    link_tags == other.link_tags &&
    moneylink_features == other.moneylink_features
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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 312

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 200

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



206
207
208
209
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 206

def hash
  [settings, customer_user, existing_link_id, institution_id, redirect_uri, webhook, link_tags,
   moneylink_features].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = []
  invalid_properties.push('invalid value for "customer_user", customer_user cannot be nil.') if @customer_user.nil?

  invalid_properties.push('invalid value for "redirect_uri", redirect_uri cannot be nil.') if @redirect_uri.nil?

  if @redirect_uri.to_s.length > 65_536
    invalid_properties.push('invalid value for "redirect_uri", the character length must be smaller than or equal to 65536.')
  end

  if @redirect_uri.to_s.length < 1
    invalid_properties.push('invalid value for "redirect_uri", the character length must be great than or equal to 1.')
  end

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

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



288
289
290
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 288

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 294

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

Returns:

  • (String) —

    String presentation of the object



282
283
284
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 282

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



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 137

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @customer_user.nil?
  return false if @redirect_uri.nil?
  return false if @redirect_uri.to_s.length > 65_536
  return false if @redirect_uri.to_s.length < 1
  return false if !@webhook.nil? && @webhook.to_s.length > 65_536
  return false if !@webhook.nil? && @webhook.to_s.length < 1

  true
end