unit_ruby_sdk 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14fc2502ef67bd580d1fb1d8ed06af33d22d99161bce1fa79ea98ac7acc9dad6
-  data.tar.gz: c0df3342ca09be9cb8f3ded2ff6717f188620716b0a8118b7850a19143b0ab4e
+  metadata.gz: e391082a9b8407e9e7ff1848ef06235d65aa3254b6c52ce5548bd4ad02534485
+  data.tar.gz: 85d795785020ef391810521d23404e989201943ab4a41ca9ab762b1bad068612
 SHA512:
-  metadata.gz: 1270a0a50b9e23a8608716098ea341708a18233d290e124416aed5be9a564a28e4c4d7b4f1c59a8224e74ae54746dc51c3908bdf1bb790df79dc810ba173602f
-  data.tar.gz: 5f4fac2c94ec93621ca4541ebc9c80a1bc0f2c0590f8503a1133d7b4fe437b783c0488ea42665f771d212c7959ac91837229f7917eec148ea7246e272a78a066
+  metadata.gz: 54185c5b5bca29ededcf81ed28d193fcf72c2012206f7a4bf095f3f58d958ec52e0f1c31ea34738ec675f3dcb4e1045f339ca6bb842298a736ae4af784e7bb0e
+  data.tar.gz: c9b2abeae465e2d34cdcb2c83f48565416fe2874ea983ced5eca080c6ee8b746675d3813e33dd5bb5fdc95d5ef01091360b4c51eedadcaf5760bb9e47d0a355a

data/README.md

@@ -14,6 +14,8 @@ gem install unit_ruby_sdk
 
 ## Usage
 
+ Bellow are a few exapmles of the Ruby SDK application. For full documentation of the Unit API please refer to the full documentation at https://docs.unit.co/
+
 ### Creating a Business Application
 
 ```ruby
@@ -45,6 +47,19 @@ response = Unit::Application.create_business_application(
 application = response.data
 
 puts application.id
+
+file = File.open("./spec/test.pdf", "rb")
+contents = file.read
+file.close
+
+upload_document_request = Unit::Application.upload_document(
+  application_id: "836683", 
+  document_id: "125214", 
+  file: contents, 
+  file_type: Unit::Types::DocumentFileType::PDF, 
+  is_back_side: true)
+
+puts upload_document_request.data.id
 ```
 
 ### Fetching a Customer
@@ -65,10 +80,10 @@ puts customer.id
 require 'unit_ruby_sdk'
 
 response = Unit::Payment.create_book_payment(
-  amount: 10000,
-  description: 'Payment for order #123',
-  relationships: { account: Unit::Types::Relationship.new("depositAccount", "12345").to_hash,
-                   counterpartyAccount: Unit::Types::Relationship.new("depositAccount", "36221").to_hash }
+  amount: 1000, 
+  description: "test payment", 
+  account_id: "27573", 
+  counterparty_account_id: "36981"
 )
 payment = response.data
 puts payment.id
@@ -82,6 +97,19 @@ transaction = response.data
 puts transaction.id
 ```
 
+### Creating an individual debit card
+```ruby
+response = Unit::Card.create_individual_debit_card(
+  account_id: '1234',
+  type: "depositAccount",
+  shipping_address: address,
+  design: "default",
+  additional_embossed_text: "Second Cardholder"
+)
+card = response.data
+puts card.id
+```
+
 ### Logging Errors
 
 ```ruby

