unit_ruby_sdk 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebccfab4c5a1935e6155ab1778b6c8beb123e7a4171b14ea6fcb2617d84d9da0
-  data.tar.gz: 195fe66d952a385323e750b19abca9940843645252771462efbefc75dc3a1e68
+  metadata.gz: bf85eb968fc7cac1337e5093a9c5998a98997ad7f37956e79c45498785b08ffb
+  data.tar.gz: e60405762229150510a2e82b76d25aecc547c009c287ca694ef95611e2319c28
 SHA512:
-  metadata.gz: 92662a6367cb982b8fe77577b729e28139a9da4b78da5518ea99e32c064fbfede80106477569380a2b68c4816e1e2e4641b4911d38f63cd608ca8f9abb8c9dc4
-  data.tar.gz: a80e9f7bb02d93e24adafa4c0f1d792ad7fa9ee9bcf64a421c5d06a45366e90ed5a909fa68271ccd026c287ef2ecf4167cddf436563a6738d66a0042688602b7
+  metadata.gz: 91ea490c2a75df07cf37281fc32aef9965767fbbcbe12b035a8caf500e3fd08bd23dc2b8eb5c522eef2491885a13c4053ad9c3b0c906925ea077c42ab27c4452
+  data.tar.gz: 4c687d3bd7a49d5c0bf4c113b20aabf42e1fcfec5381165ced6fb5f45825565bd5ab058529c97224d6d3680df936663589f02011de0b2b636429af8174b37d29

data/README.md

@@ -121,6 +121,18 @@ deposit = response.data
 puts deposit.id
 ```
 
+### Creating a counterparty with a plaid token
+```ruby
+response = Unit::Counterparty.create_with_plaid_token(
+  customer_id: "823139", 
+  type: "Business", 
+  name: "Jo Joel", 
+  plaid_processor_token: "processor-sandbox-plaid-token")
+
+counterparty = response.data
+puts counterparty.id
+```
+
 ### Logging Errors
 
 ```ruby

