unit_ruby_sdk 1.0.2 → 1.0.4

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

@@ -2,9 +2,17 @@
 
 module Unit
   module Payment
+    PAYMENT_LIMIT = 100
+    PAYMENT_OFFSET = 0
     autoload :CreateBookPaymentRequest, "unit/models/payment/create_book_payment_request"
     autoload :PatchBookPaymentRequest, "unit/models/payment/patch_book_payment_request"
-
+    autoload :CreateAchPaymentInlineRequest, "unit/models/payment/create_ach_payment_inline_request"
+    autoload :CreatePaymentLinkedRequest, "unit/models/payment/create_payment_linked_request"
+    autoload :CreateWithPlaidTokenRequest, "unit/models/payment/create_with_plaid_token_request"
+    autoload :PatchReceivedPaymentRequest, "unit/models/payment/patch_received_payment_request"
+    autoload :CreateWirePaymentRequest, "unit/models/payment/create_wire_payment_request"
+    autoload :ListPaymentParams, "unit/models/payment/list_payment_params"
+    autoload :GetRequest, "unit/models/payment/get_request"
     class << self
       # Create a new book payment by calling Unit's API
       # @see https://docs.unit.co/book-payments#book-payments
@@ -32,6 +40,139 @@ module Unit
         request = Unit::Payment::PatchBookPaymentRequest.new(payment_id, tags)
         Unit::Resource::PaymentResource.update_payment(request)
       end
