unit_ruby_sdk 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5668d5b6f37c4258503b7997aea3921af80a511c16c3b41a93dbb5088d1101b5
-  data.tar.gz: 6e4d664998ceb9e4d33433357892b9e16e06bb59e5991b2d9e41a9ada74444e0
+  metadata.gz: d20a17ad0586962f7984a43e052bbe2f8a1637adf318b91cbb35c2bd65268efe
+  data.tar.gz: 113eeaae42a13b4d89d31b870c935fc36d6221c4a09c3e4e8770c19e6b96a724
 SHA512:
-  metadata.gz: 89fc34d5d4563ce3ba91507f352aa29d402e8e6a91cf108f3429f3abdc3f3ac936a3e00f8fff5df002fab987188b20dc150f8fc8ab1c4a132049be202becc50e
-  data.tar.gz: d93fed682b4d440b17ae9871f2323b68ffbd0a9660524e5e78b65d29d80f3f4e529fc5b55a800e2aa5fde4cbaf2915c8e0438da7f36260fe76b5dd211fb8bcc7
+  metadata.gz: '0178fda07e7f4f9b3011c8e5b1dfa7a5fc4efffdc9d77b50bfabdab34c174293a2ca4cc90b77cb521646bba08d34b52732509c1652f96f3eab8bd0d38e573976'
+  data.tar.gz: 8a2b410f41503b00a1cd23637e8f332d96b4116e7a06d980894adff0f8e5ebf9343652629b6177e1890077805b88bcaded6e5dd525590671bacbae77870dc5ab

data/README.md

@@ -181,6 +181,22 @@ puts counterparty.id
  puts wire_payment.id
 ```
 
+### Creating a bulk payment
+```ruby
+address = Unit::Types::Address.new('123 Main St', 'San Francisco', 'CA', '94205', 'US')
+wire_counterparty = Unit::Types::WireCounterparty.new("Jane Doe", "27573", "812345678", address)
+counterparty = Unit::Types::Counterparty.new("Jane Doe", "27573", "812345678", "Checking")
+book_payment_request = Unit::Payment::CreateBookPaymentRequest.new(amount: 1000, description: "test payment", account_id: "27573", counterparty_account_id: "36981", tags: { "test": "test-tag" })
+wire_payment_request = Unit::Payment::CreateWirePaymentRequest.new(amount: 1000, description: "test payment", account_id: "27573", counterparty: wire_counterparty, tags: { "test": "test-tag" })
+ach_payment_inline_request = Unit::Payment::CreateAchPaymentInlineRequest.new(amount: 1000, direction: "Credit", counterparty: counterparty, description: "test payment", account_id: "27573", tags: { "test": "test-tag" })
+ach_payment_linked_request = Unit::Payment::CreatePaymentLinkedRequest.new(amount: 1000, direction: "Credit", description: "test payment", account_id: "27573", counterparty_id: "313118", tags: { "test": "test-tag" })
+ach_payment_plaid_token_request = Unit::Payment::CreateWithPlaidTokenRequest.new(amount: 1000, direction: "Credit", description: "test payment", account_id: "27573", plaid_processor_token: "processor-sandbox-fc8b9c23-b400-40f9-8ee8-c2cabd719721", tags: { "test": "test-tag" })
+
+response = Unit::Payment.create_bulk_payment(
+  requests: [book_payment_request, wire_payment_request, ach_payment_inline_request, ach_payment_linked_request, ach_payment_plaid_token_request])
+bulk_payment = response.data
+puts bulk_payment.id
+```
 ### Logging Errors
 
 ```ruby

data/lib/unit/api_resources/payment_resource.rb

@@ -19,6 +19,14 @@ module Unit
           response_handler(response)
         end
 
+        # Create a new bulk payment by calling Unit's API
+        # @param request [BulkPaymentRequest]
+        # @return [UnitResponse, UnitError]
+        def create_bulk_payment(request)
+          response = HttpHelper.post("#{api_url}/payments/bulk", body: request, headers: headers)
+          response_handler(response)
+        end
+
         # Update a payment by calling Unit's API
         # @param request [PatchBookPaymentRequest, PatchAchPaymentRequest]
         # @return [UnitResponse, UnitError]

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "json"
+
+# class for serializing payment requests
+module Unit
+  module Payment
+    class BulkPaymentRequest
+      def self.serialize(requests)
+        payload = requests.map(&:change_attributes)
+        { "data": payload }.to_json
+      end
+    end
+  end
+end

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

