unit_ruby_sdk 0.1.2 → 0.1.4

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Unit
+  module Application
+    APPLICATION_LIST_OFFSET = 0
+    APPLICATION_LIST_LIMIT = 100
+    autoload :CreateBusinessApplicationRequest, "unit/models/application/create_business_application_request"
+    autoload :CreateIndividualApplicationRequest, "unit/models/application/create_individual_application_request"
+    autoload :ListApplicationParams, "unit/models/application/list_application_params"
+    autoload :PatchApplicationRequest, "unit/models/application/patch_application_request"
+    autoload :UploadDocumentRequest, "unit/models/application/upload_document_request"
+
+    class << self
+      # Create a new business application by calling Unit's API
+      # @param name [String]
+      # @param address [Address]
+      # @param phone [Phone]
+      # @param state_of_incorporation [String]
+      # @param ein [String]
+      # @param industry [String]
+      # @param contact [BusinessContact]
+      # @param officer [Officer]
+      # @param beneficial_owners [Array]
+      # @param entity_type [String]
+      # @param dba [String] - optional
+      # @param ip [String] - optional
+      # @param website [String] - optional
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      # @param device_fingerprints [DeviceFingerprint] - optional
+      # @return [UnitResponse, UnitError]
+      def create_business_application(name:, address:, phone:, state_of_incorporation:, ein:, industry:, contact:,
+                                      officer:, beneficial_owners:, entity_type:, dba: nil, ip: nil, website: nil,
+                                      tags: nil, idempotency_key: nil, device_fingerprints: nil)
+
+        request = CreateBusinessApplicationRequest.new(
+          name, address, phone, state_of_incorporation, ein, industry, contact, officer,
+          beneficial_owners, entity_type, dba, ip, website, tags, idempotency_key, device_fingerprints
+        )
+
+        Unit::Resource::ApplicationResource.create_application(request)
+      end
+
+      # Create a new individual application by calling Unit's API
+      # @param ssn [String]
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @param email [String]
+      # @param phone [Phone]
+      # @param ip [String] - optional
+      # @param ein [String] - optional
+      # @param industry [String] - optional
+      # @param dba [String] - optional
+      # @param sole_proprietorship [Boolean] - optional
+      # @param passport [String] - optional
+      # @param nationality [String] - optional
+      # @param device_fingerprints [DeviceFingerprint] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param jwt_subject [String] - optional
+      # @param power_of_attorney_agent [PowerOfAttorneyAgent] - optional
+      # @param evaluation_params [EvaluationParams] - optional
+      # @return [UnitResponse, UnitError]
+      def create_individual_application(ssn:, full_name:, date_of_birth:, address:, email:, phone:, ip: nil, ein: nil,
+                                        industry: nil, dba: nil, sole_proprietorship: nil, passport: nil, nationality: nil,
+                                        device_fingerprints: nil, idempotency_key: nil, tags: nil, jwt_subject: nil,
+                                        power_of_attorney_agent: nil, evaluation_params: nil)
+
+        request = CreateIndividualApplicationRequest.new(
+          ssn, full_name, date_of_birth, address, email, phone, ip, ein, industry, dba, sole_proprietorship, passport,
+          nationality, device_fingerprints, idempotency_key, tags, jwt_subject, power_of_attorney_agent, evaluation_params
+        )
+
+        Unit::Resource::ApplicationResource.create_application(request)
+      end
+
+      # Update an application by calling Unit's API
+      # @param application_id [String] The application id
+      # @param type [String] The type
+      # @param tags [Hash] The tags
+      # @return [UnitResponse, UnitError]
+      def update_application(application_id:, type:, tags: nil)
+        request = PatchApplicationRequest.new(application_id, type, tags)
+        Unit::Resource::ApplicationResource.update(request)
+      end
+
+      # List applications by calling Unit's API
+      # @param offset [Integer] Number of resources to skip.
+      # @param limit [Integer] The limit Maximum number of resources that will be returned.
+      # @param email [String] Filter applications by email address (case sensitive).
+      # @param tags [String] Filter applications by tags. More information regarding tags: https://docs.unit.co/#tags
+      # @param query [String] Search term according to the: https://docs.unit.co/#full-text-search
+      # @param status [String] Filter applications by status: https://docs.unit.co/applications/#application-statuses
+      # @param sort [String] Sorts the resources by the specified field.
+      # @option sort=createdAt for ascending order
+      # @option sort=-createdAt (leading minus sign) for descending order.
+      # @return [UnitResponse, UnitError]
+      def list_applications(offset: APPLICATION_LIST_OFFSET, limit: APPLICATION_LIST_LIMIT, email: nil, tags: nil, query: nil, status: nil, sort: nil)
+        request = Unit::Application::ListApplicationParams.new(offset, limit, email, tags, query, status, sort)
+        Unit::Resource::ApplicationResource.list_applications(request)
+      end
+
+      # Get an application by calling Unit's API
+      # @param [String] application_id
+      # @return [UnitResponse, UnitError]
+      def get_application(application_id)
+        Unit::Resource::ApplicationResource.get_application(application_id)
+      end
+
+      # Upload an application document by calling Unit's API
+      # @param application_id [String] The application ID
+      # @param document_id [String] The document ID
+      # @param file [String] The file path
+      # @param file_type [String] The file type
+      # @option file_type [String] :pdf
+      # @option file_type [String] :jpg
+      # @option file_type [String] :png
+      # @param is_back_side [Boolean] The file is back side
+      # @return [UnitResponse, UnitError]
+      def upload_document(application_id:, document_id:, file:, file_type:, is_back_side: false)
+        request = UploadDocumentRequest.new(application_id, document_id, file, file_type, is_back_side: is_back_side)
+        Unit::Resource::ApplicationResource.upload(request)
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ require "unit/types/beneficial_owner"
 require "unit/types/officer"
 
 # Request to create a business application
