unit_ruby_sdk 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4427f4ca95ba8cf893f2e7c9ff5c21605419518429095a8aff3a41cd8876fed9
-  data.tar.gz: 672fd892ed734631361b0f94b52b3ca95bc88780a6f4f9942b278c956526f245
+  metadata.gz: 8dffd0552f07ada33b8cf7784a77ed1920c614648fd98279ec5df4a0556ea3c2
+  data.tar.gz: c825b344c162333143e63902e68b4c5bbdae064c6578d077de9b70b927699403
 SHA512:
-  metadata.gz: bef4edade650df1097bda85a10b7d81c614a4dc0d9e05247335e25d079a00fb2da81b71fd440963bd7bce69fede707bafd2c5c56230725dc9998b2ffdc8418af
-  data.tar.gz: a5db0ecc8a1baa2a2d48f523f4e4e05ad8dc98c58ba9da7fb82bd4acd8be4ef22e1502607f764eec055bdc92e2b3b947fef9b479f8ac83841725c90bacc14c5a
+  metadata.gz: 7fbb567aac32e7fa8e30673fef006bdb02584ebab67a414798ebcd027cf477e652ece5366a0c672317f0a9fd69389349640c160b237d4539f7b0f35c8c36ef41
+  data.tar.gz: affbc56b24a3182ddaf5f060a9dedc68f7c49b51213e683a6854a9a78a88e5e7f1a8e515cd250a031f6c8c6b00435b46833744f94b7b44d8ce12dbbab8e458ce

data/.rubocop.yml

@@ -5,6 +5,9 @@ Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Lint/DuplicateMethods:
+  Enabled: false
+
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes

data/README.md

@@ -14,7 +14,8 @@ gem install unit_ruby_sdk
 
 ## Usage
 
-Bellow are a few usage examples of Unit's Ruby SDK. For full documentation of Unit's API please refer to the full documentation at https://docs.unit.co/
+Bellow are a few usage examples of Unit's Ruby SDK. For full documentation of Unit's API please refer to the full
+documentation at https://docs.unit.co/
 
 ### Creating a Business Application
 
@@ -53,10 +54,10 @@ contents = file.read
 file.close
 
 upload_document_request = Unit::Application.upload_document(
-  application_id: "836683", 
-  document_id: "125214", 
-  file: contents, 
-  file_type: Unit::Types::DocumentFileType::PDF, 
+  application_id: "836683",
+  document_id: "125214",
+  file: contents,
+  file_type: Unit::Types::DocumentFileType::PDF,
   is_back_side: true)
 
 puts upload_document_request.data["id"]
@@ -72,54 +73,56 @@ 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)
+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")
+  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
 relationships = { "customer": Unit::Types::Relationship.new("customer", "111009").to_hash }
 response = Unit::Account::Deposit.create_deposit_account(
-  deposit_product: "checking", 
-  tags: { "purpose": "checking" }, 
+  deposit_product: "checking",
+  tags: { "purpose": "checking" },
   relationships: relationships)
 deposit_account = response.data
 puts deposit_account["id"]
 ```
 
 ### Creating a credit account request
+
 ```ruby
 response = Unit::Account::Credit.create_credit_account(
-  credit_terms: "credit_terms_test", 
-  credit_limit: 20_000, 
-  customer_id: "851228", 
+  credit_terms: "credit_terms_test",
+  credit_limit: 20_000,
+  customer_id: "851228",
   tags: { "purpose": "tax" })
 credit_account = response.data
 puts credit_account["id"]
 ```
 
 ### Creating a batch release request
+
 ```ruby
 requests =
   [
@@ -128,10 +131,9 @@ requests =
   ]
 response = Unit::Payment.create_batch_release(requests)
 batch_release = response.data
-puts batch_release[0].id
+puts batch_release[0]["id"]
 ```
 
-
 ### Fetching a Customer
 
 ```ruby
@@ -144,14 +146,14 @@ puts customer["id"]
 ```
 
 ### Creating a Payment
-    
+
 ```ruby
 require 'unit_ruby_sdk'
 
 response = Unit::Payment.create_book_payment(
-  amount: 1000, 
-  description: "test payment", 
-  account_id: "27573", 
+  amount: 1000,
+  description: "test payment",
+  account_id: "27573",
   counterparty_account_id: "36981"
 )
 payment = response.data