+
+      # Create a new ach payment to inline counterparty by calling Unit's API
+      # @see https://docs.unit.co/ach-origination#payment-inline-counterparty
+      # @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 create_ach_payment_inline(account_id:, amount:, direction:, counterparty:,
+                                    description:, addenda: nil, idempotency_key: nil, tags: nil,
+                                    same_day: nil, sec_code: nil)
+        request = Unit::Payment::CreateAchPaymentInlineRequest.new(account_id, amount, direction, counterparty, description,
+                                                                   addenda, idempotency_key, tags, same_day, sec_code)
+        Unit::Resource::PaymentResource.create_payment(request)
+      end
+
+      # Create a new ach payment to linked counterparty by calling Unit's API
+      # @see https://docs.unit.co/ach-origination#payment-linked-counterparty
+      # @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 create_ach_payment_linked(account_id:, counterparty_id:, amount:, direction:,
+                                    description:, addenda: nil, idempotency_key: nil, tags: nil,
+                                    verify_counterparty_balance: nil, same_day: nil, sec_code: nil)
+        request = Unit::Payment::CreatePaymentLinkedRequest.new(account_id, counterparty_id, amount, direction,
+                                                                description, addenda, idempotency_key, tags,
+                                                                verify_counterparty_balance, same_day, sec_code)
+        Unit::Resource::PaymentResource.create_payment(request)
+      end
+
+      # Create a new ach payment with a plaid token by calling Unit's API
+      # @see https://docs.unit.co/ach-origination#create-ach-payment-with-plaid-token
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param direction [String]
+      # @param description [String]
+      # @param plaid_processor_token [String]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param counterparty_name [String] - optional
+      # @param tags [Hash] - optional
+      # @param verify_counterparty_balance [Boolean] - optional
+      # @param same_day [Boolean] - optional
+      # @param sec_code [String] - optional
+      def create_ach_payment_with_plaid_token(account_id:, amount:, direction:, description:, plaid_processor_token:,
+                                              addenda: nil, idempotency_key: nil, counterparty_name: nil, tags: nil,
+                                              verify_counterparty_balance: nil, same_day: nil, sec_code: nil)
+        request = Unit::Payment::CreateWithPlaidTokenRequest.new(account_id, amount, direction, description, plaid_processor_token,
+                                                                 addenda, idempotency_key, counterparty_name, tags,
+                                                                 verify_counterparty_balance, same_day, sec_code)
+        Unit::Resource::PaymentResource.create_payment(request)
+      end
+
+      # Update an ACH payment by calling Unit's API
+      # @see https://docs.unit.co/ach-origination#update-ach-payment
+      # @param payment_id [String]
+      # @param tags [Hash] - optional
+      def update_ach_payment(payment_id:, tags: nil)
+        request = Unit::Payment::PatchAchPaymentRequest.new(payment_id, tags)
+        Unit::Resource::PaymentResource.update_payment(request)
+      end
+
+      # Cancel a payment by calling Unit's API
+      # @see https://docs.unit.co/ach-origination#cancel-ach-payment
+      # @param payment_id [String]
+      def cancel_payment(payment_id:)
+        Unit::Resource::PaymentResource.cancel_payment(payment_id)
+      end
+
+      # Create a wire payment by calling Unit's API
+      # @see https://docs.unit.co/wires#wire-payments
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param counterparty [WireCounterparty]
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def create_wire_payment(account_id:, amount:, description:, counterparty:, idempotency_key: nil, tags: nil)
+        request = Unit::Payment::CreateWirePaymentRequest.new(account_id, amount, description, counterparty, idempotency_key, tags)
+        Unit::Resource::PaymentResource.create_payment(request)
+      end
+
+      # List payments by calling Unit's API
+      # @see https://docs.unit.co/payments#list-payments
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param counterparty_account_id [String] - optional
+      # @param tags [Hash] - optional
+      # @param status [Array<String>] - optional
+      # @param type [Array<String>] - optional
+      # @param direction [Array<String>] - optional
+      # @param since [String] - optional
+      # @param _until [String] - optional
+      # @param from_amount [Integer] - optional
+      # @param to_amount [Integer] - optional
+      # @param recurring_payment_id [String] - optional
+      # @param feature [Array<String>] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def list_payments(limit: PAYMENT_LIMIT, offset: PAYMENT_OFFSET, account_id: nil, customer_id: nil,
+                        counterparty_account_id: nil, tags: nil, status: nil,
+                        type: nil, direction: nil, since: nil, until_: nil,
+                        from_amount: nil, to_amount: nil, recurring_payment_id: nil,
+                        feature: nil, sort: nil, include: nil)
+        request = Unit::Payment::ListPaymentParams.new(limit, offset, account_id, customer_id,
+                                                       counterparty_account_id, tags, status, type, direction, since, until_,
+                                                       from_amount, to_amount, recurring_payment_id, feature, sort, include)
+        Unit::Resource::PaymentResource.list_payments(request)
+      end
+
+      # Get a payment by calling Unit's API
+      # @see https://docs.unit.co/payments#get-specific-payment
+      # @param payment_id [String]
+      # @param include [Array<String>] - optional
+      def get_payment(payment_id:, include: nil)
+        request = Unit::Payment::GetRequest.new(payment_id, include)
+        Unit::Resource::PaymentResource.get_payment(request)
+      end
     end
   end
 end

data/lib/unit/models/transaction/patch_book_transaction_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Request to update a transaction's tags
+# @see https://docs.unit.co/transactions#update-transaction-tags
+module Unit
+  module Transaction
+    class PatchBookTransactionRequest
+      attr_reader :account_id, :transaction_id, :summary, :tags
+
+      # @param account_id [String]
+      # @param transaction_id [String]
+      # @param summary [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(account_id, transaction_id, summary = nil, tags = nil)
+        @account_id = account_id
+        @transaction_id = transaction_id
+        @summary = summary
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "bookTransaction",
+            attributes: {
+              summary: summary,
+              tags: tags
+            },
+            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/transaction/patch_chargeback_transaction_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Request to update a transaction's tags
+# @see https://docs.unit.co/transactions#update-transaction-tags
+module Unit
+  module Transaction
+    class PatchChargebackTransactionRequest
+      attr_reader :account_id, :transaction_id, :summary, :tags
+
+      # @param account_id [String]
+      # @param transaction_id [String]
+      # @param summary [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(account_id, transaction_id, summary = nil, tags = nil)
+        @account_id = account_id
+        @summary = summary
+        @tags = tags
+        @transaction_id = transaction_id
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "chargebackTransaction",
+            attributes: {
+              summary: summary,
+              tags: tags
+            },
+            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/transaction/transaction.rb