-# See: https://docs.unit.co/applications/#create-business-application
+# @see https://docs.unit.co/applications/#create-business-application
 module Unit
   module Application
     class CreateBusinessApplicationRequest
@@ -25,12 +25,12 @@ module Unit
       # @param officer [Officer]
       # @param beneficial_owners [Array]
       # @param entity_type [String]
-      # @param optional dba [String]
-      # @param optional ip [String]
-      # @param optional website [String]
-      # @param optional tags [Hash]
-      # @param optional idempotency_key [String]
-      # @param optional device_fingerprints [DeviceFingerprint]
+      # @param dba [String] - optional
+      # @param ip [String] - optional
+      # @param website [String] - optional
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      # @param device_fingerprints [DeviceFingerprint] - optional
       def initialize(name, address, phone, state_of_incorporation, ein, industry, contact, officer,
                      beneficial_owners, entity_type, dba = nil, ip = nil, website = nil, tags = nil, idempotency_key = nil,
                      device_fingerprints = nil)

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

@@ -6,7 +6,7 @@ require "unit/types/phone"
 require "unit/types/device_fingerprint"
 
 # Request to create an individual application
-# See https://docs.unit.co/applications/#create-individual-application
+# @see https://docs.unit.co/applications/#create-individual-application
 module Unit
   module Application
     class CreateIndividualApplicationRequest
@@ -20,19 +20,19 @@ module Unit
       # @param address [Address]
       # @param email [String]
       # @param phone [Phone]
-      # @param optional ip [String]
-      # @param optional ein [String]
-      # @param optional industry [String]
-      # @param optional dba [String]
-      # @param optional sole_proprietorship [Boolean]
-      # @param optional passport [String]
-      # @param optional nationality [String]
-      # @param optional device_fingerprints [DeviceFingerprint]
-      # @param optional idempotency_key [String]
-      # @param optional tags [Hash]
-      # @param optional jwt_subject [String]
-      # @param optional power_of_attorney_agent [PowerOfAttorneyAgent]
-      # @param optional evaluation_params [EvaluationParams]
+      # @param ip [String] - optional
+      # @param ein [String] - optional
+      # @param industry [String] - optional
+      # @param dba [String] - optional
+      # @param sole_proprietorship [Boolean] - optional
+      # @param passport [String] - optional
+      # @param nationality [String] - optional
+      # @param device_fingerprints [DeviceFingerprint] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param jwt_subject [String] - optional
+      # @param power_of_attorney_agent [PowerOfAttorneyAgent] - optional
+      # @param evaluation_params [EvaluationParams] - optional
       def initialize(ssn, full_name, date_of_birth, address, email, phone, ip = nil, ein = nil, industry = nil, dba = nil, sole_proprietorship = nil, passport = nil,
                      nationality = nil, device_fingerprints = nil, idempotency_key = nil, tags = nil, jwt_subject = nil, power_of_attorney_agent = nil,
                      evaluation_params = nil)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # params for list applications
