unit_ruby_sdk 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6886c703f37b77fbd4ccc6e174cf0c79b83c588c53f0cfaaa6a1503598fc1fbd
-  data.tar.gz: 0371acc6dc064fb9bf8969d10839cbe915e23772bb088493bf889abfeee50244
+  metadata.gz: 4427f4ca95ba8cf893f2e7c9ff5c21605419518429095a8aff3a41cd8876fed9
+  data.tar.gz: 672fd892ed734631361b0f94b52b3ca95bc88780a6f4f9942b278c956526f245
 SHA512:
-  metadata.gz: 11d43e7bdaa9d8af5b2f3ac73823576773a784e9bf098d6fb232c08cbb5d76ac7de441da062ed33645c7804c2f19a897a4f0e8cdc1309f6b2b146c249c8edd0c
-  data.tar.gz: b8077c7600d42b3396a2f0b5437edde30b1e3d09899df5e0d5ebec0761822a3a8bbcd3b83cc9706245f3a02c26d3b4e0c0481ef19410874eed952292584464c7
+  metadata.gz: bef4edade650df1097bda85a10b7d81c614a4dc0d9e05247335e25d079a00fb2da81b71fd440963bd7bce69fede707bafd2c5c56230725dc9998b2ffdc8418af
+  data.tar.gz: a5db0ecc8a1baa2a2d48f523f4e4e05ad8dc98c58ba9da7fb82bd4acd8be4ef22e1502607f764eec055bdc92e2b3b947fef9b479f8ac83841725c90bacc14c5a

data/README.md

@@ -262,7 +262,7 @@ puts counterparty["id"]
  response = Unit::RecurringPayment.create_recurring_credit_book_payment(account_id: "27573", counterparty_id: "36099", amount: 1000, 
                                                                         description: "test payme", schedule: schedule)
  recurring_payment = response.data
- puts recurring_payment.id
+ puts recurring_payment["id"]
 ```
 
 
@@ -313,9 +313,22 @@ response = Unit::Repayment.create_book_repayment(
   tags: { purpose: "test" }, 
   idempotency_key: "3a1a33be-4e12-4603-9ed0-820922389fb8")
 book_repayment = response.data
-puts book_repayment.id
+puts book_repayment["id"]
 ```
 
+### Creating a control agreement
+```ruby
+response = Unit::Account::DACA.activate_control_agreement(account_id: "1234")
+control_agreement = response.data
+puts control_agreement["id"]
+```
+
+### Get a check payment by id
+```ruby
+response = Unit::CheckPayment.get_payment(payment_id: "199")
+check_payment = response.data
+puts check_payment["id"]
+```
 ### Logging Errors
 
 ### Handling Response

data/lib/unit/api_resources/account_resource.rb

@@ -10,6 +10,30 @@ module Unit
   module Resource
     class AccountResource < Unit::Resource::BaseResource
       class << self
+        # Enter a control agreement by calling Unit's API
+        # @param account_id [String]
+        # @return [UnitResponse, UnitError]
+        def enter_control_agreement(account_id)
+          response = HttpHelper.post("#{api_url}/accounts/#{account_id}/enter-daca", headers: headers)
+          response_handler(response)
+        end
+
+        # Activate a control agreement by calling Unit's API
+        # @param account_id [String]
+        # @return [UnitResponse, UnitError]
+        def activate_control_agreement(account_id)
+          response = HttpHelper.post("#{api_url}/accounts/#{account_id}/activate-daca", headers: headers)
+          response_handler(response)
+        end
+
+        # Deactivate a control agreement by calling Unit's API
+        # @param account_id [String]
+        # @return [UnitResponse, UnitError]
+        def deactivate_control_agreement(account_id)
+          response = HttpHelper.post("#{api_url}/accounts/#{account_id}/deactivate-daca", headers: headers)
+          response_handler(response)
+        end
+
         # Create a new account by calling Unit's API
         # @param request [CreateDepositAccountRequest] request
         # @return [UnitResponse, UnitError]