@@ -7,6 +7,8 @@ module Unit
     autoload :GetTransactionParams, "unit/models/transaction/get_transaction_params"
     autoload :ListTransactionParams, "unit/models/transaction/list_transaction_params"
     autoload :PatchTagsRequest, "unit/models/transaction/patch_tags_request"
+    autoload :PatchBookTransactionRequest, "unit/models/transaction/patch_book_transaction_request"
+    autoload :PatchChargebackTransactionRequest, "unit/models/transaction/patch_chargeback_transaction_request"
 
     class << self
       # Get a transaction by id
@@ -55,6 +57,28 @@ module Unit
         request = PatchTagsRequest.new(account_id, transaction_id, tags)
         Unit::Resource::TransactionResource.update_tags(request)
       end
+
+      # Update a book transaction
+      # @see https://docs.unit.co/transactions#update-book-transaction
+      # @param account_id [String]
+      # @param transaction_id [String]
+      # @param summary [String] - optional
+      # @param tags [Hash] - optional
+      def update_book_transaction(account_id:, transaction_id:, summary:, tags: nil)
+        request = PatchBookTransactionRequest.new(account_id, transaction_id, summary, tags)
+        Unit::Resource::TransactionResource.update_transaction(request)
+      end
+
+      # Update a chargeback transaction
+      # @see https://docs.unit.co/transactions#update-chargeback-transaction
+      # @param account_id [String]
+      # @param transaction_id [String]
+      # @param summary [String] - optional
+      # @param tags [Hash] - optional
+      def update_chargeback_transaction(account_id:, transaction_id:, summary:, tags: nil)
+        request = PatchChargebackTransactionRequest.new(account_id, transaction_id, summary, tags)
+        Unit::Resource::TransactionResource.update_transaction(request)
+      end
     end
   end
 end

data/lib/unit/types/counterparty.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# @see https://docs.unit.co/types/#counterparty
+module Unit
+  module Types
+    class Counterparty
+      attr_reader :name, :account_number, :routing_number, :account_type
+
+      # @param name [String]
+      # @param account_number [String]
+      # @param routing_number [String]
+      # @param account_type [String]
+      def initialize(name, account_number, routing_number, account_type)
+        @name = name
+        @account_number = account_number
+        @routing_number = routing_number
+        @account_type = account_type
+      end
+
+      def represent
+        params = {
+          name: name,
+          accountNumber: account_number,
+          routingNumber: routing_number,
+          accountType: account_type
+        }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/types/wire_counterparty.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# @see https://docs.unit.co/types/#wire-counterparty
+module Unit
+  module Types
+    class WireCounterparty
+      attr_reader :name, :account_number, :routing_number, :address
+
+      # @param name [String]
+      # @param account_number [String]
+      # @param routing_number [String]
+      # @param address [Address]
+      def initialize(name, account_number, routing_number, address)
+        @name = name
+        @account_number = account_number
+        @routing_number = routing_number
+        @address = address
+      end
+
+      def represent
+        params = {
+          name: name,
+          accountNumber: account_number,
+          routingNumber: routing_number,
+          address: address&.represent
+        }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/version.rb

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

data/lib/unit_ruby_sdk.rb

@@ -13,6 +13,8 @@ module Unit
   autoload :Statement, "unit/models/statement/statement"
   autoload :AtmLocation, "unit/models/atm_location/atm_location"
   autoload :CheckDeposit, "unit/models/check_deposit/check_deposit"
+  autoload :Counterparty, "unit/models/counterparty/counterparty"
+
   module Resource
     autoload :ApplicationResource, "unit/api_resources/application_resource"
     autoload :CustomerResource, "unit/api_resources/customer_resource"
@@ -24,6 +26,7 @@ module Unit
     autoload :StatementResource, "unit/api_resources/statement_resource"
     autoload :AtmLocationResource, "unit/api_resources/atm_location_resource"
     autoload :CheckDepositResource, "unit/api_resources/check_deposit_resource"
+    autoload :CounterpartyResource, "unit/api_resources/counterparty_resource"
   end
 
   module Types
