plaid 14.1.0 → 14.5.0

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

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

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

data/lib/plaid/version.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.26.1
+The version of the OpenAPI document: 2020-09-14_1.37.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.1.0
 =end
 
 module Plaid
-  VERSION = '14.1.0'
+  VERSION = '14.5.0'
 end

data/lib/plaid.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.26.1
+The version of the OpenAPI document: 2020-09-14_1.37.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -72,6 +72,8 @@ require 'plaid/models/auth_get_numbers'
 require 'plaid/models/auth_get_request'
 require 'plaid/models/auth_get_request_options'
 require 'plaid/models/auth_get_response'
+require 'plaid/models/auth_metadata'
+require 'plaid/models/auth_supported_methods'
 require 'plaid/models/automatically_verified_webhook'
 require 'plaid/models/bank_initiated_return_risk'
 require 'plaid/models/bank_transfer'
@@ -103,6 +105,8 @@ require 'plaid/models/bank_transfer_sweep'
 require 'plaid/models/bank_transfer_sweep_account'
 require 'plaid/models/bank_transfer_sweep_get_request'
 require 'plaid/models/bank_transfer_sweep_get_response'
+require 'plaid/models/bank_transfer_sweep_list_request'
+require 'plaid/models/bank_transfer_sweep_list_response'
 require 'plaid/models/bank_transfer_type'
 require 'plaid/models/bank_transfer_user'
 require 'plaid/models/bank_transfers_events_update_webhook'
@@ -139,9 +143,13 @@ require 'plaid/models/employee'
 require 'plaid/models/employee_income_summary_field_string'
 require 'plaid/models/employer'
 require 'plaid/models/employer_income_summary_field_string'
+require 'plaid/models/employer_verification'
 require 'plaid/models/employers_search_request'
 require 'plaid/models/employers_search_response'
 require 'plaid/models/employment_details'
+require 'plaid/models/employment_verification'
+require 'plaid/models/employment_verification_get_request'
+require 'plaid/models/employment_verification_get_response'
 require 'plaid/models/error'
 require 'plaid/models/external_payment_options'
 require 'plaid/models/external_payment_refund_details'
@@ -159,16 +167,23 @@ require 'plaid/models/identity_get_request_options'
 require 'plaid/models/identity_get_response'
 require 'plaid/models/incident_update'
 require 'plaid/models/income_breakdown'
+require 'plaid/models/income_override'
 require 'plaid/models/income_summary'
 require 'plaid/models/income_summary_field_number'
 require 'plaid/models/income_summary_field_string'
 require 'plaid/models/income_verification_create_request'
 require 'plaid/models/income_verification_create_response'
 require 'plaid/models/income_verification_documents_download_request'
-require 'plaid/models/income_verification_documents_download_response'
 require 'plaid/models/income_verification_paystub_get_request'
+require 'plaid/models/income_verification_paystub_get_response'
 require 'plaid/models/income_verification_paystubs_get_request'
 require 'plaid/models/income_verification_paystubs_get_response'
+require 'plaid/models/income_verification_precheck_employer'
+require 'plaid/models/income_verification_precheck_employer_address'
+require 'plaid/models/income_verification_precheck_military_info'
+require 'plaid/models/income_verification_precheck_request'
+require 'plaid/models/income_verification_precheck_response'
+require 'plaid/models/income_verification_precheck_user'
 require 'plaid/models/income_verification_refresh_request'
 require 'plaid/models/income_verification_refresh_response'
 require 'plaid/models/income_verification_status_webhook'
@@ -246,6 +261,7 @@ require 'plaid/models/link_token_create_request_auth'
 require 'plaid/models/link_token_create_request_deposit_switch'
 require 'plaid/models/link_token_create_request_income_verification'
 require 'plaid/models/link_token_create_request_payment_initiation'
+require 'plaid/models/link_token_create_request_update'
 require 'plaid/models/link_token_create_request_user'
 require 'plaid/models/link_token_create_response'
 require 'plaid/models/link_token_eu_config'
@@ -260,6 +276,7 @@ require 'plaid/models/mortgage_interest_rate'
 require 'plaid/models/mortgage_liability'
 require 'plaid/models/mortgage_property_address'
 require 'plaid/models/net_pay'
+require 'plaid/models/new_accounts_available_webhook'
 require 'plaid/models/numbers'
 require 'plaid/models/numbers_ach'
 require 'plaid/models/numbers_ach_nullable'
@@ -288,6 +305,8 @@ require 'plaid/models/payment_initiation_payment_get_request'
 require 'plaid/models/payment_initiation_payment_get_response'
 require 'plaid/models/payment_initiation_payment_list_request'
 require 'plaid/models/payment_initiation_payment_list_response'