data/lib/unit/api_resources/check_payment_resource.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+
+# class for creating request for check payments to Unit API and parsing responses
+# @see https://docs.unit.co/check-payments
+module Unit
+  module Resource
+    class CheckPaymentResource < Unit::Resource::BaseResource
+      class << self
+        # Get a check payment by id by calling Unit's API
+        # @param params [GetRequest]
+        # @return [UnitResponse, UnitError]
+        def get(params)
+          payload = params.to_hash
+          response = HttpHelper.get("#{api_url}/check-payments/#{params.payment_id}", params: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a list of check payments by calling Unit's API
+        # @param params [ListCheckPaymentParams]
+        # @return [UnitResponse, UnitError]
+        def list(params = nil)
+          response = HttpHelper.get("#{api_url}/check-payments", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a check payment image by calling Unit's API
+        # @param request [GetImageRequest]
+        # @return [UnitResponse, UnitError]
+        def get_image(request)
+          side = request.is_front_side ? "front" : "back"
+          response = HttpHelper.get("#{api_url}/check-payments/#{request.payment_id}/#{side}", headers: headers, response_type: "image")
+          file_response_handler(response)
+        end
+
+        # Return a check payment by calling Unit's API
+        # @param request [ReturnCheckPaymentRequest]
+        # @return [UnitResponse, UnitError]
+        def return_payment(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/check-payments/#{request.payment_id}/return", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Approve Check Payment Additional Verification by calling Unit's API
+        # @param payment_id [String]
+        # @return [UnitResponse, UnitError]
+        def approve_payment_verification(payment_id)
+          payload = { data: { type: "additionalVerification" } }.to_json
+          response = HttpHelper.post("#{api_url}/check-payments/#{payment_id}/approve", body: payload, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/institution_resource.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+
+# class for creating request for institutions to Unit API and parsing responses
+# @see https://docs.unit.co/institutions/
+module Unit
+  module Resource
+    class InstitutionResource < Unit::Resource::BaseResource
+      class << self
+        # Get an institution by routing number by calling Unit's API
+        # @param routing_number [String]
+        # @return [UnitResponse, UnitError]
+        def get_institution(routing_number)
+          response = HttpHelper.get("#{api_url}/institutions/#{routing_number}", headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

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

@@ -261,5 +261,30 @@ module Unit
         end
       end
     end
+
+    module DACA
+      class << self
+        # Enter DACA
+        # @see https://docs.unit.co/deposit-account-control-agreement/#enter-daca
+        # @param account_id [String]
+        def enter_control_agreement(account_id:)
+          Unit::Resource::AccountResource.enter_control_agreement(account_id)
+        end
+
+        # Activate DACA
+        # @see https://docs.unit.co/deposit-account-control-agreement/#activate-daca
+        # @param account_id [String]
+        def activate_control_agreement(account_id:)
+          Unit::Resource::AccountResource.activate_control_agreement(account_id)
+        end
+
+        # Deactivate DACA
+        # @see https://docs.unit.co/deposit-account-control-agreement/#deactivate-daca
+        # @param account_id [String]
+        def deactivate_control_agreement(account_id:)
+          Unit::Resource::AccountResource.deactivate_control_agreement(account_id)
+        end
+      end
+    end
   end
 end

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

@@ -25,7 +25,8 @@ module Unit
               type: "depositAccount",
               attributes: {
                 depositProduct: deposit_product,
-                tags: tags
+                tags: tags,
+                idempotencyKey: idempotency_key
               },
               relationships: relationships
             }

data/lib/unit/models/application/create_individual_application_request.rb

@@ -77,6 +77,7 @@ module Unit
               soleProprietorship: sole_proprietorship,
               passport: passport,
               nationality: nationality,
+              device_fingerprints: device_fingerprints,
               idempotencyKey: idempotency_key,
               tags: tags,
               jwtSubject: jwt_subject,

data/lib/unit/models/check_payment/check_payment.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Unit
+  module CheckPayment
+    CHECK_PAYMENT_LIMIT = 100
+    CHECK_PAYMENT_OFFSET = 0
+
+    autoload :GetRequest, "unit/models/check_payment/get_request"
+    autoload :ListPaymentParams, "unit/models/check_payment/list_check_payment_params"
+    autoload :GetImageRequest, "unit/models/check_payment/get_image_request"
+    autoload :ReturnCheckPaymentRequest, "unit/models/check_payment/return_check_payment_request"
+
+    class << self
+      # Get a check payment by id
+      # @see https://docs.unit.co/check-payments#get-specific-check-payment
+      # @param payment_id [String]
+      # @param include [Array<String>] - optional
+      def get_payment(payment_id:, include: nil)
+        request = GetRequest.new(payment_id, include)
+        Unit::Resource::CheckPaymentResource.get(request)
+      end
+
+      # Request to list check payments
+      # @see https://docs.unit.co/check-payments#list-check-payments
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param since [String] - optional
+      # @param _until [String] - optional
+      # @param status [Array<String>] - optional
+      # @param from_amount [String] - optional
+      # @param to_amount [String] - optional
+      # @param check_number [String] - optional
+      # @param include [Array<String>] - optional
+      def list_payment(limit: CHECK_PAYMENT_LIMIT, offset: CHECK_PAYMENT_OFFSET, account_id: nil,
+                       customer_id: nil, tags: nil, sort: nil, since: nil, _until: nil, status: nil,
+                       from_amount: nil, to_amount: nil, check_number: nil, include: nil)
+
+        request = ListPaymentParams.new(limit, offset, account_id, customer_id, tags, sort, since, _until,
+                                        status, from_amount, to_amount, check_number, include)
+        Unit::Resource::CheckPaymentResource.list(request)
+      end
+
+      # Get a check deposit image front or back side
+      # @see https://docs.unit.co/check-payments#get-specific-check-payment-front-image
+      # @see https://docs.unit.co/check-payments#get-specific-check-payment-back-image
+      # @param payment_id [String]
+      # @param is_front_side [Boolean] - optional
+      def get_image(payment_id:, is_front_side: true)
+        request = GetImageRequest.new(payment_id, is_front_side: is_front_side)
+        Unit::Resource::CheckPaymentResource.get_image(request)
+      end
+
+      # Return check payment by id
+      # @see https://docs.unit.co/check-payments#return-check-payment
+      # @param payment_id [String]
+      # @param return_reason_code [String]
+      def return_payment(payment_id:, return_reason_code:)
+        request = ReturnCheckPaymentRequest.new(payment_id, return_reason_code)
+        Unit::Resource::CheckPaymentResource.return_payment(request)
+      end
+
+      # Approve Check Payment Additional Verification
+      # @see https://docs.unit.co/check-payments#approve-check-payment-additional-verification
+      # @param payment_id [String]
+      def approve_payment_verification(payment_id:)
+        Unit::Resource::CheckPaymentResource.approve_payment_verification(payment_id)
+      end
+    end
+  end
+end

data/lib/unit/models/check_payment/get_image_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Request to get a check deposit image
+# @see https://docs.unit.co/check-payments#get-specific-check-payment-front-image
+# @see https://docs.unit.co/check-payments#get-specific-check-payment-back-image
+module Unit
+  module CheckPayment
+    class GetImageRequest
+      attr_reader :payment_id, :is_front_side
+
+      # @param payment_id [String]
+      # @param is_front_side [Boolean] - optional
+      def initialize(payment_id, is_front_side: true)
+        @payment_id = payment_id
+        @is_front_side = is_front_side
+      end
+    end
+  end
+end

data/lib/unit/models/check_payment/get_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Request to get check payment by id
+# @see https://docs.unit.co/check-payments#get-specific-check-payment
+module Unit
+  module CheckPayment
+    class GetRequest
+      attr_reader :payment_id, :include
+
+      # @param payment_id [String]
+      # @param include [Array<String>] - optional
+      def initialize(payment_id, include = nil)
+        @payment_id = payment_id
+        @include = include
+      end
+
+      def to_hash
+        { include: include&.join(",") }.compact
+      end
+    end
+  end
+end

data/lib/unit/models/check_payment/list_check_payment_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Request to list check payments
+# @see https://docs.unit.co/check-payments#list-check-payments
+module Unit
+  module CheckPayment
+    class ListPaymentParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :tags, :sort,
+                  :since, :_until, :status, :from_amount, :to_amount, :check_number, :include
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param since [String] - optional
+      # @param _until [String] - optional
+      # @param status [Array<String>] - optional
+      # @param from_amount [String] - optional
+      # @param to_amount [String] - optional
+      # @param check_number [String] - optional
+      # @param include [Array<String>] - optional
+      def initialize(limit = CHECK_PAYMENT_LIMIT, offset = CHECK_PAYMENT_OFFSET, account_id = nil,
+                     customer_id = nil, tags = nil, sort = nil, since = nil, _until = nil, status = nil, from_amount = nil,
+                     to_amount = nil, check_number = nil, include = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @tags = tags
+        @sort = sort
+        @since = since
+        @until = _until
+        @status = status
+        @from_amount = from_amount
+        @to_amount = to_amount
+        @check_number = check_number
+        @include = include
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[accountId]": account_id,
+          "filter[customerId]": customer_id,
+          "filter[tags]": tags,
+          "sort": sort,
+          "filter[since]": since,
+          "filter[until]": _until,
+          "filter[fromAmount]": from_amount,
+          "filter[toAmount]": to_amount,
+          "filter[checkNumber]": check_number,
+          "include": include&.join(",")
+        }
+        status&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[status][#{index}]": val })
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/check_payment/return_check_payment_request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Request to return check payment by id
+# @see https://docs.unit.co/check-payments#return-check-payment
+module Unit
+  module CheckPayment
+    class ReturnCheckPaymentRequest
+      attr_reader :payment_id, :return_reason_code
+
+      # @param payment_id [String]
+      # @param return_reason_code [String]
+      def initialize(payment_id, return_reason_code)
+        @payment_id = payment_id
+        @return_reason_code = return_reason_code
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "checkPaymentReturn",
+            attributes: { returnReasonCode: return_reason_code }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/institution/institution.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Unit
+  module Institution
+    class << self
+      # Get institution by routing number
+      # @see https://docs.unit.co/institutions/#get-institution-by-routingNumber
+      # @param routing_number [String]
+      def get_institution(routing_number:)
+        Unit::Resource::InstitutionResource.get_institution(routing_number)
+      end
+    end
+  end
+end

data/lib/unit/version.rb

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

data/lib/unit_ruby_sdk.rb

@@ -10,12 +10,15 @@ module Unit
   autoload :ApiToken, "unit/models/api_token/api_token"
   autoload :Payment, "unit/models/payment/payment"
   autoload :ReceivedPayment, "unit/models/received_payment/received_payment"
+  autoload :CheckPayment, "unit/models/check_payment/check_payment"
   autoload :Transaction, "unit/models/transaction/transaction"
   autoload :Card, "unit/models/card/card"
   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"
+  autoload :RecurringPayment, "unit/models/recurring_payment/recurring_payment"
+  autoload :Institution, "unit/models/institution/institution"
   autoload :Repayment, "unit/models/repayment/repayment"
   autoload :Event, "unit/models/event/event"
   autoload :Webhook, "unit/models/webhook/webhook"
@@ -33,12 +36,15 @@ module Unit
     autoload :ApiTokenResource, "unit/api_resources/api_token_resource"
     autoload :PaymentResource, "unit/api_resources/payment_resource"
     autoload :ReceivedPaymentResource, "unit/api_resources/received_payment_resource"
+    autoload :CheckPaymentResource, "unit/api_resources/check_payment_resource"
     autoload :TransactionResource, "unit/api_resources/transaction_resource"
     autoload :CardResource, "unit/api_resources/card_resource"
     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"
+    autoload :RecurringPaymentResource, "unit/api_resources/recurring_payment_resource"
+    autoload :InstitutionResource, "unit/api_resources/institution_resource"
     autoload :RepaymentResource, "unit/api_resources/repayment_resource"
     autoload :EventResource, "unit/api_resources/event_resource"
     autoload :WebhookResource, "unit/api_resources/webhook_resource"
@@ -67,6 +73,7 @@ module Unit
     autoload :RestrictedResource, "unit/types/restricted_resource"
     autoload :DocumentFileType, "unit/types/document_file_type"
     autoload :Coordinates, "unit/types/coordinates"
+    autoload :CreateSchedule, "unit/types/create_schedule"
     autoload :TrustContact, "unit/types/trust_contact"
     autoload :Trustee, "unit/types/trustee"
     autoload :Grantor, "unit/types/grantor"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Unit
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -104,10 +104,12 @@ 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/check_payment_resource.rb
 - lib/unit/api_resources/counterparty_resource.rb
 - lib/unit/api_resources/customer_resource.rb
 - lib/unit/api_resources/event_resource.rb
 - lib/unit/api_resources/fee_resource.rb
+- lib/unit/api_resources/institution_resource.rb
 - lib/unit/api_resources/payment_resource.rb
 - lib/unit/api_resources/received_payment_resource.rb
 - lib/unit/api_resources/recurring_payment_resource.rb
@@ -180,6 +182,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/check_payment/check_payment.rb
+- lib/unit/models/check_payment/get_image_request.rb
+- lib/unit/models/check_payment/get_request.rb
+- lib/unit/models/check_payment/list_check_payment_params.rb
+- lib/unit/models/check_payment/return_check_payment_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
@@ -197,6 +204,7 @@ files:
 - lib/unit/models/fee/create_fee_request.rb
 - lib/unit/models/fee/fee.rb
 - lib/unit/models/fee/reverse_fee_request.rb
+- lib/unit/models/institution/institution.rb
 - lib/unit/models/payment/batch_release_request_builder.rb
 - lib/unit/models/payment/bulk_payment_request.rb
 - lib/unit/models/payment/create_ach_payment_inline_request.rb
@@ -290,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: This library provides a Ruby wrapper to http://unit.co API. See https://docs.unit.co/