fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/primary_principal1.rb

@@ -0,0 +1,209 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # The Primary Principal.
+  class PrimaryPrincipal1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Signer's first name
+    # @return [String]
+    attr_accessor :first_name
+
+    # Signer's last name
+    # @return [String]
+    attr_accessor :last_name
+
+    # Signer's middle name
+    # @return [String]
+    attr_accessor :middle_name
+
+    # Signer's title
+    # @return [String]
+    attr_accessor :title
+
+    # Signer's date of birth
+    # @return [String]
+    attr_accessor :date_of_birth
+
+    # Signer's residential address line 1
+    # @return [String]
+    attr_accessor :address_line_1
+
+    # Signer's residential address line 2
+    # @return [String]
+    attr_accessor :address_line_2
+
+    # Signer's city
+    # @return [String]
+    attr_accessor :city
+
+    # Signer's two-digit state code
+    # @return [String]
+    attr_accessor :state_province
+
+    # Signer's postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Last four digits of the primary principal or Signer's social security
+    # number
+    # @return [String]
+    attr_accessor :ssn
+
+    # Percentage of business owned by primary principal or signer
+    # @return [Integer]
+    attr_accessor :ownership_percent
+
+    # Signer's phone number
+    # @return [String]
+    attr_accessor :phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['middle_name'] = 'middle_name'
+      @_hash['title'] = 'title'
+      @_hash['date_of_birth'] = 'date_of_birth'
+      @_hash['address_line_1'] = 'address_line_1'
+      @_hash['address_line_2'] = 'address_line_2'
+      @_hash['city'] = 'city'
+      @_hash['state_province'] = 'state_province'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['ssn'] = 'ssn'
+      @_hash['ownership_percent'] = 'ownership_percent'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        middle_name
+        title
+        date_of_birth
+        address_line_1
+        address_line_2
+        city
+        state_province
+        postal_code
+        ssn
+        ownership_percent
+        phone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        middle_name
+        title
+        date_of_birth
+        address_line_1
+        address_line_2
+        city
+        state_province
+        postal_code
+        ssn
+        ownership_percent
+        phone_number
+      ]
+    end
+
+    def initialize(first_name = nil, last_name = nil, middle_name = SKIP,
+                   title = SKIP, date_of_birth = SKIP, address_line_1 = SKIP,
+                   address_line_2 = SKIP, city = SKIP, state_province = SKIP,
+                   postal_code = SKIP, ssn = SKIP, ownership_percent = SKIP,
+                   phone_number = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @first_name = first_name
+      @last_name = last_name
+      @middle_name = middle_name unless middle_name == SKIP
+      @title = title unless title == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @address_line_1 = address_line_1 unless address_line_1 == SKIP
+      @address_line_2 = address_line_2 unless address_line_2 == SKIP
+      @city = city unless city == SKIP
+      @state_province = state_province unless state_province == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @ssn = ssn unless ssn == SKIP
+      @ownership_percent = ownership_percent unless ownership_percent == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      first_name = hash.key?('first_name') ? hash['first_name'] : nil
+      last_name = hash.key?('last_name') ? hash['last_name'] : nil
+      middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      date_of_birth = hash.key?('date_of_birth') ? hash['date_of_birth'] : SKIP
+      address_line_1 =
+        hash.key?('address_line_1') ? hash['address_line_1'] : SKIP
+      address_line_2 =
+        hash.key?('address_line_2') ? hash['address_line_2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state_province =
+        hash.key?('state_province') ? hash['state_province'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      ssn = hash.key?('ssn') ? hash['ssn'] : SKIP
+      ownership_percent =
+        hash.key?('ownership_percent') ? hash['ownership_percent'] : SKIP
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      PrimaryPrincipal1.new(first_name,
+                            last_name,
+                            middle_name,
+                            title,
+                            date_of_birth,
+                            address_line_1,
+                            address_line_2,
+                            city,
+                            state_province,
+                            postal_code,
+                            ssn,
+                            ownership_percent,
+                            phone_number,
+                            additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name}, last_name: #{@last_name}, middle_name:"\
+      " #{@middle_name}, title: #{@title}, date_of_birth: #{@date_of_birth}, address_line_1:"\
+      " #{@address_line_1}, address_line_2: #{@address_line_2}, city: #{@city}, state_province:"\
+      " #{@state_province}, postal_code: #{@postal_code}, ssn: #{@ssn}, ownership_percent:"\
+      " #{@ownership_percent}, phone_number: #{@phone_number}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect},"\
+      " middle_name: #{@middle_name.inspect}, title: #{@title.inspect}, date_of_birth:"\
+      " #{@date_of_birth.inspect}, address_line_1: #{@address_line_1.inspect}, address_line_2:"\
+      " #{@address_line_2.inspect}, city: #{@city.inspect}, state_province:"\
+      " #{@state_province.inspect}, postal_code: #{@postal_code.inspect}, ssn: #{@ssn.inspect},"\
+      " ownership_percent: #{@ownership_percent.inspect}, phone_number: #{@phone_number.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/process_method_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Ui Prefs Process Method
+  class ProcessMethodEnum
+    PROCESS_METHOD_ENUM = [
+      # TODO: Write general description for VIRTUAL_TERMINAL
+      VIRTUAL_TERMINAL = 'virtual_terminal'.freeze,
+
+      # TODO: Write general description for PHYSICAL_TERMINAL
+      PHYSICAL_TERMINAL = 'physical_terminal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROCESS_METHOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = VIRTUAL_TERMINAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'virtual_terminal' then VIRTUAL_TERMINAL
+      when 'physical_terminal' then PHYSICAL_TERMINAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/processor_enum.rb

@@ -0,0 +1,52 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Processor
+  class ProcessorEnum
+    PROCESSOR_ENUM = [
+      # TODO: Write general description for ZGATE
+      ZGATE = 'zgate'.freeze,
+
+      # TODO: Write general description for ZGATE2
+      ZGATE2 = 'zgate2'.freeze,
+
+      # TODO: Write general description for ZACH
+      ZACH = 'zach'.freeze,
+
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for FORTISACH
+      FORTISACH = 'fortisach'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROCESSOR_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ZGATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'zgate' then ZGATE
+      when 'zgate2' then ZGATE2
+      when 'zach' then ZACH
+      when 'ach' then ACH
+      when 'fortisach' then FORTISACH
+      when 'cash' then CASH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/product_accountvault.rb

@@ -0,0 +1,173 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Product Token array (legacy)
+  class ProductAccountvault < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Title
+    # @return [String]
+    attr_accessor :title
+
+    # Location Id
+    # @return [String]
+    attr_accessor :location_id
+
+    # Location Api Id
+    # @return [String]
+    attr_accessor :location_api_id
+
+    # Multiple Use Tickets
+    # @return [TrueClass | FalseClass]
+    attr_accessor :multi_use_tickets
+
+    # Product Token Id
+    # @return [String]
+    attr_accessor :id
+
+    # Active
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # Modified Time Stamp
+    # @return [Integer]
+    attr_accessor :modified_ts
+
+    # User ID Created the register
+    # @return [String]
+    attr_accessor :created_user_id
+
+    # Last User ID that updated the register
+    # @return [String]
+    attr_accessor :modified_user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['location_id'] = 'location_id'
+      @_hash['location_api_id'] = 'location_api_id'
+      @_hash['multi_use_tickets'] = 'multi_use_tickets'
+      @_hash['id'] = 'id'
+      @_hash['active'] = 'active'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['modified_ts'] = 'modified_ts'
+      @_hash['created_user_id'] = 'created_user_id'
+      @_hash['modified_user_id'] = 'modified_user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        title
+        location_id
+        location_api_id
+        multi_use_tickets
+        id
+        active
+        created_ts
+        modified_ts
+        created_user_id
+        modified_user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        location_api_id
+        created_user_id
+        modified_user_id
+      ]
+    end
+
+    def initialize(title = SKIP, location_id = SKIP, location_api_id = SKIP,
+                   multi_use_tickets = SKIP, id = SKIP, active = SKIP,
+                   created_ts = SKIP, modified_ts = SKIP,
+                   created_user_id = SKIP, modified_user_id = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @title = title unless title == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @location_api_id = location_api_id unless location_api_id == SKIP
+      @multi_use_tickets = multi_use_tickets unless multi_use_tickets == SKIP
+      @id = id unless id == SKIP
+      @active = active unless active == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @modified_ts = modified_ts unless modified_ts == SKIP
+      @created_user_id = created_user_id unless created_user_id == SKIP
+      @modified_user_id = modified_user_id unless modified_user_id == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      title = hash.key?('title') ? hash['title'] : SKIP
+      location_id = hash.key?('location_id') ? hash['location_id'] : SKIP
+      location_api_id =
+        hash.key?('location_api_id') ? hash['location_api_id'] : SKIP
+      multi_use_tickets =
+        hash.key?('multi_use_tickets') ? hash['multi_use_tickets'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      active = hash.key?('active') ? hash['active'] : SKIP
+      created_ts = hash.key?('created_ts') ? hash['created_ts'] : SKIP
+      modified_ts = hash.key?('modified_ts') ? hash['modified_ts'] : SKIP
+      created_user_id =
+        hash.key?('created_user_id') ? hash['created_user_id'] : SKIP
+      modified_user_id =
+        hash.key?('modified_user_id') ? hash['modified_user_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      ProductAccountvault.new(title,
+                              location_id,
+                              location_api_id,
+                              multi_use_tickets,
+                              id,
+                              active,
+                              created_ts,
+                              modified_ts,
+                              created_user_id,
+                              modified_user_id,
+                              additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} title: #{@title}, location_id: #{@location_id}, location_api_id:"\
+      " #{@location_api_id}, multi_use_tickets: #{@multi_use_tickets}, id: #{@id}, active:"\
+      " #{@active}, created_ts: #{@created_ts}, modified_ts: #{@modified_ts}, created_user_id:"\
+      " #{@created_user_id}, modified_user_id: #{@modified_user_id}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} title: #{@title.inspect}, location_id: #{@location_id.inspect},"\
+      " location_api_id: #{@location_api_id.inspect}, multi_use_tickets:"\
+      " #{@multi_use_tickets.inspect}, id: #{@id.inspect}, active: #{@active.inspect}, created_ts:"\
+      " #{@created_ts.inspect}, modified_ts: #{@modified_ts.inspect}, created_user_id:"\
+      " #{@created_user_id.inspect}, modified_user_id: #{@modified_user_id.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/product_file.rb

@@ -0,0 +1,227 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Product file array
+  class ProductFile < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Title
+    # @return [String]
+    attr_accessor :title
+
+    # Product File Credential Id
+    # @return [String]
+    attr_accessor :product_file_credential_id
+
+    # Free Bytes
+    # @return [Float]
+    attr_accessor :free_bytes
+
+    # Byte Increment
+    # @return [Float]
+    attr_accessor :byte_increment
+
+    # Max File Size Bytes
+    # @return [Float]
+    attr_accessor :max_file_size_bytes
+
+    # Increment Cost
+    # @return [Float]
+    attr_accessor :increment_cost
+
+    # Monthly Fee
+    # @return [Integer]
+    attr_accessor :monthly_fee
+
+    # File Ext Allowed
+    # @return [String]
+    attr_accessor :file_ext_allowed
+
+    # Container
+    # @return [String]
+    attr_accessor :container
+
+    # Product File Id
+    # @return [String]
+    attr_accessor :id
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # Modified Time Stamp
+    # @return [Integer]
+    attr_accessor :modified_ts
+
+    # Active
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # User ID Created the register
+    # @return [String]
+    attr_accessor :created_user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['product_file_credential_id'] = 'product_file_credential_id'
+      @_hash['free_bytes'] = 'free_bytes'
+      @_hash['byte_increment'] = 'byte_increment'
+      @_hash['max_file_size_bytes'] = 'max_file_size_bytes'
+      @_hash['increment_cost'] = 'increment_cost'
+      @_hash['monthly_fee'] = 'monthly_fee'
+      @_hash['file_ext_allowed'] = 'file_ext_allowed'
+      @_hash['container'] = 'container'
+      @_hash['id'] = 'id'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['modified_ts'] = 'modified_ts'
+      @_hash['active'] = 'active'
+      @_hash['created_user_id'] = 'created_user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        title
+        product_file_credential_id
+        free_bytes
+        byte_increment
+        max_file_size_bytes
+        increment_cost
+        monthly_fee
+        file_ext_allowed
+        container
+        id
+        created_ts
+        modified_ts
+        active
+        created_user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        free_bytes
+        byte_increment
+        max_file_size_bytes
+        increment_cost
+        monthly_fee
+        file_ext_allowed
+        container
+        created_ts
+        modified_ts
+        created_user_id
+      ]
+    end
+
+    def initialize(title = SKIP, product_file_credential_id = SKIP,
+                   free_bytes = SKIP, byte_increment = SKIP,
+                   max_file_size_bytes = SKIP, increment_cost = SKIP,
+                   monthly_fee = SKIP, file_ext_allowed = SKIP,
+                   container = SKIP, id = SKIP, created_ts = SKIP,
+                   modified_ts = SKIP, active = SKIP, created_user_id = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @title = title unless title == SKIP
+      unless product_file_credential_id == SKIP
+        @product_file_credential_id =
+          product_file_credential_id
+      end
+      @free_bytes = free_bytes unless free_bytes == SKIP
+      @byte_increment = byte_increment unless byte_increment == SKIP
+      @max_file_size_bytes = max_file_size_bytes unless max_file_size_bytes == SKIP
+      @increment_cost = increment_cost unless increment_cost == SKIP
+      @monthly_fee = monthly_fee unless monthly_fee == SKIP
+      @file_ext_allowed = file_ext_allowed unless file_ext_allowed == SKIP
+      @container = container unless container == SKIP
+      @id = id unless id == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @modified_ts = modified_ts unless modified_ts == SKIP
+      @active = active unless active == SKIP
+      @created_user_id = created_user_id unless created_user_id == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      title = hash.key?('title') ? hash['title'] : SKIP
+      product_file_credential_id =
+        hash.key?('product_file_credential_id') ? hash['product_file_credential_id'] : SKIP
+      free_bytes = hash.key?('free_bytes') ? hash['free_bytes'] : SKIP
+      byte_increment =
+        hash.key?('byte_increment') ? hash['byte_increment'] : SKIP
+      max_file_size_bytes =
+        hash.key?('max_file_size_bytes') ? hash['max_file_size_bytes'] : SKIP
+      increment_cost =
+        hash.key?('increment_cost') ? hash['increment_cost'] : SKIP
+      monthly_fee = hash.key?('monthly_fee') ? hash['monthly_fee'] : SKIP
+      file_ext_allowed =
+        hash.key?('file_ext_allowed') ? hash['file_ext_allowed'] : SKIP
+      container = hash.key?('container') ? hash['container'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created_ts = hash.key?('created_ts') ? hash['created_ts'] : SKIP
+      modified_ts = hash.key?('modified_ts') ? hash['modified_ts'] : SKIP
+      active = hash.key?('active') ? hash['active'] : SKIP
+      created_user_id =
+        hash.key?('created_user_id') ? hash['created_user_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      ProductFile.new(title,
+                      product_file_credential_id,
+                      free_bytes,
+                      byte_increment,
+                      max_file_size_bytes,
+                      increment_cost,
+                      monthly_fee,
+                      file_ext_allowed,
+                      container,
+                      id,
+                      created_ts,
+                      modified_ts,
+                      active,
+                      created_user_id,
+                      additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} title: #{@title}, product_file_credential_id:"\
+      " #{@product_file_credential_id}, free_bytes: #{@free_bytes}, byte_increment:"\
+      " #{@byte_increment}, max_file_size_bytes: #{@max_file_size_bytes}, increment_cost:"\
+      " #{@increment_cost}, monthly_fee: #{@monthly_fee}, file_ext_allowed: #{@file_ext_allowed},"\
+      " container: #{@container}, id: #{@id}, created_ts: #{@created_ts}, modified_ts:"\
+      " #{@modified_ts}, active: #{@active}, created_user_id: #{@created_user_id},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} title: #{@title.inspect}, product_file_credential_id:"\
+      " #{@product_file_credential_id.inspect}, free_bytes: #{@free_bytes.inspect},"\
+      " byte_increment: #{@byte_increment.inspect}, max_file_size_bytes:"\
+      " #{@max_file_size_bytes.inspect}, increment_cost: #{@increment_cost.inspect}, monthly_fee:"\
+      " #{@monthly_fee.inspect}, file_ext_allowed: #{@file_ext_allowed.inspect}, container:"\
+      " #{@container.inspect}, id: #{@id.inspect}, created_ts: #{@created_ts.inspect},"\
+      " modified_ts: #{@modified_ts.inspect}, active: #{@active.inspect}, created_user_id:"\
+      " #{@created_user_id.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end