unit_ruby_sdk 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dffd0552f07ada33b8cf7784a77ed1920c614648fd98279ec5df4a0556ea3c2
-  data.tar.gz: c825b344c162333143e63902e68b4c5bbdae064c6578d077de9b70b927699403
+  metadata.gz: f637ade0b91b546e19ba9dfcc469869673505646fd991e395c4693ec79ba9a7d
+  data.tar.gz: 5cde210d03a1e829bb1daa89b15ac35d6f80d1ff2e58a702d28de9736818bf82
 SHA512:
-  metadata.gz: 7fbb567aac32e7fa8e30673fef006bdb02584ebab67a414798ebcd027cf477e652ece5366a0c672317f0a9fd69389349640c160b237d4539f7b0f35c8c36ef41
-  data.tar.gz: affbc56b24a3182ddaf5f060a9dedc68f7c49b51213e683a6854a9a78a88e5e7f1a8e515cd250a031f6c8c6b00435b46833744f94b7b44d8ce12dbbab8e458ce
+  metadata.gz: 03e714af1bd2b100d9f9188cf86f0ac5d85dd6280c354f0b2b8a85ed4db1d3f7668c1f851a93b88c29c2fda25e00c5f7ff2d76bda284d4e4921815f3ea638bc0
+  data.tar.gz: 3adb4378919434296c6a106ad05efc6d77aa2e1940b18c436f6f2b14de008ad8aa024db50d302cebafc5910cfc7658a807f8b7d4d8d972f14ba65fead350f2a6

data/README.md

