plaid 15.5.0 → 15.8.0

data/lib/plaid/models/entity_watchlist_screening_response.rb

@@ -0,0 +1,302 @@
+=begin
+#The Plaid API
+
+#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
+
+The version of the OpenAPI document: 2020-09-14_1.128.4
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entity screenings will not receive new hits, regardless of entity program configuration.
+  class EntityWatchlistScreeningResponse
+    # ID of the associated entity screening.
+    attr_accessor :id
+
+    attr_accessor :search_terms
+
+    attr_accessor :assignee
+
+    attr_accessor :status
+
+    attr_accessor :client_user_id
+
+    attr_accessor :audit_trail
+
+    # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
+    attr_accessor :request_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'search_terms' => :'search_terms',
+        :'assignee' => :'assignee',
+        :'status' => :'status',
+        :'client_user_id' => :'client_user_id',
+        :'audit_trail' => :'audit_trail',
+        :'request_id' => :'request_id'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'search_terms' => :'EntityWatchlistScreeningSearchTerms',
+        :'assignee' => :'String',
+        :'status' => :'WatchlistScreeningStatus',
+        :'client_user_id' => :'String',
+        :'audit_trail' => :'WatchlistScreeningAuditTrail',
+        :'request_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'assignee',
+        :'client_user_id',
+      ])
+    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 `Plaid::EntityWatchlistScreeningResponse` 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::EntityWatchlistScreeningResponse`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'search_terms')
+        self.search_terms = attributes[:'search_terms']
+      end
+
+      if attributes.key?(:'assignee')
+        self.assignee = attributes[:'assignee']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'client_user_id')
+        self.client_user_id = attributes[:'client_user_id']
+      end
+
+      if attributes.key?(:'audit_trail')
+        self.audit_trail = attributes[:'audit_trail']
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      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
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @search_terms.nil?
+        invalid_properties.push('invalid value for "search_terms", search_terms cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @audit_trail.nil?
+        invalid_properties.push('invalid value for "audit_trail", audit_trail cannot be nil.')
+      end
+
+      if @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
+      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?
+      return false if @id.nil?
+      return false if @search_terms.nil?
+      return false if @status.nil?
+      return false if @audit_trail.nil?
+      return false if @request_id.nil?
+      true
+    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 &&
+          id == o.id &&
+          search_terms == o.search_terms &&
+          assignee == o.assignee &&
+          status == o.status &&
+          client_user_id == o.client_user_id &&
+          audit_trail == o.audit_trail &&
+          request_id == o.request_id
+    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
+      [id, search_terms, assignee, status, client_user_id, audit_trail, request_id].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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)
+          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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # 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

data/lib/plaid/models/entity_watchlist_screening_review.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.115.2
+The version of the OpenAPI document: 2020-09-14_1.128.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/entity_watchlist_screening_review_response.rb

@@ -0,0 +1,316 @@
+=begin
+#The Plaid API
+
+#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
+
+The version of the OpenAPI document: 2020-09-14_1.128.4
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # A review submitted by a team member for an entity watchlist screening. A review can be either a comment on the current screening state, actions taken against hits attached to the watchlist screening, or both.
+  class EntityWatchlistScreeningReviewResponse
+    # ID of the associated entity review.
+    attr_accessor :id
+
+    # Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.
+    attr_accessor :confirmed_hits
+
+    # Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.
+    attr_accessor :dismissed_hits
+
+    # A comment submitted by a team member as part of reviewing a watchlist screening.
+    attr_accessor :comment
+
+    attr_accessor :audit_trail
+
+    # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
+    attr_accessor :request_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'confirmed_hits' => :'confirmed_hits',
+        :'dismissed_hits' => :'dismissed_hits',
+        :'comment' => :'comment',
+        :'audit_trail' => :'audit_trail',
+        :'request_id' => :'request_id'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'confirmed_hits' => :'Array<String>',
+        :'dismissed_hits' => :'Array<String>',
+        :'comment' => :'String',
+        :'audit_trail' => :'WatchlistScreeningAuditTrail',
+        :'request_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'comment',
+      ])
+    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 `Plaid::EntityWatchlistScreeningReviewResponse` 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::EntityWatchlistScreeningReviewResponse`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'confirmed_hits')
+        if (value = attributes[:'confirmed_hits']).is_a?(Array)
+          self.confirmed_hits = value
+        end
+      end
+
+      if attributes.key?(:'dismissed_hits')
+        if (value = attributes[:'dismissed_hits']).is_a?(Array)
+          self.dismissed_hits = value
+        end
+      end
+
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
+      end
+
+      if attributes.key?(:'audit_trail')
+        self.audit_trail = attributes[:'audit_trail']
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      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
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @confirmed_hits.nil?
+        invalid_properties.push('invalid value for "confirmed_hits", confirmed_hits cannot be nil.')
+      end
+
+      if @dismissed_hits.nil?
+        invalid_properties.push('invalid value for "dismissed_hits", dismissed_hits cannot be nil.')
+      end
+
+      if @comment.to_s.length < 1
+        invalid_properties.push('invalid value for "comment", the character length must be great than or equal to 1.')
+      end
+
+
+      if @audit_trail.nil?
+        invalid_properties.push('invalid value for "audit_trail", audit_trail cannot be nil.')
+      end
+
+      if @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
+      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?
+      return false if @id.nil?
+      return false if @confirmed_hits.nil?
+      return false if @dismissed_hits.nil?
+      return false if @comment.to_s.length < 1
+      return false if @audit_trail.nil?
+      return false if @request_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] comment Value to be assigned
+    def comment=(comment)
+      if comment.to_s.length < 1
+        fail ArgumentError, 'invalid value for "comment", the character length must be great than or equal to 1.'
+      end
+
+
+      @comment = comment
+    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 &&
+          id == o.id &&
+          confirmed_hits == o.confirmed_hits &&
+          dismissed_hits == o.dismissed_hits &&
+          comment == o.comment &&
+          audit_trail == o.audit_trail &&
+          request_id == o.request_id
+    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
+      [id, confirmed_hits, dismissed_hits, comment, audit_trail, request_id].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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)
+          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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # 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

