plaid 15.5.0 → 15.8.0

data/lib/plaid/models/entity_watchlist_program.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,8 +22,8 @@ module Plaid
     # An ISO8601 formatted timestamp.
     attr_accessor :created_at
 
-    # Indicator specifying whether the program is enabled and can be used to screen entities.
-    attr_accessor :enabled
+    # Indicator specifying whether the program is enabled and will perform daily rescans.
+    attr_accessor :is_rescanning_enabled
 
     # Watchlists enabled for the associated program
     attr_accessor :lists_enabled
@@ -36,19 +36,19 @@ module Plaid
     attr_accessor :audit_trail
 
     # Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.
-    attr_accessor :archived
+    attr_accessor :is_archived
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'created_at' => :'created_at',
-        :'enabled' => :'enabled',
+        :'is_rescanning_enabled' => :'is_rescanning_enabled',
         :'lists_enabled' => :'lists_enabled',
         :'name' => :'name',
         :'name_sensitivity' => :'name_sensitivity',
         :'audit_trail' => :'audit_trail',
-        :'archived' => :'archived'
+        :'is_archived' => :'is_archived'
       }
     end
 
@@ -62,12 +62,12 @@ module Plaid
       {
         :'id' => :'String',
         :'created_at' => :'Time',
-        :'enabled' => :'Boolean',
+        :'is_rescanning_enabled' => :'Boolean',
         :'lists_enabled' => :'Array<EntityWatchlistCode>',
         :'name' => :'String',
         :'name_sensitivity' => :'ProgramNameSensitivity',
         :'audit_trail' => :'WatchlistScreeningAuditTrail',
-        :'archived' => :'Boolean'
+        :'is_archived' => :'Boolean'
       }
     end
 
@@ -100,8 +100,8 @@ module Plaid
         self.created_at = attributes[:'created_at']
       end
 
-      if attributes.key?(:'enabled')
-        self.enabled = attributes[:'enabled']
+      if attributes.key?(:'is_rescanning_enabled')
+        self.is_rescanning_enabled = attributes[:'is_rescanning_enabled']
       end
 
       if attributes.key?(:'lists_enabled')
@@ -122,8 +122,8 @@ module Plaid
         self.audit_trail = attributes[:'audit_trail']
       end
 
-      if attributes.key?(:'archived')
-        self.archived = attributes[:'archived']
+      if attributes.key?(:'is_archived')
+        self.is_archived = attributes[:'is_archived']
       end
     end
 
@@ -139,8 +139,8 @@ module Plaid
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
-      if @enabled.nil?
-        invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
+      if @is_rescanning_enabled.nil?
+        invalid_properties.push('invalid value for "is_rescanning_enabled", is_rescanning_enabled cannot be nil.')
       end
 
       if @lists_enabled.nil?
@@ -170,8 +170,8 @@ module Plaid
         invalid_properties.push('invalid value for "audit_trail", audit_trail cannot be nil.')
       end
 
-      if @archived.nil?
-        invalid_properties.push('invalid value for "archived", archived cannot be nil.')
+      if @is_archived.nil?
+        invalid_properties.push('invalid value for "is_archived", is_archived cannot be nil.')
       end
 
       invalid_properties
@@ -182,14 +182,14 @@ module Plaid
     def valid?
       return false if @id.nil?
       return false if @created_at.nil?
-      return false if @enabled.nil?
+      return false if @is_rescanning_enabled.nil?
       return false if @lists_enabled.nil?
       return false if @name.nil?
       return false if @name.to_s.length < 1
       return false if @name !~ Regexp.new(/^\S+(\s+\S+)*$/)
       return false if @name_sensitivity.nil?
       return false if @audit_trail.nil?
-      return false if @archived.nil?
+      return false if @is_archived.nil?
       true
     end
 
@@ -231,12 +231,12 @@ module Plaid
       self.class == o.class &&
           id == o.id &&
           created_at == o.created_at &&