-# See: https://docs.unit.co/applications/#list-applications
+# @see https://docs.unit.co/applications/#list-applications
 module Unit
   module Application
     class ListApplicationParams
@@ -10,13 +10,13 @@ module Unit
       # @param offset [Integer] Number of resources to skip. See pagination: https://docs.unit.co/#intro-pagination
       # @param limit [Integer] The limit Maximum number of resources that will be returned. Maximum is 1000 resources.
       # @param email [String] Filter applications by email address (case sensitive).
-      # @param tags [String] Filter applications by tags. More information regarding tags: https://docs.unit.co/#tags
+      # @param tags [Hash] Filter applications by tags. More information regarding tags: https://docs.unit.co/#tags
       # @param query [String] Search term according to the: https://docs.unit.co/#full-text-search
       # @param status [String] Filter applications by status: https://docs.unit.co/applications/#application-statuses
       # @param sort [String] Sorts the resources by the specified field.
       # @option sort=createdAt for ascending order
       # @option sort=-createdAt (leading minus sign) for descending order.
-      def initialize(offset = 0, limit = 100, email = nil, tags = nil,
+      def initialize(offset = APPLICATION_LIST_OFFSET, limit = APPLICATION_LIST_LIMIT, email = nil, tags = nil,
                      query = nil, status = nil, sort = nil)
         @offset = offset
         @limit = limit
@@ -35,7 +35,7 @@ module Unit
                    "filter[query]": query,
                    "filter[status]": status,
                    "sort": sort }
-        params.compact!
+        params.compact
       end
     end
   end

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Request to update application
-# See for updating business application: https://docs.unit.co/applications/#update-business-application
-# See for updating individual application: https://docs.unit.co/applications/#update-individual-application
+# @see for updating business application: https://docs.unit.co/applications/#update-business-application
+# @see for updating individual application: https://docs.unit.co/applications/#update-individual-application
 module Unit
   module Application
     class PatchApplicationRequest
@@ -10,7 +10,7 @@ module Unit
 
       # @param application_id [String] The application id
       # @param type [String] The type
-      # @param optional tags [String] The tags
+      # @param tags [String] The tags
       def initialize(application_id, type, tags = nil)
         @application_id = application_id
         @type = type

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Creates request for uploading a document
-# See: https://docs.unit.co/application-documents/#upload-document
+# @see https://docs.unit.co/application-documents/#upload-document
 module Unit
   module Application
     class UploadDocumentRequest

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

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Request to add authorized users to a project
-# See: https://docs.unit.co/customers#add-authorized-users
+# @see https://docs.unit.co/customers#add-authorized-users
 module Unit
   module Customer
     class AddAuthorizedUsersRequest
       attr_reader :customer_id, :authorized_users
 
-      # @param customer_id [String] The id of customer
-      # @param authorized_users [Array<AuthorizedUser>] The authorized users
+      # @param customer_id [String]
+      # @param authorized_users [Array<AuthorizedUser>]
       def initialize(customer_id, authorized_users)
         @customer_id = customer_id
         @authorized_users = authorized_users

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

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
 # Request to archive customer
-# See: https://docs.unit.co/customers#archive-customer
+# @see https://docs.unit.co/customers#archive-customer
 module Unit
   module Customer
     class ArchiveCustomerRequest
       attr_reader :customer_id, :reason
 
