unit_ruby_sdk 1.1.0 → 1.3.0

data/lib/unit/models/fee/fee.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Unit
+  module Fee
+    autoload :CreateFeeRequest, "unit/models/fee/create_fee_request"
+    autoload :ReverseFeeRequest, "unit/models/fee/reverse_fee_request"
+
+    class << self
+      # Request to create fee
+      # @see https://docs.unit.co/fees/#create-fee
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def create_fee(account_id:, amount:, description:, tags: nil, idempotency_key: nil)
+        request = CreateFeeRequest.new(account_id, amount, description, tags, idempotency_key)
+        Unit::Resource::FeeResource.create_fee(request)
+      end
+
+      # Request to reverse a fee
+      # @see https://docs.unit.co/fees/#reverse-fee
+      # @param account_id [String]
+      # @param transaction_id [Integer]
+      # @param description [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def reverse_fee(account_id:, transaction_id:, description:, tags: nil, idempotency_key: nil)
+        request = ReverseFeeRequest.new(account_id, transaction_id, description, tags, idempotency_key)
+        Unit::Resource::FeeResource.reverse_fee(request)
+      end
+    end
+  end
+end

data/lib/unit/models/fee/reverse_fee_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Request to reverse a fee
+# @see https://docs.unit.co/fees/#reverse-fee
+module Unit
+  module Fee
+    class ReverseFeeRequest
+      attr_reader :account_id, :transaction_id, :description, :tags, :idempotency_key
+
+      # @param account_id [String]
+      # @param transaction_id [Integer]
+      # @param description [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(account_id, transaction_id, description, tags = nil, idempotency_key = nil)
+        @account_id = account_id
+        @transaction_id = transaction_id
+        @description = description
+        @tags = tags
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "feeReversal",
+            "attributes": {
+              "description": description,
+              "tags": tags,
+              "idempotencyKey": idempotency_key
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+              "transaction": Unit::Types::Relationship.new("transaction", transaction_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# class to create a batch release using
+module Unit
+  module Payment
+    class BatchReleaseRequestBuilder
+      def initialize
+        @requests = []
+      end
+
+      def add_request(account_id, batch_account_id, amount, description, sender_name, sender_address, sender_account_number, tags = nil, idempotency_key = nil)
+        request = Unit::Payment::CreateBatchReleaseRequest.new(account_id, batch_account_id, amount, description, sender_name, sender_address, sender_account_number, tags, idempotency_key)
+        @requests << request.to_hash
+      end
+
+      def to_hash
+        { "data": @requests }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Request to create a batch release
+# @see https://docs.unit.co/batch-payments/#create-batch-releases
+module Unit
+  module Payment
+    class CreateBatchReleaseRequest
+      attr_reader :account_id, :batch_account_id, :amount, :description, :sender_name, :sender_address,
+                  :sender_account_number, :tags, :idempotency_key
+
+      # @param account_id [String]
+      # @param batch_account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param sender_name [String]
+      # @param sender_address [Address]
+      # @param sender_account_number [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(account_id, batch_account_id, amount, description, sender_name, sender_address, sender_account_number, tags = nil, idempotency_key = nil)
+        @account_id = account_id
+        @batch_account_id = batch_account_id
+        @amount = amount
+        @description = description
+        @sender_name = sender_name
+        @sender_address = sender_address
+        @sender_account_number = sender_account_number
+        @tags = tags
+        @idempotency_key = idempotency_key
+      end
+
+      def to_hash
+        payload = {
+          "type": "batchRelease",
+          "attributes": {
+            "amount": amount,
+            "description": description,
+            "senderName": sender_name,
+            "senderAddress": sender_address&.represent,
+            "senderAccountNumber": sender_account_number,
+            "tags": tags,
+            "idempotencyKey": idempotency_key
+          },
+          "relationships": {
+            "batchAccount": Unit::Types::Relationship.new("batchAccount", batch_account_id).to_hash,
+            "receiver": Unit::Types::Relationship.new("depositAccount", account_id).to_hash
+          }
+        }
+        payload[:attributes].compact!
+        payload
+      end
+    end
+  end
+end

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

@@ -14,6 +14,8 @@ module Unit
     autoload :ListPaymentParams, "unit/models/payment/list_payment_params"
     autoload :GetRequest, "unit/models/payment/get_request"
     autoload :BulkPaymentRequest, "unit/models/payment/bulk_payment_request"
+    autoload :CreateBatchReleaseRequest, "unit/models/payment/create_batch_release_request"
+    autoload :BatchReleaseRequestBuilder, "unit/models/payment/batch_release_request_builder"
     class << self
       # Create a new book payment by calling Unit's API
       # @see https://docs.unit.co/book-payments#book-payments
@@ -181,6 +183,24 @@ module Unit
         request = Unit::Payment::BulkPaymentRequest.serialize(requests)
         Unit::Resource::PaymentResource.create_bulk_payment(request)
       end
-    end
+
+      # Create a batch release
+      # @see https://docs.unit.co/batch-payments/#create-batch-releases
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param sender_name [String]
+      # @param sender_address [Address]
+      # @param sender_account_number [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def create_batch_release(requests)
+        payload = BatchReleaseRequestBuilder.new
+        requests.each do |req|
+          payload.add_request(req[:account_id], req[:batch_account_id], req[:amount], req[:description], req[:sender_name], req[:sender_address], req[:sender_account_number], req[:tags], req[:idempotency_key])
+        end
+        Unit::Resource::PaymentResource.create_batch_release(payload.to_hash)
+      end
+     end
   end
 end

data/lib/unit/models/received_payment/list_payment_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Request to list ach received payments by calling Unit's API
+# @see https://docs.unit.co/received-ach#list-received-payments
+module Unit
+  module ReceivedPayment
+    class ListPaymentParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :status,
+                  :include_completed, :tags, :sort, :include
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param include_completed [Boolean] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def initialize(limit = RECEIVED_PAYMENT_LIMIT, offset = ACH_PAYMENT_OFFSET, account_id = nil, customer_id = nil, status = nil,
+                     include_completed = nil, tags = nil, sort = nil, include = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @status = status
+        @include_completed = include_completed
+        @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[includeCompleted]": include_completed,
+          "filter[tags]": tags,
+          "sort": sort,
+          "include": include&.join(",")
+        }
+        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/received_payment/patch_payment_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Request to update a received ACH payment
+# @see https://docs.unit.co/received-ach#update-received-payment
+module Unit
+  module ReceivedPayment
+    class PatchPaymentRequest
+      attr_reader :payment_id, :tags
+
+      # @param payment_id [String]
+      # @param tags [Hash] - optional
+      def initialize(payment_id, tags = nil)
+        @payment_id = payment_id
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "achReceivedPayment",
+            "attributes": {
+              tags: tags
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/received_payment/received_payment.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Unit
+  module ReceivedPayment
+    RECEIVED_PAYMENT_LIMIT = 100
+    RECEIVED_PAYMENT_OFFSET = 0
+
+    autoload :PatchPaymentRequest, "unit/models/received_payment/patch_payment_request"
+    autoload :ListPaymentParams, "unit/models/received_payment/list_payment_params"
+
+    class << self
+      # Get received ach payment by calling Unit's API
+      # @see https://docs.unit.co/received-ach#get-specific-received-payment
+      # @param payment_id [String]
+      def get_payment(payment_id:)
+        Unit::Resource::ReceivedPaymentResource.get_payment(payment_id)
+      end
+
+      # Update a received ACH payment by calling Unit's API
+      # @see https://docs.unit.co/received-ach#update-received-payment
+      # @param payment_id [String]
+      # @param tags [Hash] - optional
+      def update_payment(payment_id:, tags: nil)
+        request = Unit::ReceivedPayment::PatchPaymentRequest.new(payment_id, tags)
+        Unit::Resource::ReceivedPaymentResource.update_payment(request)
+      end
+
+      # List ach payments by calling Unit's API
+      # @see https://docs.unit.co/received-ach#list-received-payments
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param include_completed [Boolean] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def list_payments(limit: RECEIVED_PAYMENT_LIMIT, offset: RECEIVED_PAYMENT_OFFSET, account_id: nil, customer_id: nil, status: nil,
+                        include_completed: nil, tags: nil, sort: nil, include: nil)
+        request = Unit::ReceivedPayment::ListPaymentParams.new(limit, offset, account_id, customer_id, status,
+                                                               include_completed, tags, sort, include)
+        Unit::Resource::ReceivedPaymentResource.list_payments(request)
+      end
+
+      # Advance a received payment by calling Unit's API
+      # @see https://docs.unit.co/received-ach#advance-received-payment
+      # @param payment_id [String]
+      def advance_payment(payment_id:)
+        Unit::Resource::ReceivedPaymentResource.advance_payment(payment_id)
+      end
+    end
+  end
+end

data/lib/unit/models/recurring_payment/create_recurring_credit_ach_payment_request.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Request to create a recurring credit ach payment
+# @see https://docs.unit.co/recurring-payments/#recurring-payment-credit-ach-payment
+module Unit
+  module RecurringPayment
+    class CreateRecurringCreditAchPaymentRequest
+      attr_reader :account_id, :counterparty_id, :amount, :description, :addenda, :schedule, :idempotency_key, :tags
+
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(account_id, counterparty_id, amount, description, schedule, addenda = nil, idempotency_key = nil, tags = nil)
+        @account_id = account_id
+        @counterparty_id = counterparty_id
+        @amount = amount
+        @description = description
+        @addenda = addenda
+        @schedule = schedule
+        @idempotency_key = idempotency_key
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "recurringCreditAchPayment",
+            "attributes": {
+              "amount": amount,
+              "description": description,
+              "addenda": addenda,
+              "schedule": schedule&.represent,
+              "idempotencyKey": idempotency_key,
+              "tags": tags
+            },
+            "relationships": {
+              account: Unit::Types::Relationship.new("depositAccount", 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

data/lib/unit/models/recurring_payment/create_recurring_credit_book_payment_request.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Request to create a recurring credit book payment
+# @see https://docs.unit.co/recurring-payments/#recurring-credit-book-payment
+module Unit
+  module RecurringPayment
+    class CreateRecurringCreditBookPaymentRequest
+      attr_reader :account_id, :counterparty_id, :amount, :description, :schedule, :transaction_summary_override, :idempotency_key, :tags
+
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param transaction_summary_override [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(account_id, counterparty_id, amount, description, schedule,
+                     transaction_summary_override = nil, idempotency_key = nil, tags = nil)
+        @account_id = account_id
+        @counterparty_id = counterparty_id
+        @amount = amount
+        @description = description
+        @transaction_summary_override = transaction_summary_override
+        @schedule = schedule
+        @idempotency_key = idempotency_key
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "recurringCreditBookPayment",
+            "attributes": {
+              "amount": amount,
+              "description": description,
+              "schedule": schedule&.represent,
+              "transaction_summary_override": transaction_summary_override,
+              "idempotencyKey": idempotency_key,
+              "tags": tags
+            },
+            "relationships":
+              {
+                account: Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+                counterpartyAccount: Unit::Types::Relationship.new("depositAccount", counterparty_id).to_hash
+              }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/recurring_payment/create_recurring_debit_ach_payment_request.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Create a recurring debit ACH payment request
+# @see https://docs.unit.co/recurring-payments/#recurring-payment-debit-ach-payment
+module Unit
+  module RecurringPayment
+    class CreateRecurringDebitAchPaymentRequest
+      attr_reader :account_id, :counterparty_id, :amount, :description, :addenda, :schedule, :idempotency_key, :tags,
+                  :verify_counterparty_balance, :same_day
+
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param verify_counterparty_balance [Boolean] - optional
+      # @param same_day [Boolean] - optional
+      def initialize(account_id, counterparty_id, amount, description, schedule, addenda = nil, idempotency_key = nil, tags = nil,
+                     verify_counterparty_balance = nil, same_day = nil)
+        @account_id = account_id
+        @counterparty_id = counterparty_id
+        @amount = amount
+        @description = description
+        @addenda = addenda
+        @schedule = schedule
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @verify_counterparty_balance = verify_counterparty_balance
+        @same_day = same_day
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "recurringDebitAchPayment",
+            "attributes": {
+              "amount": amount,
+              "description": description,
+              "addenda": addenda,
+              "schedule": schedule&.represent,
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "verifyCounterpartyBalance": verify_counterparty_balance,
+              "sameDay": same_day
+            },
+            "relationships": {
+              account: Unit::Types::Relationship.new("depositAccount", 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

data/lib/unit/models/recurring_payment/list_recurring_payment_params.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Params for listing recurring payments
+# @see https://docs.unit.co/recurring-payments/#list-recurring-payments
+module Unit
+  module RecurringPayment
+    class ListRecurringPaymentParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :status, :type,
+                  :from_start_time, :to_start_time, :from_end_time, :to_end_time, :sort
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array] - optional
+      # @param type [Array] - optional
+      # @param from_start_time [String] - optional
+      # @param to_start_time [String] - optional
+      # @param from_end_time [String] - optional
+      # @param to_end_time [String] - optional
+      # @param sort [String] - optional
+      def initialize(limit = RECURRING_PAYMENT_LIMIT, offset = RECURRING_PAYMENT_OFFSET, account_id = nil, customer_id = nil, status = nil, type = nil,
+                     from_start_time = nil, to_start_time = nil, from_end_time = nil, to_end_time = nil, sort = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @status = status
+        @type = type
+        @from_start_date = from_start_time
+        @to_start_date = to_start_time
+        @from_end_date = from_end_time
+        @to_end_date = to_end_time
+        @sort = sort
+      end
+
+      def to_hash
+        payload = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[accountId]": account_id,
+          "filter[customerId]": customer_id,
+          "filter[fromStartTime]": from_start_time,
+          "filter[toStartTime]": to_start_time,
+          "filter[fromEndTime]": from_end_time,
+          "filter[toEndTime]": to_end_time,
+          "sort": sort
+        }
+        filters = %i[status type]
+        filters.each do |filter|
+          values = send(filter)
+          values&.each_with_index&.map do |val, index|
+            params.merge!({ "filter[#{filter}][#{index}]": val })
+          end
+        end
+        payload.compact!
+      end
+    end
+  end
+end