-          enabled == o.enabled &&
+          is_rescanning_enabled == o.is_rescanning_enabled &&
           lists_enabled == o.lists_enabled &&
           name == o.name &&
           name_sensitivity == o.name_sensitivity &&
           audit_trail == o.audit_trail &&
-          archived == o.archived
+          is_archived == o.is_archived
     end
 
     # @see the `==` method
@@ -248,7 +248,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_at, enabled, lists_enabled, name, name_sensitivity, audit_trail, archived].hash
+      [id, created_at, is_rescanning_enabled, lists_enabled, name, name_sensitivity, audit_trail, is_archived].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/entity_watchlist_program_response.rb

@@ -0,0 +1,389 @@
+=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 program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.
+  class EntityWatchlistProgramResponse
+    # ID of the associated entity program.
+    attr_accessor :id
+
+    # An ISO8601 formatted timestamp.
+    attr_accessor :created_at
+
+    # Indicator specifying whether the program is enabled and will perform daily rescans.
+    attr_accessor :is_rescanning_enabled
+
+    # Watchlists enabled for the associated program
+    attr_accessor :lists_enabled
+
+    # A name for the entity program to define its purpose. For example, \"High Risk Organizations\" or \"Applicants\".
+    attr_accessor :name
+
+    attr_accessor :name_sensitivity
+
+    attr_accessor :audit_trail
+
+    # Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.
+    attr_accessor :is_archived
+
+    # 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',
+        :'created_at' => :'created_at',
+        :'is_rescanning_enabled' => :'is_rescanning_enabled',
+        :'lists_enabled' => :'lists_enabled',
+        :'name' => :'name',
+        :'name_sensitivity' => :'name_sensitivity',
+        :'audit_trail' => :'audit_trail',
+        :'is_archived' => :'is_archived',
+        :'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',
+        :'created_at' => :'Time',
+        :'is_rescanning_enabled' => :'Boolean',
+        :'lists_enabled' => :'Array<EntityWatchlistCode>',
+        :'name' => :'String',
+        :'name_sensitivity' => :'ProgramNameSensitivity',
+        :'audit_trail' => :'WatchlistScreeningAuditTrail',
+        :'is_archived' => :'Boolean',
+        :'request_id' => :'String'
+      }
+    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 `Plaid::EntityWatchlistProgramResponse` 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::EntityWatchlistProgramResponse`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'is_rescanning_enabled')
+        self.is_rescanning_enabled = attributes[:'is_rescanning_enabled']
+      end
+
+      if attributes.key?(:'lists_enabled')
+        if (value = attributes[:'lists_enabled']).is_a?(Array)
+          self.lists_enabled = value
+        end
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'name_sensitivity')
+        self.name_sensitivity = attributes[:'name_sensitivity']
+      end
+
+      if attributes.key?(:'audit_trail')
+        self.audit_trail = attributes[:'audit_trail']
+      end
+
+      if attributes.key?(:'is_archived')
+        self.is_archived = attributes[:'is_archived']
+      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 @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @is_rescanning_enabled.nil?
+        invalid_properties.push('invalid value for "is_rescanning_enabled", is_rescanning_enabled cannot be nil.')
+      end
+
+      if @lists_enabled.nil?
+        invalid_properties.push('invalid value for "lists_enabled", lists_enabled cannot be nil.')
+      end
+
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^\S+(\s+\S+)*$/)
+      if @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      end
+
+
+      if @name_sensitivity.nil?
+        invalid_properties.push('invalid value for "name_sensitivity", name_sensitivity cannot be nil.')
+      end
+
+      if @audit_trail.nil?
+        invalid_properties.push('invalid value for "audit_trail", audit_trail cannot be nil.')
+      end
+
+      if @is_archived.nil?
+        invalid_properties.push('invalid value for "is_archived", is_archived 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 @created_at.nil?
+      return false if @is_rescanning_enabled.nil?
+      return false if @lists_enabled.nil?
+      return false if @name.nil?
+      return false if @name.to_s.length < 1
+      return false if @name !~ Regexp.new(/^\S+(\s+\S+)*$/)
+      return false if @name_sensitivity.nil?
+      return false if @audit_trail.nil?
+      return false if @is_archived.nil?
+      return false if @request_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] lists_enabled Value to be assigned
+    def lists_enabled=(lists_enabled)
+      if lists_enabled.nil?
+        fail ArgumentError, 'lists_enabled cannot be nil'
+      end
+
+
+      @lists_enabled = lists_enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^\S+(\s+\S+)*$/)
+      if name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+
+      @name = name
+    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 &&
+          created_at == o.created_at &&
+          is_rescanning_enabled == o.is_rescanning_enabled &&
+          lists_enabled == o.lists_enabled &&
+          name == o.name &&
+          name_sensitivity == o.name_sensitivity &&
+          audit_trail == o.audit_trail &&
+          is_archived == o.is_archived &&
+          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, created_at, is_rescanning_enabled, lists_enabled, name, name_sensitivity, audit_trail, is_archived, 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.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_hit.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
@@ -24,11 +24,13 @@ module Plaid
     # An ISO8601 formatted timestamp.
     attr_accessor :first_active
 
+    # An ISO8601 formatted timestamp.
     attr_accessor :inactive_since
 
+    # An ISO8601 formatted timestamp.
     attr_accessor :historical_since
 
-    attr_accessor :entity_list_code
+    attr_accessor :list_code
 
     # A universal identifier for a watchlist individual that is stable across searches and updates.
     attr_accessor :plaid_uid
@@ -48,7 +50,7 @@ module Plaid
         :'first_active' => :'first_active',
         :'inactive_since' => :'inactive_since',
         :'historical_since' => :'historical_since',
-        :'entity_list_code' => :'entity_list_code',
+        :'list_code' => :'list_code',
         :'plaid_uid' => :'plaid_uid',
         :'source_uid' => :'source_uid',
         :'analysis' => :'analysis',
@@ -69,7 +71,7 @@ module Plaid
         :'first_active' => :'Time',
         :'inactive_since' => :'Time',
         :'historical_since' => :'Time',
-        :'entity_list_code' => :'EntityWatchlistCode',
+        :'list_code' => :'EntityWatchlistCode',
         :'plaid_uid' => :'String',
         :'source_uid' => :'String',
         :'analysis' => :'EntityScreeningHitAnalysis',
@@ -121,8 +123,8 @@ module Plaid
         self.historical_since = attributes[:'historical_since']
       end
 
-      if attributes.key?(:'entity_list_code')
-        self.entity_list_code = attributes[:'entity_list_code']
+      if attributes.key?(:'list_code')
+        self.list_code = attributes[:'list_code']
       end
 
       if attributes.key?(:'plaid_uid')
@@ -158,8 +160,8 @@ module Plaid
         invalid_properties.push('invalid value for "first_active", first_active cannot be nil.')
       end
 
-      if @entity_list_code.nil?
-        invalid_properties.push('invalid value for "entity_list_code", entity_list_code cannot be nil.')
+      if @list_code.nil?
+        invalid_properties.push('invalid value for "list_code", list_code cannot be nil.')
       end
 
       if @plaid_uid.nil?
@@ -180,7 +182,7 @@ module Plaid
       return false if @id.nil?
       return false if @review_status.nil?
       return false if @first_active.nil?
-      return false if @entity_list_code.nil?
+      return false if @list_code.nil?
       return false if @plaid_uid.nil?
       return false if @source_uid.to_s.length < 1
       true
@@ -207,7 +209,7 @@ module Plaid
           first_active == o.first_active &&
           inactive_since == o.inactive_since &&
           historical_since == o.historical_since &&
-          entity_list_code == o.entity_list_code &&
+          list_code == o.list_code &&
           plaid_uid == o.plaid_uid &&
           source_uid == o.source_uid &&
           analysis == o.analysis &&
@@ -223,7 +225,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, review_status, first_active, inactive_since, historical_since, entity_list_code, plaid_uid, source_uid, analysis, data].hash
+      [id, review_status, first_active, inactive_since, historical_since, list_code, plaid_uid, source_uid, analysis, data].hash
     end
 
     # Builds the object from hash