unit_ruby_sdk 1.0.5 → 1.2.0

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Request to create webhook
+# @see https://docs.unit.co/webhooks#create-webhook
+module Unit
+  module Webhook
+    class CreateWebhookRequest
+      attr_accessor :label, :url, :token, :content_type, :delivery_mode,
+                    :include_resources, :subscription_type
+
+      # @param label [String]
+      # @param url [String]
+      # @param token [String]
+      # @param content_type [String]
+      # @param delivery_mode [String]
+      # @param include_resources [Boolean] - optional
+      # @param subscription_type [String] - optional
+      def initialize(label, url, token, content_type, delivery_mode,
+                     include_resources = nil, subscription_type = nil)
+        @label = label
+        @url = url
+        @token = token
+        @content_type = content_type
+        @delivery_mode = delivery_mode
+        @include_resources = include_resources
+        @subscription_type = subscription_type
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "webhook",
+            attributes: {
+              label: label,
+              url: url,
+              token: token,
+              contentType: content_type,
+              deliveryMode: delivery_mode,
+              includeResources: include_resources,
+              subscriptionType: subscription_type
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Request to list webhooks
+# @see https://docs.unit.co/webhooks#list-webhooks
+module Unit
+  module Webhook
+    class ListWebhookParams
+      attr_accessor :limit, :offset, :since, :until_, :from_id, :told
+
+      # @param limit [Integer]
+      # @param offset [Integer]
+      # @param since [String] - optional
+      # @param until_ [String] - optional
+      # @param from_id [Integer] - optional
+      # @param told [Integer] - optional
+      def initialize(limit = WEBHOOK_LIMIT, offset = WEBHOOK_OFFSET, since = nil,
+                     until_ = nil, from_id = nil, told = nil)
+        @limit = limit
+        @offset = offset
+        @since = since
+        @until_ = until_
+        @from_id = from_id
+        @told = told
+      end
+
+      def to_hash
+        payload = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[since]": since,
+          "filter[until]": until_,
+          "filter[fromId]": from_id,
+          "filter[told]": told
+        }
+        payload.compact!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Request to patch webhook
+# @see https://docs.unit.co/webhooks#update-webhook
+module Unit
+  module Webhook
+    class PatchWebhookRequest
+      attr_reader :webhook_id, :label, :url, :token, :content_type, :token, :include_resources, :subscription_type
+
+      # @param webhook_id [String]
+      # @param label [String]
+      # @param url [String]
+      # @param content_type [String]
+      # @param token [String]
+      # @param include_resources [Boolean] - optional
+      # @param subscription_type [String] - optional
+      def initialize(webhook_id, label, url, content_type, token,
+                     include_resources = nil, subscription_type = nil)
+        @webhook_id = webhook_id
+        @label = label
+        @url = url
+        @token = token
+        @content_type = content_type
+        @include_resources = include_resources
+        @subscription_type = subscription_type
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "webhook",
+            attributes: {
+              label: label,
+              url: url,
+              content_type: content_type,
+              token: token,
+              include_resources: include_resources,
+              subscription_type: subscription_type
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+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"
+
+      # Create a webhook
+      # @see https://docs.unit.co/webhooks#create-webhook
+      # @param label [String]
+      # @param url [String]
+      # @param token [String]
+      # @param content_type [String]
+      # @param delivery_mode [String]
+      # @param include_resources [Boolean] - optional
+      # @param subscription_type [String] - optional
+      def create_webhook(label:, url:, token:, content_type:, delivery_mode:,
+                         include_resources: nil, subscription_type: nil)
+        request = CreateWebhookRequest.new(label, url, token, content_type, delivery_mode,
+                                           include_resources, subscription_type)
+        Unit::Resource::WebhookResource.create_webhook(request)
+      end
+
+      # Request to list webhooks
+      # @see https://docs.unit.co/webhooks#list-webhooks
+      # @param limit [Integer]
+      # @param offset [Integer]
+      # @param since [String] - optional
+      # @param until_ [String] - optional
+      # @param from_id [Integer] - optional
+      # @param told [Integer] - optional
+      def list_webhooks(limit: WEBHOOK_LIMIT, offset: WEBHOOK_OFFSET, since: nil,
+                        until_: nil, from_id: nil, told: nil)
+        request = ListWebhookParams.new(limit, offset, since, until_, from_id, told)
+        Unit::Resource::WebhookResource.list_webhooks(request)
+      end
+
+      # Request to patch webhook
+      # @see https://docs.unit.co/webhooks#update-webhook
+      # @param webhook_id [String]
+      # @param label [String]
+      # @param url [String]
+      # @param content_type [String]
+      # @param token [String]
+      # @param include_resources [Boolean] - optional
+      # @param subscription_type [String] - optional
+      def update_webhook(webhook_id:, label:, url:, content_type:, token:,
+                         include_resources: nil, subscription_type: nil)
+        request = PatchWebhookRequest.new(webhook_id, label, url, content_type, token,
+                                          include_resources, subscription_type)
+        Unit::Resource::WebhookResource.update_webhook(request)
+      end
+
+      # Request to get a webhook
+      # @see https://docs.unit.co/webhooks#get-webhook
+      # @param webhook_id [String]
+      def get_webhook(webhook_id:)
+        Unit::Resource::WebhookResource.get_webhook(webhook_id)
+      end
+
+      # Request to enable a webhook
+      # @see https://docs.unit.co/webhooks#enable
+      # @param webhook_id [String]
+      def enable_webhook(webhook_id:)
+        Unit::Resource::WebhookResource.enable_webhook(webhook_id)
+      end
+
+      # Request to disable a webhook
+      # @see https://docs.unit.co/webhooks#disable
+      # @param webhook_id [String]
+      def disable_webhook(webhook_id:)
+        Unit::Resource::WebhookResource.disable_webhook(webhook_id)
+      end
+    end
+  end
+end

data/lib/unit/types/application_form_prefill.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Type representing application form prefill
+# @see https://docs.unit.co/types#applicationformprefill
+module Unit
+  module Types
+    class ApplicationFormPrefill
+      attr_reader :application_type, :full_name, :ssn, :passport, :nationality, :date_of_birth, :email,
+                  :name, :state_of_incorporation, :entity_type, :contact, :officer, :beneficial_owners,
+                  :website, :dba, :ein, :industry, :address, :phone, :jwt_subject
+
+      # @param application_type [Array<String>] - optional
+      # @param full_name [FullName] - optional
+      # @param ssn [String] - optional
+      # @param passport [String] - optional
+      # @param nationality [String] - optional
+      # @param date_of_birth [Date] - optional
+      # @param email [String] - optional
+      # @param name [String] - optional
+      # @param state_of_incorporation [String] - optional
+      # @param entity_type [String] - optional
+      # @param contact [BusinessContact] - optional
+      # @param officer [Officer] - optional
+      # @param beneficial_owners [Array<BeneficialOwner>] - optional
+      # @param website [String] - optional
+      # @param dba [String] - optional
+      # @param ein [String] - optional
+      # @param industry [String] - optional
+      # @param address [Address] - optional
+      # @param phone [Phone] - optional
+      def initialize(application_type = nil, full_name = nil, ssn = nil, passport = nil, nationality = nil,
+                     date_of_birth = nil, email = nil, name = nil, state_of_incorporation = nil, entity_type = nil,
+                     contact = nil, officer = nil, beneficial_owners = nil, website = nil, dba = nil, ein = nil,
+                     industry = nil, address = nil, phone = nil, jwt_subject = nil)
+        @application_type = application_type
+        @full_name = full_name
+        @ssn = ssn
+        @passport = passport
+        @nationality = nationality
+        @date_of_birth = date_of_birth
+        @email = email
+        @name = name
+        @state_of_incorporation = state_of_incorporation
+        @entity_type = entity_type
+        @contact = contact
+        @officer = officer
+        @beneficial_owners = beneficial_owners
+        @website = website
+        @dba = dba
+        @ein = ein
+        @industry = industry
+        @address = address
+        @phone = phone
+        @jwt_subject = jwt_subject
+      end
+
+      def represent
+        payload = {
+          applicationType: application_type,
+          fullName: full_name&.represent,
+          ssn: ssn,
+          passport: passport,
+          nationality: nationality,
+          dateOfBirth: date_of_birth,
+          email: email,
+          name: name,
+          stateOfIncorporation: state_of_incorporation,
+          entityType: entity_type,
+          contact: contact&.represent,
+          officer: officer&.represent,
+          beneficialOwners: beneficial_owners,
+          website: website,
+          dba: dba,
+          ein: ein,
+          industry: industry,
+          address: address&.represent,
+          phone: phone&.represent,
+          jwtSubject: jwt_subject
+        }
+        payload.compact
+      end
+    end
+  end
+end

data/lib/unit/types/application_form_settings_override.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Type representing application form settings override
+# @see https://docs.unit.co/types#applicationformsettingsoverride
+module Unit
+  module Types
+    class ApplicationFormSettingsOverride
+      attr_reader :redirect_url, :privacy_policy_url, :electronic_disclosures_url, :deposit_terms_url,
+                  :client_terms_url, :cardholder_terms_url, :cash_advanced_terms_url, :debit_card_disclosure_url,
+                  :additional_disclosures
+
+      # @param redirect_url [String] - optional
+      # @param privacy_policy_url [String] - optional
+      # @param electronic_disclosures_url [String] - optional
+      # @param deposit_terms_url [String] - optional
+      # @param client_terms_url [String] - optional
+      # @param cardholder_terms_url [String] - optional
+      # @param cash_advanced_terms_url [String] - optional
+      # @param debit_card_disclosure_url [String] - optional
+      # @param additional_disclosures [Array] - optional
+      def initialize(redirect_url = nil, privacy_policy_url = nil, electronic_disclosures_url = nil, deposit_terms_url = nil,
+                     client_terms_url = nil, cardholder_terms_url = nil, cash_advanced_terms_url = nil, debit_card_disclosure_url = nil,
+                     additional_disclosures = nil)
+        @redirect_url = redirect_url
+        @privacy_policy_url = privacy_policy_url
+        @electronic_disclosures_url = electronic_disclosures_url
+        @deposit_terms_url = deposit_terms_url
+        @client_terms_url = client_terms_url
+        @cardholder_terms_url = cardholder_terms_url
+        @cash_advanced_terms_url = cash_advanced_terms_url
+        @debit_card_disclosure_url = debit_card_disclosure_url
+        @additional_disclosures = additional_disclosures
+      end
+
+      def represent
+        payload = {
+          redirectUrl: redirect_url,
+          privacyPolicyUrl: privacy_policy_url,
+          electronicDisclosuresUrl: electronic_disclosures_url,
+          depositTermsUrl: deposit_terms_url,
+          clientTermsUrl: client_terms_url,
+          cardholderTermsUrl: cardholder_terms_url,
+          cashAdvancedTermsUrl: cash_advanced_terms_url,
+          debitCardDisclosureUrl: debit_card_disclosure_url,
+          additionalDisclosures: additional_disclosures&.join(",")
+        }
+        payload.compact
+      end
+    end
+  end
+end

data/lib/unit/types/beneficial_owner.rb

@@ -6,16 +6,21 @@ module Unit
       attr_reader :full_name, :date_of_birth, :address, :phone, :email,
                   :status, :ssn, :passport, :nationality, :percentage
 
-      # @param [FullName] full_name
-      # @param [Date] date_of_birth
-      # @param [Address] address
-      # @param [Phone] phone
-      # @param [String] email
-      # @param [String] ssn
-      # @param optional [String] status
-      # @param optional [String] passport
-      # @param optional [String] nationality
-      # @param optional [Integer] percentage
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @param phone [Phone]
+      # @param email [String]
+      # @param ssn [String]
+      # @param status [String] - optional
+      # @param passport [String] - optional
+      # @param nationality [String] - optional
+      # @param percentage [Integer] - optional
+      # @param evaluation_params [EvaluationParams] - optional
+      # @param id_theft_score [Integer] - optional
+      # @param occupation [String] - optional
+      # @param annual_income [String] - optional
+      # @param source_of_income [String] - optional
       # @return [BeneficialOwner]
       def initialize(full_name, date_of_birth, address, phone, email, ssn, status = nil, passport = nil,
                      nationality = nil, percentage = nil)

data/lib/unit/types/beneficiary.rb

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

data/lib/unit/types/create_schedule.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Type for creating a schedule for recurring payments
+# @see https://docs.unit.co/types#create-schedule
+module Unit
+  module Types
+    class CreateSchedule
+      attr_reader :interval, :day_of_month, :day_of_week, :start_time, :end_time, :total_number_of_payments
+
+      # @param interval [String]
+      # @param day_of_month [Integer]
+      # @param day_of_week [String] - optional
+      # @param start_time [String] - optional
+      # @param end_time [String] - optional
+      # @param total_number_of_payments [Integer] - optional
+      def initialize(interval, day_of_month, day_of_week = nil, start_time = nil, end_time = nil, total_number_of_payments = nil)
+        @interval = interval
+        @day_of_month = day_of_month
+        @day_of_week = day_of_week
+        @start_time = start_time
+        @end_time = end_time
+        @total_number_of_payments = total_number_of_payments
+      end
+
+      def represent
+        payload = {
+          interval: interval,
+          dayOfMonth: day_of_month,
+          dayOfWeek: day_of_week,
+          startTime: start_time,
+          endTime: end_time,
+          totalNumberOfPayments: total_number_of_payments
+        }
+        payload.compact!
+      end
+    end
+  end
+end

data/lib/unit/types/evaluation_params.rb

@@ -8,14 +8,14 @@ module Unit
 
       def initialize(use_selfie_verification = nil, required_verification = nil)
         @use_selfie_verification = use_selfie_verification
-        @required_verificaion = required_verification
+        @required_verification = required_verification
       end
 
       def represent
         {
-          use_selfie_verification: use_selfie_verification,
-          required_verification: required_verification
-        }
+          useSelfieVerification: use_selfie_verification,
+          requiredVerification: required_verification
+        }.compact!
       end
     end
   end