-      # @param customer_id [String] The id of customer
-      # @param optional reason [String] The reason for archiving the customer
-      # @option reason [String] Need to be one of the following: Inactive, FraudACHActivity, FraudCardActivity, FraudCheckActivity, FraudApplicationHistory, FraudAccountActivity, FraudClientIdentified, FraudLinkedToFraudulentCustomer.
+      # @param customer_id [String]
+      # @param reason [String] - optional
       def initialize(customer_id, reason = nil)
         @customer_id = customer_id
         @reason = reason

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Unit
+  module Customer
+    CUSTOMER_LIST_LIMIT = 100
+    CUSTOMER_LIST_OFFSET = 0
+
+    autoload :AddAuthorizedUsersRequest, "unit/models/customer/add_authorized_users_request"
+    autoload :ArchiveCustomerRequest, "unit/models/customer/archive_customer_request"
+    autoload :ListCustomerParams, "unit/models/customer/list_customer_params"
+    autoload :PatchBusinessCustomerRequest, "unit/models/customer/patch_business_customer_request"
+    autoload :PatchIndividualCustomerRequest, "unit/models/customer/patch_individual_customer_request"
+    autoload :RemoveAuthorizedUsersRequest, "unit/models/customer/remove_authorized_users_request"
+
+    class << self
+      # Update individual customer by calling Unit's API
+      # @see https://docs.unit.co/customers#update-individual-customer
+      # @param customer_id [String]
+      # @param address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param dba [String] - optional
+      # @param authorized_users [Array<AuthorizedUser>] - optional
+      # @param tags [Hash] - optional
+      # @param jwt_subject [String] - optional
+      def update_individual_customer(customer_id:, address: nil, phone: nil, email: nil, dba: nil, authorized_users: nil, tags: nil, jwt_subject: nil)
+        request = PatchIndividualCustomerRequest.new(customer_id, address, phone, email, dba, authorized_users, tags, jwt_subject)
+        Unit::Resource::CustomerResource.update(request)
+      end
+
+      # Update business customer by calling Unit's API
+      # @see https://docs.unit.co/customers#update-business-customer
+      # @param customer_id [String]
+      # @param address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param contact [BusinessContact] - optional
+      # @param authorized_users [Array<AuthorizedUser>] - optional
+      # @param dba [String] - optional
+      # @param tags [Hash] - optional
+      # @return [UnitResponse, UnitError]
+      def update_business_customer(customer_id:, address: nil, phone: nil, contact: nil, authorized_users: nil, dba: nil, tags: nil)
+        request = PatchBusinessCustomerRequest.new(customer_id, address, phone, contact, authorized_users, dba, tags)
+        Unit::Resource::CustomerResource.update(request)
+      end
+
+      # Get customer by calling Unit's API
+      # @see https://docs.unit.co/customers#get-specific-customer
+      # @param customer_id [String]
+      # @return [UnitResponse, UnitError]
+      def get_customer(customer_id)
+        Unit::Resource::CustomerResource.get(customer_id)
+      end
+
+      # List customers by calling Unit's API
+      # @see https://docs.unit.co/customers#list-customers
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param query [String] - optional
+      # @param email [String] - optional
+      # @param tags [Hash] - optional
+      # @param status [String] - optional
+      # @param sort [String] - optional
+      def list_customers(offset: CUSTOMER_LIST_OFFSET, limit: CUSTOMER_LIST_LIMIT, email: nil, tags: nil, status: nil, query: nil, sort: nil)
+        request = ListCustomerParams.new(offset, limit, email, tags, status, query, sort)
+        Unit::Resource::CustomerResource.list(request)
+      end
+
+      # Archive customer by calling Unit's API
+      # @see https://docs.unit.co/customers#archive-customer
+      # @param customer_id [String]
+      # @param reason [String] - optional
+      def archive_customer(customer_id:, reason: nil)
+        request = ArchiveCustomerRequest.new(customer_id, reason)
+        Unit::Resource::CustomerResource.archive(request)
+      end
+
+      # Add authorized users by calling Unit's API
+      # @see https://docs.unit.co/customers#add-authorized-users
+      # @param customer_id [String]
+      # @param authorized_users [Array<AuthorizedUser>]
+      def add_authorized_users(customer_id:, authorized_users:)
+        request = AddAuthorizedUsersRequest.new(customer_id, authorized_users)
+        Unit::Resource::CustomerResource.add_authorized_users(request)
+      end
+
+      # Remove authorized users by calling Unit's API
+      # @see https://docs.unit.co/customers#remove-authorized-users
+      # @param customer_id [String]
+      # @param authorized_users [Array<AuthorizedUser>]
+      def remove_authorized_users(customer_id:, authorized_users:)
+        request = RemoveAuthorizedUsersRequest.new(customer_id, authorized_users)
+        Unit::Resource::CustomerResource.remove_authorized_users(request)
+      end
+    end
+  end
+end

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

