unit_ruby_sdk 1.1.0 → 1.3.0

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+# Request to create a proprietor application
+# @see https://docs.unit.co/applications#create-sole-proprietor-application
+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,
+                  :business_vertical, :website, :ip, :tags, :idempotency_key,
+                  :device_fingerprints, :jwt_subject
+
+      # @param nationality [String]
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @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
+      # @param website [String] - optional
+      # @param ip [String] - optional
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      # @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,
+                     idempotency_key = nil, device_fingerprints = nil, jwt_subject = nil, sole_proprietorship: true)
+        @ssn = ssn
+        @passport = passport
+        @nationality = nationality
+        @full_name = full_name
+        @date_of_birth = date_of_birth
+        @address = address
+        @phone = phone
+        @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
+        @website = website
+        @ip = ip
+        @tags = tags
+        @idempotency_key = idempotency_key
+        @device_fingerprints = device_fingerprints
+        @jwt_subject = jwt_subject
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "individualApplication",
+            attributes: {
+              ssn: ssn,
+              passport: passport,
+              nationality: nationality,
+              fullName: full_name.represent,
+              dateOfBirth: date_of_birth,
+              address: address.represent,
+              phone: phone&.represent,
+              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,
+              website: website,
+              ip: ip,
+              tags: tags,
+              idempotencyKey: idempotency_key,
+              deviceFingerprints: device_fingerprints&.map(&:represent),
+              jwtSubject: jwt_subject
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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

@@ -0,0 +1,31 @@
+# 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/models/application_form/application_form.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Unit
+  module ApplicationForm
+    APPLICATION_FORM_LIST_LIMIT = 100
+    APPLICATION_FORM_LIST_OFFSET = 0
+    autoload :CreateApplicationFormRequest, "unit/models/application_form/create_application_form_request"
+    autoload :ListApplicationFormParams, "unit/models/application_form/list_application_form_params"
+    class << self
+      # Create an application form by calling Unit's API
+      # @see https://docs.unit.co/application-forms/#create-application-form
+      # @param tags [Hash] - optional
+      # @param applicant_details [ApplicationFormPrefill] - optional
+      # @parma allowed_application_types [Array<String>] - optional
+      # @param lang [String] - optional
+      # @param settings_override [ApplicationFormSettingsOverride] - optional
+      # @param require_id_verification [RequireIdVerification] - optional
+      # @param hide_application_progress_tracker [Boolean] - optional
+      def create_application_form(tags: nil, applicant_details: nil, allowed_application_types: nil, lang: nil, settings_override: nil, require_id_verification: nil, hide_application_progress_tracker: nil)
+        request = Unit::ApplicationForm::CreateApplicationFormRequest.new(tags, applicant_details, allowed_application_types, lang, settings_override, require_id_verification, hide_application_progress_tracker)
+        Unit::Resource::ApplicationFormResource.create_application_form(request)
+      end
+
+      # Get an application form by calling Unit's API
+      # @see https://docs.unit.co/application-forms#get-application-form-by-id
+      # @param application_form_id [String]
+      def get_application_form(application_form_id)
+        Unit::Resource::ApplicationFormResource.get_application_form(application_form_id)
+      end
+
+      # List application forms by calling Unit's API
+      # @see https://docs.unit.co/application-forms#list-application-forms
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      def list_application_forms(limit: APPLICATION_FORM_LIST_LIMIT, offset: APPLICATION_FORM_LIST_OFFSET, tags: nil, sort: nil)
+        request = Unit::ApplicationForm::ListApplicationFormParams.new(limit, offset, tags, sort)
+        Unit::Resource::ApplicationFormResource.list_application_forms(request)
+      end
+    end
+  end
+end

data/lib/unit/models/application_form/create_application_form_request.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Unit
+  # Create application form request
+  # @see https://docs.unit.co/application-forms/#create-application-form
+  module ApplicationForm
+    class CreateApplicationFormRequest
+      attr_reader :tags, :applicant_details, :allowed_application_types, :lang,
+                  :settings_override, :require_id_verification, :hide_application_progress_tracker
+
+      # @param tags [Hash] - optional
+      # @param applicant_details [ApplicationFormPrefill] - optional
+      # @parma allowed_application_types [Array<String>] - optional
+      # @param lang [String] - optional
+      # @param settings_override [ApplicationFormSettingsOverride] - optional
+      # @param require_id_verification [RequireIdVerification] - optional
+      # @param hide_application_progress_tracker [Boolean] - optional
+      def initialize(tags = nil, applicant_details = nil, allowed_application_types = nil, lang = nil, settings_override = nil, require_id_verification = nil, hide_application_progress_tracker = nil)
+        @tags = tags
+        @applicant_details = applicant_details&.represent
+        @allowed_application_types = allowed_application_types
+        @lang = lang
+        @settings_override = settings_override&.represent
+        @require_id_verification = require_id_verification&.represent
+        @hide_application_progress_tracker = hide_application_progress_tracker
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "applicationForm",
+            attributes: {
+              tags: tags,
+              applicantDetails: applicant_details,
+              allowedApplicationTypes: allowed_application_types,
+              lang: lang,
+              settingsOverride: settings_override,
+              requireIdVerification: require_id_verification,
+              hideApplicationProgressTracker: hide_application_progress_tracker
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/application_form/list_application_form_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# params for listing application form params
+# @see https://docs.unit.co/application-forms#list-application-forms
+module Unit
+  module ApplicationForm
+    class ListApplicationFormParams
+      attr_reader :limit, :offset, :tags, :sort
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      def initialize(limit = APPLICATION_FORM_LIST_LIMIT, offset = APPLICATION_FORM_LIST_OFFSET, tags = nil, sort = nil)
+        @limit = limit
+        @offset = offset
+        @tags = tags
+        @sort = sort
+      end
+
+      def to_hash
+        params = { "page[limit]": limit,
+                   "page[offset]": offset,
+                   "filter[tags]": tags,
+                   "sort": sort }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/authorization/authorization.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Unit
+  module Authorization
+    AUTHORIZATION_LIMIT = 100
+    AUTHORIZATION_OFFSET = 0
+
+    autoload :GetRequest, "unit/models/authorization/get_request"
+    autoload :ListRequest, "unit/models/authorization/list_request"
+    class << self
+      # Get authorization by id
+      # @see https://docs.unit.co/cards-authorizations#get-authorization-by-id
+      # @param authorization_id [String]
+      # @param include_non_authorized [Boolean] - optional
+      def get_authorization(authorization_id:, include_non_authorized: nil)
+        request = GetRequest.new(authorization_id, include_non_authorized)
+        Unit::Resource::AuthorizationResource.get(request)
+      end
+
+      # List authorizations
+      # @see https://docs.unit.co/cards-authorizations#list-authorizations
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param card_id [String] - optional
+      # @param since [String] - optional
+      # @param until_ [String] - optional
+      # @param include_non_authorized [Boolean] - optional
+      # @param status [Array<String>] - optional
+      # @param merchant_category_code [Array<String>] - optional
+      # @param from_amount [Integer] - optional
+      # @param to_amount [Integer] - optional
+      # @param sort [String] - optional
+      def list_authorizations(limit: AUTHORIZATION_LIMIT, offset: AUTHORIZATION_OFFSET, account_id: nil, customer_id: nil, card_id: nil, since: nil,
+                              until_: nil, include_non_authorized: nil, status: nil, merchant_category_code: nil, from_amount: nil, to_amount: nil, sort: nil)
+        request = ListRequest.new(limit, offset, account_id, customer_id, card_id, since, until_, include_non_authorized, status, merchant_category_code, from_amount, to_amount, sort)
+        Unit::Resource::AuthorizationResource.list(request)
+      end
+    end
+  end
+end

data/lib/unit/models/authorization/get_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Request to get authorization
+# @see https://docs.unit.co/cards-authorizations#get-authorization-by-id
+module Unit
+  module Authorization
+    class GetRequest
+      attr_reader :authorization_id, :include_non_authorized
+
+      # @param authorization_id [String]
+      # @param include_non_authorized [Boolean]
+      def initialize(authorization_id, include_non_authorized = nil)
+        @authorization_id = authorization_id
+        @include_non_authorized = include_non_authorized
+      end
+
+      def to_hash
+        { 'filter[includeNonAuthorized]': include_non_authorized }.compact
+      end
+    end
+  end
+end

data/lib/unit/models/authorization/list_request.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# List authorizations
+# @see https://docs.unit.co/cards-authorizations#list-authorizations
+module Unit
+  module Authorization
+    class ListRequest
+      attr_reader :limit, :offset, :account_id, :customer_id, :card_id, :since,
+                  :until_, :include_non_authorized, :status, :merchant_category_code,
+                  :from_amount, :to_amount, :sort
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param card_id [String] - optional
+      # @param since [String] - optional
+      # @param until_ [String] - optional
+      # @param include_non_authorized [Boolean] - optional
+      # @param status [Array<String>] - optional
+      # @param merchant_category_code [Array<String>] - optional
+      # @param from_amount [Integer] - optional
+      # @param to_amount [Integer] - optional
+      # @param sort [String] - optional
+      def initialize(limit = AUTHORIZATION_LIMIT, offset = AUTHORIZATION_OFFSET, account_id = nil, customer_id = nil, card_id = nil,
+                     since = nil, until_ = nil, include_non_authorized = nil, status = nil, merchant_category_code = nil,
+                     from_amount = nil, to_amount = nil, sort = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @card_id = card_id
+        @since = since
+        @until_ = until_
+        @include_non_authorized = include_non_authorized
+        @status = status
+        @merchant_category_code = merchant_category_code
+        @from_amount = from_amount
+        @to_amount = to_amount
+        @sort = sort
+      end
+
+      def to_hash
+        payload = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[accountId]": account_id,
+          "filter[customerId]": customer_id,
+          "filter[cardId]": card_id,
+          "filter[since]": since,
+          "filter[until]": until_,
+          "filter[includeNonAuthorized]": include_non_authorized,
+          "filter[fromAmount]": from_amount,
+          "filter[toAmount]": to_amount,
+          sort: sort
+        }
+        merchant_category_code&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[merchantCategoryCode][#{index}]": val })
+        end
+        status&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[status][#{index}]": val })
+        end
+        payload.compact
+      end
+    end
+  end
+end

data/lib/unit/models/authorization_request/approve_request.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# class for approving the authorization request
+# @see https://docs.unit.co/cards-authorization-requests/#approve-authorization-request
+module Unit
+  module AuthorizationRequest
+    class ApproveRequest
+      attr_reader :authorization_request_id, :amount, :funding_account, :tags
+
+      # @param authorization_request_id [String]
+      # @param amount [Integer] - optional
+      # @param funding_account [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(authorization_request_id, amount = nil, funding_account = nil, tags = nil)
+        @authorization_request_id = authorization_request_id
+        @amount = amount
+        @funding_account = funding_account
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "approveAuthorizationRequest",
+            attributes: {
+              amount: amount,
+              fundingAccount: funding_account,
+              tags: tags
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/authorization_request/authorization_request.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Unit
+  module AuthorizationRequest
+    AUTHORIZATION_REQUEST_LIMIT = 100
+    AUTHORIZATION_REQUEST_OFFSET = 0
+
+    autoload :ApproveRequest, "unit/models/authorization_request/approve_request"
+    autoload :DeclineRequest, "unit/models/authorization_request/decline_request"
+    autoload :ListAuthorizationParams, "unit/models/authorization_request/list_authorization_params"
+    class << self
+      # get authorization request
+      # @see https://docs.unit.co/cards-authorization-requests/#get-authorization-request-by-id
+      # @param authorization_request_id [String]
+      def get_authorization_request(authorization_request_id:)
+        Unit::Resource::AuthorizationRequestResource.get_authorization_request(authorization_request_id)
+      end
+
+      # Approve authorization request
+      # @see https://docs.unit.co/cards-authorization-requests/#approve-authorization-request
+      # @param authorization_request_id [String]
+      # @param amount [Integer] - optional
+      # @param funding_account [String] - optional
+      # @param tags [Hash] - optional
+      def approve_authorization_request(authorization_request_id:, amount:, funding_account:, tags:)
+        request = ApproveRequest.new(authorization_request_id, amount, funding_account, tags)
+        Unit::Resource::AuthorizationRequestResource.approve(request)
+      end
+
+      # decline authorization request
+      # @see https://docs.unit.co/cards-authorization-requests/#decline-authorization-request
+      # @param authorization_request_id [String]
+      # @param reason [String]
+      def decline_authorization_request(authorization_request_id:, reason:)
+        request = DeclineRequest.new(authorization_request_id, reason)
+        Unit::Resource::AuthorizationRequestResource.decline(request)
+      end
+
+      # list params for the authorization request
+      # @see https://docs.unit.co/cards-authorization-requests/#list-authorization-requests
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param merchant_category_code [Array] - optional
+      # @param from_amount [Integer] - optional
+      # @param to_amount [Integer]- optional
+      def list_authorization_requests(limit = AUTHORIZATION_REQUEST_LIMIT, offset = AUTHORIZATION_REQUEST_OFFSET,
+                                      account_id: nil, customer_id: nil, merchant_category_code: nil, from_amount: nil, to_amount: nil)
+        params = ListAuthorizationParams.new(limit, offset, account_id, customer_id, merchant_category_code, from_amount, to_amount)
+        Unit::Resource::AuthorizationRequestResource.list(params)
+      end
+    end
+  end
+end

data/lib/unit/models/authorization_request/decline_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# class for declining the authorization request
+# @see https://docs.unit.co/cards-authorization-requests/#decline-authorization-request
+module Unit
+  module AuthorizationRequest
+    class DeclineRequest
+      attr_reader :authorization_request_id, :reason
+
+      # @param authorization_request_id [String]
+      # @param reason [String]
+      def initialize(authorization_request_id, reason)
+        @authorization_request_id = authorization_request_id
+        @reason = reason
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "declineAuthorizationRequest",
+            attributes: {
+              reason: reason
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/authorization_request/list_authorization_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# list params for the authorization request
+# @see https://docs.unit.co/cards-authorization-requests/#list-authorization-requests
+module Unit
+  module AuthorizationRequest
+    class ListAuthorizationParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :merchant_category_code,
+                  :from_amount, :to_amount
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param merchant_category_code [Array] - optional
+      # @param from_amount [Integer] - optional
+      # @param to_amount [Integer]- optional
+      def initialize(limit = AUTHORIZATION_REQUEST_LIMIT, offset = AUTHORIZATION_REQUEST_OFFSET,
+                     account_id = nil, customer_id = nil, merchant_category_code = nil,
+                     from_amount = nil, to_amount = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @merchant_category_code = merchant_category_code
+        @from_amount = from_amount
+        @to_amount = to_amount
+      end
+
+      def to_hash
+        params = { "page[limit]": limit,
+                   "page[offset]": offset,
+                   "filter[accountId]": account_id,
+                   "filter[customerId]": customer_id,
+                   "filter[fromAmount]": from_amount,
+                   "filter[toAmount]": to_amount }
+        merchant_category_code&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[merchantCategoryCode][#{index}]": val })
+        end
+        params.compact
+      end
+    end
+  end
+end