data/lib/unit/api_resources/counterparty_resource.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+
+# class for creating requests for counterparties to Unit API and parsing responses
+# @see https://docs.unit.co/payments-counterparties
+module Unit
+  module Resource
+    class CounterpartyResource < Unit::Resource::BaseResource
+      class << self
+        # Create a counterparty by calling Unit's API
+        # @param request [CreateCounterpartyRequest, CreateWithPlaidTokenRequest]
+        # @return [UnitResponse, UnitError]
+        def create_counterparty(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/counterparties", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Update counterparty by calling Unit's API
+        # @param request [UpdateCounterpartyRequest]
+        # @return [UnitResponse, UnitError]
+        def update_counterparty(request)
+          payload = request.to_json_api
+          response = HttpHelper.patch("#{api_url}/counterparties/#{request.counterparty_id}", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Delete counterparty by calling Unit's API
+        # @param counterparty_id String
+        # @return [UnitResponse, UnitError]
+        def delete(counterparty_id)
+          response = HttpHelper.delete("#{api_url}/counterparties/#{counterparty_id}", headers: headers, response_type: "delete")
+          file_response_handler(response)
+        end
+
+        # Get counterparty by id by calling Unit's API
+        # @param counterparty_id String
+        # @return [UnitResponse, UnitError]
+        def get_counterparty(counterparty_id)
+          response = HttpHelper.get("#{api_url}/counterparties/#{counterparty_id}", headers: headers)
+          response_handler(response)
+        end
+
+        # Get counterparty balance
+        # @param counterparty_id String
+        # @return [UnitResponse, UnitError]
+        def get_counterparty_balance(counterparty_id)
+          response = HttpHelper.get("#{api_url}/counterparties/#{counterparty_id}/balance", headers: headers)
+          response_handler(response)
+        end
+
+        # List counterparties
+        # @param params [ListCounterpartyParams]
+        # @return [UnitResponse, UnitError]
+        def list(params = nil)
+          response = HttpHelper.get("#{api_url}/counterparties", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/account/account.rb

@@ -34,8 +34,8 @@ module Unit
         # @param reason [String]
         # @param fraud_reason [String] - optional
         # @return [UnitResponse, UnitError]
-        def close_deposit_account(account_id:, reason:)
-          request = CloseDepositAccountRequest.new(account_id, reason)
+        def close_deposit_account(account_id:, reason:, fraud_reason: nil)
+          request = CloseDepositAccountRequest.new(account_id, reason, fraud_reason)
           Unit::Resource::AccountResource.close_account(request)
         end
 

data/lib/unit/models/counterparty/counterparty.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Unit
+  module Counterparty
+    COUNTER_PARTY_LIMIT = 100
+    COUNTER_PARTY_OFFSET = 0
+
+    autoload :CreateCounterpartyRequest, "unit/models/counterparty/create_counterparty_request"
+    autoload :CreateWithPlaidTokenRequest, "unit/models/counterparty/create_with_plaid_token_request"
+    autoload :ListCounterpartyParams, "unit/models/counterparty/list_counterparty_params"
+    autoload :UpdateCounterpartyRequest, "unit/models/counterparty/update_counterparty_request"
+
+    class << self
+      # Create counterparty by calling Unit's API
+      # @see https://docs.unit.co/payments-counterparties/#create-counterparty
+      # @param customer_id [String]
+      # @param name [String]
+      # @param routing_number [String]
+      # @param account_number [String]
+      # @param account_type [String]
+      # @param type [String]
+      # @param tags [Hash] - optional
+      # @param permissions [String] - optional
+      # @param idempotency_key [String] - optional
+      def create_counterparty(customer_id:, name:, routing_number:, account_number:, account_type:, type:, tags: nil, permissions: nil, idempotency_key: nil)
+        request = CreateCounterpartyRequest.new(customer_id, name, routing_number, account_number, account_type, type, tags, permissions, idempotency_key)
+        Unit::Resource::CounterpartyResource.create_counterparty(request)
+      end
+
+      # Create counterparty with plaid token
+      # @see https://docs.unit.co/payments-counterparties/#create-counterparty-with-plaid-token
+      # @param customer_id [String]
+      # @param type [String]
+      # @param name [String]
+      # @param plaid_processor_token [String]
+      # @param verify_name [Boolean] - optional
+      # @param permissions [String] - optional
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def create_with_plaid_token(customer_id:, type:, name:, plaid_processor_token:, verify_name: nil, permissions: nil, tags: nil, idempotency_key: nil)
+        request = CreateWithPlaidTokenRequest.new(customer_id, type, name, plaid_processor_token, verify_name, permissions, tags, idempotency_key)
+        Unit::Resource::CounterpartyResource.create_counterparty(request)
+      end
+
+      # List counterparties
+      # @see https://docs.unit.co/payments-counterparties/#list-counterparties
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param customer_id [String] - optional
+      # @param account_number [String] - optional
+      # @param routing_number [String] - optional
+      # @param tags [Hash] - optional
+      # @param permissions [Array<String>] - optional
+      def list_counterparty(limit: COUNTER_PARTY_LIMIT, offset: COUNTER_PARTY_OFFSET, customer_id: nil, account_number: nil, routing_number: nil, tags: nil, permissions: nil)
+        params = ListCounterpartyParams.new(limit, offset, customer_id, account_number, routing_number, tags, permissions)
+        Unit::Resource::CounterpartyResource.list(params)
+      end
+
+      # Get counterparty by id
+      # @param counterparty_id [String]
+      # @see https://docs.unit.co/payments-counterparties/#get-one-counterparty
+      def get_counterparty(counterparty_id:)
+        Unit::Resource::CounterpartyResource.get_counterparty(counterparty_id)
+      end
+
+      # Get counterparty balance
+      # @param counterparty_id [String]
+      # @see https://docs.unit.co/payments-counterparties/#get-counterparty-balance
+      def get_counterparty_balance(counterparty_id:)
+        Unit::Resource::CounterpartyResource.get_counterparty_balance(counterparty_id)
+      end
+
+      # Update counterparty
+      # @see https://docs.unit.co/payments-counterparties/#list-counterparties
+      # @param counterparty_id [String]
+      # @param plaid_processor_token [String]
+      # @param verify_name [Boolean] - optional
+      # @param permissions [String] - optional
+      # @param tags [Hash] - optional
+      def update_counterparty(counterparty_id:, plaid_processor_token: nil, verify_name: nil, permissions: nil, tags: nil)
+        request = UpdateCounterpartyRequest.new(counterparty_id, plaid_processor_token, verify_name, permissions, tags)
+        Unit::Resource::CounterpartyResource.update_counterparty(request)
+      end
+
+      # Delete counterparty
+      # @param counterparty_id [String]
+      # @see https://docs.unit.co/payments-counterparties/#get-one-counterparty
+      def delete_counterparty(counterparty_id:)
+        Unit::Resource::CounterpartyResource.delete(counterparty_id)
+      end
+    end
+  end
+end

data/lib/unit/models/counterparty/create_counterparty_request.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Request to create a counterparty
+# @see https://docs.unit.co/payments-counterparties/#create-counterparty
+module Unit
+  module Counterparty
+    class CreateCounterpartyRequest
+      attr_reader :customer_id, :name, :routing_number, :account_number, :account_type,
+                  :type, :tags, :permissions, :idempotency_key
+
+      # @param customer_id [String]
+      # @param name [String]
+      # @param routing_number [String]
+      # @param account_number [String]
+      # @param account_type [String]
+      # @param type [String]
+      # @param tags [Hash] - optional
+      # @param permissions [String] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(customer_id, name, routing_number, account_number, account_type, type, tags = nil, permissions = nil, idempotency_key = nil)
+        @customer_id = customer_id
+        @name = name
+        @routing_number = routing_number
+        @account_number = account_number
+        @account_type = account_type
+        @type = type
+        @tags = tags
+        @permissions = permissions
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "achCounterparty",
+            "attributes": {
+              name: name,
+              routingNumber: routing_number,
+              accountNumber: account_number,
+              accountType: account_type,
+              type: type,
+              tags: tags,
+              permissions: permissions,
+              idempotencyKey: idempotency_key
+            },
+            "relationships": {
+              customer: Unit::Types::Relationship.new("customer", customer_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/counterparty/create_with_plaid_token_request.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Request to create a counterparty with plaid token
+# @see https://docs.unit.co/payments-counterparties/#create-counterparty-with-plaid-token
+module Unit
+  module Counterparty
+    class CreateWithPlaidTokenRequest
+      attr_reader :customer_id, :type, :name, :plaid_processor_token,
+                  :verify_name, :permissions, :tags, :idempotency_key
+
+      # @param customer_id [String]
+      # @param type [String]
+      # @param name [String]
+      # @param plaid_processor_token [String]
+      # @param verify_name [Boolean] - optional
+      # @param permissions [String] - optional
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(customer_id, type, name, plaid_processor_token, verify_name = nil, permissions = nil, tags = nil, idempotency_key = nil)
+        @customer_id = customer_id
+        @type = type
+        @name = name
+        @plaid_processor_token = plaid_processor_token
+        @verify_name = verify_name
+        @permissions = permissions
+        @tags = tags
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "achCounterparty",
+            "attributes": {
+              type: type,
+              name: name,
+              plaidProcessorToken: plaid_processor_token,
+              verifyName: verify_name,
+              permissions: permissions,
+              tags: tags,
+              idempotencyKey: idempotency_key
+            },
+            "relationships": {
+              customer: Unit::Types::Relationship.new("customer", customer_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/counterparty/list_counterparty_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Request to list counterparties
+# @see https://docs.unit.co/payments-counterparties/#list-counterparties
+module Unit
+  module Counterparty
+    class ListCounterpartyParams
+      attr_reader :limit, :offset, :customer_id, :account_number, :routing_number, :tags, :permissions
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param customer_id [String] - optional
+      # @param account_number [String] - optional
+      # @param routing_number [String] - optional
+      # @param tags [Hash] - optional
+      # @param permissions [Array<String>] - optional
+      def initialize(limit = COUNTER_PARTY_LIMIT, offset = COUNTER_PARTY_OFFSET, customer_id = nil,
+                     account_number = nil, routing_number = nil, tags = nil, permissions = nil)
+        @limit = limit
+        @offset = offset
+        @customer_id = customer_id
+        @account_number = account_number
+        @routing_number = routing_number
+        @tags = tags
+        @permissions = permissions
+      end
+
+      def to_hash
+        params =
+          {
+            "page[limit]": limit,
+            "page[offset]": offset,
+            "filter[customerId]": customer_id,
+            "filter[accountNumber]": account_number,
+            "filter[routingNumber]": routing_number,
+            "filter[tags]": tags
+          }
+        permissions&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[permissions][#{index}]": val })
+        end
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/counterparty/update_counterparty_request.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Request to update a counterparty
+# @see https://docs.unit.co/payments-counterparties/#list-counterparties
+module Unit
+  module Counterparty
+    class UpdateCounterpartyRequest
+      attr_reader :counterparty_id, :plaid_processor_token, :verify_name, :permissions, :tags
+
+      # @param counterparty_id [String]
+      # @param plaid_processor_token [String]
+      # @param verify_name [Boolean] - optional
+      # @param permissions [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(counterparty_id, plaid_processor_token, verify_name = nil, permissions = nil, tags = nil)
+        @counterparty_id = counterparty_id
+        @plaid_processor_token = plaid_processor_token
+        @verify_name = verify_name
+        @permissions = permissions
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "counterparty",
+            attributes: {
+              plaidProcessorToken: plaid_processor_token,
+              verifyName: verify_name,
+              permissions: permissions,
+              tags: tags
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Unit
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/lib/unit_ruby_sdk.rb

@@ -13,6 +13,8 @@ module Unit
   autoload :Statement, "unit/models/statement/statement"
   autoload :AtmLocation, "unit/models/atm_location/atm_location"
   autoload :CheckDeposit, "unit/models/check_deposit/check_deposit"
+  autoload :Counterparty, "unit/models/counterparty/counterparty"
+
   module Resource
     autoload :ApplicationResource, "unit/api_resources/application_resource"
     autoload :CustomerResource, "unit/api_resources/customer_resource"
@@ -24,6 +26,7 @@ module Unit
     autoload :StatementResource, "unit/api_resources/statement_resource"
     autoload :AtmLocationResource, "unit/api_resources/atm_location_resource"
     autoload :CheckDepositResource, "unit/api_resources/check_deposit_resource"
+    autoload :CounterpartyResource, "unit/api_resources/counterparty_resource"
   end
 
   module Types

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Unit
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -101,6 +101,7 @@ files:
 - lib/unit/api_resources/base_resource.rb
 - lib/unit/api_resources/card_resource.rb
 - lib/unit/api_resources/check_deposit_resource.rb
+- lib/unit/api_resources/counterparty_resource.rb
 - lib/unit/api_resources/customer_resource.rb
 - lib/unit/api_resources/payment_resource.rb
 - lib/unit/api_resources/statement_resource.rb
@@ -144,6 +145,11 @@ files:
 - lib/unit/models/check_deposit/list_deposit_params.rb
 - lib/unit/models/check_deposit/patch_deposit_request.rb
 - lib/unit/models/check_deposit/upload_image_request.rb
+- lib/unit/models/counterparty/counterparty.rb
+- lib/unit/models/counterparty/create_counterparty_request.rb
+- lib/unit/models/counterparty/create_with_plaid_token_request.rb
+- lib/unit/models/counterparty/list_counterparty_params.rb
+- lib/unit/models/counterparty/update_counterparty_request.rb
 - lib/unit/models/customer/add_authorized_users_request.rb
 - lib/unit/models/customer/archive_customer_request.rb
 - lib/unit/models/customer/customer.rb