unit_ruby_sdk 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf85eb968fc7cac1337e5093a9c5998a98997ad7f37956e79c45498785b08ffb
-  data.tar.gz: e60405762229150510a2e82b76d25aecc547c009c287ca694ef95611e2319c28
+  metadata.gz: 5b262e1336d0a6f1e2a6633172d3fe0fb030eb658e3a30ced02803e6f00bd22d
+  data.tar.gz: cbcb03bfba7390d4b27e5b1485d5f60c66fbc50104d4066764c482a3fd2ecb12
 SHA512:
-  metadata.gz: 91ea490c2a75df07cf37281fc32aef9965767fbbcbe12b035a8caf500e3fd08bd23dc2b8eb5c522eef2491885a13c4053ad9c3b0c906925ea077c42ab27c4452
-  data.tar.gz: 4c687d3bd7a49d5c0bf4c113b20aabf42e1fcfec5381165ced6fb5f45825565bd5ab058529c97224d6d3680df936663589f02011de0b2b636429af8174b37d29
+  metadata.gz: 35379395a2258233b3b9cff6cc239fde4aeee3ba43b7b423a6da5508e1b4ed2ca0aae735cad7d5bda0ef539816b761d44b1071f637f167010708704c37bb6fff
+  data.tar.gz: 291d0580135e0832bead828127eb3341f740d9cd4b9cb131349fcda06a7700dd02aae5b1cb179de9ac09eda3b347304566b370f19f7eaccfc002b2c1582f995e

data/README.md

