unit_ruby_sdk 1.1.0 → 1.2.0

data/lib/unit/models/repayment/repayment.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Unit
+  module Repayment
+    REPAYMENT_LIMIT = 100
+    REPAYMENT_OFFSET = 0
+
+    autoload :CreateAchRepaymentRequest, "unit/models/repayment/create_ach_repayment_request"
+    autoload :CreateBookRepaymentRequest, "unit/models/repayment/create_book_repayment_request"
+    autoload :ListRepaymentParams, "unit/models/repayment/list_repayment_params"
+
+    class << self
+      # Get a repayment by calling Unit's API
+      # @see https://docs.unit.co/repayments#get-specific-repayment
+      # @param repayment_id [String]
+      def get_repayment(repayment_id:)
+        Unit::Resource::RepaymentResource.get(repayment_id)
+      end
+
+      # Create a book repayment by calling Unit's API
+      # @see https://docs.unit.co/repayments#book-repayment
+      # @param account_id [String]
+      # @param credit_account_id [String]
+      # @param counterparty_account_id [String]
+      # @param description [String]
+      # @param amount [Integer]
+      # @param transaction_summary_override [String]
+      # @param tags [Array<String>] - optional
+      # @param idempotency_key [String] - optional
+      def create_book_repayment(account_id:, credit_account_id:, counterparty_account_id:, description:, amount:, transaction_summary_override:, tags: nil, idempotency_key: nil)
+        request = Unit::Repayment::CreateBookRepaymentRequest.new(account_id, credit_account_id, counterparty_account_id, description, amount, transaction_summary_override, tags, idempotency_key)
+        Unit::Resource::RepaymentResource.create(request)
+      end
+
+      # Create an ach repayment by calling Unit's API
+      # @see https://docs.unit.co/repayments#create-ach-repayment
+      # @param account_id [String]
+      # @param credit_account_id [String]
+      # @param counterparty_id [String]
+      # @param description [String]
+      # @param amount [Integer]
+      # @param addenda [String] - optional
+      # @param tags [Hash] - optional
+      # @param same_day [Boolean] - optional
+      # @param idempotency_key [String] - optional
+      def create_ach_repayment(account_id:, credit_account_id:, counterparty_id:, description:, amount:, addenda: nil, tags: nil, idempotency_key: nil, same_day: false)
+        request = Unit::Repayment::CreateAchRepaymentRequest.new(account_id, credit_account_id, counterparty_id, description, amount, addenda, tags, idempotency_key, same_day: same_day)
+        Unit::Resource::RepaymentResource.create(request)
+      end
+
+      # List repayments by calling Unit's API
+      # @see https://docs.unit.co/repayments#list-repayments
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param credit_account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param type [Array<String>] - optional
+      def list_repayments(limit: REPAYMENT_LIMIT, offset: REPAYMENT_OFFSET, account_id: nil,
+                          credit_account_id: nil, customer_id: nil, status: nil, type: nil)
+        request = Unit::Repayment::ListRepaymentParams.new(limit, offset, account_id, credit_account_id, customer_id, status, type)
+        Unit::Resource::RepaymentResource.list(request)
+      end
+    end
+  end
+end

data/lib/unit/models/reward/create_reward_request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Create a reward request
+# @see https://docs.unit.co/rewards/#create-reward
+module Unit
+  module Reward
+    class CreateRewardRequest
+      attr_reader :receiving_account_id, :funding_account_id, :rewarded_transaction_id, :amount, :description, :tags, :idempotency_key
+
+      # @param receiving_account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param tags [Hash]
+      # @param idempotency_key [String]
+      # @param funding_account_id [String] - optional
+      # @param rewarded_transaction_id [String] - optional
+      def initialize(receiving_account_id, amount, description, tags = nil, idempotency_key = nil, funding_account_id = nil, rewarded_transaction_id = nil)
+        @receiving_account_id = receiving_account_id
+        @amount = amount
+        @description = description
+        @tags = tags
+        @idempotency_key = idempotency_key
+        @funding_account_id = funding_account_id
+        @rewarded_transaction = rewarded_transaction_id
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "reward",
+            attributes: {
+              amount: amount,
+              description: description,
+              tags: tags,
+              idempotencyKey: idempotency_key
+            },
+            relationships: {
+              receivingAccount: Unit::Types::Relationship.new("depositAccount", receiving_account_id).to_hash
+            }
+          }
+        }
+        payload[:data][:relationships][:funding_account] = Unit::Types::Relationship.new("fundingAccount", funding_account_id).to_hash if funding_account_id
+        payload[:data][:relationships][:rewardedTransaction] = Unit::Types::Relationship.new("rewardedTransaction", rewarded_transaction).to_hash if rewarded_transaction_id
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Get a reward by id request
+# @see https://docs.unit.co/rewards/#get-specific-reward
+module Unit
+  module Reward
+    class GetRequest
+      attr_reader :reward_id, :include
+
+      # @param reward_id [String]
+      # @param include [Array<String>] - optional
+      def initialize(reward_id, include = nil)
+        @reward_id = reward_id
+        @include = include
+      end
+
+      def to_hash
+        { include: include&.join(",") }.compact
+      end
+    end
+  end
+end

