unit_ruby_sdk 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e391082a9b8407e9e7ff1848ef06235d65aa3254b6c52ce5548bd4ad02534485
-  data.tar.gz: 85d795785020ef391810521d23404e989201943ab4a41ca9ab762b1bad068612
+  metadata.gz: ebccfab4c5a1935e6155ab1778b6c8beb123e7a4171b14ea6fcb2617d84d9da0
+  data.tar.gz: 195fe66d952a385323e750b19abca9940843645252771462efbefc75dc3a1e68
 SHA512:
-  metadata.gz: 54185c5b5bca29ededcf81ed28d193fcf72c2012206f7a4bf095f3f58d958ec52e0f1c31ea34738ec675f3dcb4e1045f339ca6bb842298a736ae4af784e7bb0e
-  data.tar.gz: c9b2abeae465e2d34cdcb2c83f48565416fe2874ea983ced5eca080c6ee8b746675d3813e33dd5bb5fdc95d5ef01091360b4c51eedadcaf5760bb9e47d0a355a
+  metadata.gz: 92662a6367cb982b8fe77577b729e28139a9da4b78da5518ea99e32c064fbfede80106477569380a2b68c4816e1e2e4641b4911d38f63cd608ca8f9abb8c9dc4
+  data.tar.gz: a80e9f7bb02d93e24adafa4c0f1d792ad7fa9ee9bcf64a421c5d06a45366e90ed5a909fa68271ccd026c287ef2ecf4167cddf436563a6738d66a0042688602b7

data/README.md

@@ -110,6 +110,17 @@ card = response.data
 puts card.id
 ```
 
+### Creating a check deposit
+```ruby
+response = Unit::CheckDeposit.create_deposit(
+  account_id: account_id,
+  amount: 50_000,
+  description: "test check deposit"
+)
+deposit = response.data
+puts deposit.id
+```
+
 ### Logging Errors
 
 ```ruby