+require 'plaid/models/payment_initiation_payment_reverse_request'
+require 'plaid/models/payment_initiation_payment_reverse_response'
 require 'plaid/models/payment_initiation_payment_token_create_request'
 require 'plaid/models/payment_initiation_payment_token_create_response'
 require 'plaid/models/payment_initiation_recipient'
@@ -298,6 +317,7 @@ require 'plaid/models/payment_initiation_recipient_get_response'
 require 'plaid/models/payment_initiation_recipient_get_response_all_of'
 require 'plaid/models/payment_initiation_recipient_list_request'
 require 'plaid/models/payment_initiation_recipient_list_response'
+require 'plaid/models/payment_initiation_refund'
 require 'plaid/models/payment_initiation_standing_order_metadata'
 require 'plaid/models/payment_meta'
 require 'plaid/models/payment_schedule_interval'
@@ -307,9 +327,15 @@ require 'plaid/models/paystub_address'
 require 'plaid/models/paystub_deduction'
 require 'plaid/models/paystub_details'
 require 'plaid/models/paystub_employer'
+require 'plaid/models/paystub_override'
+require 'plaid/models/paystub_override_employee'
+require 'plaid/models/paystub_override_employee_address'
+require 'plaid/models/paystub_override_employer'
 require 'plaid/models/paystub_ytd_details'
 require 'plaid/models/pending_expiration_webhook'
+require 'plaid/models/personal_finance_category'
 require 'plaid/models/phone_number'
+require 'plaid/models/platform_ids'
 require 'plaid/models/processor_apex_processor_token_create_request'
 require 'plaid/models/processor_auth_get_request'
 require 'plaid/models/processor_auth_get_response'
@@ -333,6 +359,7 @@ require 'plaid/models/projected_income_summary_field_number'
 require 'plaid/models/recaptcha_required_error'
 require 'plaid/models/recipient_bacs'
 require 'plaid/models/recipient_bacs_nullable'
+require 'plaid/models/recurring_transaction_frequency'
 require 'plaid/models/requested_scopes'
 require 'plaid/models/sandbox_bank_transfer_fire_webhook_request'
 require 'plaid/models/sandbox_bank_transfer_fire_webhook_response'
@@ -391,9 +418,13 @@ require 'plaid/models/transaction_base'
 require 'plaid/models/transaction_code'
 require 'plaid/models/transaction_data'
 require 'plaid/models/transaction_override'
+require 'plaid/models/transaction_stream'
+require 'plaid/models/transaction_stream_amount'
 require 'plaid/models/transactions_get_request'
 require 'plaid/models/transactions_get_request_options'
 require 'plaid/models/transactions_get_response'
+require 'plaid/models/transactions_recurring_get_request'
+require 'plaid/models/transactions_recurring_get_response'
 require 'plaid/models/transactions_refresh_request'
 require 'plaid/models/transactions_refresh_response'
 require 'plaid/models/transactions_removed_webhook'
@@ -408,7 +439,6 @@ require 'plaid/models/transfer_cancel_request'
 require 'plaid/models/transfer_cancel_response'
 require 'plaid/models/transfer_create_request'
 require 'plaid/models/transfer_create_response'
-require 'plaid/models/transfer_direction'
 require 'plaid/models/transfer_event'
 require 'plaid/models/transfer_event_list_request'
 require 'plaid/models/transfer_event_list_response'
@@ -421,7 +451,6 @@ require 'plaid/models/transfer_get_response'
 require 'plaid/models/transfer_list_request'
 require 'plaid/models/transfer_list_response'
 require 'plaid/models/transfer_network'
-require 'plaid/models/transfer_receiver_details'
 require 'plaid/models/transfer_status'
 require 'plaid/models/transfer_type'
 require 'plaid/models/transfer_user_address_in_request'

data/plaid.gemspec

@@ -5,7 +5,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.26.1
+The version of the OpenAPI document: 2020-09-14_1.37.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/templates/ruby/api_client.mustache

@@ -28,11 +28,10 @@ module {{moduleName}}
     def initialize(config = Configuration.default)
       @config = config
       {{! Modified by plaid - adding default headers }}
-      @user_agent = "{{#httpUserAgent}}{{{.}}}{{/httpUserAgent}}{{^httpUserAgent}}Plaid Ruby v#{VERSION}{{/httpUserAgent}}"
+      @user_agent = "{{#httpUserAgent}}{{{.}}}{{/httpUserAgent}}{{^httpUserAgent}}Plaid Ruby v#{{VERSION}}{{/httpUserAgent}}"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent,
-        'Plaid-Version' => '{{{plaidApiVersion}}}',
       }
     end
 

data/templates/ruby/api_client_faraday_partial.mustache