@@ -33,6 +36,8 @@ module Unit
     autoload :BusinessContact, "unit/types/business_contact"
     autoload :DeviceFingerprint, "unit/types/device_fingerprint"
     autoload :EvaluationParams, "unit/types/evaluation_params"
+    autoload :Counterparty, "unit/types/counterparty"
+    autoload :WireCounterparty, "unit/types/wire_counterparty"
     autoload :FullName, "unit/types/full_name"
     autoload :Officer, "unit/types/officer"
     autoload :Phone, "unit/types/phone"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Unit
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -101,6 +101,7 @@ files:
 - lib/unit/api_resources/base_resource.rb
 - lib/unit/api_resources/card_resource.rb
 - lib/unit/api_resources/check_deposit_resource.rb
+- lib/unit/api_resources/counterparty_resource.rb
 - lib/unit/api_resources/customer_resource.rb
 - lib/unit/api_resources/payment_resource.rb
 - lib/unit/api_resources/statement_resource.rb
@@ -108,6 +109,12 @@ files:
 - lib/unit/errors/unit_error.rb
 - lib/unit/errors/unit_error_payload.rb
 - lib/unit/models/account/account.rb
+- lib/unit/models/account/credit/balance_history_request.rb
+- lib/unit/models/account/credit/close_account_request.rb
+- lib/unit/models/account/credit/create_account_request.rb
+- lib/unit/models/account/credit/freeze_account_request.rb
+- lib/unit/models/account/credit/list_account_params.rb
+- lib/unit/models/account/credit/patch_account_request.rb
 - lib/unit/models/account/deposit/account_owners_request.rb
 - lib/unit/models/account/deposit/balance_history_request.rb
 - lib/unit/models/account/deposit/close_deposit_account_request.rb
@@ -144,6 +151,11 @@ files:
 - lib/unit/models/check_deposit/list_deposit_params.rb
 - lib/unit/models/check_deposit/patch_deposit_request.rb
 - lib/unit/models/check_deposit/upload_image_request.rb
+- lib/unit/models/counterparty/counterparty.rb
+- lib/unit/models/counterparty/create_counterparty_request.rb
+- lib/unit/models/counterparty/create_with_plaid_token_request.rb
+- lib/unit/models/counterparty/list_counterparty_params.rb
+- lib/unit/models/counterparty/update_counterparty_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
@@ -151,7 +163,14 @@ files:
 - lib/unit/models/customer/patch_business_customer_request.rb
 - lib/unit/models/customer/patch_individual_customer_request.rb
 - lib/unit/models/customer/remove_authorized_users_request.rb
+- lib/unit/models/payment/create_ach_payment_inline_request.rb
 - lib/unit/models/payment/create_book_payment_request.rb
+- lib/unit/models/payment/create_payment_linked_request.rb
+- lib/unit/models/payment/create_wire_payment_request.rb
+- lib/unit/models/payment/create_with_plaid_token_request.rb
+- lib/unit/models/payment/get_request.rb
+- lib/unit/models/payment/list_payment_params.rb
+- lib/unit/models/payment/patch_ach_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
@@ -161,6 +180,8 @@ files:
 - 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_book_transaction_request.rb
+- lib/unit/models/transaction/patch_chargeback_transaction_request.rb
 - lib/unit/models/transaction/patch_tags_request.rb
 - lib/unit/models/transaction/transaction.rb
 - lib/unit/models/unit_resource.rb
@@ -170,6 +191,7 @@ files:
 - lib/unit/types/beneficial_owner.rb
 - lib/unit/types/business_contact.rb
 - lib/unit/types/coordinates.rb
+- lib/unit/types/counterparty.rb
 - lib/unit/types/device_fingerprint.rb
 - lib/unit/types/document_file_type.rb
 - lib/unit/types/evaluation_params.rb
@@ -180,6 +202,7 @@ files:
 - lib/unit/types/relationship.rb
 - lib/unit/types/relationship_array.rb
 - lib/unit/types/restricted_resource.rb
+- lib/unit/types/wire_counterparty.rb
 - lib/unit/utils/http_helper.rb
 - lib/unit/version.rb
 - lib/unit_ruby_sdk.rb