plaid 15.11.0 → 18.0.0

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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -25,9 +25,10 @@ Gem::Specification.new do |s|
   s.summary     = "The Plaid API Ruby Gem"
   s.description = "Ruby gem wrapper for the Plaid API. Read more at the homepage, the wiki, or in the Plaid documentation."
   s.license     = "MIT"
-  s.required_ruby_version = ">= 2.4.0"
+  s.required_ruby_version = ">= 3.0.0"
 
-  s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart', '>= 1.0.1', '< 2.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
   s.add_development_dependency 'bundler', '~> 2.2.9'
@@ -41,4 +42,4 @@ Gem::Specification.new do |s|
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
-end
+end

data/templates/ruby/api_client.mustache

@@ -11,6 +11,7 @@ require 'typhoeus'
 {{/isFaraday}}
 {{#isFaraday}}
 require 'faraday'
+require 'faraday/multipart'
 {{/isFaraday}}
 
 module {{moduleName}}

data/templates/ruby/api_client_faraday_partial.mustache

@@ -23,10 +23,17 @@
             fail ApiError.new(:code => 0,
                               :message => response.return_message)
           else
+            raw_body = response.body
+            # Gracefully handle malformed body which is possible during API outage/maintanance
+            parsed_body = begin
+               JSON.parse(raw_body)
+             rescue JSON::ParserError
+               nil
+             end
             fail ApiError.new(:code => response.status,
                               :response_headers => response.headers,
-                              :response_body => response.body,
-                              :data => JSON.parse(response.body)),
+                              :response_body => raw_body,
+                              :data => parsed_body),
                  response.reason_phrase
           end
         end
@@ -101,7 +108,7 @@
           case value
           when ::File, ::Tempfile
             # TODO hardcode to application/octet-stream, need better way to detect content type
-            data[key] = Faraday::UploadIO.new(value.path, 'application/octet-stream', value.path)
+            data[key] = Faraday::Multipart::Post::UploadIO.new(value.path, 'application/octet-stream', value.path)
           when ::Array, nil
             # let Faraday handle Array and nil parameters
             data[key] = value
@@ -115,4 +122,4 @@
         data = nil
       end
       data
-    end
+    end

data/templates/ruby/gemspec.mustache

@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = "{{{gemRequiredRubyVersion}}}{{^gemRequiredRubyVersion}}>= 2.4{{/gemRequiredRubyVersion}}"
 
   {{#isFaraday}}
-  s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart', '>= 1.0.1', '< 2.0'
   {{/isFaraday}}
   {{^isFaraday}}
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
@@ -38,4 +39,4 @@ Gem::Specification.new do |s|
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
-end
+end

data/test/test_accounts.rb

@@ -71,6 +71,28 @@ class PlaidAccountsTest < PlaidTest
     assert_equal 1, response_w_id.accounts.size
   end
 
+  def test_balance_get_persistent_account_id
+    balance_get_request = Plaid::AccountsBalanceGetRequest.new
+    balance_get_request.access_token = access_token
+
+    response = client.accounts_balance_get(balance_get_request)
+    refute_empty(response.accounts)
+    assert_kind_of(Plaid::AccountsGetResponse, response)
+
+    account_id = response.accounts[0].account_id
+
+    options_payload = {}
+    options_payload[:account_ids] = [account_id]
+
+    accounts_balance_get_request = Plaid::AccountsBalanceGetRequest.new
+    accounts_balance_get_request.access_token = access_token
+    accounts_balance_get_request.options = options_payload
+
+    response_w_id = client.accounts_balance_get(accounts_balance_get_request)
+    assert_equal 1, response_w_id.accounts.size
+    assert_equal "8cfb8beb89b774ee43b090625f0d61d0814322b43bff984eaf60386e", response_w_id.accounts[0].persistent_account_id
+  end
+
   def test_balance_get_invalid_access_token
     accounts_balance_get_request = Plaid::AccountsBalanceGetRequest.new
     accounts_balance_get_request.access_token = BAD_STRING
@@ -96,4 +118,4 @@ class PlaidAccountsTest < PlaidTest
       assert_equal(e.data["error_code"], "INVALID_FIELD")
     end
   end
-end
+end

data/test/test_api_client.rb

@@ -1,4 +1,6 @@
 require 'faraday'
+require 'faraday/multipart'
+
 
 require_relative "test_helper"
 

data/test/test_enrich.rb

@@ -0,0 +1,60 @@
+require_relative 'test_helper'
+
+# Internal: The test for Plaid::Enrich.
+class PlaidEnrichTest < PlaidTest
+  def test_get
+    sample_transactions_to_enrich = [
+      Plaid::ClientProvidedTransaction.new({
+        id: "1",
+        description: "TST *JETTIES BAGELS",
+        amount: 10.00,
+        direction: Plaid::EnrichTransactionDirection::OUTFLOW,
+        location: Plaid::ClientProvidedTransactionLocation.new({
+          city: "Ipswich",
+          region: "MA",
+        }),
+        iso_currency_code: "USD",
+      }),
+      Plaid::ClientProvidedTransaction.new({
+        id: "2",
+        description: "AMAZON.COM*MJ3LO9AN2",
+        amount: 10.00,
+        direction: Plaid::EnrichTransactionDirection::OUTFLOW,
+        iso_currency_code: "USD",
+      }),
+      Plaid::ClientProvidedTransaction.new({
+        id: "3",
+        description: "GOOGLE *FRESHBOOKS",
+        amount: 10.00,
+        direction: Plaid::EnrichTransactionDirection::OUTFLOW,
+        iso_currency_code: "USD",
+      }),
+      Plaid::ClientProvidedTransaction.new({
+        id: "4",
+        description: "EARNIN TRANSFER",
+        amount: 100.00,
+        direction: Plaid::EnrichTransactionDirection::INFLOW,
+        iso_currency_code: "USD",
+      })
+    ]
+
+    transactions_enrich_get_request = Plaid::TransactionsEnrichGetRequest.new
+
+    transactions_enrich_get_request.account_type = "depository"
+    transactions_enrich_get_request.transactions = sample_transactions_to_enrich
+
+    response = client.transactions_enrich(transactions_enrich_get_request)
+    assert_kind_of(Plaid::TransactionsEnrichGetResponse, response)
+
+    refute_empty(response.enriched_transactions)
+    assert_equal(sample_transactions_to_enrich.length, response.enriched_transactions.length)
+
+    response.enriched_transactions.each do |item|
+      assert_kind_of(Float, item.amount)
+      refute_nil(item.description)
+      refute_nil(item.direction)
+      refute_nil(item.enrichments)
+      refute_nil(item.id)
+    end
+  end
+end

data/test/test_identity_verification.rb

@@ -0,0 +1,51 @@
+require_relative 'test_helper'
+
+# Internal: The test for Plaid::IdentityVerification.
+
+TEMPLATE_ID = "flwtmp_aWogUuKsL6NEHU"
+CLIENT_USER_ID = "idv-user-" + Time.now.to_i.to_s
+class PlaidIdentityVerificationTest < PlaidTest
+  def test_all_routes
+    user = Plaid::IdentityVerificationRequestUser.new({
+        :client_user_id => CLIENT_USER_ID,
+        :email_address => CLIENT_USER_ID + "@example.com",
+    })
+    identity_verification_create_request = Plaid::IdentityVerificationCreateRequest.new({
+        :is_shareable => true,
+        :template_id => TEMPLATE_ID,
+        :gave_consent => true,
+        :user => user,
+    })
+    response = client.identity_verification_create(identity_verification_create_request)
+    assert_kind_of(Plaid::IdentityVerificationCreateResponse, response)
+    refute_nil(response.shareable_url)
+    assert_equal("active", response.status)
+
+    identity_verification_retry_request = Plaid::IdentityVerificationRetryRequest.new({
+        :template_id => TEMPLATE_ID,
+        :client_user_id => CLIENT_USER_ID,
+        :strategy => Plaid::Strategy::RESET,
+    })
+    response = client.identity_verification_retry(identity_verification_retry_request)
+    assert_kind_of(Plaid::IdentityVerificationRetryResponse, response)
+    refute_nil(response.shareable_url)
+    assert_equal("active", response.status)
+    
+    identity_verification_list_request = Plaid::IdentityVerificationListRequest.new({
+        :template_id => TEMPLATE_ID,
+        :client_user_id => CLIENT_USER_ID,
+    })
+    response = client.identity_verification_list(identity_verification_list_request)
+    assert_kind_of(Plaid::IdentityVerificationListResponse, response)
+    refute_nil(response.identity_verifications[0])
+    assert_equal(CLIENT_USER_ID, response.identity_verifications[0].client_user_id)
+
+    identity_verification_id = response.identity_verifications[0].id
+    identity_verification_get_request = Plaid::IdentityVerificationGetRequest.new({
+        :identity_verification_id => identity_verification_id,
+    })
+    response = client.identity_verification_get(identity_verification_get_request)
+    assert_kind_of(Plaid::IdentityVerificationGetResponse, response)
+    assert_equal(identity_verification_id, response.id)
+  end
+end

data/test/test_institutions.rb

@@ -5,7 +5,7 @@ class PlaidInstitutionsTest < PlaidTest
   def test_get
     institutions_get_request = Plaid::InstitutionsGetRequest.new({
       :count => 3,
-      :offset => 1,
+      :offset => 4,
       :country_codes => ["US"],
     })
 
@@ -16,7 +16,7 @@ class PlaidInstitutionsTest < PlaidTest
   def test_get_with_options
     institutions_get_request = Plaid::InstitutionsGetRequest.new({
       :count => 3,
-      :offset => 1,
+      :offset => 4,
       :country_codes => ["US"],
       :options => {
         products: ["transactions"],

data/test/test_monitor.rb

@@ -0,0 +1,55 @@
+require "date"
+
+require_relative 'test_helper'
+
+# Internal: The test for Plaid::WatchlistScreening.
+
+WATCHLIST_PROGRAM_ID = "prg_egdF5fGjY8fWqk"
+LEGAL_NAME = "Domingo Huang"
+CLIENT_USER_ID = "monitor-user-" + Time.now.to_i.to_s
+DOCUMENT_NUMBER = "123456789"
+class PlaidMonitorTest < PlaidTest
+  def test_screening_individual
+    date_of_birth = Time.now.to_date
+    search_terms = Plaid::WatchlistScreeningRequestSearchTerms.new({
+        :watchlist_program_id => WATCHLIST_PROGRAM_ID,
+        :legal_name => LEGAL_NAME,
+        :country => Plaid::CountryCode::US,
+        :date_of_birth => date_of_birth,
+        :document_number => DOCUMENT_NUMBER,
+    })
+    monitor_create_request = Plaid::WatchlistScreeningIndividualCreateRequest.new({
+        :client_user_id => CLIENT_USER_ID,
+        :search_terms => search_terms,
+    })
+    response = client.watchlist_screening_individual_create(monitor_create_request)
+    assert_kind_of(Plaid::WatchlistScreeningIndividualCreateResponse, response)
+    assert_equal(LEGAL_NAME, response.search_terms.legal_name)
+    assert_equal(DOCUMENT_NUMBER, response.search_terms.document_number)
+    assert_equal(date_of_birth, response.search_terms.date_of_birth)
+    assert_equal(Plaid::CountryCode::US, response.search_terms.country)
+
+    monitor_update_request = Plaid::WatchlistScreeningIndividualUpdateRequest.new({
+        :watchlist_screening_id => response.id,
+        :status => Plaid::WatchlistScreeningStatus::PENDING_REVIEW,
+    })
+    response = client.watchlist_screening_individual_update(monitor_update_request)
+    assert_kind_of(Plaid::WatchlistScreeningIndividualUpdateResponse, response)
+    assert_equal(Plaid::WatchlistScreeningStatus::PENDING_REVIEW, response.status)
+
+    monitor_list_request = Plaid::WatchlistScreeningIndividualListRequest.new({
+        :watchlist_program_id => WATCHLIST_PROGRAM_ID,
+        :client_user_id => CLIENT_USER_ID,
+    })
+    response = client.watchlist_screening_individual_list(monitor_list_request)
+    assert_kind_of(Plaid::WatchlistScreeningIndividualListResponse, response)
+    assert_equal(1, response.watchlist_screenings.length)
+
+    monitor_get_request = Plaid::WatchlistScreeningIndividualGetRequest.new({
+        :watchlist_screening_id => response.watchlist_screenings[0].id,
+    })
+    response = client.watchlist_screening_individual_get(monitor_get_request)
+    assert_kind_of(Plaid::WatchlistScreeningIndividualGetResponse, response)
+    assert_equal(LEGAL_NAME, response.search_terms.legal_name)
+  end
+end

data/test/test_payment_initiation.rb

@@ -45,8 +45,8 @@ class PlaidPaymentInitiationTest < PlaidTest
     # list recipients
     payment_initiation_recipient_list_request = Plaid::PaymentInitiationRecipientListRequest.new
 
-    list_recipients_response = client.payment_initiation_payment_list(payment_initiation_recipient_list_request)
-    refute_empty(list_recipients_response.payments)
+    list_recipients_response = client.payment_initiation_recipient_list(payment_initiation_recipient_list_request)
+    refute_empty(list_recipients_response.recipients)
 
     # create payment
     payment_initiation_payment_create_request = Plaid::PaymentInitiationPaymentCreateRequest.new

data/test/test_sandbox.rb

@@ -0,0 +1,31 @@
+require_relative 'test_helper'
+
+class PlaidSandboxTest < PlaidTest
+    # rubocop:disable Metrics/MethodLength
+    def test_sandbox_income_verification
+        skip "TODO (czhou): unskip when tests are fixed"
+        # test sandbox public token for income verification
+        sandbox_public_token_create_request = Plaid::SandboxPublicTokenCreateRequest.new
+        sandbox_public_token_create_request.institution_id = SANDBOX_INSTITUTION
+        sandbox_public_token_create_request.initial_products = ["income_verification"]
+        
+        options_payload = {}
+        options_payload[:income_verification] = {
+            income_verification: {
+                income_source_types: ["bank"],
+                bank_income: {
+                    days_requested: 180,
+                }
+            }
+        }
+        
+        sandbox_public_token_create_request.options = options_payload
+
+        public_token_response = client.sandbox_public_token_create(
+        sandbox_public_token_create_request
+        )
+
+        refute_empty(public_token_response.to_hash)
+        refute_empty(public_token_response.public_token)
+    end
+end