class Plaid::LinkSessionFinishedWebhook
Contains the state of a completed Link session, along with the public token(s) if available. By default, the ‘EVENTS` webhook is sent only for sessions where the end user goes through a Hosted Link flow (including Link Recovery flows) or a Multi-Item Link flow. If you would like to receive this webhook for other sessions, contact your Account Manager or Support.
Attributes
The identifier for the Link session.
The link token used to create the Link session.
The public token generated by the Link session. This field has been deprecated; please use ‘public_tokens` instead.
The public tokens generated by the Link session.
The final status of the Link session. Will always be "SUCCESS" or "EXITED".
‘SESSION_FINISHED`
‘LINK`
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/link_session_finished_webhook.rb, line 79 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/link_session_finished_webhook.rb, line 65 def self.attribute_map { :'webhook_type' => :'webhook_type', :'webhook_code' => :'webhook_code', :'status' => :'status', :'link_session_id' => :'link_session_id', :'link_token' => :'link_token', :'public_token' => :'public_token', :'public_tokens' => :'public_tokens', :'environment' => :'environment' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/link_session_finished_webhook.rb, line 226 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/plaid/models/link_session_finished_webhook.rb, line 105 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::LinkSessionFinishedWebhook` 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::LinkSessionFinishedWebhook`. 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?(:'webhook_type') self.webhook_type = attributes[:'webhook_type'] end if attributes.key?(:'webhook_code') self.webhook_code = attributes[:'webhook_code'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'link_session_id') self.link_session_id = attributes[:'link_session_id'] end if attributes.key?(:'link_token') self.link_token = attributes[:'link_token'] end if attributes.key?(:'public_token') self.public_token = attributes[:'public_token'] end if attributes.key?(:'public_tokens') if (value = attributes[:'public_tokens']).is_a?(Array) self.public_tokens = value end end if attributes.key?(:'environment') self.environment = attributes[:'environment'] end end
List of attributes with nullable: true
# File lib/plaid/models/link_session_finished_webhook.rb, line 98 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/plaid/models/link_session_finished_webhook.rb, line 84 def self.openapi_types { :'webhook_type' => :'String', :'webhook_code' => :'String', :'status' => :'String', :'link_session_id' => :'String', :'link_token' => :'String', :'public_token' => :'String', :'public_tokens' => :'Array<String>', :'environment' => :'WebhookEnvironmentValues' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/link_session_finished_webhook.rb, line 198 def ==(o) return true if self.equal?(o) self.class == o.class && webhook_type == o.webhook_type && webhook_code == o.webhook_code && status == o.status && link_session_id == o.link_session_id && link_token == o.link_token && public_token == o.public_token && public_tokens == o.public_tokens && environment == o.environment end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/link_session_finished_webhook.rb, line 257 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
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
# File lib/plaid/models/link_session_finished_webhook.rb, line 328 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/link_session_finished_webhook.rb, line 233 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/link_session_finished_webhook.rb, line 213 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/link_session_finished_webhook.rb, line 219 def hash [webhook_type, webhook_code, status, link_session_id, link_token, public_token, public_tokens, environment].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/link_session_finished_webhook.rb, line 155 def list_invalid_properties invalid_properties = Array.new if @webhook_type.nil? invalid_properties.push('invalid value for "webhook_type", webhook_type cannot be nil.') end if @webhook_code.nil? invalid_properties.push('invalid value for "webhook_code", webhook_code cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @link_session_id.nil? invalid_properties.push('invalid value for "link_session_id", link_session_id cannot be nil.') end if @link_token.nil? invalid_properties.push('invalid value for "link_token", link_token cannot be nil.') end if @environment.nil? invalid_properties.push('invalid value for "environment", environment cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/link_session_finished_webhook.rb, line 310 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/plaid/models/link_session_finished_webhook.rb, line 298 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/plaid/models/link_session_finished_webhook.rb, line 186 def valid? return false if @webhook_type.nil? return false if @webhook_code.nil? return false if @status.nil? return false if @link_session_id.nil? return false if @link_token.nil? return false if @environment.nil? true end