data/lib/unit/types/grantor.rb

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

data/lib/unit/types/officer.rb

@@ -4,21 +4,24 @@ module Unit
   module Types
     class Officer
       attr_reader :full_name, :date_of_birth, :address, :phone, :email,
-                  :status, :title, :ssn, :passport, :nationality
+                  :status, :title, :ssn, :passport, :nationality,
+                  :evaluation_params, :id_theft_score, :occupation,
+                  :annual_income, :source_of_income
 
-      # @param [FullName] full_name
-      # @param [Date] date_of_birth
-      # @param [Address] address
-      # @param [Phone] phone
-      # @param [String] email
-      # @param [String] ssn
-      # @param optional [String] status
-      # @param optional [String] title
-      # @param optional [String] passport
-      # @param optional [String] nationality
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @param phone [Phone]
+      # @param email [String]
+      # @param ssn [String]
+      # @param status [String] - optional
+      # @param title [String] - optional
+      # @param passport [String] - optional
+      # @param nationality [String] - optional
       def initialize(full_name, date_of_birth, address, phone, email, ssn,
                      status = nil, title = nil, passport = nil,
-                     nationality = nil)
+                     nationality = nil, evaluation_params = nil, id_theft_score = nil, occupation = nil,
+                     annual_income = nil, source_of_income = nil)
         @full_name = full_name
         @date_of_birth = date_of_birth
         @address = address