@@ -1,22 +1,20 @@
 # frozen_string_literal: true
 
 # params for listing customers
-# See: https://docs.unit.co/customers#list-customers
+# @see https://docs.unit.co/customers#list-customers
 module Unit
   module Customer
     class ListCustomerParams
       attr_reader :limit, :offset, :query, :email, :tags, :status, :sort
 
-      # @param optional limit [Integer] Maximum number of resources that will be returned. Maximum is 1000 resources.
-      # @param optional offset [Integer] Number of resources to skip. See pagination: https://docs.unit.co/#intro-pagination
-      # @param optional query [String] Search term according to the: https://docs.unit.co/#full-text-search
-      # @param optional email [String] Filter customers by email address (case sensitive).
-      # @param optional tags [Hash] Filter customers by tags. More information regarding tags: https://docs.unit.co/#tags
-      # @param optional status [String] Filter customers by status. One of: Active, Archived
-      # @param optional sort [String] Sorts the resources by the specified field.
-      # @option sort=createdAt for ascending order
-      # @option sort=-createdAt (leading minus sign) for descending order.
-      def initialize(limit = 100, offset = 0, query = nil, email = nil, tags = nil, status = nil,
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param query [String] - optional
+      # @param email [String] - optional
+      # @param tags [Hash] - optional
+      # @param status [String] - optional
+      # @param sort [String] - optional
+      def initialize(limit = CUSTOMER_LIST_LIMIT, offset = CUSTOMER_LIST_OFFSET, query = nil, email = nil, tags = nil, status = nil,
                      sort = nil)
         @limit = limit
         @offset = offset
@@ -35,7 +33,7 @@ module Unit
                    "filter[tags]": tags,
                    "filter[status]": status,
                    "sort": sort }
-        params.compact!
+        params.compact
       end
     end
   end

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

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
 # Update business customer information request
-# See: https://docs.unit.co/customers#update-business-customer
+# @see https://docs.unit.co/customers#update-business-customer
 module Unit
   module Customer
     class PatchBusinessCustomerRequest
       attr_reader :customer_id, :address, :phone, :contact, :authorized_users, :dba, :tags
 
-      # @param customer_id [String] The id of business
-      # @param optional address [Address] The address of business
-      # @param optional phone [Phone] The phone of business
-      # @param optional contact [BusinessContact] The primary contact of the business
-      # @param optional authorized_users [Array<AuthorizedUser>] The authorized users of business
-      # @param optional dba [String] The dba of business. To modify or add needed to specify the new dba name.
-      # @param optional tags [Hash] Provides opportunity to add, update or delete tags from resources with the tags attribute on the corresponding Update operation
+      # @param customer_id [String]
+      # @param address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param contact [BusinessContact] - optional
+      # @param authorized_users [Array<AuthorizedUser>] - optional
+      # @param dba [String] - optional
+      # @param tags [Hash] - optional
       # more information regarding tags: https://docs.unit.co/#updating-tags
       def initialize(customer_id, address = nil, phone = nil, contact = nil,
                      authorized_users = nil, dba = nil, tags = nil)

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

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
 # Update individual customer information request
