unit_ruby_sdk 0.1.0 → 0.1.1

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Creates request for uploading a document
+# See: https://docs.unit.co/application-documents/#upload-document
+module Unit
+  module Application
+    class UploadDocumentRequest
+      attr_reader :application_id, :document_id, :file, :file_type, :content_type, :is_back_side
+
+      # @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
+      def initialize(application_id, document_id, file, file_type, is_back_side: false)
+        @application_id = application_id
+        @document_id = document_id
+        @file = file
+        @file_type = file_type
+        @is_back_side = is_back_side
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Request to add authorized users to a project
+# 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
+      def initialize(customer_id, authorized_users)
+        @customer_id = customer_id
+        @authorized_users = authorized_users
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "addAuthorizedUsers",
+            attributes: {
+              authorizedUsers: authorized_users.map(&:represent)
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Request to 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.
+      def initialize(customer_id, reason = nil)
+        @customer_id = customer_id
+        @reason = reason
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "archiveCustomer",
+            attributes: { reason: reason }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# params for listing 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,
+                     sort = nil)
+        @limit = limit
+        @offset = offset
+        @query = query
+        @email = email
+        @tags = tags
+        @status = status
+        @sort = sort
+      end
+
+      def to_hash
+        params = { "page[limit]": limit,
+                   "page[offset]": offset,
+                   "filter[query]": query,
+                   "filter[email]": email,
+                   "filter[tags]": tags,
+                   "filter[status]": status,
+                   "sort": sort }
+        params.compact!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Update business customer information request
+# 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
+      # 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)
+        @customer_id = customer_id
+        @address = address
+        @phone = phone
+        @contact = contact
+        @authorized_users = authorized_users
+        @dba = dba
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "businessCustomer",
+            attributes: {
+              address: address&.represent,
+              phone: phone&.represent,
+              contact: contact&.represent,
+              authorized_users: authorized_users&.map(&:represent),
+              dba: dba,
+              tags: tags
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Update individual customer information request
+# 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
+      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
+        @phone = phone
+        @email = email
+        @dba = dba
+        @authorized_users = authorized_users
+        @tags = tags
+        @jwt_subject = jwt_subject
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "individualCustomer",
+            attributes: {
+              address: address&.represent,
+              phone: phone&.represent,
+              email: email,
+              dba: dba,
+              authorized_users: authorized_users&.map(&:represent),
+              tags: tags
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Request to remove authorized users from customer
+# 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.
+      def initialize(customer_id, authorized_users_emails)
+        @customer_id = customer_id
+        @authorized_users_emails = authorized_users_emails
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "removeAuthorizedUsers",
+            attributes: {
+              authorizedUsersEmails: authorized_users_emails
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/unit_resource.rb

@@ -2,17 +2,19 @@
 
 # class that represents objects that can be created
 # Unit's resources include applications, customers, cards, accounts, transactions
-class UnitResource
-  attr_reader :id, :type, :attributes, :relationships
+module Unit
+  class UnitResource
+    attr_reader :id, :type, :attributes, :relationships
 
-  # @param id [String] The resource's ID
-  # @param type [String] The type of the resource
-  # @param attributes [Hash] The attributes
-  # @param relationships [Hash] The relationships
-  def initialize(id, type, attributes, relationships)
-    @id = id
-    @type = type
-    @attributes = attributes
-    @relationships = relationships
+    # @param id [String] The resource's ID
+    # @param type [String] The type of the resource
+    # @param attributes [Hash] The attributes
+    # @param relationships [Hash] The relationships
+    def initialize(id, type, attributes, relationships)
+      @id = id
+      @type = type
+      @attributes = attributes
+      @relationships = relationships
+    end
   end
 end

data/lib/unit/models/unit_response.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 # Represents a response from Unit's API
-class UnitResponse
-  attr_reader :data, :included
+module Unit
+  class UnitResponse
+    attr_reader :data, :included
 
-  # @param data [Hash] The JSON API payload
-  # @param included [Array] The JSON API payload
+    # @param data [Hash] The JSON API payload
+    # @param included [Array] The JSON API payload
 
-  def initialize(data, included, meta)
-    @data = data
-    @included = included
-    @meta = meta
+    def initialize(data, included, meta)
+      @data = data
+      @included = included
+      @meta = meta
+    end
   end
 end

data/lib/unit/types/address.rb

@@ -1,31 +1,35 @@
 # frozen_string_literal: true
 
-class Address
-  attr_reader :street, :street2, :city, :state, :postal_code, :country
+module Unit
+  module Types
+    class Address
+      attr_reader :street, :street2, :city, :state, :postal_code, :country
 
-  # @param street [String]
-  # @param city [String]
-  # @param state [String]
-  # @param postal_code [String]
-  # @param country [String]
-  # @param optional street2 [String]
-  def initialize(street, city, state, postal_code, country, street2 = nil)
-    @street = street
-    @street2 = street2
-    @city = city
-    @state = state
-    @postal_code = postal_code
-    @country = country
-  end
+      # @param street [String]
+      # @param city [String]
+      # @param state [String]
+      # @param postal_code [String]
+      # @param country [String]
+      # @param optional street2 [String]
+      def initialize(street, city, state, postal_code, country, street2 = nil)
+        @street = street
+        @street2 = street2
+        @city = city
+        @state = state
+        @postal_code = postal_code
+        @country = country
+      end
 
-  def represent
-    {
-      street: street,
-      street2: street2,
-      city: city,
-      state: state,
-      postalCode: postal_code,
-      country: country
-    }
+      def represent
+        {
+          street: street,
+          street2: street2,
+          city: city,
+          state: state,
+          postalCode: postal_code,
+          country: country
+        }
+      end
+    end
   end
 end

data/lib/unit/types/authorized_user.rb

@@ -2,27 +2,31 @@
 
 # Type representing authorized user
 # See: https://docs.unit.co/customers/#authorized-users
-class AuthorizedUser
-  attr_reader :full_name, :email, :phone, :jwt_subject
+module Unit
+  module Types
+    class AuthorizedUser
+      attr_reader :full_name, :email, :phone, :jwt_subject
 
-  # @param full_name [FullName] The full name of the authorized user
-  # @param email [String] The email of the authorized user
-  # @param phone [Phone] The phone of the authorized user
-  # @param optional jwt_subject [String] The JWT subject of the authorized user. See https://docs.unit.co/customer-api-tokens/#customers-create-customer-bearer-token-jwt
-  def initialize(full_name, email, phone, jwt_subject = nil)
-    @full_name = full_name
-    @email = email
-    @phone = phone
-    @jwt_subject = jwt_subject
-  end
+      # @param full_name [FullName] The full name of the authorized user
+      # @param email [String] The email of the authorized user
+      # @param phone [Phone] The phone of the authorized user
+      # @param optional jwt_subject [String] The JWT subject of the authorized user. See https://docs.unit.co/customer-api-tokens/#customers-create-customer-bearer-token-jwt
+      def initialize(full_name, email, phone, jwt_subject = nil)
+        @full_name = full_name
+        @email = email
+        @phone = phone
+        @jwt_subject = jwt_subject
+      end
 
-  def represent
-    payload = {
-      fullName: full_name.represent,
-      email: email,
-      phone: phone.represent,
-      jwtSubject: jwt_subject
-    }
-    payload.compact
+      def represent
+        payload = {
+          fullName: full_name.represent,
+          email: email,
+          phone: phone.represent,
+          jwtSubject: jwt_subject
+        }
+        payload.compact
+      end
+    end
   end
 end

data/lib/unit/types/beneficial_owner.rb

@@ -1,48 +1,52 @@
 # frozen_string_literal: true
 
-class BeneficialOwner
-  attr_reader :full_name, :date_of_birth, :address, :phone, :email,
-              :status, :ssn, :passport, :nationality, :percentage
+module Unit
+  module Types
+    class BeneficialOwner
+      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
-  # @return [BeneficialOwner]
-  def initialize(full_name, date_of_birth, address, phone, email, ssn, status = nil, passport = nil,
-                 nationality = nil, percentage = nil)
-    @full_name = full_name
-    @date_of_birth = date_of_birth
-    @address = address
-    @phone = phone
-    @email = email
-    @status = status
-    @ssn = ssn
-    @passport = passport
-    @nationality = nationality
-    @percentage = percentage
-  end
+      # @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
+      # @return [BeneficialOwner]
+      def initialize(full_name, date_of_birth, address, phone, email, ssn, status = nil, passport = nil,
+                     nationality = nil, percentage = nil)
+        @full_name = full_name
+        @date_of_birth = date_of_birth
+        @address = address
+        @phone = phone
+        @email = email
+        @status = status
+        @ssn = ssn
+        @passport = passport
+        @nationality = nationality
+        @percentage = percentage
+      end
 
-  def represent
-    payload =
-      {
-        fullName: full_name.represent,
-        dateOfBirth: date_of_birth,
-        address: address.represent,
-        phone: phone.represent,
-        email: email,
-        ssn: ssn,
-        status: status,
-        passport: passport,
-        nationality: nationality,
-        percentage: percentage
-      }
-    payload.compact
+      def represent
+        payload =
+          {
+            fullName: full_name.represent,
+            dateOfBirth: date_of_birth,
+            address: address.represent,
+            phone: phone.represent,
+            email: email,
+            ssn: ssn,
+            status: status,
+            passport: passport,
+            nationality: nationality,
+            percentage: percentage
+          }
+        payload.compact
+      end
+    end
   end
 end

data/lib/unit/types/business_contact.rb

@@ -3,23 +3,27 @@
 require_relative "full_name"
 require_relative "phone"
 
-class BusinessContact
-  attr_reader :full_name, :email, :phone
+module Unit
+  module Types
+    class BusinessContact
+      attr_reader :full_name, :email, :phone
 
-  # @param [FullName] full_name
-  # @param [String] email
-  # @param [Phone] phone
-  def initialize(full_name, email, phone)
-    @full_name = full_name
-    @email = email
-    @phone = phone
-  end
+      # @param [FullName] full_name
+      # @param [String] email
+      # @param [Phone] phone
+      def initialize(full_name, email, phone)
+        @full_name = full_name
+        @email = email
+        @phone = phone
+      end
 
-  def represent
-    {
-      fullName: full_name.represent,
-      email: email,
-      phone: phone.represent
-    }
+      def represent
+        {
+          fullName: full_name.represent,
+          email: email,
+          phone: phone.represent
+        }
+      end
+    end
   end
 end

data/lib/unit/types/device_fingerprint.rb

@@ -1,19 +1,23 @@
 # frozen_string_literal: true
 
-class DeviceFingerprint
-  attr_reader :value, :provider
+module Unit
+  module Types
+    class DeviceFingerprint
+      attr_reader :value, :provider
 
-  # @param value [String] The value
-  # @param provider [String] The provider
-  def initialize(value, provider = "iovation")
-    @value = value
-    @provider = provider
-  end
+      # @param value [String] The value
+      # @param provider [String] The provider
+      def initialize(value, provider = "iovation")
+        @value = value
+        @provider = provider
+      end
 
-  def represent
-    {
-      value: value,
-      provider: provider
-    }
+      def represent
+        {
+          value: value,
+          provider: provider
+        }
+      end
+    end
   end
 end

data/lib/unit/types/evaluation_params.rb

@@ -1,18 +1,22 @@
 # frozen_string_literal: true
 
 # Evaluation parameters for a particular entity.
-class EvaluationParams
-  attr_reader :use_selfie_verification, :required_verification
+module Unit
+  module Types
+    class EvaluationParams
+      attr_reader :use_selfie_verification, :required_verification
 
-  def initialize(use_selfie_verification = nil, required_verification = nil)
-    @use_selfie_verification = use_selfie_verification
-    @required_verificaion = required_verification
-  end
+      def initialize(use_selfie_verification = nil, required_verification = nil)
+        @use_selfie_verification = use_selfie_verification
+        @required_verificaion = required_verification
+      end
 
-  def represent
-    {
-      use_selfie_verification: use_selfie_verification,
-      required_verification: required_verification
-    }
+      def represent
+        {
+          use_selfie_verification: use_selfie_verification,
+          required_verification: required_verification
+        }
+      end
+    end
   end
 end