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



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
125
126
127
128
129
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail 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({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail 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
  }

  if attributes.key?(:'settings')
    self.settings = attributes[:'settings']
  end

  if attributes.key?(:'customer_user')
    self.customer_user = attributes[:'customer_user']
  else
    self.customer_user = nil
  end

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

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

  if attributes.key?(:'redirect_uri')
    self.redirect_uri = attributes[:'redirect_uri']
  else
    self.redirect_uri = nil
  end

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

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

  if attributes.key?(:'connect_features')
    self.connect_features = attributes[:'connect_features']
  end
end

Instance Attribute Details

#connect_features ⇒ Object

Returns the value of attribute connect_features.



36
37
38
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 36

def connect_features
  @connect_features
end

#customer_user ⇒ Object

Returns the value of attribute customer_user.



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

def customer_user
  @customer_user
end

#existing_link_id ⇒ Object

Supply the existing ‘link_id` if you are asking the user to reconnect or modify this link. <p>When reconnecting, if new accounts are discovered they will be presented to the user so permission to access them can be granted (or denied). Access to previously permitted accounts is not revokable at this point. <p>If necessary, MoneyKit may attempt to reconnect the account using a different provider than the link was originally connected through. The change in provider is generally seamless. MoneyKit normalizes incoming data to minimize provider-specific differences, and we deduplicate new transactions, so data continuity is generally assured; however, small discrepancies can still occur. <p>A reconnection cannot change the institution, the customer_user.id, or the country for an existing link. These parameters will be silently ignored if `existing_link_id` is supplied. <p>New products can be added to an existing link. The user will be asked for permission for any added products. Existing product settings, however, cannot be changed and will be silently ignored. <p>The `webhook` for an existing link can be changed, and the existing webhook will be removed if the `webhook` parameter is omitted, so you should supply the `webhook` URL if you want to receive webhook events for the reconnected link. <p>Similarly, a reconnected link will be assigned whatever `link_tags` are supplied, and existing tags will be removed if `link_tags` is omitted, so you should supply the `link_tags` you want the link to have, if any.



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

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. This field is ignored if ‘existing_link_id` is provided.



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

def institution_id
  @institution_id
end

#link_tags ⇒ Object

Returns the value of attribute link_tags.



34
35
36
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 34

def link_tags
  @link_tags
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 app setup process.



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

def redirect_uri
  @redirect_uri
end

#settings ⇒ Object

Returns the value of attribute settings.



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

def settings
  @settings
end

#webhook ⇒ Object

The destination URL to which any webhooks should be sent.



32
33
34
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 32

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



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
298
299
300
301
302
303
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 266

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



53
54
55
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 39

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',
    :'connect_features' => :'connect_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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 242

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 { |v| _deserialize($1, v) }
      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



72
73
74
75
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 58

def self.openapi_types
  {
    :'settings' => :'LinkSessionSettingOverrides',
    :'customer_user' => :'CustomerUser',
    :'existing_link_id' => :'String',
    :'institution_id' => :'String',
    :'redirect_uri' => :'String',
    :'webhook' => :'String',
    :'link_tags' => :'Array<String>',
    :'connect_features' => :'MoneyKitConnectFeatures'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      settings == o.settings &&
      customer_user == o.customer_user &&
      existing_link_id == o.existing_link_id &&
      institution_id == o.institution_id &&
      redirect_uri == o.redirect_uri &&
      webhook == o.webhook &&
      link_tags == o.link_tags &&
      connect_features == o.connect_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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 337

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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


229
230
231
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 235

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



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

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

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

  if @redirect_uri.to_s.length > 65536
    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 > 65536
    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



313
314
315
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 313

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 319

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



307
308
309
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 307

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



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/moneykit/models/create_link_session_request.rb', line 165

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 > 65536
  return false if @redirect_uri.to_s.length < 1
  return false if !@webhook.nil? && @webhook.to_s.length > 65536
  return false if !@webhook.nil? && @webhook.to_s.length < 1
  true
end