Class: MoneyKit::PlaidCompatible::LinkTokenCreateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb

Overview

LinkTokenCreateRequest defines the request schema for ‘/link/token/create`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkTokenCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 104

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:redirect_uri)

  self.redirect_uri = attributes[:redirect_uri]
end

Instance Attribute Details

#access_token ⇒ Object

The ‘access_token` associated with the Item to update or reference, used when updating, modifying, or accessing an existing `access_token`. Used when launching Link in update mode, when completing the Same-day (manual) Micro-deposit flow, or (optionally) when initializing Link for a returning user as part of the Transfer UI flow.



45
46
47
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 45

def access_token
  @access_token
end

#additional_consented_products ⇒ Object

(Beta) This field has no effect unless you are participating in the Product Scope Transparency beta program. List of additional Plaid product(s) you wish to collect consent for. These products will not be billed until you start using them by calling the relevant endpoints. ‘balance` is not a valid value, the Balance product does not require explicit initialization and will automatically have consent collected. Institutions that do not support these products will still be shown in Link



39
40
41
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 39

def additional_consented_products
  @additional_consented_products
end

#client_id ⇒ Object

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.



19
20
21
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 19

def client_id
  @client_id
end

#client_name ⇒ Object

The name of your application, as it should be displayed in Link. Maximum length of 30 characters. If a value longer than 30 characters is provided, Link will display "This Application" instead.



25
26
27
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 25

def client_name
  @client_name
end

#country_codes ⇒ Object

Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown. For a complete mapping of supported products by country, see plaid.com/global/. If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. Access to European institutions requires additional compliance steps. To request access to European institutions in the Production environment, [file a product access Support ticket](dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow. If using a Link customization, make sure the country codes in the customization match those specified in ‘country_codes`, or the customization may not be applied. If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `[’US’]‘.



31
32
33
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 31

def country_codes
  @country_codes
end

#language ⇒ Object

The language that Link should be displayed in. When initializing with Identity Verification, this field is not used; for more details, see [Identity Verification supported languages](www.plaid.com/docs/identity-verification/#supported-languages). Supported languages are: - Danish (‘’da’‘) - Dutch (`’nl’‘) - English (`’en’‘) - Estonian (`’et’‘) - French (`’fr’‘) - German (`’de’‘) - Italian (`’it’‘) - Latvian (`’lv’‘) - Lithuanian (`’lt’‘) - Norwegian (`’no’‘) - Polish (`’pl’‘) - Portuguese (`’pt’‘) - Romanian (`’ro’‘) - Spanish (`’es’‘) - Swedish (`’se’‘) When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied.



28
29
30
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 28

def language
  @language
end

#products ⇒ Object

List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted (unless you are using update mode to add Income or Assets to an Item); required otherwise. ‘balance` is not a valid value, the Balance product does not require explicit initialization and will automatically be initialized when any other product is initialized. The products specified here will determine which institutions will be available to your users in Link. Only institutions that support all requested products can be selected; a if a user attempts to select an institution that does not support a listed product, a "Connectivity not supported" error message will appear in Link. To maximize the number of institutions available, initialize Link with the minimal product set required for your use case. Additional products can be added after Link initialization by calling the relevant endpoints. For details and exceptions, see [Choosing when to initialize products](plaid.com/docs/link/initializing-products/). Note that, unless you have opted to disable Instant Match support, institutions that support Instant Match will also be shown in Link if `auth` is specified as a product, even though these institutions do not contain `auth` in their product array. In Production, you will be billed for each product that you specify when initializing Link. Note that a product cannot be removed from an Item once the Item has been initialized with that product. To stop billing on an Item for subscription-based products, such as Liabilities, Investments, and Transactions, remove the Item via `/item/remove`.



36
37
38
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 36

def products
  @products
end

#redirect_uri ⇒ Object

A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. The ‘redirect_uri` should not contain any query parameters. When used in Production or Development, must be an https URI. To specify any subdomain, use `*` as a wildcard character, e.g. `*.example.com/oauth.html`. Note that any redirect URI must also be added to the Allowed redirect URIs list in the [developer dashboard](dashboard.plaid.com/team/api). If initializing on Android, `android_package_name` must be specified instead and `redirect_uri` should be left blank.



48
49
50
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 48

def redirect_uri
  @redirect_uri
end

#secret ⇒ Object

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.



22
23
24
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 22

def secret
  @secret
end

#user ⇒ Object

Returns the value of attribute user.



33
34
35
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 33

def user
  @user
end

#webhook ⇒ Object

The destination URL to which any webhooks should be sent. Note that webhooks for Payment Initiation (e-wallet transactions only), Transfer, Bank Transfer (including Auth micro-deposit notification webhooks) and Identity Verification are configured via the Dashboard instead.



42
43
44
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 42

def webhook
  @webhook
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 68

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 51

def self.attribute_map
  {
    'client_id': :client_id,
    'secret': :secret,
    'client_name': :client_name,
    'language': :language,
    'country_codes': :country_codes,
    'user': :user,
    'products': :products,
    'additional_consented_products': :additional_consented_products,
    'webhook': :webhook,
    'access_token': :access_token,
    'redirect_uri': :redirect_uri
  }
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
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 214

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 90

def self.openapi_nullable
  Set.new(%i[
            client_id
            secret
            products
            additional_consented_products
            webhook
            access_token
            redirect_uri
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 73

def self.openapi_types
  {
    'client_id': :String,
    'secret': :String,
    'client_name': :String,
    'language': :String,
    'country_codes': :'Array<CountryCode>',
    'user': :LinkTokenCreateRequestUser,
    'products': :'Array<Products>',
    'additional_consented_products': :'Array<Products>',
    'webhook': :String,
    'access_token': :String,
    'redirect_uri': :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 181

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

  self.class == other.class &&
    client_id == other.client_id &&
    secret == other.secret &&
    client_name == other.client_name &&
    language == other.language &&
    country_codes == other.country_codes &&
    user == other.user &&
    products == other.products &&
    additional_consented_products == other.additional_consented_products &&
    webhook == other.webhook &&
    access_token == other.access_token &&
    redirect_uri == other.redirect_uri
end

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



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
279
280
281
282
283
284
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 247

def _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::PlaidCompatible.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 318

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 221

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

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

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_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/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 206

def hash
  [client_id, secret, client_name, language, country_codes, user, products, additional_consented_products, webhook,
   access_token, redirect_uri].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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 153

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "client_name", client_name cannot be nil.') if @client_name.nil?

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

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

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

  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



294
295
296
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 294

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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 300

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



288
289
290
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 288

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



170
171
172
173
174
175
176
177
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request.rb', line 170

def valid?
  return false if @client_name.nil?
  return false if @language.nil?
  return false if @country_codes.nil?
  return false if @user.nil?

  true
end