@@ -18,8 +18,8 @@ module Unit
       # @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)
+      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
@@ -34,27 +34,37 @@ module Unit
 
       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
-            }
-          }
+          "data": to_hash
         }
         payload[:data][:attributes].compact!
         payload.to_json
       end
+
+      def to_hash
+        {
+          "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
+          }
+        }
+      end
+
+      def change_attributes
+        payload = to_hash
+        payload[:attributes].compact!
+        payload
+      end
     end
   end
 end

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

@@ -14,8 +14,8 @@ module Unit
       # @param transaction_summary_override [String] - optional
       # @param idempotency_key [String] - optional
       # @param tags [Hash] - optional
-      def initialize(amount, description, account_id, counterparty_account_id, transaction_summary_override = nil,
-                     idempotency_key = nil, tags = nil)
+      def initialize(amount:, description:, account_id:, counterparty_account_id:, transaction_summary_override: nil,
+                     idempotency_key: nil, tags: nil)
         @amount = amount
         @description = description
         @account_id = account_id
@@ -27,22 +27,32 @@ module Unit
 
       def to_json_api
         payload = {
-          data: {
-            type: "bookPayment",
-            attributes: {
-              amount: amount,
-              description: description,
-              transactionSummaryOverride: 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_account_id).to_hash }
-          }
+          data: to_hash
         }
         payload[:data][:attributes].compact!
         payload.to_json
       end
+
+      def to_hash
+        {
+          type: "bookPayment",
+          attributes: {
+            amount: amount,
+            description: description,
+            transactionSummaryOverride: 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_account_id).to_hash }
+        }
+      end
+
+      def change_attributes
+        payload = to_hash
+        payload[:attributes].compact!
+        payload
+      end
     end
   end
 end

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

@@ -20,9 +20,9 @@ module Unit
       # @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)
+      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
@@ -38,28 +38,38 @@ module Unit
 
       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
-            }
-          }
+          "data": to_hash
         }
         payload[:data][:attributes].compact!
         payload.to_json
       end
+
+      def to_hash
+        {
+          "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
+          }
+        }
+      end
+
+      def change_attributes
+        payload = to_hash
+        payload[:attributes].compact!
+        payload
+      end
     end
   end
 end

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

@@ -13,7 +13,7 @@ module Unit
       # @param counterparty [WireCounterparty]
       # @param idempotency_key [String] - optional
       # @param tags [Hash] - optional
-      def initialize(account_id, amount, description, counterparty, idempotency_key = nil, tags = nil)
+      def initialize(account_id:, amount:, description:, counterparty:, idempotency_key: nil, tags: nil)
         @account_id = account_id
         @amount = amount
         @description = description
@@ -24,21 +24,31 @@ module Unit
 
       def to_json_api
         payload = {
-          data: {
-            type: "wirePayment",
-            attributes: {
-              amount: amount,
-              description: description,
-              counterparty: counterparty.represent,
-              idempotencyKey: idempotency_key,
-              tags: tags
-            },
-            relationships: { account: Unit::Types::Relationship.new("account", account_id).to_hash }
-          }
+          data: to_hash
         }
         payload[:data][:attributes].compact!
         payload.to_json
       end
+
+      def to_hash
+        {
+          type: "wirePayment",
+          attributes: {
+            amount: amount,
+            description: description,
+            counterparty: counterparty.represent,
+            idempotencyKey: idempotency_key,
+            tags: tags
+          },
+          relationships: { account: Unit::Types::Relationship.new("account", account_id).to_hash }
+        }
+      end
+
+      def change_attributes
+        payload = to_hash
+        payload[:attributes].compact!
+        payload
+      end
     end
   end
 end

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

@@ -22,9 +22,9 @@ module Unit
       # @param verify_counterparty_balance [Boolean] - optional
       # @param same_day [Boolean] - optional
       # @param sec_code [String] - optional
-      def initialize(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)
+      def initialize(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)
         @account_id = account_id
         @amount = amount
         @direction = direction
@@ -41,29 +41,39 @@ module Unit
 
       def to_json_api
         payload = {
-          "data": {
-            "type": "achPayment",
-            "attributes": {
-              amount: amount,
-              direction: direction,
-              description: description,
-              plaidProcessorToken: plaid_processor_token,
-              addenda: addenda,
-              idempotencyKey: idempotency_key,
-              counterpartyName: counterparty_name,
-              tags: tags,
-              verifyCounterpartyBalance: verify_counterparty_balance,
-              sameDay: same_day,
-              secCode: sec_code
-            },
-            "relationships": {
-              "account": Unit::Types::Relationship.new("account", account_id).to_hash
-            }
-          }
+          "data": to_hash
         }
         payload[:data][:attributes].compact!
         payload.to_json
       end