@@ -28,7 +28,8 @@
           else
             fail ApiError.new(:code => response.status,
                               :response_headers => response.headers,
-                              :response_body => response.body),
+                              :response_body => response.body,
+                              :data => JSON.parse(response.body)),
                  response.reason_phrase
           end
         end

data/templates/ruby/api_error.mustache

@@ -0,0 +1,49 @@
+=begin
+{{> api_info}}
+=end
+
+module {{moduleName}}
+  class ApiError < StandardError
+    attr_reader :code, :response_headers, :response_body, :data
+
+    # Usage examples:
+    #   ApiError.new
+    #   ApiError.new("message")
+    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+    #   ApiError.new(:code => 404, :message => "Not Found")
+    def initialize(arg = nil)
+      if arg.is_a? Hash
+        if arg.key?(:message) || arg.key?('message')
+          super(arg[:message] || arg['message'])
+        else
+          super arg
+        end
+
+        arg.each do |k, v|
+          instance_variable_set "@#{k}", v
+        end
+      else
+        super arg
+      end
+    end
+
+    # Override to_s to display a friendly error message
+    def to_s
+      message
+    end
+
+    def message
+      if @message.nil?
+        msg = "Error message: the server returns an error"
+      else
+        msg = @message
+      end
+
+      msg += "\nHTTP status code: #{code}" if code
+      msg += "\nResponse headers: #{response_headers}" if response_headers
+      msg += "\nResponse body: #{response_body}" if response_body
+
+      msg
+    end
+  end
+end

data/templates/ruby/configuration.mustache

@@ -81,7 +81,6 @@ module {{moduleName}}
     attr_accessor :temp_folder_path
 
     # The time limit for HTTP request in seconds.
-    # Default to 0 (never times out).
     attr_accessor :timeout
 
     # Set this to false to skip client side validation in the operation.
@@ -114,9 +113,12 @@ module {{moduleName}}
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
-      @api_key = {}
+      @api_key = {
+        'Plaid-Version' => '{{{plaidApiVersion}}}',
+      }
       @api_key_prefix = {}
-      @timeout = 0
+      {{! Modified by Plaid - Changed from default timeout of 0 to default of 60 }}
+      @timeout = 60
       @client_side_validation = true
       {{#isFaraday}}
       @ssl_verify = true

data/templates/ruby/partial_model_enum_class.mustache

@@ -0,0 +1,22 @@
+  class {{classname}}{{#allowableValues}}{{#enumVars}}
+    {{{name}}} = {{{value}}}.freeze{{/enumVars}}
+
+{{/allowableValues}}
+    # 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)
+      {{! Modified by Plaid - allow for extensible enum values }}
+      # 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

data/test/test_accounts.rb

@@ -31,8 +31,7 @@ class PlaidAccountsTest < PlaidTest
     begin
       client.accounts_get(accounts_get_request)
     rescue Plaid::ApiError => e
-      json_response = JSON.parse(e.response_body)
-      assert_equal(json_response["error_code"], "INVALID_ACCESS_TOKEN")
+      assert_equal(e.data["error_code"], "INVALID_ACCESS_TOKEN")
     end
   end
 
@@ -47,8 +46,7 @@ class PlaidAccountsTest < PlaidTest
     begin
       client.accounts_get(accounts_get_request)
     rescue Plaid::ApiError => e
-      json_response = JSON.parse(e.response_body)
-      assert_equal(json_response["error_code"], "INVALID_FIELD")
+      assert_equal(e.data["error_code"], "INVALID_FIELD")
     end
   end
 
@@ -80,8 +78,7 @@ class PlaidAccountsTest < PlaidTest
     begin
       client.accounts_balance_get(accounts_balance_get_request)
     rescue Plaid::ApiError => e
-      json_response = JSON.parse(e.response_body)
-      assert_equal(json_response["error_code"], "INVALID_ACCESS_TOKEN")
+      assert_equal(e.data["error_code"], "INVALID_ACCESS_TOKEN")
     end
   end
 
@@ -96,8 +93,7 @@ class PlaidAccountsTest < PlaidTest
     begin
       client.accounts_balance_get(accounts_balance_get_request)
     rescue Plaid::ApiError => e
-      json_response = JSON.parse(e.response_body)
-      assert_equal(json_response["error_code"], "INVALID_FIELD")
+      assert_equal(e.data["error_code"], "INVALID_FIELD")
     end
   end
 end

data/test/test_item.rb

@@ -73,7 +73,6 @@ class PlaidItemTest < PlaidTest # rubocop:disable Metrics/ClassLength
 
     item = client.item_get(item_get_request)
     refute_empty(item.item.to_hash)
-    refute_empty(item.status.to_hash)
     assert_kind_of(Plaid::ItemGetResponse, item)
   end