-# See: https://docs.unit.co/customers#update-individual-customer
+# @see https://docs.unit.co/customers#update-individual-customer
 module Unit
   module Customer
     class PatchIndividualCustomerRequest
       attr_reader :customer_id, :address, :phone, :email, :dba, :authorized_users, :tags, :jwt_subject
 
-      # @param customer_id [String] The id of individual customer
-      # @param optional address [Address] The address of individual customer
-      # @param optional phone [Phone] The phone of individual customer
-      # @param optional email [String] The email of individual customer
-      # @param optional dba [String] The dba of individual customer. If the individual is a sole proprietor who is doing business under a different name.
-      # @param optional authorized_users [Array<AuthorizedUser>] The authorized users of individual customer
-      # @param optional tags [Hash] Provides opportunity to add, update or delete tags from resources with the tags attribute on the corresponding Update operation
-      # @param optional jwt_subject [String] The subject of the JWT
-      # More information regarding JWTSubject: https://docs.unit.co/customer-api-tokens/#customers-create-customer-bearer-token-jwt
+      # @param customer_id [String]
+      # @param address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param dba [String] - optional
+      # @param authorized_users [Array<AuthorizedUser>] - optional
+      # @param tags [Hash] - optional
+      # @param jwt_subject [String] - optional
       def initialize(customer_id, address = nil, phone = nil, email = nil, dba = nil, authorized_users = nil, tags = nil, jwt_subject = nil)
         @customer_id = customer_id
         @address = address

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

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Request to remove authorized users from customer
-# See: https://docs.unit.co/customers#remove-authorized-users
+# @see https://docs.unit.co/customers#remove-authorized-users
 module Unit
   module Customer
     class RemoveAuthorizedUsersRequest
       attr_reader :customer_id, :authorized_users_emails
 
-      # @param customer_id [String] The id of customer
-      # @param authorized_users_emails [Array<String>] The list of authorized users emails to remove from the customer.
+      # @param customer_id [String]
+      # @param authorized_users_emails [Array<String>]
       def initialize(customer_id, authorized_users_emails)
         @customer_id = customer_id
         @authorized_users_emails = authorized_users_emails

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Request to create a book payment
+# @see https://docs.unit.co/book-payments#book-payments
+module Unit
+  module Payment
+    class CreateBookPaymentRequest
+      attr_reader :amount, :description, :account_id, :counterparty_account_id, :transaction_summary_override, :idempotency_key, :tags, :relationships
+
+      # @param amount [Integer]
+      # @param description [String]
+      # @param account_id [String]
+      # @param counterparty_account_id [String]
+      # @param transaction_summary_override [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(amount, description, account_id, counterparty_account_id, relationships, transaction_summary_override = nil,
+                     idempotency_key = nil, tags = nil)
+        @amount = amount
+        @description = description
+        @account_id = account_id
+        @counterparty_account_id = counterparty_account_id
+        @relationships = relationships
+        @transaction_summary_override = transaction_summary_override
+        @idempotency_key = idempotency_key
+        @tags = tags
+      end
+
+      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 }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Unit
+  module Payment
+    autoload :CreateBookPaymentRequest, "unit/models/payment/create_book_payment_request"
+    autoload :PatchBookPaymentRequest, "unit/models/payment/patch_book_payment_request"
+
+    class << self
+      # Create a new book payment by calling Unit's API
+      # @see https://docs.unit.co/book-payments#book-payments
+      # @param amount [Integer]
+      # @param description [String]
+      # @param account_id [String]
+      # @param counterparty_account_id [String]
+      # @param transaction_summary_override [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @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)
+        Unit::Resource::PaymentResource.create_payment(request)
+      end
+
+      # Update a book payment by calling Unit's API
+      # @see https://docs.unit.co/book-payments#update-book-payment
+      # @param payment_id [String]
+      # @param tags [Hash] - optional
+      # @return [UnitResponse, UnitError]
+      def update_book_payment(payment_id:, tags: nil)
+        request = Unit::Payment::PatchBookPaymentRequest.new(payment_id, tags)
+        Unit::Resource::PaymentResource.update_payment(request)
+      end
+    end
+  end
+end