=begin
#MoneyKit API
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
The version of the OpenAPI document: 2023-02-18
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 7.1.0
=end
require 'date'
require 'time'
module MoneyKit
class CreateLinkSessionRequest
attr_accessor :settings
attr_accessor :customer_user
# Supply the existing `link_id` if you are asking the user to reconnect this link.
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.
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.
A reconnection cannot change the institution, the customer_user.id, the products, or the country for an existing link. These parameters will be silently ignored if `existing_link_id` is supplied.
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.
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.
attr_accessor :existing_link_id
# 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.
attr_accessor :institution_id
# 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.
attr_accessor :redirect_uri
# The destination URL to which any webhooks should be sent.
attr_accessor :webhook
attr_accessor :link_tags
attr_accessor :connect_features
# Attribute mapping from ruby-style variable name to JSON key.
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
# Returns all the JSON keys this model knows about
def self.acceptable_attributes
attribute_map.values
end
# Attribute type mapping.
def self.openapi_types
{
:'settings' => :'LinkSessionSettingOverrides',
:'customer_user' => :'LinkSessionCustomerUser',
:'existing_link_id' => :'String',
:'institution_id' => :'String',
:'redirect_uri' => :'String',
:'webhook' => :'String',
:'link_tags' => :'Array',
:'connect_features' => :'MoneyKitConnectFeatures'
}
end
# List of attributes with nullable: true
def self.openapi_nullable
Set.new([
])
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
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
# Show invalid properties with the reasons. Usually used together with valid?
# @return Array for valid properties with the reasons
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
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
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
# Custom attribute writer method with validation
# @param [Object] redirect_uri Value to be assigned
def redirect_uri=(redirect_uri)
if redirect_uri.nil?
fail ArgumentError, 'redirect_uri cannot be nil'
end
if redirect_uri.to_s.length > 65536
fail ArgumentError, 'invalid value for "redirect_uri", the character length must be smaller than or equal to 65536.'
end
if redirect_uri.to_s.length < 1
fail ArgumentError, 'invalid value for "redirect_uri", the character length must be great than or equal to 1.'
end
@redirect_uri = redirect_uri
end
# Custom attribute writer method with validation
# @param [Object] webhook Value to be assigned
def webhook=(webhook)
if webhook.nil?
fail ArgumentError, 'webhook cannot be nil'
end
if webhook.to_s.length > 65536
fail ArgumentError, 'invalid value for "webhook", the character length must be smaller than or equal to 65536.'
end
if webhook.to_s.length < 1
fail ArgumentError, 'invalid value for "webhook", the character length must be great than or equal to 1.'
end
@webhook = webhook
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
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
# @see the `==` method
# @param [Object] Object to be compared
def eql?(o)
self == o
end
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[settings, customer_user, existing_link_id, institution_id, redirect_uri, webhook, link_tags, connect_features].hash
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
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
# Deserializes the data based on type
# @param string type Data type
# @param string value Value to be deserialized
# @return [Object] Deserialized data
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<(?.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?.+?), (?.+)>\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
# Returns the string representation of the object
# @return [String] String presentation of the object
def to_s
to_hash.to_s
end
# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
def to_body
to_hash
end
# Returns the object in the form of hash
# @return [Hash] Returns the object in the form of hash
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
# Outputs non-array value in the form of hash
# For object, use to_hash. Otherwise, just return the value
# @param [Object] value Any valid value
# @return [Hash] Returns the value in the form of hash
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
end
end