unit_ruby_sdk 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19b63ebda9542149ccda54951cd38604a8c3175879f3377893f3cd9e2d0acb02
-  data.tar.gz: ce345af67e8bd02d4f7970096600d5b694a052366a65ebf067afe4e343bd6818
+  metadata.gz: 4427f4ca95ba8cf893f2e7c9ff5c21605419518429095a8aff3a41cd8876fed9
+  data.tar.gz: 672fd892ed734631361b0f94b52b3ca95bc88780a6f4f9942b278c956526f245
 SHA512:
-  metadata.gz: 14689b03dd416d25d6f97767429188301240645ea51dfda65e203051aa357c01f3c7181fe3436cea9fef4fc231c8fca71944f94b51726b581bb1d967152755a3
-  data.tar.gz: f93ecf9f33ece644fe9343ed583f34366db4437b1c2e1866718f4be7526c5546b85561915960352c803f33f170270a5ab08aa2df844f33647ac474039b3f5f0f
+  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"]
 ```
 
 
@@ -323,6 +323,12 @@ 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/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/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/version.rb

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

data/lib/unit_ruby_sdk.rb

@@ -10,6 +10,7 @@ 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"
@@ -35,6 +36,7 @@ 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Unit
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -104,6 +104,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/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
@@ -181,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
@@ -292,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/