+
+      def to_hash
+        {
+          "type": "achPayment",
+          "attributes": {
+            amount: amount,
+            direction: direction,
+            description: description,
+            plaidProcessorToken: plaid_processor_token,
+            addenda: addenda,
+            idempotencyKey: idempotency_key,
+            counterpartyName: counterparty_name,
+            tags: tags,
+            verifyCounterpartyBalance: verify_counterparty_balance,
+            sameDay: same_day,
+            secCode: sec_code
+          },
+          "relationships": {
+            "account": Unit::Types::Relationship.new("account", account_id).to_hash
+          }
+        }
+      end
+
+      def change_attributes
+        payload = to_hash
+        payload[:attributes].compact!
+        payload
+      end
     end
   end
 end

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

@@ -13,6 +13,7 @@ module Unit
     autoload :CreateWirePaymentRequest, "unit/models/payment/create_wire_payment_request"
     autoload :ListPaymentParams, "unit/models/payment/list_payment_params"
     autoload :GetRequest, "unit/models/payment/get_request"
+    autoload :BulkPaymentRequest, "unit/models/payment/bulk_payment_request"
     class << self
       # Create a new book payment by calling Unit's API
       # @see https://docs.unit.co/book-payments#book-payments
@@ -26,8 +27,9 @@ module Unit
       # @return [UnitResponse, UnitError]
       def create_book_payment(amount:, description:, account_id:, counterparty_account_id:, transaction_summary_override: nil,
                               idempotency_key: nil, tags: nil)
-        request = Unit::Payment::CreateBookPaymentRequest.new(amount, description, account_id, counterparty_account_id, transaction_summary_override,
-                                                              idempotency_key, tags)
+        request = Unit::Payment::CreateBookPaymentRequest.new(amount: amount, description: description, account_id: account_id, counterparty_account_id: counterparty_account_id, transaction_summary_override: transaction_summary_override,
+                                                              idempotency_key: idempotency_key, tags: tags)
+
         Unit::Resource::PaymentResource.create_payment(request)
       end
 
@@ -56,8 +58,8 @@ module Unit
       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)
+        request = Unit::Payment::CreateAchPaymentInlineRequest.new(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)
         Unit::Resource::PaymentResource.create_payment(request)
       end
 
@@ -77,9 +79,8 @@ module Unit
       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)
+        request = Unit::Payment::CreatePaymentLinkedRequest.new(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)
         Unit::Resource::PaymentResource.create_payment(request)
       end
 
@@ -100,9 +101,8 @@ module Unit
       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)
+        request = Unit::Payment::CreateWithPlaidTokenRequest.new(account_id: account_id, amount: amount, direction: direction, description: description, plaid_processor_token: plaid_processor_token, addenda: addenda, idempotency_key: idempotency_key,
+                                                                 counterparty_name: counterparty_name, tags: tags, verify_counterparty_balance: verify_counterparty_balance, same_day: same_day, sec_code: sec_code)
         Unit::Resource::PaymentResource.create_payment(request)
       end
 
@@ -131,7 +131,7 @@ module Unit
       # @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)
+        request = Unit::Payment::CreateWirePaymentRequest.new(account_id: account_id, amount: amount, description: description, counterparty: counterparty, idempotency_key: idempotency_key, tags: tags)
         Unit::Resource::PaymentResource.create_payment(request)
       end
 
@@ -173,6 +173,14 @@ module Unit
         request = Unit::Payment::GetRequest.new(payment_id, include)
         Unit::Resource::PaymentResource.get_payment(request)
       end
+
+      # Create a bulk payment by calling Unit's API
+      # @see https://docs.unit.co/payments/#bulk-payments
+      # @param requests [Array<CreateAchPaymentInlineRequest, CreatePaymentLinkedRequest, CreateBookPaymentRequest, CreateWithPlaidTokenRequest, CreateWirePaymentRequest>]
+      def create_bulk_payment(requests:)
+        request = Unit::Payment::BulkPaymentRequest.serialize(requests)
+        Unit::Resource::PaymentResource.create_bulk_payment(request)
+      end
     end
   end
 end

data/lib/unit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Unit
@@ -163,6 +163,7 @@ 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/bulk_payment_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