@@ -63,40 +63,6 @@ upload_document_request = Unit::Application.upload_document(
 puts upload_document_request.data["id"]
 ```
 
-### Creating a trust application
-
-```ruby
-full_name = Unit::Types::FullName.new('John', 'Doe')
-date_of_birth = '1980-08-10'
-address = Unit::Types::Address.new('123 Main St', 'San Francisco', 'CA', '94205', 'US')
-phone = Unit::Types::Phone.new('380', '555123222')
-email = 'jone.doe@unit-finance.com'
-ssn = '123456789'
-trust_contact = Unit::Types::TrustContact.new(full_name, email, phone, address)
-beneficiaries = [Unit::Types::Beneficiary.new(full_name, date_of_birth).represent]
-grantor = Unit::Types::Grantor.new(full_name, ssn, email, phone, address, date_of_birth)
-trustees = [Unit::Types::Trustee.new(full_name, ssn, email, phone, address, date_of_birth).represent]
-
-response = Unit::Application.create_trust_application(
-  name: "Trust me Inc.",
-  state_of_incorporation: "CA",
-  revocability: "Revocable",
-  source_of_funds: "Salary",
-  tax_id: "123456789",
-  grantor: grantor,
-  trustees: trustees,
-  beneficiaries: beneficiaries,
-  contact: trust_contact,
-  ip: "127.0.0.2",
-  tags: {
-    "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
-  },
-  idempotency_key: "3a1a33be-4e12-4603-9ed0-820922389fb8")
-
-trust_application = response.data
-puts trust_application["id"]
-```
-
 ### Creating a deposit account request
 
 ```ruby
@@ -273,6 +239,16 @@ recurring_payment = response.data
 puts recurring_payment["id"]
 ```
 
+### Creating a recurring payment
+```ruby
+ schedule = Unit::Types::CreateSchedule.new("Monthly", 3)
+ response = Unit::RecurringPayment.create_recurring_credit_book_payment(account_id: "27573", counterparty_id: "36099", amount: 1000, 
+                                                                        description: "test payme", schedule: schedule)
+ recurring_payment = response.data
+ puts recurring_payment.id
+```
+
+
 ### Creating a wire payment
 
 ```ruby
@@ -348,6 +324,23 @@ control_agreement = response.data
 puts control_agreement["id"]
 ```
 
+### Originate a check payment
+
+```ruby
+address = Unit::Types::Address.new('123 Main St', 'San Francisco', 'CA', '94205', 'US') 
+check_payment_counterparty = Unit::Types::CheckPaymentCounterparty.new("Jane Doe", address)
+response = Unit::CheckPayment.originate_check_payment(
+  account_id: "123",
+  customer_id: "123",
+  customer_type: "individualCustomer",
+  amount: 100,
+  counterparty: check_payment_counterparty,
+  description: "test",
+  idempotency_key: "test")
+check_payment = response.data
+puts check_payment["id"]
+```
+
 ### Get a check payment by id
 
 ```ruby

data/lib/unit/api_resources/cash_deposit_resource.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+# class for creating requests for cash deposits to Unit API and parsing responses
+# @see https://unit.co/docs/api/payments/cash-deposits/
+module Unit
+  module Resource
+    class CashDepositResource < Unit::Resource::BaseResource
+      class << self
+        # Generate a barcode for cash deposit
+        # @param request [GenerateBarcodeRequest]
+        # @return [UnitResponse, UnitError]
+        def generate_barcode(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/cash-deposits/barcodes", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # List cash deposit store locations by coordinates
+        # @param request [ListByCoordinatesParams]
+        # @return [UnitResponse, UnitError]
+        def list_by_coordinates(params = nil)
+          response = HttpHelper.get("#{api_url}/store-locations", params: params&.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # List cash deposit store locations by postal code
+        # @param request [ListByPostalCodeParams]
+        # @return [UnitResponse, UnitError]
+        def list_by_postal_code(params = nil)
+          response = HttpHelper.get("#{api_url}/store-locations", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Get cash deposit image by barcode number
+        # @param barcode_number [String]
+        # @return [UnitResponse, UnitError]
+        def get_image_by_barcode_number(barcode_number)
+          response = HttpHelper.get("#{api_url}/cash-deposits/barcodes/#{barcode_number}/image", headers: headers, response_type: "image")
+          file_response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/check_payment_resource.rb

@@ -10,6 +10,15 @@ module Unit
   module Resource
     class CheckPaymentResource < Unit::Resource::BaseResource
       class << self
+        # Originate a check payment by calling Unit's API
+        # @param request [OriginateCheckPaymentRequest]
+        # @return [UnitResponse, UnitError]
+        def originate_payment(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/check-payments", body: payload, headers: headers)
+          response_handler(response)
+        end
+
         # Get a check payment by id by calling Unit's API
         # @param params [GetRequest]
         # @return [UnitResponse, UnitError]
@@ -53,6 +62,14 @@ module Unit
           response = HttpHelper.post("#{api_url}/check-payments/#{payment_id}/approve", body: payload, headers: headers)
           response_handler(response)
         end
+
+        # Cancel check payment
+        # @param payment_id [String]
+        # @return [UnitResponse, UnitError]
+        def cancel_payment(payment_id)
+          response = HttpHelper.post("#{api_url}/check-payments/#{payment_id}/cancel", headers: headers)
+          response_handler(response)
+        end
       end
     end
   end

data/lib/unit/api_resources/tax_form_resource.rb

@@ -0,0 +1,39 @@
+# 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://unit.co/docs/api/tax-forms/
+module Unit
+  module Resource
+    class TaxFormResource < Unit::Resource::BaseResource
+      class << self
+        # Get tax_forms by calling Unit's API
+        # @param params [ListTaxFormParams]
+        # @return [UnitResponse, UnitError]
+        def list(params = nil)
+          response = HttpHelper.get("#{api_url}/tax-forms", params: params&.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a tax form by id by calling Unit's API
+        # @param tax_form_id [String]
+        # @return [UnitResponse, UnitError]
+        def get_tax_form_by_id(tax_form_id)
+          response = HttpHelper.get("#{api_url}/tax-forms/#{tax_form_id}", headers: headers)
+          response_handler(response)
+        end
+
+        # Get a tax form pdf by id by calling Unit's API
+        # @param tax_form_id [String]
+        # @return [UnitResponse, UnitError]
+        def get_tax_form_pdf_by_id(tax_form_id)
+          response = HttpHelper.get("#{api_url}/tax-forms/#{tax_form_id}/pdf", headers: headers)
+          file_response_handler(response)
+        end
+      end
+    end
+  end
+end

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

@@ -10,8 +10,7 @@ module Unit
     autoload :ListApplicationParams, "unit/models/application/list_application_params"
     autoload :PatchApplicationRequest, "unit/models/application/patch_application_request"
     autoload :UploadDocumentRequest, "unit/models/application/upload_document_request"
-    autoload :CreateTrustApplicationRequest, "unit/models/application/create_trust_application_request"
-    autoload :PatchTrustApplicationRequest, "unit/models/application/patch_trust_application_request"
+
     class << self
       # Create a new business application by calling Unit's API
       # @see https://docs.unit.co/applications#create-business-application
@@ -175,33 +174,6 @@ module Unit
         request = UploadDocumentRequest.new(application_id, document_id, file, file_type, is_back_side: is_back_side)
         Unit::Resource::ApplicationResource.upload(request)
       end
-
-      # Create a trust application
-      # @see https://docs.unit.co/applications/#create-trust-application
-      # @param name [String]
-      # @param state_of_incorporation [String]
-      # @param revocability [String]
-      # @param source_of_funds [String]
-      # @param tax_id [String]
-      # @param grantor [Grantor]
-      # @param trustees [Array<Trustee>]
-      # @param beneficiaries [Array<Beneficiary>]
-      # @param contact [TrustContact]
-      # @param ip [String] - optional
-      # @param tags [Hash] - optional
-      # @param idempotency_key [String] - optional
-      # @param device_fingerprints [Array<DeviceFingerprint>] - optional
-      def create_trust_application(name:, state_of_incorporation:, revocability:, source_of_funds:, tax_id:,
-                                   grantor:, trustees:, beneficiaries:, contact:, ip: nil, tags: nil, idempotency_key: nil, device_fingerprints: nil)
-        request = CreateTrustApplicationRequest.new(name, state_of_incorporation, revocability, source_of_funds, tax_id,
-                                                    grantor, trustees, beneficiaries, contact, ip, tags, idempotency_key, device_fingerprints)
-        Unit::Resource::ApplicationResource.create_application(request)
-      end
-
-      def update_trust_application(application_id:, tags: nil)
-        request = PatchTrustApplicationRequest.new(application_id, tags)
-        Unit::Resource::ApplicationResource.update(request)
-      end
     end
   end
 end

data/lib/unit/models/cash_deposit/cash_deposit.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Unit
+  module CashDeposit
+    CASH_DEPOSIT_LIMIT = 100
+    CASH_DEPOSIT_OFFSET = 0
+
+    autoload :GenerateBarcodeRequest, "unit/models/cash_deposit/generate_barcode_request"
+    autoload :ListByCoordinatesParams, "unit/models/cash_deposit/list_by_coordinates_params"
+    autoload :ListByPostalCodeParams, "unit/models/cash_deposit/list_by_postal_code_params"
+
+    class << self
+      # Generate a barcode for cash deposit
+      # @see https://unit.co/docs/api/payments/cash-deposits/#post-cash-deposit-generate-barcode
+      # @param store_id [String]
+      # @param account_id [String]
+      # @param customer_id [String]
+      def generate_barcode(store_id:, account_id:, customer_id:)
+        request = GenerateBarcodeRequest.new(store_id, account_id, customer_id)
+        Unit::Resource::CashDepositResource.generate_barcode(request)
+      end
+
+      # List cash deposit store locations by coordinates
+      # @see https://unit.co/docs/api/payments/cash-deposits/#list-cash-deposit-store-locations-by-coordinates
+      # @param coordinates [Coordinates]
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param service_type [String] - optional
+      def list_by_coordinates(coordinates:, limit: CASH_DEPOSIT_LIMIT, offset: CASH_DEPOSIT_OFFSET, service_type: nil)
+        request = ListByCoordinatesParams.new(coordinates, limit, offset, service_type)
+        Unit::Resource::CashDepositResource.list_by_coordinates(request)
+      end
+
+      # List cash deposit store locations by postal code
+      # @see https://unit.co/docs/api/payments/cash-deposits/#list-cash-deposit-store-locations-by-postal-code
+      # @param postal_code [String]
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param service_type [String] - optional
+      def list_by_postal_code(postal_code:, limit: CASH_DEPOSIT_LIMIT, offset: CASH_DEPOSIT_OFFSET, service_type: nil)
+        request = ListByPostalCodeParams.new(postal_code, limit, offset, service_type)
+        Unit::Resource::CashDepositResource.list_by_postal_code(request)
+      end
+
+      # Get image by barcode number
+      # @see https://unit.co/docs/api/payments/cash-deposits/#get-barcode-image-by-barcode-number
+      # @param barcode_number [String]
+      def get_image_by_barcode_number(barcode_number:)
+        Unit::Resource::CashDepositResource.get_image_by_barcode_number(barcode_number)
+      end
+    end
+  end
+end

data/lib/unit/models/cash_deposit/generate_barcode_request.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Request to generate a barcode for cash deposit
+# @see https://unit.co/docs/api/payments/cash-deposits/#post-cash-deposit-generate-barcode
+module Unit
+  module CashDeposit
+    class GenerateBarcodeRequest
+      attr_reader :store_id, :account_id, :customer_id
+
+      # @param store_id [String]
+      # @param account_id [String]
+      # @param customer_id [String]
+      def initialize(store_id, account_id, customer_id)
+        @store_id = store_id
+        @account_id = account_id
+        @customer_id = customer_id
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "cashDepositBarcode",
+            "attributes": {
+              storeId: store_id
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("account", account_id).to_hash,
+              "customer": Unit::Types::Relationship.new("customer", customer_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Request to list cash deposits
+# @see https://unit.co/docs/api/payments/cash-deposits/#list-cash-deposit-store-locations-by-coordinates
+module Unit
+  module CashDeposit
+    class ListByCoordinatesParams
+      attr_reader :limit, :offset, :coordinates, :service_type
+
+      # @param coordinates [Coordinates]
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param service_type [String] - optional
+      def initialize(coordinates, limit = CASH_DEPOSIT_LIMIT, offset = CASH_DEPOSIT_OFFSET,
+                     service_type = nil)
+        @limit = limit
+        @offset = offset
+        @coordinates = coordinates
+        @service_type = service_type
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[coordinates]": coordinates.represent,
+          "filter[serviceType]": service_type
+        }
+        params.compact
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Request to list cash deposits by postal code
+# @see https://unit.co/docs/api/payments/cash-deposits/#list-cash-deposit-store-locations-by-postal-code
+module Unit
+  module CashDeposit
+    class ListByPostalCodeParams
+      attr_reader :limit, :offset, :postal_code, :service_type
+
+      # @param postal_code [String]
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param service_type [String] - optional
+      def initialize(postal_code, limit = CASH_DEPOSIT_LIMIT, offset = CASH_DEPOSIT_OFFSET,
+                     service_type = nil)
+        @limit = limit
+        @offset = offset
+        @postal_code = postal_code
+        @service_type = service_type
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[postalCode]": postal_code,
+          "filter[serviceType]": service_type
+        }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/check_payment/check_payment.rb

@@ -6,11 +6,29 @@ module Unit
     CHECK_PAYMENT_OFFSET = 0
 
     autoload :GetRequest, "unit/models/check_payment/get_request"
+    autoload :OriginateCheckPaymentRequest, "unit/models/check_payment/originate_check_payment_request"
     autoload :ListPaymentParams, "unit/models/check_payment/list_check_payment_params"
     autoload :GetImageRequest, "unit/models/check_payment/get_image_request"
     autoload :ReturnCheckPaymentRequest, "unit/models/check_payment/return_check_payment_request"
 
     class << self
+      # Originate a check payment by id
+      # @see https://docs.unit.co/originate-check-payments/#check-payments
+      # @param account_id [String]
+      # @param customer_id [String]
+      # @param customer_type [String]
+      # @param amount [Integer]
+      # @param counterparty [CheckPaymentCounterparty]
+      # @param description [String]
+      # @param idempotency_key [String]
+      # @param memo [String] - optional
+      # @param send_date [String] - optional
+      # @param tags [Hash] - optional
+      def originate_check_payment(account_id:, customer_id:, customer_type:, amount:, counterparty:, description:, idempotency_key:, memo: nil, send_date: nil, tags: nil)
+        request = OriginateCheckPaymentRequest.new(account_id, customer_id, customer_type, amount, counterparty, description, idempotency_key, memo, send_date, tags)
+        Unit::Resource::CheckPaymentResource.originate_payment(request)
+      end
+
       # Get a check payment by id
       # @see https://docs.unit.co/check-payments#get-specific-check-payment
       # @param payment_id [String]
@@ -69,6 +87,13 @@ module Unit
       def approve_payment_verification(payment_id:)
         Unit::Resource::CheckPaymentResource.approve_payment_verification(payment_id)
       end
+
+      # Cancel Check Payment
+      # @see https://docs.unit.co/originate-check-payments/#cancel-check-payment
+      # @param payment_id [String]
+      def cancel_check_payment(payment_id:)
+        Unit::Resource::CheckPaymentResource.cancel_payment(payment_id)
+      end
     end
   end
 end

data/lib/unit/models/check_payment/originate_check_payment_request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Request to originate check payments
+# @see https://docs.unit.co/originate-check-payments/#check-payments
+module Unit
+  module CheckPayment
+    class OriginateCheckPaymentRequest
+      attr_reader :account_id, :customer_id, :customer_type, :amount, :counterparty, :description, :memo, :idempotency_key, :send_date, :tags
+
+      # @param account_id [String]
+      # @param customer_id [String]
+      # @param customer_type [String]
+      # @param amount [Integer]
+      # @param counterparty [CheckPaymentCounterparty]
+      # @param description [String]
+      # @param idempotency_key [String]
+      # @param memo [String] - optional
+      # @param send_date [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(account_id, customer_id, customer_type, amount, counterparty, description, idempotency_key, memo, send_date, tags = nil)
+        @account_id = account_id
+        @customer_id = customer_id
+        @customer_type = customer_type
+        @amount = amount
+        @counterparty = counterparty
+        @description = description
+        @idempotency_key = idempotency_key
+        @memo = memo
+        @send_date = send_date
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "checkPayment",
+            "attributes": {
+              "amount": amount,
+              "counterparty": counterparty.represent,
+              "description": description,
+              "memo": memo,
+              "sendDate": send_date,
+              "idempotencyKey": idempotency_key,
+              "tags": tags
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+              "customer": Unit::Types::Relationship.new(customer_type, customer_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/tax_form/list_tax_form_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Request to list tax forms
+# @see https://unit.co/docs/api/tax-forms/#list-tax-forms
+module Unit
+  module TaxForm
+    class ListTaxFormParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :tax_years, :tax_form_types
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param tax_years [String] - optional
+      # @param tax_form_types [String] - optional
+      def initialize(limit = TAX_FORM_LIMIT, offset = TAX_FORM_OFFSET,
+                     account_id = nil, customer_id = nil, tax_years = nil, tax_form_types = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @tax_years = tax_years
+        @tax_form_types = tax_form_types
+      end
+
+      def to_hash
+        params = { "page[limit]": limit,
+                   "page[offset]": offset,
+                   "filter[accountId]": account_id,
+                   "filter[customerId]": customer_id,
+                   "filter[taxYears]": tax_years,
+                   "filter[taxFormTypes]": tax_form_types }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/tax_form/tax_form.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Unit
+  module TaxForm
+    TAX_FORM_LIMIT = 100
+    TAX_FORM_OFFSET = 0
+    autoload :ListTaxFormParams, "unit/models/tax_form/list_tax_form_params"
+
+    class << self
+      # List tax forms
+      # @see https://unit.co/docs/api/tax-forms/#list-tax-forms
+      # @param limit [Integer]
+      # @param offset [Integer]
+      # @param account_id [String]
+      # @param customer_id [String]
+      # @param tax_years [String]
+      # @param tax_form_types [String]
+      def list_tax_forms(limit: TAX_FORM_LIMIT, offset: TAX_FORM_OFFSET,
+                         account_id: nil, customer_id: nil, tax_years: nil, tax_form_types: nil)
+        params = ListTaxFormParams.new(limit, offset, account_id, customer_id, tax_years, tax_form_types)
+        Unit::Resource::TaxFormResource.list(params)
+      end
+
+      # Get tax form by id
+      # @see https://unit.co/docs/api/tax-forms/#get-tax-form
+      # @param tax_form_id [String]
+      def get_by_id(tax_form_id:)
+        Unit::Resource::TaxFormResource.get_tax_form_by_id(tax_form_id)
+      end
+
+      # Get tax form pdf by id
+      # @see https://unit.co/docs/api/tax-forms/#get-tax-form-pdf
+      # @param tax_form_id [String]
+      def get_pdf_by_id(tax_form_id:)
+        Unit::Resource::TaxFormResource.get_tax_form_pdf_by_id(tax_form_id)
+      end
+    end
+  end
+end

data/lib/unit/types/check_payment_counterparty.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# @see https://docs.unit.co/types#check-payment-counterparty
+module Unit
+  module Types
+    class CheckPaymentCounterparty
+      attr_reader :name, :address, :counterparty_moved
+
+      # @param name [String]
+      # @param address [Address]
+      # @param counterparty_moved [Boolean]
+      def initialize(name, address, counterparty_moved = nil)
+        @name = name
+        @address = address
+        @counterparty_moved = counterparty_moved
+      end
+
+      def represent
+        params = {
+          name: name,
+          address: address&.represent,
+          counterpartyMoved: counterparty_moved
+        }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/version.rb

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

data/lib/unit_ruby_sdk.rb

@@ -18,7 +18,6 @@ module Unit
   autoload :AtmLocation, "unit/models/atm_location/atm_location"
   autoload :CheckDeposit, "unit/models/check_deposit/check_deposit"
   autoload :Counterparty, "unit/models/counterparty/counterparty"
-  autoload :RecurringPayment, "unit/models/recurring_payment/recurring_payment"
   autoload :Institution, "unit/models/institution/institution"
   autoload :Repayment, "unit/models/repayment/repayment"
   autoload :Event, "unit/models/event/event"
@@ -28,6 +27,8 @@ module Unit
   autoload :Authorization, "unit/models/authorization/authorization"
   autoload :AuthorizationRequest, "unit/models/authorization_request/authorization_request"
   autoload :RecurringPayment, "unit/models/recurring_payment/recurring_payment"
+  autoload :TaxForm, "unit/models/tax_form/tax_form"
+  autoload :CashDeposit, "unit/models/cash_deposit/cash_deposit"
 
   module Resource
     autoload :ApplicationResource, "unit/api_resources/application_resource"
@@ -45,7 +46,6 @@ module Unit
     autoload :AtmLocationResource, "unit/api_resources/atm_location_resource"
     autoload :CheckDepositResource, "unit/api_resources/check_deposit_resource"
     autoload :CounterpartyResource, "unit/api_resources/counterparty_resource"
-    autoload :RecurringPaymentResource, "unit/api_resources/recurring_payment_resource"
     autoload :InstitutionResource, "unit/api_resources/institution_resource"
     autoload :RepaymentResource, "unit/api_resources/repayment_resource"
     autoload :EventResource, "unit/api_resources/event_resource"
@@ -55,6 +55,8 @@ module Unit
     autoload :AuthorizationResource, "unit/api_resources/authorization_resource"
     autoload :AuthorizationRequestResource, "unit/api_resources/authorization_request_resource"
     autoload :RecurringPaymentResource, "unit/api_resources/recurring_payment_resource"
+    autoload :TaxFormResource, "unit/api_resources/tax_form_resource"
+    autoload :CashDepositResource, "unit/api_resources/cash_deposit_resource"
   end
 
   module Types
@@ -66,6 +68,7 @@ module Unit
     autoload :EvaluationParams, "unit/types/evaluation_params"
     autoload :Counterparty, "unit/types/counterparty"
     autoload :WireCounterparty, "unit/types/wire_counterparty"
+    autoload :CheckPaymentCounterparty, "unit/types/check_payment_counterparty"
     autoload :FullName, "unit/types/full_name"
     autoload :Officer, "unit/types/officer"
     autoload :Phone, "unit/types/phone"
@@ -76,11 +79,6 @@ module Unit
     autoload :DocumentFileType, "unit/types/document_file_type"
     autoload :Coordinates, "unit/types/coordinates"
     autoload :CreateSchedule, "unit/types/create_schedule"
-    autoload :TrustContact, "unit/types/trust_contact"
-    autoload :Trustee, "unit/types/trustee"
-    autoload :Grantor, "unit/types/grantor"
-    autoload :Beneficiary, "unit/types/beneficiary"
-    autoload :CreateSchedule, "unit/types/create_schedule"
     autoload :ApplicationFormSettingsOverride, "unit/types/application_form_settings_override"
     autoload :ApplicationFormPrefill, "unit/types/application_form_prefill"
     autoload :RequireIdVerification, "unit/types/require_id_verification"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Unit
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-13 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -103,6 +103,7 @@ files:
 - lib/unit/api_resources/authorization_resource.rb
 - lib/unit/api_resources/base_resource.rb
 - lib/unit/api_resources/card_resource.rb
+- lib/unit/api_resources/cash_deposit_resource.rb
 - lib/unit/api_resources/check_deposit_resource.rb
 - lib/unit/api_resources/check_payment_resource.rb
 - lib/unit/api_resources/counterparty_resource.rb
@@ -117,6 +118,7 @@ files:
 - lib/unit/api_resources/reward_resource.rb
 - lib/unit/api_resources/statement_resource.rb
 - lib/unit/api_resources/stop_payment_resource.rb
+- lib/unit/api_resources/tax_form_resource.rb
 - lib/unit/api_resources/transaction_resource.rb
 - lib/unit/api_resources/webhook_resource.rb
 - lib/unit/errors/unit_error.rb
@@ -144,10 +146,8 @@ files:
 - lib/unit/models/application/create_business_application_request.rb
 - lib/unit/models/application/create_individual_application_request.rb
 - lib/unit/models/application/create_sole_proprietor_application_request.rb
-- lib/unit/models/application/create_trust_application_request.rb
 - lib/unit/models/application/list_application_params.rb
 - lib/unit/models/application/patch_application_request.rb
-- lib/unit/models/application/patch_trust_application_request.rb
 - lib/unit/models/application/upload_document_request.rb
 - lib/unit/models/application_form/application_form.rb
 - lib/unit/models/application_form/create_application_form_request.rb
@@ -176,6 +176,10 @@ files:
 - lib/unit/models/card/patch_business_virtual_card_request.rb
 - lib/unit/models/card/patch_business_virtual_credit_card_request.rb
 - lib/unit/models/card/replace_card_request.rb
+- lib/unit/models/cash_deposit/cash_deposit.rb
+- lib/unit/models/cash_deposit/generate_barcode_request.rb
+- lib/unit/models/cash_deposit/list_by_coordinates_params.rb
+- lib/unit/models/cash_deposit/list_by_postal_code_params.rb
 - lib/unit/models/check_deposit/check_deposit.rb
 - lib/unit/models/check_deposit/create_check_deposit_request.rb
 - lib/unit/models/check_deposit/get_image_request.rb
@@ -187,6 +191,7 @@ files:
 - lib/unit/models/check_payment/get_image_request.rb
 - lib/unit/models/check_payment/get_request.rb
 - lib/unit/models/check_payment/list_check_payment_params.rb
+- lib/unit/models/check_payment/originate_check_payment_request.rb
 - lib/unit/models/check_payment/return_check_payment_request.rb
 - lib/unit/models/counterparty/counterparty.rb
 - lib/unit/models/counterparty/create_counterparty_request.rb
@@ -243,6 +248,8 @@ files:
 - lib/unit/models/stop_payment/create_stop_payment_request.rb
 - lib/unit/models/stop_payment/list_stop_payment_params.rb
 - lib/unit/models/stop_payment/stop_payment.rb
+- lib/unit/models/tax_form/list_tax_form_params.rb
+- lib/unit/models/tax_form/tax_form.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
@@ -260,8 +267,8 @@ files:
 - lib/unit/types/application_form_settings_override.rb
 - lib/unit/types/authorized_user.rb
 - lib/unit/types/beneficial_owner.rb
-- lib/unit/types/beneficiary.rb
 - lib/unit/types/business_contact.rb
+- lib/unit/types/check_payment_counterparty.rb
 - lib/unit/types/coordinates.rb
 - lib/unit/types/counterparty.rb
 - lib/unit/types/create_schedule.rb
@@ -269,7 +276,6 @@ files:
 - lib/unit/types/document_file_type.rb
 - lib/unit/types/evaluation_params.rb
 - lib/unit/types/full_name.rb
-- lib/unit/types/grantor.rb
 - lib/unit/types/officer.rb
 - lib/unit/types/phone.rb
 - lib/unit/types/power_of_attorney_agent.rb
@@ -277,12 +283,11 @@ files:
 - lib/unit/types/relationship_array.rb
 - lib/unit/types/require_id_verification.rb
 - lib/unit/types/restricted_resource.rb
-- lib/unit/types/trust_contact.rb
-- lib/unit/types/trustee.rb
 - lib/unit/types/wire_counterparty.rb
 - lib/unit/utils/http_helper.rb
 - lib/unit/version.rb
 - lib/unit_ruby_sdk.rb
+- tax_form_1.pdf
 homepage: https://github.com/unit-finance/unit-ruby-sdk
 licenses:
 - Mozilla Public License 2.0

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

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-# Request to create a trust application
-# @see https://docs.unit.co/applications#create-trust-application
-module Unit
-  module Application
-    class CreateTrustApplicationRequest
-      attr_reader :name, :state_of_incorporation, :revocability, :source_of_funds, :tax_id,
-                  :grantor, :trustees, :beneficiaries, :contact, :ip, :tags, :idempotency_key, :device_fingerprints
-
-      # @param name [String]
-      # @param state_of_incorporation [String]
-      # @param revocability [String]
-      # @param source_of_funds [String]
-      # @param tax_id [String]
-      # @param grantor [Grantor]
-      # @param trustees [Array<Trustee>]
-      # @param beneficiaries [Array<Beneficiary>]
-      # @param contact [TrustContact]
-      # @param ip [String] - optional
-      # @param tags [Hash] - optional
-      # @param idempotency_key [String] - optional
-      # @param device_fingerprints [Array<DeviceFingerprint>] - optional
-      def initialize(name, state_of_incorporation, revocability, source_of_funds, tax_id,
-                     grantor, trustees, beneficiaries, contact, ip = nil, tags = nil, idempotency_key = nil, device_fingerprints = nil)
-        @name = name
-        @state_of_incorporation = state_of_incorporation
-        @revocability = revocability
-        @source_of_funds = source_of_funds
-        @tax_id = tax_id
-        @grantor = grantor
-        @trustees = trustees
-        @beneficiaries = beneficiaries
-        @contact = contact
-        @ip = ip
-        @tags = tags
-        @idempotency_key = idempotency_key
-        @device_fingerprints = device_fingerprints
-      end
-
-      def to_json_api
-        payload = {
-          data: {
-            type: "trustApplication",
-            attributes: {
-              name: name,
-              stateOfIncorporation: state_of_incorporation,
-              revocability: revocability,
-              sourceOfFunds: source_of_funds,
-              taxId: tax_id,
-              grantor: grantor&.represent,
-              trustees: trustees,
-              beneficiaries: beneficiaries,
-              contact: contact&.represent,
-              ip: ip,
-              tags: tags,
-              idempotencyKey: idempotency_key,
-              deviceFingerprints: device_fingerprints
-            }
-          }
-        }
-        payload[:data][:attributes].compact!
-        payload.to_json
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-# Request to update a trust application
-# @see https://docs.unit.co/applications/#update-trust-application
-module Unit
-  module Application
-    class PatchTrustApplicationRequest
-      attr_reader :application_id, :tags
-
-      # @param application_id [String]
-      # @param tags [Hash] - optional
-      def initialize(application_id, tags = nil)
-        @application_id = application_id
-        @tags = tags
-      end
-
-      def to_json_api
-        payload = {
-          data: {
-            type: "trustApplication",
-            attributes: {
-              tags: tags
-            }
-          }
-        }
-        payload[:data][:attributes].compact!
-        payload.to_json
-      end
-    end
-  end
-end

data/lib/unit/types/beneficiary.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# @see https://docs.unit.co/types#beneficiary
-module Unit
-  module Types
-    class Beneficiary
-      attr_reader :full_name, :date_of_birth
-
-      # @param full_name [FullName]
-      # @param date_of_birth [Date]
-      def initialize(full_name, date_of_birth = nil)
-        @full_name = full_name
-        @date_of_birth = date_of_birth
-      end
-
-      def represent
-        payload = {
-          fullName: full_name.represent,
-          dateOfBirth: date_of_birth
-        }
-        payload.compact
-      end
-    end
-  end
-end

data/lib/unit/types/grantor.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# @see https://docs.unit.co/types#grantor
-module Unit
-  module Types
-    class Grantor
-      attr_reader :full_name, :date_of_birth, :ssn, :email, :phone, :address
-
-      # @param full_name [FullName]
-      # @param ssn [String]
-      # @param email [String]
-      # @param phone [Phone]
-      # @param address [Address]
-      # @param date_of_birth [Date] - optional
-      def initialize(full_name, ssn, email, phone, address, date_of_birth = nil)
-        @full_name = full_name
-        @date_of_birth = date_of_birth
-        @ssn = ssn
-        @email = email
-        @phone = phone
-        @address = address
-      end
-
-      def represent
-        payload = {
-          fullName: full_name.represent,
-          dateOfBirth: date_of_birth,
-          ssn: ssn,
-          email: email,
-          phone: phone.represent,
-          address: address.represent
-        }
-        payload.compact
-      end
-    end
-  end
-end

data/lib/unit/types/trust_contact.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-# @see https://docs.unit.co/types#trustcontact
-module Unit
-  module Types
-    class TrustContact
-      attr_reader :full_name, :email, :phone, :address, :jwt_subject
-
-      # @param full_name [FullName]
-      # @param email [String]
-      # @param phone [Phone]
-      # @param address [Address]
-      # @param jwt_subject [String] - optional
-      def initialize(full_name, email, phone, address, jwt_subject = nil)
-        @full_name = full_name
-        @email = email
-        @phone = phone
-        @address = address
-        @jwt_subject = jwt_subject
-      end
-
-      def represent
-        payload = {
-          fullName: full_name.represent,
-          email: email,
-          phone: phone.represent,
-          address: address.represent,
-          jwtSubject: jwt_subject
-        }
-        payload.compact
-      end
-    end
-  end
-end

data/lib/unit/types/trustee.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# @see https://docs.unit.co/types#trustee
-module Unit
-  module Types
-    class Trustee
-      attr_reader :full_name, :ssn, :email, :phone, :address, :date_of_birth
-
-      # @param full_name [FullName]
-      # @param ssn [String]
-      # @param email [String]
-      # @param phone [Phone]
-      # @param address [Address]
-      # @param date_of_birth [Date] - optional
-      def initialize(full_name, ssn, email, phone, address, date_of_birth = nil)
-        @full_name = full_name
-        @ssn = ssn
-        @email = email
-        @phone = phone
-        @address = address
-        @date_of_birth = date_of_birth
-      end
-
-      def represent
-        payload = {
-          fullName: full_name.represent,
-          ssn: ssn,
-          email: email,
-          phone: phone.represent,
-          address: address.represent,
-          dateOfBirth: date_of_birth
-        }
-        payload.compact
-      end
-    end
-  end
-end