fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/addon.rb

@@ -0,0 +1,130 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Addon Model.
+  class Addon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Title
+    # @return [String]
+    attr_accessor :title
+
+    # Secret
+    # @return [String]
+    attr_accessor :secret
+
+    # Iframe URL
+    # @return [String]
+    attr_accessor :iframe_url
+
+    # Location Setup URL
+    # @return [String]
+    attr_accessor :location_setup_url
+
+    # User Setup URL
+    # @return [String]
+    attr_accessor :user_setup_url
+
+    # Encrypt URL Params
+    # @return [TrueClass | FalseClass]
+    attr_accessor :encrypt_url_params
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['secret'] = 'secret'
+      @_hash['iframe_url'] = 'iframe_url'
+      @_hash['location_setup_url'] = 'location_setup_url'
+      @_hash['user_setup_url'] = 'user_setup_url'
+      @_hash['encrypt_url_params'] = 'encrypt_url_params'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        title
+        secret
+        iframe_url
+        location_setup_url
+        user_setup_url
+        encrypt_url_params
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        location_setup_url
+        user_setup_url
+      ]
+    end
+
+    def initialize(title = SKIP, secret = SKIP, iframe_url = SKIP,
+                   location_setup_url = SKIP, user_setup_url = SKIP,
+                   encrypt_url_params = 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
+      @secret = secret unless secret == SKIP
+      @iframe_url = iframe_url unless iframe_url == SKIP
+      @location_setup_url = location_setup_url unless location_setup_url == SKIP
+      @user_setup_url = user_setup_url unless user_setup_url == SKIP
+      @encrypt_url_params = encrypt_url_params unless encrypt_url_params == 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
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      iframe_url = hash.key?('iframe_url') ? hash['iframe_url'] : SKIP
+      location_setup_url =
+        hash.key?('location_setup_url') ? hash['location_setup_url'] : SKIP
+      user_setup_url =
+        hash.key?('user_setup_url') ? hash['user_setup_url'] : SKIP
+      encrypt_url_params =
+        hash.key?('encrypt_url_params') ? hash['encrypt_url_params'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Addon.new(title,
+                secret,
+                iframe_url,
+                location_setup_url,
+                user_setup_url,
+                encrypt_url_params,
+                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}, secret: #{@secret}, iframe_url: #{@iframe_url},"\
+      " location_setup_url: #{@location_setup_url}, user_setup_url: #{@user_setup_url},"\
+      " encrypt_url_params: #{@encrypt_url_params}, 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}, secret: #{@secret.inspect}, iframe_url:"\
+      " #{@iframe_url.inspect}, location_setup_url: #{@location_setup_url.inspect},"\
+      " user_setup_url: #{@user_setup_url.inspect}, encrypt_url_params:"\
+      " #{@encrypt_url_params.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/address.rb

@@ -0,0 +1,118 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Address of contact
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # City of contact
+    # @return [String]
+    attr_accessor :city
+
+    # State of contact
+    # @return [String]
+    attr_accessor :state
+
+    # Postal code of contact
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The alpha 2 or alpha 3 format country code. If alpha 3 is provided, it
+    # will be converted to alpha 2.
+    # @return [String]
+    attr_accessor :country
+
+    # Street of contact
+    # @return [String]
+    attr_accessor :street
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country'] = 'country'
+      @_hash['street'] = 'street'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        state
+        postal_code
+        country
+        street
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        city
+        state
+        postal_code
+        country
+        street
+      ]
+    end
+
+    def initialize(city = SKIP, state = SKIP, postal_code = SKIP,
+                   country = SKIP, street = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == SKIP
+      @street = street unless street == 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.
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      street = hash.key?('street') ? hash['street'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Address.new(city,
+                  state,
+                  postal_code,
+                  country,
+                  street,
+                  additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, state: #{@state}, postal_code: #{@postal_code}, country:"\
+      " #{@country}, street: #{@street}, 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} city: #{@city.inspect}, state: #{@state.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, street: #{@street.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/address1.rb

@@ -0,0 +1,129 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Address
+  class Address1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # City name
+    # @return [String]
+    attr_accessor :city
+
+    # State name
+    # @return [String]
+    attr_accessor :state
+
+    # Postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # An alpha 2 format country code of US or CA.
+    # @return [CountryEnum]
+    attr_accessor :country
+
+    # Street
+    # @return [String]
+    attr_accessor :street
+
+    # Street 2
+    # @return [String]
+    attr_accessor :street2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country'] = 'country'
+      @_hash['street'] = 'street'
+      @_hash['street2'] = 'street2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        state
+        postal_code
+        country
+        street
+        street2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        city
+        state
+        postal_code
+        country
+        street
+        street2
+      ]
+    end
+
+    def initialize(city = SKIP, state = SKIP, postal_code = SKIP,
+                   country = SKIP, street = SKIP, street2 = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == SKIP
+      @street = street unless street == SKIP
+      @street2 = street2 unless street2 == 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.
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      street = hash.key?('street') ? hash['street'] : SKIP
+      street2 = hash.key?('street2') ? hash['street2'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Address1.new(city,
+                   state,
+                   postal_code,
+                   country,
+                   street,
+                   street2,
+                   additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, state: #{@state}, postal_code: #{@postal_code}, country:"\
+      " #{@country}, street: #{@street}, street2: #{@street2}, 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} city: #{@city.inspect}, state: #{@state.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, street: #{@street.inspect},"\
+      " street2: #{@street2.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/address2.rb

@@ -0,0 +1,117 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Address
+  class Address2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # City name
+    # @return [String]
+    attr_accessor :city
+
+    # State name
+    # @return [String]
+    attr_accessor :state
+
+    # Postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # An alpha 2 format country code of US or CA.
+    # @return [CountryEnum]
+    attr_accessor :country
+
+    # Street
+    # @return [String]
+    attr_accessor :street
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country'] = 'country'
+      @_hash['street'] = 'street'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        state
+        postal_code
+        country
+        street
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        city
+        state
+        postal_code
+        country
+        street
+      ]
+    end
+
+    def initialize(city = SKIP, state = SKIP, postal_code = SKIP,
+                   country = SKIP, street = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == SKIP
+      @street = street unless street == 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.
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      street = hash.key?('street') ? hash['street'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Address2.new(city,
+                   state,
+                   postal_code,
+                   country,
+                   street,
+                   additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, state: #{@state}, postal_code: #{@postal_code}, country:"\
+      " #{@country}, street: #{@street}, 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} city: #{@city.inspect}, state: #{@state.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, street: #{@street.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/address81.rb

@@ -0,0 +1,133 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Array of merchant addresses.
+  class Address81 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Line 1 of address.
+    # @return [String]
+    attr_accessor :address_line_1
+
+    # Line 2 of address.
+    # @return [String]
+    attr_accessor :address_line_2
+
+    # City of address.
+    # @return [String]
+    attr_accessor :city
+
+    # State or province of address.
+    # @return [String]
+    attr_accessor :state_province
+
+    # Postal code of address.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Country of address.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Address type of address.
+    # @return [AddressTypeEnum]
+    attr_accessor :address_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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['address_type'] = 'address_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_line_2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        address_line_2
+      ]
+    end
+
+    def initialize(address_line_1 = nil, city = nil, state_province = nil,
+                   postal_code = nil, country_code = nil, address_type = nil,
+                   address_line_2 = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @address_line_1 = address_line_1
+      @address_line_2 = address_line_2 unless address_line_2 == SKIP
+      @city = city
+      @state_province = state_province
+      @postal_code = postal_code
+      @country_code = country_code
+      @address_type = address_type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      address_line_1 =
+        hash.key?('address_line_1') ? hash['address_line_1'] : 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
+      address_type = hash.key?('address_type') ? hash['address_type'] : nil
+      address_line_2 =
+        hash.key?('address_line_2') ? hash['address_line_2'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Address81.new(address_line_1,
+                    city,
+                    state_province,
+                    postal_code,
+                    country_code,
+                    address_type,
+                    address_line_2,
+                    additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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}, address_type: #{@address_type}, 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} 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}, address_type: #{@address_type.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/address_match_enum.rb

@@ -0,0 +1,40 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Indicates whether the Cardholder Shipping Address and Cardholder Billing
+  # Address are the same.  If the field is not set and the shipping and billing
+  # addresses are the same, the 3DS Server will set the value to Y. Otherwise,
+  # the value will not be changed. >Y - Shipping Address matches Billing Address
+  # > >N - Shipping Address does not match Billing Address >
+  class AddressMatchEnum
+    ADDRESS_MATCH_ENUM = [
+      # TODO: Write general description for Y
+      Y = 'Y'.freeze,
+
+      # TODO: Write general description for N
+      N = 'N'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADDRESS_MATCH_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = Y)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'y' then Y
+      when 'n' then N
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/address_type_enum.rb

@@ -0,0 +1,40 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Address type of address.
+  class AddressTypeEnum
+    ADDRESS_TYPE_ENUM = [
+      # TODO: Write general description for LOCATION
+      LOCATION = 'location'.freeze,
+
+      # TODO: Write general description for MAILING
+      MAILING = 'mailing'.freeze,
+
+      # TODO: Write general description for CORPORATE
+      CORPORATE = 'corporate'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADDRESS_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOCATION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'location' then LOCATION
+      when 'mailing' then MAILING
+      when 'corporate' then CORPORATE
+      else
+        default_value
+      end
+    end
+  end
+end