@@ -29,6 +32,11 @@ module Unit
         @ssn = ssn
         @passport = passport
         @nationality = nationality
+        @evaluation_params = evaluation_params
+        @id_theft_score = id_theft_score
+        @occupation = occupation
+        @annual_income = annual_income
+        @source_of_income = source_of_income
       end
 
       def represent
@@ -43,7 +51,12 @@ module Unit
             status: status,
             title: title,
             passport: passport,
-            nationality: nationality
+            nationality: nationality,
+            evaluation_params: evaluation_params,
+            id_theft_score: id_theft_score,
+            occupation: occupation,
+            annual_income: annual_income,
+            source_of_income: source_of_income
           }
         payload.compact
       end

data/lib/unit/types/power_of_attorney_agent.rb

@@ -1,27 +1,21 @@
 # frozen_string_literal: true
 
-require_relative "full_name"
-require_relative "address"
-require_relative "phone"
-
 module Unit
   module Types
     class PowerOfAttorneyAgent
-      attr_reader :status, :full_name, :ssn, :passport, :nationality,
+      attr_reader :full_name, :ssn, :passport, :nationality,
                   :date_of_birth, :address, :phone, :email, :jwt_subject
 
-      # @param [String] status
       # @param [FullName] full_name
       # @param [String] ssn