data/lib/unit/api_resources/atm_location_resource.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+
+module Unit
+  module Resource
+    class AtmLocationResource < Unit::Resource::BaseResource
+      class << self
+        # Get a list of ATM locations by calling Unit's API
+        # @param params [ListByCoordinatesParams, ListByAddressParams, ListByPostalCodeParams] The parameters to use to get a list of ATM locations
+        # @return [Unit::Response] The response from Unit's API
+        def list(params = nil)
+          response = HttpHelper.get("#{api_url}/atm-locations", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/base_resource.rb

@@ -11,6 +11,10 @@ module Unit
           handler.from_json_api(response)
         end
 
+        def file_response_handler(response)
+          response.code.to_i.between?(200, 299) ? response.body : Unit::UnitError
+        end
+
         protected
 
         def api_url
@@ -25,7 +29,7 @@ module Unit
           {
             "Content-Type" => "application/vnd.api+json",
             "Authorization" => "Bearer #{Unit.config[:token]}",
-            "User-Agent" => "unit-ruby-sdk"
+            "X-UNIT-SDK" => "unit-ruby-sdk@v#{Unit::VERSION}"
           }
         end
       end

data/lib/unit/api_resources/card_resource.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+# class for creating requests for cards to Unit API and parsing responses
+# @see https://docs.unit.co/cards
+module Unit
+  module Resource
+    class CardResource < Unit::Resource::BaseResource
+      class << self
+        # Create a new card by calling Unit's API
+        # @param [CreateIndividualDebitCardRequest, CreateIndividualVirtualCardRequest] request
+        # @return [UnitResponse, UnitError]
+        def create_card(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/cards", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get pin status by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def get_pin_status(card_id)
+          response = HttpHelper.get("#{api_url}/cards/#{card_id}/secure-data/pin/status", headers: headers)
+          response_handler(response)
+        end
+
+        # Report a card as a stolen by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def report_stolen(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/report-stolen", headers: headers)
+          response_handler(response)
+        end
+
+        # Report a card as a lost by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def report_lost(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/report-lost", headers: headers)
+          response_handler(response)
+        end
+
+        # Close a card by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def close_card(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/close", headers: headers)
+          response_handler(response)
+        end
+
+        # Freeze a card by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def freeze_card(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/freeze", headers: headers)
+          response_handler(response)
+        end
+
+        # Unfreeze a card by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def unfreeze_card(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/unfreeze", headers: headers)
+          response_handler(response)
+        end
+
+        # Replace a card by calling Unit's API
+        # @param request [ReplaceCardRequest]
+        # @return [UnitResponse, UnitError]
+        def replace_card(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/cards/#{request.card_id}/replace", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a card by id by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def get_card(card_id)
+          response = HttpHelper.get("#{api_url}/cards/#{card_id}", headers: headers)
+          response_handler(response)
+        end
+
+        # List cards by calling Unit's API
+        # @param params [ListCardParams]
+        # @return [UnitResponse, UnitError]
+        def list_cards(params = nil)
+          response = HttpHelper.get("#{api_url}/cards", params: params&.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Get card limits by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def limits(card_id)
+          response = HttpHelper.get("#{api_url}/cards/#{card_id}/limits", headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/statement_resource.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+# class for creating requests for statements to Unit API and parsing responses
+# @see https://docs.unit.co/cards
+module Unit
+  module Resource
+    class StatementResource < Unit::Resource::BaseResource
+      class << self
+        # Get statements by calling Unit's API
+        # @param params [ListStatementParams]
+        # @return [UnitResponse, UnitError]
+        def list(params = nil)
+          response = HttpHelper.get("#{api_url}/statements", params: params&.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a html statement by id by calling Unit's API
+        # @param params [GetHtmlByIdRequest]
+        # @return [UnitResponse, UnitError]
+        def get_html_by_id(request)
+          response = HttpHelper.get("#{api_url}/statements/#{request.statement_id}/html", params: request.to_hash, headers: headers)
+          file_response_handler(response)
+        end
+
+        # Get a pdf statement by id by calling Unit's API
+        # @param request [GetPdfByIdRequest]
+        # @return [UnitResponse, UnitError]
+        def get_pdf_by_id(request)
+          response = HttpHelper.get("#{api_url}/statements/#{request.statement_id}/pdf", params: request.to_hash, headers: headers)
+          file_response_handler(response)
+        end
+
+        # Get bank verification by calling Unit's API
+        # @param request [GetBankVerificationRequest]
+        # @return [UnitResponse, UnitError]
+        def get_bank_verification(request)
+          response = HttpHelper.get("#{api_url}/statements/#{request.account_id}/bank/pdf", params: request&.to_hash, headers: headers)
+          file_response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/api_token/org/create_api_token_request.rb

@@ -10,7 +10,7 @@ module Unit
 
         # @param user_id [String]
         # @param description [String]
-        # @param scope [String]
+        # @param scope [Array<String>]
         # @param expiration [String]
         # @param source_ip [String] - optional
         # @param resources [Array<RestrictedResource>] - optional
@@ -27,7 +27,7 @@ module Unit
           result = { data: { type: "apiToken",
                              attributes:
                                { description: description,
-                                 scope: scope,
+                                 scope: scope.join(" "),
                                  expiration: expiration,
                                  sourceIp: source_ip,
                                  resources: resources } } }

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

@@ -111,11 +111,8 @@ module Unit
       # Upload an application document by calling Unit's API
       # @param application_id [String] The application ID
       # @param document_id [String] The document ID
-      # @param file [String] The file path
-      # @param file_type [String] The file type
-      # @option file_type [String] :pdf
-      # @option file_type [String] :jpg
-      # @option file_type [String] :png
+      # @param file [String] The file content
+      # @param file_type [String] The file type. One of the Unit::Types::DocumentFileType constants.
       # @param is_back_side [Boolean] The file is back side
       # @return [UnitResponse, UnitError]
       def upload_document(application_id:, document_id:, file:, file_type:, is_back_side: false)

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

@@ -9,11 +9,8 @@ module Unit
 
       # @param application_id [String] The application ID
       # @param document_id [String] The document ID
-      # @param file [String] The file path
-      # @param file_type [String] The file type
-      # @option file_type [String] :pdf
-      # @option file_type [String] :jpg
-      # @option file_type [String] :png
+      # @param file [String] The file content
+      # @param file_type [String] The file type. One of the Unit::Types::DocumentFileType constants.
       # @param is_back_side [Boolean] The file is back side
       def initialize(application_id, document_id, file, file_type, is_back_side: false)
         @application_id = application_id

data/lib/unit/models/atm_location/atm_location.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Unit
+  module AtmLocation
+    autoload :ListByCoordinatesParams, "unit/models/atm_location/list_by_coordinates_params"
+    autoload :ListByAddressParams, "unit/models/atm_location/list_by_address_params"
+    autoload :ListByPostalCodeParams, "unit/models/atm_location/list_by_postal_code_params"
+
+    class << self
+      # Get a list of ATM locations by coordinates by calling Unit's API
+      # @see https://docs.unit.co/cards-atm-locations#list-atm-locations-by-coordinates
+      # @param coordinates [Coordinates]
+      # @param search_radius [Integer] - optional
+      def list_by_coordinates(coordinates:, search_radius: nil)
+        params = ListByCoordinatesParams.new(coordinates, search_radius)
+        Unit::Resource::AtmLocationResource.list(params)
+      end
+
+      # Get a list of ATM locations by postal code by calling Unit's API
+      # @see https://docs.unit.co/cards-atm-locations#list-atm-locations-by-postal-code
+      # @param postal_code [String]
+      # @param search_radius [Integer] - optional
+      def list_by_postal_code(postal_code:, search_radius: nil)
+        params = ListByPostalCodeParams.new(postal_code, search_radius)
+        Unit::Resource::AtmLocationResource.list(params)
+      end
+
+      # Get a list of ATM locations by address by calling Unit's API
+      # @see https://docs.unit.co/cards-atm-locations#list-atm-locations-by-address
+      # @param address [Address]
+      # @param search_radius [Integer] - optional
+      def list_by_address(address:, search_radius: nil)
+        params = ListByAddressParams.new(address, search_radius)
+        Unit::Resource::AtmLocationResource.list(params)
+      end
+    end
+  end
+end

data/lib/unit/models/atm_location/list_by_address_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# params fot list atm locations by address
+# @see
+module Unit
+  module AtmLocation
+    class ListByAddressParams
+      attr_reader :address, :search_radius
+
+      # @param address [Address]
+      # @param search_radius [Integer]
+      def initialize(address, search_radius = nil)
+        @address = address
+        @search_radius = search_radius
+      end
+
+      def to_hash
+        params = {
+          "filter[address]": address.represent.to_json,
+          "filter[searchRadius]": search_radius
+        }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/atm_location/list_by_coordinates_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# params to list atm locations by coordinates
+# @see https://docs.unit.co/cards-atm-locations/#list-atm-locations-by-coordinates
+module Unit
+  module AtmLocation
+    class ListByCoordinatesParams
+      attr_reader :coordinates, :search_radius
+
+      # @param coordinates [Coordinates]
+      # @param search_radius [Integer]
+      def initialize(coordinates, search_radius = nil)
+        @coordinates = coordinates
+        @search_radius = search_radius
+      end
+
+      def to_hash
+        params = {
+          "filter[coordinates]": coordinates.represent,
+          "filter[searchRadius]": search_radius
+        }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/atm_location/list_by_postal_code_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# params to list atm locations by postal code
+# @see https://docs.unit.co/cards-atm-locations/#list-atm-locations-by-postal-code
+module Unit
+  module AtmLocation
+    class ListByPostalCodeParams
+      attr_reader :postal_code, :search_radius
+
+      # @param postal_code [String]
+      # @param search_radius [Integer]
+      def initialize(postal_code, search_radius = nil)
+        @postal_code = postal_code
+        @search_radius = search_radius
+      end
+
+      def to_hash
+        params = {
+          "filter[postalCode]": postal_code,
+          "filter[searchRadius]": search_radius
+        }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/card/card.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Unit
+  module Card
+    CARD_LIST_LIMIT = 100
+    CARD_LIST_OFFSET = 0
+    autoload :CreateIndividualDebitCardRequest, "unit/models/card/create_individual_debit_card_request"
+    autoload :CreateBusinessDebitCardRequest, "unit/models/card/create_business_debit_card_request"
+    autoload :CreateBusinessVirtualDebitCardRequest, "unit/models/card/create_business_virtual_debit_card_request"
+    autoload :CreateIndividualVirtualCardRequest, "unit/models/card/create_individual_virtual_card_request"
+    autoload :ReplaceCardRequest, "unit/models/card/replace_card_request"
+    autoload :ListCardParams, "unit/models/card/list_card_params"
+
+    class << self
+      # Create a new individual debit card by calling Unit's API
+      # @see https://docs.unit.co/cards#create-individual-debit-card
+      # @param account_id [String]
+      # @param shipping_address [Address] - optional
+      # @param design [String] - optional
+      # @param additional_embossed_text [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      # @param print_only_business_name [String] - optional
+      def create_individual_debit_card(account_id:, customer_id: nil, shipping_address: nil, design: nil, additional_embossed_text: nil,
+                                       idempotency_key: nil, tags: nil, limits: nil, print_only_business_name: nil)
+        request = CreateIndividualDebitCardRequest.new(account_id, customer_id, shipping_address, design, additional_embossed_text,
+                                                       idempotency_key, tags, limits, print_only_business_name)
+        Unit::Resource::CardResource.create_card(request)
+      end
+
+      # Create a new business debit card by calling Unit's API
+      # @see https://docs.unit.co/cards#create-business-debit-card
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @param shipping_address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param design [String] - optional
+      # @param additional_embossed_text [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      # @param print_only_business_name [Boolean] - optional
+      def create_business_debit_card(account_id:, full_name:, date_of_birth:, address:, phone:, email:, shipping_address: nil,
+                                     design: nil, additional_embossed_text: nil, idempotency_key: nil, tags: nil, limits: nil, print_only_business_name: nil)
+        request = CreateBusinessDebitCardRequest.new(account_id, full_name, date_of_birth, address, shipping_address, phone, email, design, additional_embossed_text,
+                                                     idempotency_key, tags, limits, print_only_business_name)
+        Unit::Resource::CardResource.create_card(request)
+      end
+
+      # Create a new individual virtual card by calling Unit's API
+      # @see https://docs.unit.co/cards#create-individual-virtual-debit-card
+      # @param account_id [String]
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def create_individual_virtual_card(account_id:, customer_id: nil, idempotency_key: nil, tags: nil, limits: nil)
+        request = CreateIndividualVirtualCardRequest.new(account_id, customer_id, idempotency_key, tags, limits)
+        Unit::Resource::CardResource.create_card(request)
+      end
+
+      # Create a new business virtual card by calling Unit's API
+      # @see https://docs.unit.co/cards#create-business-virtual-debit-card
+      # @param account_id [String]
+      # @param type [String]
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def create_business_virtual_card(account_id:, full_name:, date_of_birth:, address:, phone: nil, email: nil, idempotency_key: nil, tags: nil, limits: nil)
+        request = CreateBusinessVirtualDebitCardRequest.new(account_id, full_name, date_of_birth, address, phone, email, idempotency_key, tags, limits)
+        Unit::Resource::CardResource.create_card(request)
+      end
+
+      # Get pin status by calling Unit's API
+      # @see https://docs.unit.co/cards#get-pin-status
+      # @param card_id [String]
+      def get_pin_status(card_id:)
+        Unit::Resource::CardResource.get_pin_status(card_id)
+      end
+
+      # Report a card as a stolen by calling Unit's API
+      # @param card_id [String]
+      def report_stolen(card_id:)
+        Unit::Resource::CardResource.report_stolen(card_id)
+      end
+
+      # Report a card as a lost by calling Unit's API
+      # @param card_id [String]
+      def report_lost(card_id:)
+        Unit::Resource::CardResource.report_lost(card_id)
+      end
+
+      # Close a card by calling Unit's API
+      # @param card_id [String]
+      def close_card(card_id:)
+        Unit::Resource::CardResource.close_card(card_id)
+      end
+
+      # Freeze a card by calling Unit's API
+      # @param card_id [String]
+      def freeze_card(card_id:)
+        Unit::Resource::CardResource.freeze_card(card_id)
+      end
+
+      # Unfreeze a card by calling Unit's API
+      # @param card_id [String]
+      def unfreeze_card(card_id:)
+        Unit::Resource::CardResource.unfreeze_card(card_id)
+      end
+
+      # Replace a card by calling Unit's API
+      # @param card_id [String]
+      # @param shipping_address [Address] - optional
+      def replace_card(card_id:, shipping_address: nil)
+        request = ReplaceCardRequest.new(card_id, shipping_address)
+        Unit::Resource::CardResource.replace_card(request)
+      end
+
+      # Get a card by id by calling Unit's API
+      # @param card_id [String]
+      def get_card(card_id:)
+        Unit::Resource::CardResource.get_card(card_id)
+      end
+
+      # List cards by calling Unit's API
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param tags [Hash] - optional
+      # @param status [Array<String>] - optional
+      # @param include [Array] - optional
+      # @param sort [String] - optional
+      def list_cards(limit: CARD_LIST_LIMIT, offset: CARD_LIST_OFFSET, account_id: nil,
+                     customer_id: nil, tags: nil, status: nil, include: nil, sort: nil)
+        request = ListCardParams.new(limit, offset, account_id, customer_id, tags, status, include, sort)
+        Unit::Resource::CardResource.list_cards(request)
+      end
+
+      # Get a card limits by calling Unit's API
+      # @param card_id [String]
+      def limits(card_id:)
+        Unit::Resource::CardResource.limits(card_id)
+      end
+    end
+  end
+end

data/lib/unit/models/card/create_business_debit_card_request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Request to create business debit card request
+# @see https://docs.unit.co/cards#create-business-debit-card
+module Unit
+  module Card
+    class CreateBusinessDebitCardRequest
+      attr_reader :account_id, :full_name, :date_of_birth, :address, :shipping_address, :phone, :email, :design, :additional_embossed_text, :idempotency_key, :tags, :limits, :print_only_business_name
+
+      # @param account_id [String]
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @param shipping_address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param design [String] - optional
+      # @param additional_embossed_text [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      # @param print_only_business_name [Boolean] - optional
+      def initialize(account_id, full_name, date_of_birth, address, shipping_address = nil, phone = nil, email = nil, design = nil,
+                     additional_embossed_text = nil, idempotency_key = nil, tags = nil, limits = nil, print_only_business_name = nil)
+        @account_id = account_id
+        @full_name = full_name
+        @date_of_birth = date_of_birth
+        @address = address
+        @shipping_address = shipping_address
+        @phone = phone
+        @email = email
+        @design = design
+        @additional_embossed_text = additional_embossed_text
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @limits = limits
+        @print_only_business_name = print_only_business_name
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "businessDebitCard",
+            "attributes": {
+              "fullName": full_name&.represent,
+              "dateOfBirth": date_of_birth,
+              "address": address&.represent,
+              "shippingAddress": shipping_address,
+              "phone": phone&.represent,
+              "email": email,
+              "design": design,
+              "additionalEmbossedText": additional_embossed_text,
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "limits": limits,
+              "printOnlyBusinessName": print_only_business_name
+            },
+            "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/card/create_business_virtual_debit_card_request.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Request to create a business virtual debit card
+# @see https://docs.unit.co/cards#create-business-virtual-debit-card
+module Unit
+  module Card
+    class CreateBusinessVirtualDebitCardRequest
+      attr_reader :account_id, :full_name, :date_of_birth, :address, :phone, :email, :idempotency_key, :tags, :limits
+
+      # @param account_id [String]
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def initialize(account_id, full_name, date_of_birth, address, phone, email,
+                     idempotency_key, tags, limits)
+        @account_id = account_id
+        @full_name = full_name
+        @date_of_birth = date_of_birth
+        @address = address
+        @phone = phone
+        @email = email
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @limits = limits
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "businessVirtualDebitCard",
+            "attributes": {
+              "fullName": full_name&.represent,
+              "dateOfBirth": date_of_birth,
+              "address": address&.represent,
+              "phone": phone&.represent,
+              "email": email,
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "limits": limits
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/card/create_individual_debit_card_request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Request to create individual debit card request
+# @see https://docs.unit.co/cards#create-individual-debit-card
+module Unit
+  module Card
+    class CreateIndividualDebitCardRequest
+      attr_reader :account_id, :customer_id, :shipping_address, :design, :additional_embossed_text, :idempotency_key, :tags, :limits, :print_only_business_name
+
+      # @param account_id [String]
+      # @param customer_id [String] - optional
+      # @param shipping_address [Address] - optional
+      # @param design [String] - optional
+      # @param additional_embossed_text [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      # @param print_only_business_name [Boolean] - optional
+      def initialize(account_id, customer_id = nil, shipping_address = nil, design = nil, additional_embossed_text = nil,
+                     idempotency_key = nil, tags = nil, limits = nil, print_only_business_name = nil)
+        @account_id = account_id
+        @customer_id = customer_id
+        @shipping_address = shipping_address
+        @design = design
+        @additional_embossed_text = additional_embossed_text
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @limits = limits
+        @print_only_business_name = print_only_business_name
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "individualDebitCard",
+            "attributes": {
+              "shippingAddress": shipping_address&.represent,
+              "design": design,
+              "additionalEmbossedText": additional_embossed_text,
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "limits": limits,
+              "printOnlyBusinessName": print_only_business_name
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash
+            }
+          }
+        }
+        customer = { "customer": Unit::Types::Relationship.new("customer", customer_id).to_hash } unless customer_id.nil?
+        payload[:data][:relationships].merge!(customer) unless customer.nil?
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/card/create_individual_virtual_card_request.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Request to create individual virtual card
+# @see https://docs.unit.co/cards#create-individual-virtual-debit-card
+module Unit
+  module Card
+    class CreateIndividualVirtualCardRequest
+      attr_reader :account_id, :customer_id, :idempotency_key, :tags, :limits
+
+      # @param account_id [String]
+      # @param customer_id [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def initialize(account_id, customer_id = nil, idempotency_key = nil, tags = nil, limits = nil)
+        @account_id = account_id
+        @customer_id = customer_id
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @limits = limits
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "individualVirtualDebitCard",
+            "attributes": {
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "limits": limits
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash
+            }
+          }
+        }
+        customer = { "customer": Unit::Types::Relationship.new("customer", customer_id).to_hash } unless customer_id.nil?
+        payload[:data][:relationships].merge!(customer) unless customer.nil?
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/card/list_card_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Request to list cards
+# @see https://docs.unit.co/cards#list-cards
+module Unit
+  module Card
+    class ListCardParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :tags, :status, :include, :sort
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param tags [String] - optional
+      # @param status [Array<String>] - optional
+      # @param include [Array] - optional
+      # @param sort [String] - optional
+      def initialize(limit = CARD_LIST_LIMIT, offset = CARD_LIST_OFFSET, account_id = nil,
+                     customer_id = nil, tags = nil, status = nil, include = nil, sort = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @tags = tags
+        @status = status
+        @include = include
+        @sort = sort
+      end
+
+      def to_hash
+        params = { "page[limit]": limit,
+                   "page[offset]": offset,
+                   "filter[accountId]": account_id,
+                   "filter[customerId]": customer_id,
+                   "filter[tags]": tags,
+                   "include": include&.join(","),
+                   "sort": sort }
+        status&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[status][#{index}]": val })
+        end
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/card/replace_card_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Request to replace a card
+# @see https://docs.unit.co/cards#replace-card
+module Unit
+  module Card
+    class ReplaceCardRequest
+      attr_reader :card_id, :shipping_address
+
+      # @param card_id [String]
+      # @param shipping_address [Address] - optional
+      def initialize(card_id, shipping_address = nil)
+        @card_id = card_id
+        @shipping_address = shipping_address
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "replaceCard",
+            "attributes": {
+              "shippingAddress": shipping_address&.represent
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/statement/get_bank_verification_pdf.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Request to get bank verification pdf
+# @see https://docs.unit.co/statements#get-bank-verification-pdf
+module Unit
+  module Statement
+    class GetBankVerificationPdf
+      attr_accessor :account_id, :include_proof_of_funds
+
+      # @param account_id [String]
+      # @param include_proof_of_funds [Boolean]
+      def initialize(account_id, include_proof_of_funds: false)
+        @account_id = account_id
+        @include_proof_of_funds = include_proof_of_funds
+      end
+
+      def to_hash
+        params = { "includeProofOfFunds": include_proof_of_funds }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/statement/get_html_by_id_request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Request to get html by id
+# @see https://docs.unit.co/statements#get-statement-html
+module Unit
+  module Statement
+    class GetHtmlByIdRequest
+      attr_accessor :statement_id, :customer_id, :language
+
+      # @param statement_id [String]
+      # @param customer_id [String]
+      # @param language [String]
+      def initialize(statement_id, customer_id, language = nil)
+        @statement_id = statement_id
+        @customer_id = customer_id
+        @language = language
+      end
+
+      def to_hash
+        params = { "filter[customerId]": customer_id,
+                   "language": language }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/statement/get_pdf_by_id_request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Request to get pdf by id
+# @see https://docs.unit.co/statements#get-statement-pdf
+module Unit
+  module Statement
+    class GetPdfByIdRequest
+      attr_accessor :statement_id, :customer_id, :language
+
+      # @param statement_id [String]
+      # @param customer_id [String]
+      # @param language [String]
+      def initialize(statement_id, customer_id, language = nil)
+        @statement_id = statement_id
+        @customer_id = customer_id
+        @language = language
+      end
+
+      def to_hash
+        params = { "filter[customerId]": customer_id,
+                   "language": language }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/statement/list_statement_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Request to list statements
+# @see https://docs.unit.co/statements#list-statements
+module Unit
+  module Statement
+    class ListStatementParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :period, :sort
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param period [String] - optional
+      # @param sort [String] - optional
+      def initialize(limit = STATEMENT_LIST_LIMIT, offset = STATEMENT_LIST_OFFSET,
+                     account_id = nil, customer_id = nil, period = nil, sort = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @period = period
+        @sort = sort
+      end
+
+      def to_hash
+        params = { "page[limit]": limit,
+                   "page[offset]": offset,
+                   "filter[accountId]": account_id,
+                   "filter[customerId]": customer_id,
+                   "filter[period]": period,
+                   "sort": sort }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/statement/statement.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Unit
+  module Statement
+    STATEMENT_LIST_LIMIT = 100
+    STATEMENT_LIST_OFFSET = 0
+    autoload :ListStatementParams, "unit/models/statement/list_statement_params"
+    autoload :GetPdfByIdRequest, "unit/models/statement/get_pdf_by_id_request"
+    autoload :GetHtmlByIdRequest, "unit/models/statement/get_html_by_id_request"
+    autoload :GetBankVerificationPdf, "unit/models/statement/get_bank_verification_pdf"
+
+    class << self
+      # List statements
+      # @see https://docs.unit.co/statements#list-statements
+      # @param limit [Integer]
+      # @param offset [Integer]
+      # @param account_id [String]
+      # @param customer_id [String]
+      # @param period [String]
+      # @param sort [String]
+      def list_statements(limit: STATEMENT_LIST_LIMIT, offset: STATEMENT_LIST_OFFSET,
+                          account_id: nil, customer_id: nil, period: nil, sort: nil)
+        params = ListStatementParams.new(limit, offset, account_id, customer_id, period, sort)
+        Unit::Resource::StatementResource.list(params)
+      end
+
+      # Get statement pdf by id
+      # @see https://docs.unit.co/statements#get-statement-pdf
+      # @param customer_id [String]
+      # @param language [String]
+      def get_pdf_by_id(statement_id:, customer_id:, language: nil)
+        request = GetPdfByIdRequest.new(statement_id, customer_id, language)
+        Unit::Resource::StatementResource.get_pdf_by_id(request)
+      end
+
+      # Get statement html by id
+      # @see https://docs.unit.co/statements#get-statement-html
+      # @param customer_id [String]
+      # @param language [String]
+      def get_html_by_id(statement_id:, customer_id:, language: nil)
+        request = GetHtmlByIdRequest.new(statement_id, customer_id, language)
+        Unit::Resource::StatementResource.get_html_by_id(request)
+      end
+
+      # Get a bank verification pdf
+      # @see https://docs.unit.co/statements#get-bank-verification-pdf
+      # @param account_id [String]
+      # @param include_proof_of_funds [Boolean]
+      def get_bank_verification_pdf(account_id:, include_proof_of_funds: false)
+        request = GetBankVerificationPdf.new(account_id, include_proof_of_funds: include_proof_of_funds)
+        Unit::Resource::StatementResource.get_bank_verification(request)
+      end
+    end
+  end
+end

data/lib/unit/types/coordinates.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Unit
+  module Types
+    class Coordinates
+      attr_reader :latitude, :longitude
+
+      # @param latitude [Float] The latitude
+      # @param longitude [Float] The longitude
+      def initialize(latitude, longitude)
+        @latitude = latitude
+        @longitude = longitude
+      end
+
+      def represent
+        params = {
+          longitude: longitude,
+          latitude: latitude
+        }
+        params.compact.to_json
+      end
+    end
+  end
+end

data/lib/unit/types/document_file_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Unit
+  module Types
+    class DocumentFileType
+      PDF = "pdf"
+      JPG = "jpg"
+      PNG = "png"
+    end
+  end
+end

data/lib/unit/utils/http_helper.rb

@@ -5,6 +5,7 @@ require "net/http"
 require "json"
 
 module HttpHelper
+  VALUES = [:"filter[searchRadius]"].freeze
   def self.get(url, headers:, params: nil)
     make_request(Net::HTTP::Get, url, headers, params: params)
   end
@@ -35,12 +36,20 @@ module HttpHelper
       request = net_http.new uri, headers
       request.body = body unless body.nil?
       response = http.request request
-      response.body = JSON.parse(response.body)
+      response.body = response_check(response)
       response
     end
   end
 
-  def self.encode(value, key = nil)
+  def self.response_check(response)
+    if response.body.include?("html") || response.body.include?("PDF")
+      response.body
+    else
+      JSON.parse(response.body)
+    end
+  end
+
+  def self.value_check(value, key = nil)
     case value
     when Hash then value.map { |k, v| encode(v, append_key(key, k)) }.join("&")
     when Array then value.map { |v| encode(v, "#{key}[]") }.join("&")
@@ -50,6 +59,10 @@ module HttpHelper
     end
   end
 
+  def self.encode(value, key = nil)
+    value.instance_of?(Hash) && value.key?(VALUES.map { |val| val }) ? value.map { |k, v| "#{k}=#{v}" }.join("&") : value_check(value, key)
+  end
+
   def self.append_key(root_key, key)
     root_key.nil? ? key : "#{root_key}[#{key}]"
   end

data/lib/unit/version.rb

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

data/lib/unit_ruby_sdk.rb

@@ -9,7 +9,9 @@ module Unit
   autoload :ApiToken, "unit/models/api_token/api_token"
   autoload :Payment, "unit/models/payment/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"
   module Resource
     autoload :ApplicationResource, "unit/api_resources/application_resource"
     autoload :CustomerResource, "unit/api_resources/customer_resource"
@@ -17,6 +19,9 @@ module Unit
     autoload :ApiTokenResource, "unit/api_resources/api_token_resource"
     autoload :PaymentResource, "unit/api_resources/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"
   end
 
   module Types
@@ -33,6 +38,8 @@ module Unit
     autoload :Relationship, "unit/types/relationship"
     autoload :RelationshipArray, "unit/types/relationship_array"
     autoload :RestrictedResource, "unit/types/restricted_resource"
+    autoload :DocumentFileType, "unit/types/document_file_type"
+    autoload :Coordinates, "unit/types/coordinates"
   end
 
   autoload :UnitErrorPayload, "unit/errors/unit_error_payload"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Unit
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-22 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -97,9 +97,12 @@ files:
 - lib/unit/api_resources/account_resource.rb
 - lib/unit/api_resources/api_token_resource.rb
 - lib/unit/api_resources/application_resource.rb
+- 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/customer_resource.rb
 - lib/unit/api_resources/payment_resource.rb
+- lib/unit/api_resources/statement_resource.rb
 - lib/unit/api_resources/transaction_resource.rb
 - lib/unit/errors/unit_error.rb
 - lib/unit/errors/unit_error_payload.rb
@@ -122,6 +125,17 @@ files:
 - lib/unit/models/application/list_application_params.rb
 - lib/unit/models/application/patch_application_request.rb
 - lib/unit/models/application/upload_document_request.rb
+- lib/unit/models/atm_location/atm_location.rb
+- lib/unit/models/atm_location/list_by_address_params.rb
+- lib/unit/models/atm_location/list_by_coordinates_params.rb
+- lib/unit/models/atm_location/list_by_postal_code_params.rb
+- lib/unit/models/card/card.rb
+- lib/unit/models/card/create_business_debit_card_request.rb
+- lib/unit/models/card/create_business_virtual_debit_card_request.rb
+- lib/unit/models/card/create_individual_debit_card_request.rb
+- 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/customer/add_authorized_users_request.rb
 - lib/unit/models/customer/archive_customer_request.rb
 - lib/unit/models/customer/customer.rb
@@ -132,6 +146,11 @@ files:
 - lib/unit/models/payment/create_book_payment_request.rb
 - lib/unit/models/payment/patch_book_payment_request.rb
 - lib/unit/models/payment/payment.rb
+- lib/unit/models/statement/get_bank_verification_pdf.rb
+- lib/unit/models/statement/get_html_by_id_request.rb
+- lib/unit/models/statement/get_pdf_by_id_request.rb
+- lib/unit/models/statement/list_statement_params.rb
+- lib/unit/models/statement/statement.rb
 - lib/unit/models/transaction/get_transaction_params.rb
 - lib/unit/models/transaction/list_transaction_params.rb
 - lib/unit/models/transaction/patch_tags_request.rb
@@ -142,7 +161,9 @@ files:
 - lib/unit/types/authorized_user.rb
 - lib/unit/types/beneficial_owner.rb
 - lib/unit/types/business_contact.rb
+- lib/unit/types/coordinates.rb
 - lib/unit/types/device_fingerprint.rb
+- lib/unit/types/document_file_type.rb
 - lib/unit/types/evaluation_params.rb
 - lib/unit/types/full_name.rb
 - lib/unit/types/officer.rb