plaid 15.11.0 → 16.0.0

data/lib/plaid/models/fdx_notification_payload.rb

@@ -0,0 +1,238 @@
+=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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Custom key-value pairs payload for a notification
+  class FDXNotificationPayload
+    # ID for the origination entity related to the notification
+    attr_accessor :id
+
+    attr_accessor :id_type
+
+    attr_accessor :custom_fields
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'id_type' => :'idType',
+        :'custom_fields' => :'customFields'
+      }
+    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',
+        :'id_type' => :'FDXNotificationPayloadIdType',
+        :'custom_fields' => :'FDXFiAttribute'
+      }
+    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::FDXNotificationPayload` 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::FDXNotificationPayload`. 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?(:'id_type')
+        self.id_type = attributes[:'id_type']
+      end
+
+      if attributes.key?(:'custom_fields')
+        self.custom_fields = attributes[:'custom_fields']
+      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
+      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?
+      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 &&
+          id_type == o.id_type &&
+          custom_fields == o.custom_fields
+    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, id_type, custom_fields].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/fdx_notification_payload_id_type.rb

@@ -0,0 +1,42 @@
+=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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class FDXNotificationPayloadIdType
+    ACCOUNT = "ACCOUNT".freeze
+    CUSTOMER = "CUSTOMER".freeze
+    PARTY = "PARTY".freeze
+    MAINTENANCE = "MAINTENANCE".freeze
+    CONSENT = "CONSENT".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end

data/lib/plaid/models/fdx_notification_priority.rb

@@ -0,0 +1,40 @@
+=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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class FDXNotificationPriority
+    HIGH = "HIGH".freeze
+    MEDIUM = "MEDIUM".freeze
+    LOW = "LOW".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end

data/lib/plaid/models/fdx_notification_severity.rb

@@ -0,0 +1,42 @@
+=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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class FDXNotificationSeverity
+    EMERGENCY = "EMERGENCY".freeze
+    ALERT = "ALERT".freeze
+    WARNING = "WARNING".freeze
+    NOTICE = "NOTICE".freeze
+    INFO = "INFO".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end

data/lib/plaid/models/fdx_notification_type.rb

@@ -0,0 +1,43 @@
+=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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class FDXNotificationType
+    CONSENT_REVOKED = "CONSENT_REVOKED".freeze
+    CONSENT_UPDATED = "CONSENT_UPDATED".freeze
+    CUSTOM = "CUSTOM".freeze
+    SERVICE = "SERVICE".freeze
+    BALANCE = "BALANCE".freeze
+    PLANNED_OUTAGE = "PLANNED_OUTAGE".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end

data/lib/plaid/models/{verification_attribute.rb → fdx_party.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -14,37 +14,37 @@ require 'date'
 require 'time'
 
 module Plaid
-  # Details about a certain reason as to why a document could potentially be fraudulent
-  class VerificationAttribute
-    # Message indicating the reason as to why the verification failed
+  # FDX Participant - an entity or person that is a part of a FDX API transaction
+  class FDXParty
+    # Human recognizable common name
+    attr_accessor :name
+
     attr_accessor :type
 
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
+    # URI for party, where an end user could learn more about the company or application involved in the data sharing chain
+    attr_accessor :home_uri
 
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
+    # URI for a logo asset to be displayed to the end user
+    attr_accessor :logo_uri
+
+    attr_accessor :registry
+
+    # Registered name of party
+    attr_accessor :registered_entity_name
+
+    # Registered id of party
+    attr_accessor :registered_entity_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'type' => :'type'
+        :'name' => :'name',
+        :'type' => :'type',
+        :'home_uri' => :'homeUri',
+        :'logo_uri' => :'logoUri',
+        :'registry' => :'registry',
+        :'registered_entity_name' => :'registeredEntityName',
+        :'registered_entity_id' => :'registeredEntityId'
       }
     end
 