data/lib/plaid/models/entity_watchlist_screening_search_terms.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.115.2
+The version of the OpenAPI document: 2020-09-14_1.128.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -22,7 +22,7 @@ module Plaid
     # The name of the organization being screened.
     attr_accessor :legal_name
 
-    attr_accessor :document
+    attr_accessor :document_number
 
     attr_accessor :email_address
 
@@ -40,7 +40,7 @@ module Plaid
       {
         :'entity_watchlist_program_id' => :'entity_watchlist_program_id',
         :'legal_name' => :'legal_name',
-        :'document' => :'document',
+        :'document_number' => :'document_number',
         :'email_address' => :'email_address',
         :'country' => :'country',
         :'phone_number' => :'phone_number',
@@ -59,7 +59,7 @@ module Plaid
       {
         :'entity_watchlist_program_id' => :'String',
         :'legal_name' => :'String',
-        :'document' => :'String',
+        :'document_number' => :'String',
         :'email_address' => :'String',
         :'country' => :'String',
         :'phone_number' => :'String',
@@ -71,7 +71,7 @@ module Plaid
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'document',
+        :'document_number',
         :'email_address',
         :'country',
         :'phone_number',
@@ -102,8 +102,8 @@ module Plaid
         self.legal_name = attributes[:'legal_name']
       end
 
-      if attributes.key?(:'document')
-        self.document = attributes[:'document']
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
       end
 
       if attributes.key?(:'email_address')
@@ -194,7 +194,7 @@ module Plaid
       self.class == o.class &&
           entity_watchlist_program_id == o.entity_watchlist_program_id &&
           legal_name == o.legal_name &&
-          document == o.document &&
+          document_number == o.document_number &&
           email_address == o.email_address &&
           country == o.country &&
           phone_number == o.phone_number &&
@@ -211,7 +211,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [entity_watchlist_program_id, legal_name, document, email_address, country, phone_number, url, version].hash
+      [entity_watchlist_program_id, legal_name, document_number, email_address, country, phone_number, url, version].hash
     end
 
     # Builds the object from hash