@@ -62,6 +62,28 @@ upload_document_request = Unit::Application.upload_document(
 puts upload_document_request.data.id
 ```
 
+### Creating a deposit account request
+```ruby
+relationships = { "customer": Unit::Types::Relationship.new("customer", "111009").to_hash }
+response = Unit::Account::Deposit.create_deposit_account(
+  deposit_product: "checking", 
+  tags: { "purpose": "checking" }, 
+  relationships: relationships)
+deposit_account = response.data
+puts deposit_account.id
+```
+
+### Creating a credit account request
+```ruby
+response = Unit::Account::Credit.create_credit_account(
+  credit_terms: "credit_terms_test", 
+  credit_limit: 20_000, 
+  customer_id: "851228", 
+  tags: { "purpose": "tax" })
+credit_account = response.data
+puts credit_account.id
+```
+
 ### Fetching a Customer
 
 ```ruby
@@ -133,6 +155,32 @@ counterparty = response.data
 puts counterparty.id
 ```
 
+
+### Creating a Payment to linked counterparty
+```ruby
+ response = Unit::Payment.create_ach_payment_linked(
+   account_id: "123456", 
+   counterparty_id: "56784", 
+   amount: 1000, 
+   direction: "Credit",
+   description: "test payment"
+ )
+ ach_payment = response.data
+ puts ach_payment.id
+```
+
+### Creating a wire payment
+```ruby
+ address = Unit::Types::Address.new('123 Main St', 'San Francisco', 'CA', '94205', 'US')
+ response = Unit::Payment.create_wire_payment(
+   account_id: "1234", 
+   amount: 1000, 
+   description: "test payment", 
+   counterparty: Unit::Types::WireCounterparty.new("Jane Doe", "27573", "812345678", address))
+ wire_payment = response.data
+ puts wire_payment.id
+```
+
 ### Logging Errors
 
 ```ruby

data/lib/unit/api_resources/account_resource.rb

@@ -98,7 +98,7 @@ module Unit
         # @param params [BalanceHistoryRequest]
         # @return [UnitResponse, UnitError]
         def get_account_balance_history(params)
-          response = HttpHelper.get("#{api_url}/account-end-of-day", params: params.to_hash.to_json, headers: headers)
+          response = HttpHelper.get("#{api_url}/account-end-of-day", params: params.to_hash, headers: headers)
           response_handler(response)
         end
 

data/lib/unit/api_resources/payment_resource.rb

@@ -3,14 +3,15 @@
 require_relative "./base_resource"
 require_relative "../utils/http_helper"
 
-# class for creating requests for book payments to Unit API and parsing responses
+# class for creating requests for payments to Unit API and parsing responses
 # @see https://docs.unit.co/book-payments#book-payments
+# @see https://docs.unit.co/ach-origination
 module Unit
   module Resource
     class PaymentResource < Unit::Resource::BaseResource
       class << self
-        # Create a new book payment by calling Unit's API
-        # @param request [CreatePaymentRequest]
+        # Create a new payment by calling Unit's API
+        # @param request [CreateAchPaymentInlineRequest, CreatePaymentLinkedRequest, CreateBookPaymentRequest, CreateWithPlaidTokenRequest, CreateWirePaymentRequest]
         # @return [UnitResponse, UnitError]
         def create_payment(request)
           payload = request.to_json_api
@@ -18,14 +19,32 @@ module Unit
           response_handler(response)
         end
 
-        # Update a book payment by calling Unit's API
-        # @param request [PatchBookPaymentRequest]
+        # Update a payment by calling Unit's API
+        # @param request [PatchBookPaymentRequest, PatchAchPaymentRequest]
         # @return [UnitResponse, UnitError]
         def update_payment(request)
           payload = request.to_json_api
           response = HttpHelper.patch("#{api_url}/payments/#{request.payment_id}", body: payload, headers: headers)
           response_handler(response)
         end
+
+        # Get a payment by calling Unit's API
+        # @param request [GetRequest]
+        # @return [UnitResponse, UnitError]
+        def get_payment(request)
+          payload = request.to_hash
+          response = HttpHelper.get("#{api_url}/payments/#{request.payment_id}", params: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # List payments by calling Unit's API
+        # @param request [ListPaymentParams]
+        # @return [UnitResponse, UnitError]
+        def list_payments(request)
+          payload = request.to_hash
+          response = HttpHelper.get("#{api_url}/payments", params: payload, headers: headers)
+          response_handler(response)
+        end
       end
     end
   end

data/lib/unit/api_resources/transaction_resource.rb

@@ -34,6 +34,15 @@ module Unit
           response = HttpHelper.patch("#{api_url}/accounts/#{request.account_id}/transactions/#{request.transaction_id}", body: payload, headers: headers)
           response_handler(response)
         end
+
+        # Update a transaction by calling Unit's API
+        # @param request [PatchBookTransactionRequest, PatchChargeTransactionRequest]
+        # @return [UnitResponse, UnitError]
+        def update_transaction(request)
+          payload = request.to_json_api
+          response = HttpHelper.patch("#{api_url}/transactions/#{request.transaction_id}", body: payload, headers: headers)
+          response_handler(response)
+        end
       end
     end
   end

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

@@ -153,5 +153,113 @@ module Unit
         end
       end
     end
+
+    module Credit
+      ACCOUNT_LIST_LIMIT = 100
+      ACCOUNT_LIST_OFFSET = 0
+      BALANCE_HISTORY_LIMIT = 100
+      BALANCE_HISTORY_OFFSET = 0
+      autoload :CreateAccountRequest, "unit/models/account/credit/create_account_request"
+      autoload :CloseAccountRequest, "unit/models/account/credit/close_account_request"
+      autoload :PatchAccountRequest, "unit/models/account/credit/patch_account_request"
+      autoload :BalanceHistoryRequest, "unit/models/account/credit/balance_history_request"
+      autoload :FreezeAccountRequest, "unit/models/account/credit/freeze_account_request"
+      autoload :ListAccountParams, "unit/models/account/credit/list_account_params"
+
+      class << self
+        # Create a credit account
+        # @see https://docs.unit.co/credit-accounts#create-credit-account
+        # @param credit_terms [String]
+        # @param credit_limit [Integer]
+        # @param customer_id [String] - optional
+        # @param tags [Hash] - optional
+        # @param idempotency_key [String] - optional
+        def create_credit_account(credit_terms:, credit_limit:, customer_id: nil, tags: nil, idempotency_key: nil)
+          request = CreateAccountRequest.new(credit_terms, credit_limit, customer_id, tags, idempotency_key)
+          Unit::Resource::AccountResource.create_account(request)
+        end
+
+        # Close a credit account
+        # @see https://docs.unit.co/credit-accounts#close-account
+        # @param account_id [String]
+        # @param reason [String]
+        # @param fraud_reason [String] - optional
+        def close_credit_account(account_id:, reason:, fraud_reason: nil)
+          request = CloseAccountRequest.new(account_id, reason, fraud_reason)
+          Unit::Resource::AccountResource.close_account(request)
+        end
+
+        # Get a credit account by id
+        # @see https://docs.unit.co/credit-accounts#get-specific-credit-account
+        # @param account_id [String]
+        def get_credit_account(account_id:)
+          Unit::Resource::AccountResource.get_account(account_id)
+        end
+
+        # Freeze credit account
+        # @see https://docs.unit.co/credit-accounts#freeze-account
+        # @param account_id [String]
+        # @param reason [String]
+        # @param reason_text [String] - optional
+        def freeze_credit_account(account_id:, reason:, reason_text: nil)
+          request = FreezeAccountRequest.new(account_id, reason, reason_text)
+          Unit::Resource::AccountResource.freeze_account(request)
+        end
+
+        # Unfreeze credit account
+        # @see https://docs.unit.co/credit-accounts#unfreeze-account
+        # @param account_id [String]
+        def unfreeze_credit_account(account_id:)
+          Unit::Resource::AccountResource.unfreeze_account(account_id)
+        end
+
+        # List credit accounts by calling Unit's API
+        # @see https://docs.unit.co/credit-accounts#list-credit-accounts
+        # @param limit [Integer] - optional
+        # @param offset [Integer] - optional
+        # @param customer_id [String] - optional
+        # @param tags [Hash] - optional
+        # @param status [Array<String>] - optional
+        # @param from_balance [Integer] - optional
+        # @param to_balance [Integer] - optional
+        # @param include [Array] - optional
+        # @param type [String] - optional
+        def list_credit_accounts(limit: ACCOUNT_LIST_LIMIT, offset: ACCOUNT_LIST_OFFSET, customer_id: nil, tags: nil,
+                                 status: nil, from_balance: nil, to_balance: nil, include: nil, type: nil)
+          request = ListAccountParams.new(limit, offset, customer_id, tags, status, from_balance, to_balance, include, type)
+          Unit::Resource::AccountResource.list_accounts(request)
+        end
+
+        # Update a credit account by calling Unit's API
+        # @see https://docs.unit.co/credit-accounts#update-accounts
+        # @param tags [Hash] - optional
+        # @param credit_limit [Integer] - optional
+        def update_credit_account(account_id:, tags: nil, credit_limit: nil)
+          request = PatchAccountRequest.new(account_id, tags, credit_limit)
+          Unit::Resource::AccountResource.update_account(request)
+        end
+
+        # Limit a credit account
+        # @see https://docs.unit.co/credit-accounts#account-limits
+        # @param account_id [String]
+        def limits(account_id:)
+          Unit::Resource::AccountResource.limits(account_id)
+        end
+
+        # Get account balance history by calling Unit's API
+        # @see https://docs.unit.co/credit-accounts#get-account-balance-history
+        # @param limit [Integer] - optional
+        # @param offset [Integer] - optional
+        # @param account_id [String] - optional
+        # @param customer_id [String] - optional
+        # @param since [String] - optional
+        # @param _until [String] - optional
+        def get_balance_history(limit = BALANCE_HISTORY_LIMIT, offset = BALANCE_HISTORY_OFFSET, account_id: nil, customer_id: nil,
+                                since: nil, _until: nil)
+          request = BalanceHistoryRequest.new(limit, offset, account_id, customer_id, since, _until)
+          Unit::Resource::AccountResource.get_account_balance_history(request)
+        end
+      end
+    end
   end
 end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Request to get the balance history of a credit account
+# @see https://docs.unit.co/credit-accounts/#get-account-balance-history
+module Unit
+  module Account
+    module Credit
+      class BalanceHistoryRequest
+        attr_reader :limit, :offset, :account_id, :customer_id, :since, :_until
+
+        # @param limit [Integer] - optional
+        # @param offset [Integer] - optional
+        # @param account_id [String] - optional
+        # @param customer_id [String] - optional
+        # @param since [String] - optional
+        # @param _until [String] - optional
+        def initialize(limit = BALANCE_HISTORY_LIMIT, offset = BALANCE_HISTORY_OFFSET, account_id = nil, customer_id = nil,
+                       since = nil, _until = nil)
+          @limit = limit
+          @offset = offset
+          @account_id = account_id
+          @customer_id = customer_id
+          @since = since
+          @_until = _until
+        end
+
+        def to_hash
+          params = { "page[limit]": limit,
+                     "page[offset]": offset,
+                     "filter[accountId]": account_id,
+                     "filter[customerId]": customer_id,
+                     "filter[since]": since,
+                     "filter[until]": _until }
+          params.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Request to close a credit account
+# @see https://docs.unit.co/credit-accounts/#close-account
+module Unit
+  module Account
+    module Credit
+      class CloseAccountRequest
+        attr_reader :account_id, :reason, :fraud_reason
+
+        # @param account_id [String]
+        # @param reason [String]
+        # @param fraud_reason [String] - optional
+        def initialize(account_id, reason, fraud_reason = nil)
+          @account_id = account_id
+          @reason = reason
+          @fraud_reason = fraud_reason
+        end
+
+        def to_json_api
+          payload = {
+            data: {
+              type: "creditAccountClose",
+              attributes: {
+                reason: reason,
+                fraudReason: fraud_reason
+              }
+            }
+          }
+          payload[:data][:attributes].compact!
+          payload.to_json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Request to create a deposit account
+# @see https://docs.unit.co/credit-accounts#create-credit-account
+module Unit
+  module Account
+    module Credit
+      class CreateAccountRequest
+        attr_reader :credit_terms, :credit_limit, :customer_id, :tags, :idempotency_key
+
+        # @param credit_terms [String]
+        # @param credit_limit [Integer]
+        # @param customer_id [String] - optional
+        # @param tags [Hash] - optional
+        # @param idempotency_key [String] - optional
+        def initialize(credit_terms, credit_limit, customer_id = nil, tags = nil, idempotency_key = nil)
+          @credit_terms = credit_terms
+          @credit_limit = credit_limit
+          @customer_id = customer_id
+          @tags = tags
+          @idempotency_key = idempotency_key
+        end
+
+        def to_json_api
+          payload = {
+            data: {
+              type: "creditAccount",
+              attributes: {
+                creditTerms: credit_terms,
+                creditLimit: credit_limit,
+                tags: tags
+              },
+              relationships: {
+                customer: Unit::Types::Relationship.new("customer", customer_id).to_hash
+              }
+            }
+          }
+          payload[:data][:attributes].compact!
+          payload.to_json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Request to freeze a credit account
+# @see https://docs.unit.co/credit-accounts#freeze-account
+module Unit
+  module Account
+    module Credit
+      class FreezeAccountRequest
+        attr_reader :account_id, :reason, :reason_text
+
+        # @param account_id [String]
+        # @param reason [String]
+        # @param reason_text [String] - optional
+        def initialize(account_id, reason, reason_text = nil)
+          @account_id = account_id
+          @reason = reason
+          @reason_text = reason_text
+        end
+
+        def to_json_api
+          payload = {
+            data: {
+              type: "creditAccountFreeze",
+              attributes: {
+                reason: reason,
+                reasonText: reason_text
+              }
+            }
+          }
+          payload[:data][:attributes].compact!
+          payload.to_json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# params for listing credit accounts
+# @see https://docs.unit.co/credit-accounts/#list-credit-accounts
+module Unit
+  module Account
+    module Credit
+      class ListAccountParams
+        attr_reader :limit, :offset, :customer_id, :tags, :status,
+                    :from_balance, :to_balance, :include, :type
+
+        # @param limit [Integer] - optional
+        # @param offset [Integer] - optional
+        # @param customer_id [String] - optional
+        # @param tags [Hash] - optional
+        # @param status [Array<String>] - optional
+        # @param from_balance [Integer] - optional
+        # @param to_balance [Integer] - optional
+        # @param include [Array] - optional
+        # @param type [String] - optional
+        def initialize(limit = ACCOUNT_LIST_LIMIT, offset = ACCOUNT_LIST_OFFSET, customer_id = nil, tags = nil,
+                       status = nil, from_balance = nil, to_balance = nil, include = nil, type = nil)
+          @limit = limit
+          @offset = offset
+          @customer_id = customer_id
+          @tags = tags
+          @status = status
+          @from_balance = from_balance
+          @to_balance = to_balance
+          @include = include
+          @type = type
+        end
+
+        def to_hash
+          params = { "page[limit]": limit,
+                     "page[offset]": offset,
+                     "filter[customerId]": customer_id,
+                     "filter[tags]": tags,
+                     "filter[fromBalance]": from_balance,
+                     "filter[toBalance]": to_balance,
+                     "filter[type]": type,
+                     "include": include&.join(",") }
+          status&.each_with_index&.map do |val, index|
+            params.merge!({ "filter[status][#{index}]": val })
+          end
+          params.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Request to update a credit account
+# @see https://docs.unit.co/credit-accounts#update-accounts
+module Unit
+  module Account
+    module Credit
+      class PatchAccountRequest
+        attr_reader :account_id, :tags, :credit_limit
+
+        # @param account_id [String]
+        # @param tags [Hash] - optional
+        # @param credit_limit [Integer] - optional
+        def initialize(account_id, tags = nil, credit_limit = nil)
+          @account_id = account_id
+          @tags = tags
+          @credit_limit = credit_limit
+        end
+
+        def to_json_api
+          payload = {
+            data: {
+              type: "creditAccount",
+              attributes: {
+                tags: tags,
+                creditLimit: credit_limit
+              }
+            }
+          }
+          payload[:data][:attributes].compact!
+          payload.to_json
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/payment/create_ach_payment_inline_request.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Request to create a new ach payment to inline counterparty by calling Unit's API
+# @see https://docs.unit.co/ach-origination#payment-inline-counterparty
+module Unit
+  module Payment
+    class CreateAchPaymentInlineRequest
+      attr_reader :account_id, :amount, :direction, :counterparty, :description,
+                  :addenda, :idempotency_key, :tags, :same_day, :sec_code
+
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param direction [String]
+      # @param counterparty [Counterparty]
+      # @param description [String]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param same_day [Boolean] - optional
+      # @param sec_code [String] - optional
+      def initialize(account_id, amount, direction, counterparty, description,
+                     addenda = nil, idempotency_key = nil, tags = nil, same_day = nil, sec_code = nil)
+        @account_id = account_id
+        @amount = amount
+        @direction = direction
+        @counterparty = counterparty
+        @description = description
+        @addenda = addenda
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @same_day = same_day
+        @sec_code = sec_code
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "achPayment",
+            "attributes": {
+              amount: amount,
+              direction: direction,
+              counterparty: counterparty.represent,
+              description: description,
+              addenda: addenda,
+              idempotencyKey: idempotency_key,
+              tags: tags,
+              sameDay: same_day,
+              secCode: sec_code
+            },
+            "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/payment/create_payment_linked_request.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Request to create a new ach payment to linked counterparty by calling Unit's API
+# @see https://docs.unit.co/ach-origination#payment-linked-counterparty
+module Unit
+  module Payment
+    class CreatePaymentLinkedRequest
+      attr_reader :account_id, :counterparty_id, :amount, :direction, :description,
+                  :addenda, :idempotency_key, :tags, :verify_counterparty_balance,
+                  :same_day, :sec_code
+
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param direction [String]
+      # @param description [String]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param verify_counterparty_balance [Boolean] - optional
+      # @param same_day [Boolean] - optional
+      # @param sec_code [String] - optional
+      def initialize(account_id, counterparty_id, amount, direction, description,
+                     addenda = nil, idempotency_key = nil, tags = nil, verify_counterparty_balance = nil,
+                     same_day = nil, sec_code = nil)
+        @account_id = account_id
+        @counterparty_id = counterparty_id
+        @amount = amount
+        @direction = direction
+        @description = description
+        @addenda = addenda
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @verify_counterparty_balance = verify_counterparty_balance
+        @same_day = same_day
+        @sec_code = sec_code
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "achPayment",
+            "attributes": {
+              amount: amount,
+              direction: direction,
+              description: description,
+              addenda: addenda,
+              idempotencyKey: idempotency_key,
+              tags: tags,
+              verifyCounterpartyBalance: verify_counterparty_balance,
+              sameDay: same_day,
+              secCode: sec_code
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("account", account_id).to_hash,
+              "counterparty": Unit::Types::Relationship.new("counterparty", counterparty_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end