plaid 14.6.0 → 14.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f65244f38d5853007a2c819a7452d1b53d2507878717ac02172f6beadffabca
-  data.tar.gz: bab745ac8f7a8b73fc109de88ffc3986245916a00b24509d1927f0f1ab589da1
+  metadata.gz: 5d0fe18c0a6842d4442f8e94f19664d407b5bad58df15767f393c826fea26408
+  data.tar.gz: 559b8bb4e2dd716fe69caa4406c322758b77d200f1225d7ef1308ce482d75a21
 SHA512:
-  metadata.gz: b72eb8038b8a0e27afaed7ab4a29f2198d7be581a615f64de582d65b89513a4bfaef8a5fda28c1ed1ed9e43445f0a17a414e29c7b90a967ff469520b85199f49
-  data.tar.gz: ef9b70b852ede48bc30578d0c65aefee42eb194b61f2c9bb5b071292fcd8f98e84e3264ab4e28ce8a3613f15dcd7eec08077c99d3984dcd9ef89eeb24dbfc5cb
+  metadata.gz: f518ab67c91eac3d60f1b644d8bd5effc7eb428678f8bc9e4322b2a0a42a6129d2d2a127e7518a5eb52bd47358d11ab8878993a07dd883727940a7e900bc2e56
+  data.tar.gz: a899cb5d647b43b53606bd93eb8fde66951fc90881a0bd1e5f64ffd7925e08fd5bc32940e3df8550d3aebc5b8c4192f8dbae9470205388b77ee27d4053ed70f9

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 14.7.0
+- Updating to OAS 2020-09-14_1.44.0
+
 # 14.6.0
 - Updating to OAS 2020-09-14_1.40.3
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (14.6.0)
+    plaid (14.7.0)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM

data/Makefile

@@ -1,2 +1,2 @@
 # Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
-RUBY_PACKAGE_VERSION=14.6.0
+RUBY_PACKAGE_VERSION=14.7.0

data/lib/plaid/api/plaid_api.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -2553,7 +2553,7 @@ module Plaid
     end
 
     # Retrieve information from the tax documents used for income verification
-    # `/income/verification/taxforms/get` returns the information collected from taxforms that were used to verify an end user's. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
+    # `/income/verification/taxforms/get` returns the information collected from taxforms that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
     # @param request_body [Hash<String, Object>] 
     # @param [Hash] opts the optional parameters
     # @return [IncomeVerificationTaxformsGetResponse]
@@ -2563,7 +2563,7 @@ module Plaid
     end
 
     # Retrieve information from the tax documents used for income verification
-    # &#x60;/income/verification/taxforms/get&#x60; returns the information collected from taxforms that were used to verify an end user&#39;s. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; webhook. Attempting to call the endpoint before verification has been completed will result in an error.
+    # &#x60;/income/verification/taxforms/get&#x60; returns the information collected from taxforms that were used to verify an end user&#39;s income. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; webhook. Attempting to call the endpoint before verification has been completed will result in an error.
     # @param request_body [Hash<String, Object>] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(IncomeVerificationTaxformsGetResponse, Integer, Hash)>] IncomeVerificationTaxformsGetResponse data, response status code and response headers
