Class: Plaid::SessionTokenCreateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/session_token_create_request.rb

Overview

SessionTokenCreateRequest defines the request schema for ‘/session/token/create`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SessionTokenCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/plaid/models/session_token_create_request.rb', line 83

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::SessionTokenCreateRequest` 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 `Plaid::SessionTokenCreateRequest`. 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?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#android_package_name ⇒ Object

The name of your app’s Android package. Required if using the session token to initialize Layer on Android. Any package name specified here must also be added to the Allowed Android package names setting on the [developer dashboard](dashboard.plaid.com/team/api). When creating a session token for initializing Layer on other platforms, ‘android_package_name` must be left blank and `redirect_uri` should be used instead.



34
35
36
 
# File 'lib/plaid/models/session_token_create_request.rb', line 34

def android_package_name
  @android_package_name
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.



20
21
22
 
# File 'lib/plaid/models/session_token_create_request.rb', line 20

def client_id
  @client_id
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 another app. The ‘redirect_uri` should not contain any query parameters. When used in Production, 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.



31
32
33
 
# File 'lib/plaid/models/session_token_create_request.rb', line 31

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.



23
24
25
 
# File 'lib/plaid/models/session_token_create_request.rb', line 23

def secret
  @secret
end

#template_id ⇒ Object

The id of a template defined in Plaid Dashboard



26
27
28
 
# File 'lib/plaid/models/session_token_create_request.rb', line 26

def template_id
  @template_id
end

#user ⇒ Object

Returns the value of attribute user.



28
29
30
 
# File 'lib/plaid/models/session_token_create_request.rb', line 28

def user
  @user
end

#user_id ⇒ Object

A unique user identifier, created by ‘/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [new user APIs](plaid.com/docs/api/users/user-apis).



40
41
42
 
# File 'lib/plaid/models/session_token_create_request.rb', line 40

def user_id
  @user_id
end

#webhook ⇒ Object

The destination URL to which any webhooks should be sent. If you use the same webhook listener for all Sandbox or all Production activity, set this value in the Layer template editor in the Dashboard instead. Only provide a value in this field if you need to use multiple webhook URLs per environment (an uncommon use case). If provided, a value in this field will take priority over webhook values set in the Layer template editor.



37
38
39
 
# File 'lib/plaid/models/session_token_create_request.rb', line 37

def webhook
  @webhook
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/plaid/models/session_token_create_request.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/plaid/models/session_token_create_request.rb', line 43

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'template_id' => :'template_id',
    :'user' => :'user',
    :'redirect_uri' => :'redirect_uri',
    :'android_package_name' => :'android_package_name',
    :'webhook' => :'webhook',
    :'user_id' => :'user_id'
  }
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



177
178
179
 
# File 'lib/plaid/models/session_token_create_request.rb', line 177

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
 
# File 'lib/plaid/models/session_token_create_request.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/plaid/models/session_token_create_request.rb', line 62

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'template_id' => :'String',
    :'user' => :'SessionTokenCreateRequestUser',
    :'redirect_uri' => :'String',
    :'android_package_name' => :'String',
    :'webhook' => :'String',
    :'user_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/plaid/models/session_token_create_request.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      template_id == o.template_id &&
      user == o.user &&
      redirect_uri == o.redirect_uri &&
      android_package_name == o.android_package_name &&
      webhook == o.webhook &&
      user_id == o.user_id
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/plaid/models/session_token_create_request.rb', line 208

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 = Plaid.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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/plaid/models/session_token_create_request.rb', line 279

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/plaid/models/session_token_create_request.rb', line 184

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


164
165
166
 
# File 'lib/plaid/models/session_token_create_request.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



170
171
172
 
# File 'lib/plaid/models/session_token_create_request.rb', line 170

def hash
  [client_id, secret, template_id, user, redirect_uri, android_package_name, webhook, user_id].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



131
132
133
134
135
136
137
138
 
# File 'lib/plaid/models/session_token_create_request.rb', line 131

def list_invalid_properties
  invalid_properties = Array.new
  if @template_id.nil?
    invalid_properties.push('invalid value for "template_id", template_id cannot be nil.')
  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



255
256
257
 
# File 'lib/plaid/models/session_token_create_request.rb', line 255

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/plaid/models/session_token_create_request.rb', line 261

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



249
250
251
 
# File 'lib/plaid/models/session_token_create_request.rb', line 249

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



142
143
144
145
 
# File 'lib/plaid/models/session_token_create_request.rb', line 142

def valid?
  return false if @template_id.nil?
  true
end