data/lib/unit/api_resources/check_deposit_resource.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+# class for creating requests for check deposits to Unit API and parsing responses
+# @see https://docs.unit.co/check-deposits
+module Unit
+  module Resource
+    class CheckDepositResource < Unit::Resource::BaseResource
+      class << self
+        # Create a check deposit by calling Unit's API
+        # @param request [CreateCheckDepositRequest]
+        # @return [UnitResponse, UnitError]
+        def create_deposit(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/check-deposits", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a check deposit 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-deposits/#{params.deposit_id}", params: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a list of check deposits by calling Unit's API
+        # @param params [ListDepositRequest]
+        # @return [UnitResponse, UnitError]
+        def list(params = nil)
+          response = HttpHelper.get("#{api_url}/check-deposits", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Update a check deposit by id by calling Unit's API
+        # @param request [PatchCheckDepositRequest]
+        # @return [UnitResponse, UnitError]
+        def update(request)
+          payload = request.to_json_api
+          response = HttpHelper.patch("#{api_url}/check-deposits/#{request.deposit_id}", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Upload a check deposit image by calling Unit's API
+        # @param request [UploadImageRequest]
+        # @return [UnitResponse, UnitError]
+        def upload(request)
+          side = request.is_front_side ? "/front" : "/back"
+
+          headers_updated = headers.clone
+
+          headers_updated["Content-Type"] = "image/jpeg"
+
+          response = HttpHelper.put("#{api_url}/check-deposits/#{request.deposit_id}#{side}", body: request.file_content, headers: headers_updated)
+
+          response_handler(response)
+        end
+
+        # Get a check deposit 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-deposits/#{request.deposit_id}/#{side}", headers: headers, response_type: "image")
+          file_response_handler(response)
+        end
+
+        # Confirm a check deposit by calling Unit's API
+        # @param deposit_id [String]
+        # @return [UnitResponse, UnitError]
+        def confirm_details(deposit_id)
+          response = HttpHelper.post("#{api_url}/check-deposits/#{deposit_id}/confirm", headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/check_deposit/check_deposit.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Unit
+  module CheckDeposit
+    CHECK_DEPOSIT_LIMIT = 100
+    CHECK_DEPOSIT_OFFSET = 0
+
+    autoload :CreateCheckDepositRequest, "unit/models/check_deposit/create_check_deposit_request"
+    autoload :GetRequest, "unit/models/check_deposit/get_request"
+    autoload :ListDepositParams, "unit/models/check_deposit/list_deposit_params"
+    autoload :UploadImageRequest, "unit/models/check_deposit/upload_image_request"
+    autoload :GetImageRequest, "unit/models/check_deposit/get_image_request"
+    autoload :PatchDepositRequest, "unit/models/check_deposit/patch_deposit_request"
+
+    class << self
+      # Create a check deposit
+      # @see https://docs.unit.co/check-deposits#create-check-deposit
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def create_deposit(account_id:, amount:, description:, tags: nil, idempotency_key: nil)
+        request = CreateCheckDepositRequest.new(account_id, amount, description, tags, idempotency_key)
+        Unit::Resource::CheckDepositResource.create_deposit(request)
+      end
+
+      # Get a check deposit by calling Unit's API
+      # @see https://docs.unit.co/check-deposits#get-specific-check-deposit
+      # @param deposit_id [String]
+      # @param include [Array<String>] - optional
+      def get_deposit(deposit_id:, include: nil)
+        request = GetRequest.new(deposit_id, include)
+        Unit::Resource::CheckDepositResource.get(request)
+      end
+
+      # List check deposits
+      # @see https://docs.unit.co/check-deposits#list-check-deposits
+      # @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 include [Array<String>] - optional
+      def list_deposit(limit: CHECK_DEPOSIT_LIMIT, offset: CHECK_DEPOSIT_OFFSET, account_id: nil,
+                       customer_id: nil, tags: nil, sort: nil, include: nil)
+        request = ListDepositParams.new(limit, offset, account_id, customer_id, tags, sort, include)
+        Unit::Resource::CheckDepositResource.list(request)
+      end
+
+      # Upload an image front side for a check deposit
+      # @see https://docs.unit.co/check-deposits#upload-front-side-image
+      # @param deposit_id [String]
+      # @param file_content [String]
+      # @param is_front_side [Boolean] - optional
+      def upload_image_front(deposit_id:, file_content:, is_front_side: true)
+        request = UploadImageRequest.new(deposit_id, file_content, is_front_side: is_front_side)
+        Unit::Resource::CheckDepositResource.upload(request)
+      end
+
+      # Upload an image back side for a check deposit
+      # @see https://docs.unit.co/check-deposits#upload-back-side-image
+      # @param deposit_id [String]
+      # @param file_content [String]
+      # @param is_front_side [Boolean] - optional
+      def upload_image_back(deposit_id:, file_content:, is_front_side: false)
+        request = UploadImageRequest.new(deposit_id, file_content, is_front_side: is_front_side)
+        Unit::Resource::CheckDepositResource.upload(request)
+      end
+
+      # Get a check deposit image front side
+      # @see https://docs.unit.co/check-deposits#get-specific-check-deposit-front-image
+      # @param deposit_id [String]
+      # @param is_front_side [Boolean] - optional
+      def get_image_front(deposit_id:, is_front_side: true)
+        request = GetImageRequest.new(deposit_id, is_front_side: is_front_side)
+        Unit::Resource::CheckDepositResource.get_image(request)
+      end
+
+      # Get a check deposit image back side
+      # @see https://docs.unit.co/check-deposits#get-specific-check-deposit-back-image
+      # @param deposit_id [String]
+      # @param is_front_side [Boolean] - optional
+      def get_image_back(deposit_id:, is_front_side: false)
+        request = GetImageRequest.new(deposit_id, is_front_side: is_front_side)
+        Unit::Resource::CheckDepositResource.get_image(request)
+      end
+
+      # Update a check deposit
+      # @see https://docs.unit.co/check-deposits#update-check-deposit
+      # @param deposit_id [String]
+      # @param tags [Hash] - optional
+      def update_deposit(deposit_id:, tags:)
+        request = PatchDepositRequest.new(deposit_id, tags)
+        Unit::Resource::CheckDepositResource.update(request)
+      end
+
+      # Confirm check deposit details
+      # @see https://docs.unit.co/check-deposits#confirm-check-deposit-details
+      # @param deposit_id [String]
+      def confirm_details(deposit_id:)
+        Unit::Resource::CheckDepositResource.confirm_details(deposit_id)
+      end
+    end
+  end
+end

data/lib/unit/models/check_deposit/create_check_deposit_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Request to create check deposit
+# @see https://docs.unit.co/check-deposits#create-check-deposit
+module Unit
+  module CheckDeposit
+    class CreateCheckDepositRequest
+      attr_reader :account_id, :amount, :description, :tags, :idempotency_key
+
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(account_id, amount, description, tags = nil, idempotency_key = nil)
+        @account_id = account_id
+        @amount = amount
+        @description = description
+        @tags = tags
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "checkDeposit",
+            "attributes": {
+              amount: amount,
+              description: description,
+              tags: tags,
+              idempotency_key: idempotency_key
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("account", account_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/check_deposit/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-deposits#get-specific-check-deposit-front-image
+# @see https://docs.unit.co/check-deposits#get-specific-check-deposit-back-image
+module Unit
+  module CheckDeposit
+    class GetImageRequest
+      attr_reader :deposit_id, :is_front_side
+
+      # @param deposit_id [String]
+      # @param is_front_side [Boolean] - optional
+      def initialize(deposit_id, is_front_side: true)
+        @deposit_id = deposit_id
+        @is_front_side = is_front_side
+      end
+    end
+  end
+end

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

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

data/lib/unit/models/check_deposit/list_deposit_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Request to list check deposits
+# @see https://docs.unit.co/check-deposits#list-check-deposits
+module Unit
+  module CheckDeposit
+    class ListDepositParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :tags, :sort, :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 include [Array<String>] - optional
+      def initialize(limit = CHECK_DEPOSIT_LIMIT, offset = CHECK_DEPOSIT_OFFSET, account_id = nil,
+                     customer_id = nil, tags = nil, sort = nil, include = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @tags = tags
+        @sort = sort
+        @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,
+          "include": include&.join(",")
+        }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/check_deposit/patch_deposit_request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Request to update check deposit
+# @see https://docs.unit.co/check-deposits#update-check-deposit
+module Unit
+  module CheckDeposit
+    class PatchDepositRequest
+      attr_reader :deposit_id, :tags
+
+      # @param deposit_id [String]
+      # @param tags [Hash] - optional
+      def initialize(deposit_id, tags)
+        @deposit_id = deposit_id
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "checkDeposit",
+            attributes: { tags: tags }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/check_deposit/upload_image_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Request to upload a check deposit image
+# @see https://docs.unit.co/check-deposits#upload-front-side-image
+# @see https://docs.unit.co/check-deposits#upload-back-side-image
+
+module Unit
+  module CheckDeposit
+    class UploadImageRequest
+      attr_reader :deposit_id, :file_content, :is_front_side
+
+      # @param deposit_id [String]
+      # @param file_content [String]
+      # @param is_front_side [Boolean] - optional
+      def initialize(deposit_id, file_content, is_front_side: true)
+        @deposit_id = deposit_id
+        @file_content = file_content
+        @is_front_side = is_front_side
+      end
+    end
+  end
+end

data/lib/unit/utils/http_helper.rb

@@ -6,8 +6,9 @@ require "json"
 
 module HttpHelper
   VALUES = [:"filter[searchRadius]"].freeze
-  def self.get(url, headers:, params: nil)
-    make_request(Net::HTTP::Get, url, headers, params: params)
+  RESPONSE_TYPES = %w[delete image].freeze
+  def self.get(url, headers:, params: nil, response_type: nil)
+    make_request(Net::HTTP::Get, url, headers, params: params, response_type: response_type)
   end
 
   def self.post(url, headers:, body: nil)
@@ -22,11 +23,11 @@ module HttpHelper
     make_request(Net::HTTP::Patch, url, headers, body: body)
   end
 
-  def self.delete(url, headers:, body: nil)
-    make_request(Net::HTTP::Delete, url, headers, body: body)
+  def self.delete(url, headers:, body: nil, response_type: nil)
+    make_request(Net::HTTP::Delete, url, headers, body: body, response_type: response_type)
   end
 
-  def self.make_request(net_http, url, headers, body: nil, params: nil)
+  def self.make_request(net_http, url, headers, body: nil, params: nil, response_type: nil)
     uri = params.nil? ? URI(url) : URI("#{url}?#{encode(params)}")
     host = uri.host.to_s
     port = uri.port
@@ -36,13 +37,13 @@ module HttpHelper
       request = net_http.new uri, headers
       request.body = body unless body.nil?
       response = http.request request
-      response.body = response_check(response)
+      response.body = response_check(response, response_type)
       response
     end
   end
 
-  def self.response_check(response)
-    if response.body.include?("html") || response.body.include?("PDF")
+  def self.response_check(response, response_type = nil)
+    if RESPONSE_TYPES.include?(response_type) || response.body.include?("html") || response.body.include?("PDF")
       response.body
     else
       JSON.parse(response.body)

data/lib/unit/version.rb

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

data/lib/unit_ruby_sdk.rb

@@ -12,6 +12,7 @@ module Unit
   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"
   module Resource
     autoload :ApplicationResource, "unit/api_resources/application_resource"
     autoload :CustomerResource, "unit/api_resources/customer_resource"
@@ -22,6 +23,7 @@ module Unit
     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"
   end
 
   module Types

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Unit
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -100,6 +100,7 @@ files:
 - lib/unit/api_resources/atm_location_resource.rb
 - 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/customer_resource.rb
 - lib/unit/api_resources/payment_resource.rb
 - lib/unit/api_resources/statement_resource.rb
@@ -136,6 +137,13 @@ files:
 - lib/unit/models/card/create_individual_virtual_card_request.rb
 - lib/unit/models/card/list_card_params.rb
 - lib/unit/models/card/replace_card_request.rb
+- lib/unit/models/check_deposit/check_deposit.rb
+- lib/unit/models/check_deposit/create_check_deposit_request.rb
+- lib/unit/models/check_deposit/get_image_request.rb
+- lib/unit/models/check_deposit/get_request.rb
+- 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/customer/add_authorized_users_request.rb
 - lib/unit/models/customer/archive_customer_request.rb
 - lib/unit/models/customer/customer.rb