plaid 14.14.0 → 15.0.0

data/lib/plaid/models/asset_report_relay_get_request.rb

@@ -0,0 +1,245 @@
+=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.79.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # AssetReportRelayGetRequest defines the request schema for `/asset_report/relay/get`
+  class AssetReportRelayGetRequest
+    # 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.
+    attr_accessor :client_id
+
+    # 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.
+    attr_accessor :secret
+
+    # The `asset_relay_token` granting access to the Asset Report you would like to get.
+    attr_accessor :asset_relay_token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'client_id' => :'client_id',
+        :'secret' => :'secret',
+        :'asset_relay_token' => :'asset_relay_token'
+      }
+    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
+      {
+        :'client_id' => :'String',
+        :'secret' => :'String',
+        :'asset_relay_token' => :'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::AssetReportRelayGetRequest` 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::AssetReportRelayGetRequest`. 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?(:'asset_relay_token')
+        self.asset_relay_token = attributes[:'asset_relay_token']
+      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 @asset_relay_token.nil?
+        invalid_properties.push('invalid value for "asset_relay_token", asset_relay_token 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 @asset_relay_token.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 &&
+          client_id == o.client_id &&
+          secret == o.secret &&
+          asset_relay_token == o.asset_relay_token
+    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
+      [client_id, secret, asset_relay_token].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/{income_verification_paystub_get_request.rb → asset_report_relay_refresh_request.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.78.2
+The version of the OpenAPI document: 2020-09-14_1.79.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -14,27 +14,26 @@ require 'date'
 require 'time'
 
 module Plaid
-  # IncomeVerificationPaystubGetRequest defines the request schema for `/income/verification/paystub/get`.
-  class IncomeVerificationPaystubGetRequest
+  # AssetReportRelayRefreshRequest defines the request schema for `/asset_report/relay/refresh`
+  class AssetReportRelayRefreshRequest
     # 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.
     attr_accessor :client_id
 
     # 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.
     attr_accessor :secret
 
-    # The ID of the verification for which to get paystub information.
-    attr_accessor :income_verification_id
+    attr_accessor :asset_relay_token
 
-    # The access token associated with the Item data is being requested for.
-    attr_accessor :access_token
+    # The URL registered to receive webhooks when the Asset Report of a Relay Token has been refreshed.
+    attr_accessor :webhook
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'client_id' => :'client_id',
         :'secret' => :'secret',
-        :'income_verification_id' => :'income_verification_id',
-        :'access_token' => :'access_token'
+        :'asset_relay_token' => :'asset_relay_token',
+        :'webhook' => :'webhook'
       }
     end
 
@@ -48,16 +47,15 @@ module Plaid
       {
         :'client_id' => :'String',
         :'secret' => :'String',
-        :'income_verification_id' => :'String',
-        :'access_token' => :'String'
+        :'asset_relay_token' => :'String',
+        :'webhook' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'income_verification_id',
-        :'access_token'
+        :'webhook'
       ])
     end
 
@@ -65,13 +63,13 @@ 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::IncomeVerificationPaystubGetRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::AssetReportRelayRefreshRequest` 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::IncomeVerificationPaystubGetRequest`. 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::AssetReportRelayRefreshRequest`. 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
       }
@@ -84,12 +82,12 @@ module Plaid
         self.secret = attributes[:'secret']
       end
 
-      if attributes.key?(:'income_verification_id')
-        self.income_verification_id = attributes[:'income_verification_id']
+      if attributes.key?(:'asset_relay_token')
+        self.asset_relay_token = attributes[:'asset_relay_token']
       end
 
-      if attributes.key?(:'access_token')
-        self.access_token = attributes[:'access_token']
+      if attributes.key?(:'webhook')
+        self.webhook = attributes[:'webhook']
       end
     end
 
@@ -97,12 +95,17 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @asset_relay_token.nil?
+        invalid_properties.push('invalid value for "asset_relay_token", asset_relay_token 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 @asset_relay_token.nil?
       true
     end
 
@@ -113,8 +116,8 @@ module Plaid
       self.class == o.class &&
           client_id == o.client_id &&
           secret == o.secret &&
-          income_verification_id == o.income_verification_id &&
-          access_token == o.access_token
+          asset_relay_token == o.asset_relay_token &&
+          webhook == o.webhook
     end
 
     # @see the `==` method
@@ -126,7 +129,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, income_verification_id, access_token].hash
+      [client_id, secret, asset_relay_token, webhook].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/{income_verification_paystub_get_response.rb → asset_report_relay_refresh_response.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.78.2
+The version of the OpenAPI document: 2020-09-14_1.79.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -14,11 +14,9 @@ require 'date'
 require 'time'
 
 module Plaid
-  # IncomeVerificationPaystubGetResponse defines the response schema for `/income/verification/paystub/get`.
-  class IncomeVerificationPaystubGetResponse
-    attr_accessor :paystub
-
-    attr_accessor :error
+  # AssetReportRelayRefreshResponse defines the response schema for `/asset_report/relay/refresh`
+  class AssetReportRelayRefreshResponse
+    attr_accessor :asset_relay_token
 
     # 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
@@ -26,8 +24,7 @@ module Plaid
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'paystub' => :'paystub',
-        :'error' => :'error',
+        :'asset_relay_token' => :'asset_relay_token',
         :'request_id' => :'request_id'
       }
     end
@@ -40,8 +37,7 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'paystub' => :'Paystub',
-        :'error' => :'PlaidError',
+        :'asset_relay_token' => :'String',
         :'request_id' => :'String'
       }
     end
@@ -56,23 +52,19 @@ 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::IncomeVerificationPaystubGetResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::AssetReportRelayRefreshResponse` 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::IncomeVerificationPaystubGetResponse`. 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::AssetReportRelayRefreshResponse`. 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?(:'paystub')
-        self.paystub = attributes[:'paystub']
-      end
-
-      if attributes.key?(:'error')
-        self.error = attributes[:'error']
+      if attributes.key?(:'asset_relay_token')
+        self.asset_relay_token = attributes[:'asset_relay_token']
       end
 
       if attributes.key?(:'request_id')
@@ -84,8 +76,8 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @paystub.nil?
-        invalid_properties.push('invalid value for "paystub", paystub cannot be nil.')
+      if @asset_relay_token.nil?
+        invalid_properties.push('invalid value for "asset_relay_token", asset_relay_token cannot be nil.')
       end
 
       if @request_id.nil?
@@ -98,7 +90,7 @@ module Plaid
     # 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 @paystub.nil?
+      return false if @asset_relay_token.nil?
       return false if @request_id.nil?
       true
     end
@@ -108,8 +100,7 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          paystub == o.paystub &&
-          error == o.error &&
+          asset_relay_token == o.asset_relay_token &&
           request_id == o.request_id
     end
 
@@ -122,7 +113,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [paystub, error, request_id].hash
+      [asset_relay_token, request_id].hash
     end
 
     # Builds the object from hash