@@ -174,11 +176,11 @@ response = Unit::Authorization.get_authorization(
   include_non_authorized: true
 )
 authorization = response.data
-puts authorization.id
+puts authorization["id"]
 ```
 
-
 ### Creating an individual debit card
+
 ```ruby
 response = Unit::Card.create_individual_debit_card(
   account_id: '1234',
@@ -193,14 +195,17 @@ puts card["id"]
 ```
 
 ### Updating a received payment
+
 ```ruby
 response = Unit::ReceivedPayment.update_payment(
-  payment_id: "1232", 
+  payment_id: "1232",
   tags: { purpose: "test" })
 received_payment = response.data
 puts received_payment["id"]
+```
 
 ### Creating a business credit card
+
 ```ruby
 full_name = Unit::Types::FullName.new('John', 'Doe')
 date_of_birth = '1980-08-10'
@@ -208,18 +213,19 @@ address = Unit::Types::Address.new('123 Main St', 'San Francisco', 'CA', '94205'
 phone = Unit::Types::Phone.new('380', '555123222')
 email = 'jone.doe@unit-finance.com'
 response = Unit::Card.create_business_credit_card(
-  account_id: "1234", 
+  account_id: "1234",
   full_name: full_name,
-  date_of_birth: date_of_birth, 
-  address: address, 
-  phone: phone, 
+  date_of_birth: date_of_birth,
+  address: address,
+  phone: phone,
   email: email
 )
 charge_card = response.data
-puts charge_card.id
+puts charge_card["id"]
 ```
 
 ### Creating a check deposit
+
 ```ruby
 response = Unit::CheckDeposit.create_deposit(
   account_id: account_id,
@@ -231,54 +237,57 @@ puts deposit["id"]
 ```
 
 ### Creating a counterparty with a plaid token
+
 ```ruby
 response = Unit::Counterparty.create_with_plaid_token(
-  customer_id: "823139", 
-  type: "Business", 
-  name: "Jo Joel", 
+  customer_id: "823139",
+  type: "Business",
+  name: "Jo Joel",
   plaid_processor_token: "processor-sandbox-plaid-token")
 
 counterparty = response.data
 puts counterparty["id"]
 ```
 
-
 ### Creating a Payment to linked counterparty
+
 ```ruby
  response = Unit::Payment.create_ach_payment_linked(
-   account_id: "123456", 
-   counterparty_id: "56784", 
-   amount: 1000, 
-   direction: "Credit",
-   description: "test payment"
- )
- ach_payment = response.data
- puts ach_payment["id"]
+  account_id: "123456",
+  counterparty_id: "56784",
+  amount: 1000,
+  direction: "Credit",
+  description: "test payment"
+)
+ach_payment = response.data
+puts ach_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"]
+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
  address = Unit::Types::Address.new('123 Main St', 'San Francisco', 'CA', '94205', 'US')
- response = Unit::Payment.create_wire_payment(
-   account_id: "1234", 
-   amount: 1000, 
-   description: "test payment", 
-   counterparty: Unit::Types::WireCounterparty.new("Jane Doe", "27573", "812345678", address))
- wire_payment = response.data
- puts wire_payment["id"]
+response = Unit::Payment.create_wire_payment(
+  account_id: "1234",
+  amount: 1000,
+  description: "test payment",
+  counterparty: Unit::Types::WireCounterparty.new("Jane Doe", "27573", "812345678", address))
+wire_payment = response.data
+puts wire_payment["id"]
 ```
 
 ### Get an event by id
+
 ```ruby
 response = Unit::Event.get_event(event_id: "12605774")
 event = response.data
@@ -286,6 +295,7 @@ puts event.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)
@@ -302,21 +312,36 @@ bulk_payment = response.data
 puts bulk_payment["id"]
 ```
 
+### Creating a stop payment
+
+```ruby
+response = Unit::StopPayment.create_stop_payment(
+  account_id: "165432",
+  amount: 10_345,
+  check_number: "123456",
+  tags: { "test": "122" }
+)
+stop_payment = response.data
+puts stop_payment["id"]
+```
+
 ### Creating a book repayment
+
 ```ruby
 response = Unit::Repayment.create_book_repayment(
   account_id: "10001",
   credit_account_id: "10002",
-  counterparty_account_id: "10003", 
+  counterparty_account_id: "10003",
   description: "test", amount: 100,
-  transaction_summary_override: "override", 
-  tags: { purpose: "test" }, 
+  transaction_summary_override: "override",
+  tags: { purpose: "test" },
   idempotency_key: "3a1a33be-4e12-4603-9ed0-820922389fb8")
 book_repayment = response.data
 puts book_repayment["id"]
 ```
 
 ### Creating a control agreement
+
 ```ruby
 response = Unit::Account::DACA.activate_control_agreement(account_id: "1234")
 control_agreement = response.data
@@ -324,22 +349,21 @@ puts control_agreement["id"]
 ```
 
 ### Get a check payment by id
+
 ```ruby
 response = Unit::CheckPayment.get_payment(payment_id: "199")
 check_payment = response.data
 puts check_payment["id"]
 ```
-### Logging Errors
-
-### Handling Response
 
 ### Creating a webhook
+
 ```ruby
 response = Unit::Webhook.create_webhook(
-  label: "some label", 
+  label: "some label",
   url: "https://webhook.site/81ee6b53-fde4-4b7d-85a0-0b6249a4488d",
-  token: "MyToken", 
-  content_type: "Json", 
+  token: "MyToken",
+  content_type: "Json",
   delivery_mode: "AtLeastOnce",
   include_resources: false,
   subscription_type: "OnlyAuthorizationRequest")
@@ -348,20 +372,23 @@ puts webhook["id"]
 ```
 
 ### Creating a fee
+
 ```ruby
 response = Unit::Fee.create_fee(
-  account_id: "27573", 
-  amount: 12_345, 
-  description: "test", 
-  tags: { purpose: "test" }, 
+  account_id: "27573",
+  amount: 12_345,
+  description: "test",
+  tags: { purpose: "test" },
   idempotency_key: "123"
 )
 fee = response.data
 puts fee["id"]
 ```
 
+### Logging Errors
 
 ### Handling Response
+
 ```ruby
 require 'unit_ruby_sdk'
 
@@ -375,6 +402,6 @@ if response.instance_of?(Unit::UnitResponse)
   # handle response
 else
   # handle error
-  response.errors.each{|error| puts error.title}
+  response.errors.each { |error| puts error.title }
 end
 ```

data/lib/unit/api_resources/stop_payment_resource.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+
+# class for creating request for stop payments to Unit API and parsing responses
+# @see https://docs.unit.co/stop-payments
+module Unit
+  module Resource
+    class StopPaymentResource < Unit::Resource::BaseResource
+      class << self
+        # Create a stop payment by calling Unit's API
+        # @param request [CreateStopPaymentRequest]
+        # @return [UnitResponse, UnitError]
+        def create_payment(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/stop-payments", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a stop payment by calling Unit's API
+        # @param payment_id [String]
+        # @return [UnitResponse, UnitError]
+        def get(payment_id)
+          response = HttpHelper.get("#{api_url}/stop-payments/#{payment_id}", headers: headers)
+          response_handler(response)
+        end
+
+        # Get a list of stop payments by calling Unit's API
+        # @param params [ListStopPaymentParams]
+        # @return [UnitResponse, UnitError]
+        def list(params = nil)
+          response = HttpHelper.get("#{api_url}/stop-payments", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Disable a stop payment by calling Unit's API
+        # @param payment_id [String]
+        # @return [UnitResponse, UnitError]
+        def disable_payment(payment_id)
+          response = HttpHelper.post("#{api_url}/stop-payments/#{payment_id}/disable", headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

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

@@ -99,16 +99,12 @@ module Unit
       # @param phone [Phone]
       # @param email [String]
       # @param sole_proprietorship [Boolean]
-      # @param industry [String]
       # @param ssn [String] - optional
       # @param passport [String] - optional
       # @param ein [String] - optional
       # @param dba [String] - optional
       # @param power_of_attorney_agent [PowerOfAttorneyAgent] - optional
       # @param evaluation_params [EvaluationParams] - optional
-      # @param occupation [String] - optional
-      # @param annual_income [String] - optional
-      # @param source_of_income [String] - optional
       # @param annual_revenue [String] - optional
       # @param number_of_employees [String] - optional
       # @param business_vertical [String] - optional
@@ -120,13 +116,12 @@ module Unit
       # @param jwt_subject [String] - optional
       # @return [UnitResponse, UnitError]
       def create_sole_proprietor_application(nationality:, full_name:, date_of_birth:, address:, phone:,
-                                             email:, industry:, ssn: nil, passport: nil, ein: nil, dba: nil, power_of_attorney_agent: nil, evaluation_params: nil,
-                                             occupation: nil, annual_income: nil, source_of_income: nil, annual_revenue: nil,
-                                             number_of_employees: nil, business_vertical: nil, website: nil, ip: nil, tags: nil,
+                                             email:, ssn: nil, passport: nil, ein: nil, dba: nil, power_of_attorney_agent: nil, evaluation_params: nil,
+                                             annual_revenue: nil, number_of_employees: nil, business_vertical: nil, website: nil, ip: nil, tags: nil,
                                              idempotency_key: nil, device_fingerprints: nil, jwt_subject: nil, sole_proprietorship: true)
         request = CreateSoleProprietorApplicationRequest.new(nationality, full_name, date_of_birth, address, phone,
-                                                             email, industry, ssn, passport, ein, dba, power_of_attorney_agent, evaluation_params,
-                                                             occupation, annual_income, source_of_income, annual_revenue, number_of_employees,
+                                                             email, ssn, passport, ein, dba, power_of_attorney_agent, evaluation_params,
+                                                             annual_revenue, number_of_employees,
                                                              business_vertical, website, ip, tags, idempotency_key,
                                                              device_fingerprints, jwt_subject, sole_proprietorship: sole_proprietorship)
         Unit::Resource::ApplicationResource.create_application(request)

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

@@ -83,10 +83,10 @@ module Unit
               ip: ip,
               website: website,
               tags: tags,
-              idempotency_key: idempotency_key,
-              device_fingerprints: device_fingerprints,
-              annual_revenue: annual_revenue,
-              number_of_employees: number_of_employees,
+              idempotencyKey: idempotency_key,
+              deviceFingerprints: device_fingerprints,
+              annualRevenue: annual_revenue,
+              numberOfEmployees: number_of_employees,
               cashFlow: cash_flow,
               yearOfIncorporation: year_of_incorporation,
               countriesOfOperation: countries_of_operation&.join(","),

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

@@ -77,7 +77,7 @@ module Unit
               soleProprietorship: sole_proprietorship,
               passport: passport,
               nationality: nationality,
-              device_fingerprints: device_fingerprints,
+              deviceFingerprints: device_fingerprints,
               idempotencyKey: idempotency_key,
               tags: tags,
               jwtSubject: jwt_subject,

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

@@ -6,9 +6,9 @@ module Unit
   module Application
     class CreateSoleProprietorApplicationRequest
       attr_reader :ssn, :passport, :nationality, :full_name, :date_of_birth,
-                  :address, :phone, :email, :sole_proprietorship, :ein, :industry,
-                  :dba, :power_of_attorney_agent, :evaluation_params, :occupation,
-                  :annual_income, :source_of_income, :annual_revenue, :number_of_employees,
+                  :address, :phone, :email, :sole_proprietorship, :ein,
+                  :dba, :power_of_attorney_agent, :evaluation_params,
+                  :annual_revenue, :number_of_employees,
                   :business_vertical, :website, :ip, :tags, :idempotency_key,
                   :device_fingerprints, :jwt_subject
 
@@ -19,16 +19,12 @@ module Unit
       # @param phone [Phone]
       # @param email [String]
       # @param sole_proprietorship [Boolean]
-      # @param industry [String]
       # @param ssn [String] - optional
       # @param passport [String] - optional
       # @param ein [String] - optional
       # @param dba [String] - optional
       # @param power_of_attorney_agent [PowerOfAttorneyAgent] - optional
       # @param evaluation_params [EvaluationParams] - optional
-      # @param occupation [String] - optional
-      # @param annual_income [String] - optional
-      # @param source_of_income [String] - optional
       # @param annual_revenue [String] - optional
       # @param number_of_employees [String] - optional
       # @param business_vertical [String] - optional
@@ -39,9 +35,8 @@ module Unit
       # @param device_fingerprints [Array<DeviceFingerprint>] - optional
       # @param jwt_subject [String] - optional
       def initialize(nationality, full_name, date_of_birth, address, phone,
-                     email, industry, ssn = nil, passport = nil, ein = nil, dba = nil, power_of_attorney_agent = nil, evaluation_params = nil,
-                     occupation = nil, annual_income = nil, source_of_income = nil, annual_revenue = nil,
-                     number_of_employees = nil, business_vertical = nil, website = nil, ip = nil, tags = nil,
+                     email, ssn = nil, passport = nil, ein = nil, dba = nil, power_of_attorney_agent = nil, evaluation_params = nil,
+                     annual_revenue = nil, number_of_employees = nil, business_vertical = nil, website = nil, ip = nil, tags = nil,
                      idempotency_key = nil, device_fingerprints = nil, jwt_subject = nil, sole_proprietorship: true)
         @ssn = ssn
         @passport = passport
@@ -53,13 +48,9 @@ module Unit
         @email = email
         @sole_proprietorship = sole_proprietorship
         @ein = ein
-        @industry = industry
         @dba = dba
         @power_of_attorney_agent = power_of_attorney_agent
         @evaluation_params = evaluation_params
-        @occupation = occupation
-        @annual_income = annual_income
-        @source_of_income = source_of_income
         @annual_revenue = annual_revenue
         @number_of_employees = number_of_employees
         @business_vertical = business_vertical
@@ -86,13 +77,9 @@ module Unit
               email: email,
               soleProprietorship: sole_proprietorship,
               ein: ein,
-              industry: industry,
               dba: dba,
               powerOfAttorneyAgent: power_of_attorney_agent&.represent,
               evaluationParams: evaluation_params&.represent,
-              occupation: occupation,
-              annualIncome: annual_income,
-              sourceOfIncome: source_of_income,
               annualRevenue: annual_revenue,
               numberOfEmployees: number_of_employees,
               businessVertical: business_vertical,

data/lib/unit/models/check_deposit/create_check_deposit_request.rb

@@ -28,7 +28,7 @@ module Unit
               amount: amount,
               description: description,
               tags: tags,
-              idempotency_key: idempotency_key
+              idempotencyKey: idempotency_key
             },
             "relationships": {
               "account": Unit::Types::Relationship.new("account", account_id).to_hash

data/lib/unit/models/customer/patch_business_customer_request.rb

@@ -34,7 +34,7 @@ module Unit
               address: address&.represent,
               phone: phone&.represent,
               contact: contact&.represent,
-              authorized_users: authorized_users&.map(&:represent),
+              authorizedUsers: authorized_users&.map(&:represent),
               dba: dba,
               tags: tags
             }

data/lib/unit/models/customer/patch_individual_customer_request.rb

@@ -35,7 +35,7 @@ module Unit
               phone: phone&.represent,
               email: email,
               dba: dba,
-              authorized_users: authorized_users&.map(&:represent),
+              authorizedUsers: authorized_users&.map(&:represent),
               tags: tags
             }
           }

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

@@ -16,6 +16,7 @@ module Unit
     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
@@ -201,6 +202,6 @@ module Unit
         end
         Unit::Resource::PaymentResource.create_batch_release(payload.to_hash)
       end
-     end
+    end
   end
 end

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

@@ -35,7 +35,7 @@ module Unit
               "amount": amount,
               "description": description,
               "schedule": schedule&.represent,
-              "transaction_summary_override": transaction_summary_override,
+              "transactionSummaryOverride": transaction_summary_override,
               "idempotencyKey": idempotency_key,
               "tags": tags
             },

data/lib/unit/models/stop_payment/create_stop_payment_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Request to create a stop payment
+# @see https://docs.unit.co/stop-payments#create-stop-payment
+module Unit
+  module StopPayment
+    class CreateStopPaymentRequest
+      attr_reader :account_id, :amount, :check_number, :tags, :idempotency_key
+
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param check_number [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(account_id, amount, check_number, tags = nil, idempotency_key = nil)
+        @account_id = account_id
+        @amount = amount
+        @check_number = check_number
+        @tags = tags
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "stopPayment",
+            attributes: {
+              amount: amount,
+              checkNumber: check_number,
+              tags: tags,
+              idempotencyKey: idempotency_key
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/stop_payment/list_stop_payment_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Request to list stop payments
+# @see https://docs.unit.co/stop-payments#list-stop-payments
+module Unit
+  module StopPayment
+    class ListStopPaymentParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :tags, :sort,
+                  :since, :_until, :status, :from_amount, :to_amount, :check_number, :include
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param since [String] - optional
+      # @param _until [String] - optional
+      # @param status [Array<String>] - optional
+      # @param from_amount [String] - optional
+      # @param to_amount [String] - optional
+      # @param check_number [String] - optional
+      # @param include [Array<String>] - optional
+      def initialize(limit = STOP_PAYMENT_LIMIT, offset = STOP_PAYMENT_OFFSET, account_id = nil,
+                     customer_id = nil, tags = nil, sort = nil, since = nil, _until = nil, status = nil, from_amount = nil,
+                     to_amount = nil, check_number = nil, include = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @tags = tags
+        @sort = sort
+        @since = since
+        @until = _until
+        @status = status
+        @from_amount = from_amount
+        @to_amount = to_amount
+        @check_number = check_number
+        @include = include
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[accountId]": account_id,
+          "filter[customerId]": customer_id,
+          "filter[tags]": tags,
+          "sort": sort,
+          "filter[since]": since,
+          "filter[until]": _until,
+          "filter[fromAmount]": from_amount,
+          "filter[toAmount]": to_amount,
+          "filter[checkNumber]": check_number,
+          "include": include&.join(",")
+        }
+        status&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[status][#{index}]": val })
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/stop_payment/stop_payment.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Unit
+  module StopPayment
+    STOP_PAYMENT_LIMIT = 100
+    STOP_PAYMENT_OFFSET = 0
+
+    autoload :CreateStopPaymentRequest, "unit/models/stop_payment/create_stop_payment_request"
+    autoload :ListStopPaymentParams, "unit/models/stop_payment/list_stop_payment_params"
+
+    class << self
+      # Create a stop payment
+      # @see https://docs.unit.co/stop-payments#create-stop-payment
+      # @param amount [Integer]
+      # @param check_number [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def create_stop_payment(account_id:, amount:, check_number:, tags: nil, idempotency_key: nil)
+        request = CreateStopPaymentRequest.new(account_id, amount, check_number, tags, idempotency_key)
+        Unit::Resource::StopPaymentResource.create_payment(request)
+      end
+
+      # Get a stop payment
+      # @see https://docs.unit.co/stop-payments#get-specific-stop-payment
+      # @param payment_id [String]
+      def get_payment(payment_id:)
+        Unit::Resource::StopPaymentResource.get(payment_id)
+      end
+
+      # Request to list stop payments
+      # @see https://docs.unit.co/stop-payments#list-stop-payments
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param since [String] - optional
+      # @param _until [String] - optional
+      # @param status [Array<String>] - optional
+      # @param from_amount [String] - optional
+      # @param to_amount [String] - optional
+      # @param check_number [String] - optional
+      # @param include [Array<String>] - optional
+      def list_stop_payment(limit: STOP_PAYMENT_LIMIT, offset: STOP_PAYMENT_OFFSET, account_id: nil,
+                            customer_id: nil, tags: nil, sort: nil, since: nil, _until: nil, status: nil,
+                            from_amount: nil, to_amount: nil, check_number: nil, include: nil)
+        request = ListStopPaymentParams.new(limit, offset, account_id, customer_id, tags, sort, since, _until,
+                                            status, from_amount, to_amount, check_number, include)
+        Unit::Resource::StopPaymentResource.list(request)
+      end
+
+      # Disable a stop payment
+      # @see https://docs.unit.co/stop-payments#disable-stop-payment
+      # @param payment_id [String]
+      def disable_stop_payment(payment_id:)
+        Unit::Resource::StopPaymentResource.disable_payment(payment_id)
+      end
+    end
+  end
+end

data/lib/unit/models/webhook/patch_webhook_request.rb

@@ -32,10 +32,10 @@ module Unit
             attributes: {
               label: label,
               url: url,
-              content_type: content_type,
+              contentType: content_type,
               token: token,
-              include_resources: include_resources,
-              subscription_type: subscription_type
+              includeResources: include_resources,
+              subscriptionType: subscription_type
             }
           }
         }

data/lib/unit/models/webhook/webhook.rb

@@ -2,13 +2,13 @@
 
 module Unit
   module Webhook
-    class << self
-      WEBHOOK_LIMIT = 100
-      WEBHOOK_OFFSET = 0
-      autoload :CreateWebhookRequest, "unit/models/webhook/create_webhook_request"
-      autoload :ListWebhookParams, "unit/models/webhook/list_webhook_params"
-      autoload :PatchWebhookRequest, "unit/models/webhook/patch_webhook_request"
+    WEBHOOK_LIMIT = 100
+    WEBHOOK_OFFSET = 0
+    autoload :CreateWebhookRequest, "unit/models/webhook/create_webhook_request"
+    autoload :ListWebhookParams, "unit/models/webhook/list_webhook_params"
+    autoload :PatchWebhookRequest, "unit/models/webhook/patch_webhook_request"
 
+    class << self
       # Create a webhook
       # @see https://docs.unit.co/webhooks#create-webhook
       # @param label [String]

data/lib/unit/version.rb

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

data/lib/unit_ruby_sdk.rb

@@ -11,6 +11,7 @@ module Unit
   autoload :Payment, "unit/models/payment/payment"
   autoload :ReceivedPayment, "unit/models/received_payment/received_payment"
   autoload :CheckPayment, "unit/models/check_payment/check_payment"
+  autoload :StopPayment, "unit/models/stop_payment/stop_payment"
   autoload :Transaction, "unit/models/transaction/transaction"
   autoload :Card, "unit/models/card/card"
   autoload :Statement, "unit/models/statement/statement"
@@ -35,6 +36,7 @@ module Unit
     autoload :AccountResource, "unit/api_resources/account_resource"
     autoload :ApiTokenResource, "unit/api_resources/api_token_resource"
     autoload :PaymentResource, "unit/api_resources/payment_resource"
+    autoload :StopPaymentResource, "unit/api_resources/stop_payment_resource"
     autoload :ReceivedPaymentResource, "unit/api_resources/received_payment_resource"
     autoload :CheckPaymentResource, "unit/api_resources/check_payment_resource"
     autoload :TransactionResource, "unit/api_resources/transaction_resource"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Unit
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -116,6 +116,7 @@ files:
 - lib/unit/api_resources/repayment_resource.rb
 - 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/transaction_resource.rb
 - lib/unit/api_resources/webhook_resource.rb
 - lib/unit/errors/unit_error.rb
@@ -239,6 +240,9 @@ files:
 - lib/unit/models/statement/get_pdf_by_id_request.rb
 - lib/unit/models/statement/list_statement_params.rb
 - lib/unit/models/statement/statement.rb
+- 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/transaction/get_transaction_params.rb
 - lib/unit/models/transaction/list_transaction_params.rb
 - lib/unit/models/transaction/patch_book_transaction_request.rb
@@ -283,7 +287,7 @@ homepage: https://github.com/unit-finance/unit-ruby-sdk
 licenses:
 - Mozilla Public License 2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -298,8 +302,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: This library provides a Ruby wrapper to http://unit.co API. See https://docs.unit.co/
 test_files: []