@@ -5670,6 +5670,71 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Get incremental transaction updates on an item
+    # The `/transactions/sync` endpoint returns item transactions as a set of delta updates. Subsequent calls to the endpoint using the cursor returned in the response will return new added, modified, and removed transactions since the last call to the endpoint  The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
+    # @param transactions_sync_request [TransactionsSyncRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [TransactionsSyncResponse]
+    def transactions_sync(transactions_sync_request, opts = {})
+      data, _status_code, _headers = transactions_sync_with_http_info(transactions_sync_request, opts)
+      data
+    end
+
+    # Get incremental transaction updates on an item
+    # The &#x60;/transactions/sync&#x60; endpoint returns item transactions as a set of delta updates. Subsequent calls to the endpoint using the cursor returned in the response will return new added, modified, and removed transactions since the last call to the endpoint  The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
+    # @param transactions_sync_request [TransactionsSyncRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
+    def transactions_sync_with_http_info(transactions_sync_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_sync ...'
+      end
+      # verify the required parameter 'transactions_sync_request' is set
+      if @api_client.config.client_side_validation && transactions_sync_request.nil?
+        fail ArgumentError, "Missing the required parameter 'transactions_sync_request' when calling PlaidApi.transactions_sync"
+      end
+      # resource path
+      local_var_path = '/transactions/sync'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_sync_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TransactionsSyncResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.transactions_sync",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PlaidApi#transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a transfer authorization
     # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk.  In Plaid's sandbox environment the decisions will be returned as follows:    - To approve a transfer, make an authorization request with an `amount` less than the available balance in the account.    - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.    - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.    - To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).    - To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required).  All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.
     # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest] 

data/lib/plaid/api_client.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/api_error.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/configuration.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/account_access.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -19,14 +19,17 @@ module Plaid
     # The unique account identifier for this account. This value must match that returned by the data access API for this account.
     attr_accessor :unique_id
 
-    # Allow the application to see this account (and associated details, including balance) in the list of accounts. If unset, defaults to `true`.
+    # Allow the application to see this account (and associated details, including balance) in the list of accounts. If relevant to the partner and unset, defaults to `true`.
     attr_accessor :authorized
 
+    attr_accessor :account_product_access
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'unique_id' => :'unique_id',
-        :'authorized' => :'authorized'
+        :'authorized' => :'authorized',
+        :'account_product_access' => :'account_product_access'
       }
     end
 
@@ -39,14 +42,16 @@ module Plaid
     def self.openapi_types
       {
         :'unique_id' => :'String',
-        :'authorized' => :'Boolean'
+        :'authorized' => :'Boolean',
+        :'account_product_access' => :'AccountProductAccessNullable'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'authorized'
+        :'authorized',
+        :'account_product_access'
       ])
     end
 
@@ -74,6 +79,10 @@ module Plaid
       else
         self.authorized = true
       end
+
+      if attributes.key?(:'account_product_access')
+        self.account_product_access = attributes[:'account_product_access']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -100,7 +109,8 @@ module Plaid
       return true if self.equal?(o)
       self.class == o.class &&
           unique_id == o.unique_id &&
-          authorized == o.authorized
+          authorized == o.authorized &&
+          account_product_access == o.account_product_access
     end
 
     # @see the `==` method
@@ -112,7 +122,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [unique_id, authorized].hash
+      [unique_id, authorized, account_product_access].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/account_assets.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/account_assets_all_of.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/account_balance.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/account_base.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/account_filter.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/account_filters_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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/account_identity.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/account_identity_all_of.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.40.3
+The version of the OpenAPI document: 2020-09-14_1.44.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/account_product_access.rb

@@ -0,0 +1,249 @@
+=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.44.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Allow the application to access specific products on this account
+  class AccountProductAccess
+    # Allow the application to access account data. Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
+    attr_accessor :account_data
+
+    # Allow the application to access bank statements. Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
+    attr_accessor :statements
+
+    # Allow the application to access tax documents. Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
+    attr_accessor :tax_documents
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_data' => :'account_data',
+        :'statements' => :'statements',
+        :'tax_documents' => :'tax_documents'
+      }
+    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
+      {
+        :'account_data' => :'Boolean',
+        :'statements' => :'Boolean',
+        :'tax_documents' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'account_data',
+        :'statements',
+        :'tax_documents'
+      ])
+    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::AccountProductAccess` 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::AccountProductAccess`. 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?(:'account_data')
+        self.account_data = attributes[:'account_data']
+      else
+        self.account_data = true
+      end
+
+      if attributes.key?(:'statements')
+        self.statements = attributes[:'statements']
+      else
+        self.statements = true
+      end
+
+      if attributes.key?(:'tax_documents')
+        self.tax_documents = attributes[:'tax_documents']
+      else
+        self.tax_documents = true
+      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 &&
+          account_data == o.account_data &&
+          statements == o.statements &&
+          tax_documents == o.tax_documents
+    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
+      [account_data, statements, tax_documents].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