fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/operator1_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Operator1.
+  class Operator1Enum
+    OPERATOR1_ENUM = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = '>='.freeze,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = '<='.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPERATOR1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_0)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_0' then ENUM_0
+      when 'enum_1' then ENUM_1
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/operator_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # The order. Ascending or descending.
+  class OperatorEnum
+    OPERATOR_ENUM = [
+      # TODO: Write general description for ASC
+      ASC = 'asc'.freeze,
+
+      # TODO: Write general description for DESC
+      DESC = 'desc'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPERATOR_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ASC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'asc' then ASC
+      when 'desc' then DESC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/order21.rb

@@ -0,0 +1,79 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Order21 Model.
+  class Order21 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Resource key to order by.
+    # @return [String]
+    attr_accessor :key
+
+    # The order. Ascending or descending.
+    # @return [OperatorEnum]
+    attr_accessor :operator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash['operator'] = 'operator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = nil, operator = nil, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @key = key
+      @operator = operator
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      key = hash.key?('key') ? hash['key'] : nil
+      operator = hash.key?('operator') ? hash['operator'] : nil
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Order21.new(key,
+                  operator,
+                  additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key}, operator: #{@operator}, 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} key: #{@key.inspect}, operator: #{@operator.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/order_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Sort direction ASC/DESC
+  class OrderEnum
+    ORDER_ENUM = [
+      # TODO: Write general description for ASC
+      ASC = 'asc'.freeze,
+
+      # TODO: Write general description for DESC
+      DESC = 'desc'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORDER_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ASC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'asc' then ASC
+      when 'desc' then DESC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/owner.rb

@@ -0,0 +1,233 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Array of merchant owners.
+  class Owner < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Owner's first name.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Owner's last name.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Owner's middle name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # Owner's title.
+    # @return [String]
+    attr_accessor :title
+
+    # Owner's date of birth.
+    # @return [String]
+    attr_accessor :date_of_birth
+
+    # Owner's street address.
+    # @return [String]
+    attr_accessor :address_line_1
+
+    # Line 2 of owner's address.
+    # @return [String]
+    attr_accessor :address_line_2
+
+    # Owner's address city.
+    # @return [String]
+    attr_accessor :city
+
+    # Owner's address state/province.
+    # @return [String]
+    attr_accessor :state_province
+
+    # Owner's address postal code.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Owner's address country.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Owner's full SSN.
+    # @return [String]
+    attr_accessor :ssn
+
+    # Owner's ownership percent.
+    # @return [Integer]
+    attr_accessor :ownership_percent
+
+    # Owner's phone number.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Owner's email address.
+    # @return [String]
+    attr_accessor :email_address
+
+    # Flag indicating whether this owner is the control owner. Maximum of 1
+    # owner can be marked as control..
+    # >Flag indicating whether this owner is the control owner. Maximum of 1
+    # owner can be marked as control.
+    # >
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_controller
+
+    # Flag indicating whether or not the owner is a signer for the business.
+    # Maximum of 1 owner can be marked as signer.
+    # >Flag indicating whether or not the owner is a signer for the business.
+    # Maximum of 1 owner can be marked as signer. 
+    # >
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_signer
+
+    # 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['country_code'] = 'country_code'
+      @_hash['ssn'] = 'ssn'
+      @_hash['ownership_percent'] = 'ownership_percent'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['email_address'] = 'email_address'
+      @_hash['is_controller'] = 'is_controller'
+      @_hash['is_signer'] = 'is_signer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        middle_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        middle_name
+      ]
+    end
+
+    def initialize(first_name = nil, last_name = nil, title = nil,
+                   date_of_birth = nil, address_line_1 = nil,
+                   address_line_2 = nil, city = nil, state_province = nil,
+                   postal_code = nil, country_code = nil, ssn = nil,
+                   ownership_percent = nil, phone_number = nil,
+                   email_address = nil, is_controller = nil, is_signer = nil,
+                   middle_name = 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
+      @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
+      @country_code = country_code
+      @ssn = ssn
+      @ownership_percent = ownership_percent
+      @phone_number = phone_number
+      @email_address = email_address
+      @is_controller = is_controller
+      @is_signer = is_signer
+    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
+      title = hash.key?('title') ? hash['title'] : nil
+      date_of_birth = hash.key?('date_of_birth') ? hash['date_of_birth'] : nil
+      address_line_1 =
+        hash.key?('address_line_1') ? hash['address_line_1'] : nil
+      address_line_2 =
+        hash.key?('address_line_2') ? hash['address_line_2'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      state_province =
+        hash.key?('state_province') ? hash['state_province'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      ssn = hash.key?('ssn') ? hash['ssn'] : nil
+      ownership_percent =
+        hash.key?('ownership_percent') ? hash['ownership_percent'] : nil
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : nil
+      email_address = hash.key?('email_address') ? hash['email_address'] : nil
+      is_controller = hash.key?('is_controller') ? hash['is_controller'] : nil
+      is_signer = hash.key?('is_signer') ? hash['is_signer'] : nil
+      middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Owner.new(first_name,
+                last_name,
+                title,
+                date_of_birth,
+                address_line_1,
+                address_line_2,
+                city,
+                state_province,
+                postal_code,
+                country_code,
+                ssn,
+                ownership_percent,
+                phone_number,
+                email_address,
+                is_controller,
+                is_signer,
+                middle_name,
+                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}, country_code: #{@country_code}, ssn:"\
+      " #{@ssn}, ownership_percent: #{@ownership_percent}, phone_number: #{@phone_number},"\
+      " email_address: #{@email_address}, is_controller: #{@is_controller}, is_signer:"\
+      " #{@is_signer}, 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}, country_code:"\
+      " #{@country_code.inspect}, ssn: #{@ssn.inspect}, ownership_percent:"\
+      " #{@ownership_percent.inspect}, phone_number: #{@phone_number.inspect}, email_address:"\
+      " #{@email_address.inspect}, is_controller: #{@is_controller.inspect}, is_signer:"\
+      " #{@is_signer.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/ownership_type_enum.rb

@@ -0,0 +1,68 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # The Ownership Type of the merchant's business.
+  class OwnershipTypeEnum
+    OWNERSHIP_TYPE_ENUM = [
+      # TODO: Write general description for C
+      C = 'c'.freeze,
+
+      # TODO: Write general description for GOV
+      GOV = 'gov'.freeze,
+
+      # TODO: Write general description for LLC
+      LLC = 'llc'.freeze,
+
+      # TODO: Write general description for LLP
+      LLP = 'llp'.freeze,
+
+      # TODO: Write general description for NP
+      NP = 'np'.freeze,
+
+      # TODO: Write general description for P
+      P = 'p'.freeze,
+
+      # TODO: Write general description for PO
+      PO = 'po'.freeze,
+
+      # TODO: Write general description for S
+      S = 's'.freeze,
+
+      # TODO: Write general description for SP
+      SP = 'sp'.freeze,
+
+      # TODO: Write general description for TE
+      TE = 'te'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OWNERSHIP_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = C)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'c' then C
+      when 'gov' then GOV
+      when 'llc' then LLC
+      when 'llp' then LLP
+      when 'np' then NP
+      when 'p' then P
+      when 'po' then PO
+      when 's' then S
+      when 'sp' then SP
+      when 'te' then TE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/page.rb

@@ -0,0 +1,84 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Use this field to specify paginate your results, by using page size and
+  # number. You can use one of the following methods: >/endpoint?page={
+  # "number": 1, "size": 50 } > >/endpoint?page[number]=1&page[size]=50 >
+  class Page < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The current page number of the page to be retrieved.
+    # @return [Integer]
+    attr_accessor :number
+
+    # The maximum number of records ta will be returned per page.
+    # @return [Integer]
+    attr_accessor :size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['size'] = 'size'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number
+        size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number = SKIP, size = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @number = number unless number == SKIP
+      @size = size unless size == 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.
+      number = hash.key?('number') ? hash['number'] : SKIP
+      size = hash.key?('size') ? hash['size'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Page.new(number,
+               size,
+               additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number}, size: #{@size}, 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} number: #{@number.inspect}, size: #{@size.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/pagination.rb

@@ -0,0 +1,113 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Pagination info
+  class Pagination < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Object type
+    # @return [Type3Enum]
+    attr_accessor :type
+
+    # Total records count
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Total page count
+    # @return [Integer]
+    attr_accessor :page_count
+
+    # Current page
+    # @return [Integer]
+    attr_accessor :page_number
+
+    # Page size
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['total_count'] = 'total_count'
+      @_hash['page_count'] = 'page_count'
+      @_hash['page_number'] = 'page_number'
+      @_hash['page_size'] = 'page_size'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        total_count
+        page_count
+        page_number
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, total_count = SKIP, page_count = SKIP,
+                   page_number = SKIP, page_size = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @type = type unless type == SKIP
+      @total_count = total_count unless total_count == SKIP
+      @page_count = page_count unless page_count == SKIP
+      @page_number = page_number unless page_number == SKIP
+      @page_size = page_size unless page_size == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      total_count = hash.key?('total_count') ? hash['total_count'] : SKIP
+      page_count = hash.key?('page_count') ? hash['page_count'] : SKIP
+      page_number = hash.key?('page_number') ? hash['page_number'] : SKIP
+      page_size = hash.key?('page_size') ? hash['page_size'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Pagination.new(type,
+                     total_count,
+                     page_count,
+                     page_number,
+                     page_size,
+                     additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, total_count: #{@total_count}, page_count: #{@page_count},"\
+      " page_number: #{@page_number}, page_size: #{@page_size}, 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} type: #{@type.inspect}, total_count: #{@total_count.inspect}, page_count:"\
+      " #{@page_count.inspect}, page_number: #{@page_number.inspect}, page_size:"\
+      " #{@page_size.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end