@@ -56,14 +56,19 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'String'
+        :'name' => :'String',
+        :'type' => :'FDXPartyType',
+        :'home_uri' => :'String',
+        :'logo_uri' => :'String',
+        :'registry' => :'FDXPartyRegistry',
+        :'registered_entity_name' => :'String',
+        :'registered_entity_id' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'type'
       ])
     end
 
@@ -71,53 +76,81 @@ module Plaid
     # @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::VerificationAttribute` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::FDXParty` 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::VerificationAttribute`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::FDXParty`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
+
+      if attributes.key?(:'home_uri')
+        self.home_uri = attributes[:'home_uri']
+      end
+
+      if attributes.key?(:'logo_uri')
+        self.logo_uri = attributes[:'logo_uri']
+      end
+
+      if attributes.key?(:'registry')
+        self.registry = attributes[:'registry']
+      end
+
+      if attributes.key?(:'registered_entity_name')
+        self.registered_entity_name = attributes[:'registered_entity_name']
+      end
+
+      if attributes.key?(:'registered_entity_id')
+        self.registered_entity_id = attributes[:'registered_entity_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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type 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?
-      type_validator = EnumAttributeValidator.new('String', ["VERIFICATION_ATTRIBUTE_TYPE_UNKNOWN", "VERIFICATION_ATTRIBUTE_TYPE_AMOUNT_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_DATE_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_DATE_MISMATCH", "VERIFICATION_ATTRIBUTE_TYPE_FILE_TAMPERING", "VERIFICATION_ATTRIBUTE_TYPE_DESCRIPTION_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_DESCRIPTION_MISMATCH", "VERIFICATION_ATTRIBUTE_TYPE_FIRST_NAME_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_FIRST_NAME_MISMATCH", "VERIFICATION_ATTRIBUTE_TYPE_LAST_NAME_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_LAST_NAME_MISMATCH", "null"])
-      return false unless type_validator.valid?(@type)
+      return false if @name.nil?
+      return false if @type.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ["VERIFICATION_ATTRIBUTE_TYPE_UNKNOWN", "VERIFICATION_ATTRIBUTE_TYPE_AMOUNT_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_DATE_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_DATE_MISMATCH", "VERIFICATION_ATTRIBUTE_TYPE_FILE_TAMPERING", "VERIFICATION_ATTRIBUTE_TYPE_DESCRIPTION_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_DESCRIPTION_MISMATCH", "VERIFICATION_ATTRIBUTE_TYPE_FIRST_NAME_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_FIRST_NAME_MISMATCH", "VERIFICATION_ATTRIBUTE_TYPE_LAST_NAME_MATCH", "VERIFICATION_ATTRIBUTE_TYPE_LAST_NAME_MISMATCH", "null"])
-      unless validator.valid?(type)
-        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
-      end
-      @type = type
-    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 &&
-          type == o.type
+          name == o.name &&
+          type == o.type &&
+          home_uri == o.home_uri &&
+          logo_uri == o.logo_uri &&
+          registry == o.registry &&
+          registered_entity_name == o.registered_entity_name &&
+          registered_entity_id == o.registered_entity_id
     end
 
     # @see the `==` method
@@ -129,7 +162,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type].hash
+      [name, type, home_uri, logo_uri, registry, registered_entity_name, registered_entity_id].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/fdx_party_registry.rb

@@ -0,0 +1,41 @@
+=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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class FDXPartyRegistry
+    FDX = "FDX".freeze
+    GLEIF = "GLEIF".freeze
+    ICANN = "ICANN".freeze
+    PRIVATE = "PRIVATE".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end

data/lib/plaid/models/fdx_party_type.rb

@@ -0,0 +1,43 @@
+=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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class FDXPartyType
+    DATA_ACCESS_PLATFORM = "DATA_ACCESS_PLATFORM".freeze
+    DATA_PROVIDER = "DATA_PROVIDER".freeze
+    DATA_RECIPIENT = "DATA_RECIPIENT".freeze
+    INDIVIDUAL = "INDIVIDUAL".freeze
+    MERCHANT = "MERCHANT".freeze
+    VENDOR = "VENDOR".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end