-      # @param [String] passport
       # @param [String] nationality
       # @param [Date] date_of_birth
       # @param [Address] address
       # @param [Phone] phone
       # @param [String] email
-      # @param [String] jwt_subject
-      def initialize(status, full_name, ssn, passport, nationality, date_of_birth, address, phone, email, jwt_subject)
-        @status = status
+      # @param [String] passport - optional
+      # @param [String] jwt_subject - optional
+      def initialize(full_name, ssn, nationality, date_of_birth, address, phone, email, passport = nil, jwt_subject = nil)
         @full_name = full_name
         @ssn = ssn
         @passport = passport
@@ -35,7 +29,6 @@ module Unit
 
       def represent
         {
-          status: status,
           fullName: full_name.represent,
           ssn: ssn,
           passport: passport,
@@ -45,7 +38,7 @@ module Unit
           phone: phone.represent,
           email: email,
           jwtSubject: jwt_subject
-        }
+        }.compact!
       end
     end
   end

data/lib/unit/types/require_id_verification.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Type representing require id verification
+# @see https://docs.unit.co/types#require-id-verification
+module Unit
+  module Types
+    class RequireIdVerification
+      attr_reader :individual, :officer, :beneficial_owners
+
+      # @param individual [Boolean] - optional
+      # @param officer [Boolean] - optional
+      # @param beneficial_owners [Boolean] - optional
+      def initialize(individual = nil, officer = nil, beneficial_owners = nil)
+        @individual = individual
+        @officer = officer
+        @beneficial_owners = beneficial_owners
+      end
+
+      def represent
+        payload = {
+          individual: individual,
+          officer: officer,
+          beneficialOwners: beneficial_owners
+        }
+        payload.compact
+      end
+    end
+  end
+end