data/lib/unit/models/reward/list_reward_params.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# List reward params request
+# @see https://docs.unit.co/rewards/#list-rewards
+module Unit
+  module Reward
+    class ListRewardParams
+      attr_reader :limit, :offset, :transaction_id, :rewarded_transaction_id,
+                  :receiving_account_id, :customer_id, :card_id, :status, :since,
+                  :until_, :tags, :sort, :include
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param transaction_id [String] - optional
+      # @param rewarded_transaction_id [String] - optional
+      # @param receiving_account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param card_id [String] - optional
+      # @param status [String] - optional
+      # @param since [String] - optional
+      # @param until_ [String] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def initialize(limit = REWARD_LIMIT, offset = REWARD_OFFSET, transaction_id = nil, rewarded_transaction_id = nil,
+                     receiving_account_id = nil, customer_id = nil, card_id = nil, status = nil, since = nil,
+                     until_ = nil, tags = nil, sort = nil, include = nil)
+        @limit = limit
+        @offset = offset
+        @transaction_id = transaction_id
+        @rewarded_transaction_id = rewarded_transaction_id
+        @receiving_account_id = receiving_account_id
+        @customer_id = customer_id
+        @card_id = card_id
+        @status = status
+        @since = since
+        @until_ = until_
+        @tags = tags
+        @sort = sort
+        @include = include
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[transactionId]": transaction_id,
+          "filter[rewardedTransactionId]": rewarded_transaction_id,
+          "filter[receivingAccountId]": receiving_account_id,
+          "filter[customerId]": customer_id,
+          "filter[cardId]": card_id,
+          "filter[since]": since,
+          "filter[until]": until_,
+          "filter[tags]": tags,
+          "sort": sort,
+          "include": include&.join(",")
+        }
+        status&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[status][#{index}]": val })
+        end
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/reward/reward.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Unit
+  module Reward
+    REWARD_LIMIT = 100
+    REWARD_OFFSET = 0
+    autoload :GetRequest, "unit/models/reward/get_request"
+    autoload :CreateRewardRequest, "unit/models/reward/create_reward_request"
+    autoload :ListRewardParams, "unit/models/reward/list_reward_params"
+    class << self
+      # Get a reward by id
+      # @see https://docs.unit.co/rewards/#get-specific-reward
+      # @param reward_id [String]
+      # @param include [Array<String>] - optional
+      def get_reward(reward_id:, include: nil)
+        request = GetRequest.new(reward_id, include)
+        Resource::RewardResource.get_reward(request)
+      end
+
+      # Create a reward request
+      # @see https://docs.unit.co/rewards/#create-reward
+      # @param receiving_account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param tags [Hash]
+      # @param idempotency_key [String]
+      # @param funding_account_id [String] - optional
+      # @param rewarded_transaction_id [String] - optional
+      def create_reward(receiving_account_id:, amount:, description:, tags:, idempotency_key:, funding_account_id: nil, rewarded_transaction: nil)
+        request = CreateRewardRequest.new(receiving_account_id, amount, description, tags, idempotency_key, funding_account_id, rewarded_transaction)
+        Resource::RewardResource.create_reward(request)
+      end
+
+      # List reward params request
+      # @see https://docs.unit.co/rewards/#list-rewards
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param transaction_id [String] - optional
+      # @param rewarded_transaction_id [String] - optional
+      # @param receiving_account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param card_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param since [String] - optional
+      # @param until_ [String] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def list_rewards(limit: REWARD_LIMIT, offset: REWARD_OFFSET, transaction_id: nil, rewarded_transaction_id: nil, receiving_account_id: nil, customer_id: nil, card_id: nil, status: nil, since: nil, until_: nil, tags: nil, sort: nil, include: nil)
+        request = ListRewardParams.new(limit, offset, transaction_id, rewarded_transaction_id, receiving_account_id, customer_id, card_id, status, since, until_, tags, sort, include)
+        Resource::RewardResource.list_rewards(request)
+      end
+    end
+  end
+end

data/lib/unit/models/unit_response.rb

@@ -3,7 +3,7 @@
 # Represents a response from Unit's API
 module Unit
   class UnitResponse
-    attr_reader :data, :included
+    attr_reader :data, :included, :meta
 
     # @param data [Hash] The JSON API payload
     # @param included [Array] The JSON API payload

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)