fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/parent3.rb

@@ -0,0 +1,387 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Parent Information on `expand`
+  class Parent3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location ID
+    # @return [String]
+    attr_accessor :id
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # Modified Time Stamp
+    # @return [Integer]
+    attr_accessor :modified_ts
+
+    # Account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Address
+    # @return [Address1]
+    attr_accessor :address
+
+    # GUID for Branding Domain
+    # @return [String]
+    attr_accessor :branding_domain_id
+
+    # If true, will email contact receipt for any transaction
+    # @return [TrueClass | FalseClass]
+    attr_accessor :contact_email_trx_receipt_default
+
+    # GUID for Location's default ACH Product Transaction
+    # @return [String]
+    attr_accessor :default_ach
+
+    # GUID for Location's default CC Product Transaction
+    # @return [String]
+    attr_accessor :default_cc
+
+    # Used as from email address when sending various notifications
+    # @return [String]
+    attr_accessor :email_reply_to
+
+    # Fax number
+    # @return [String]
+    attr_accessor :fax
+
+    # Location api ID
+    # @return [String]
+    attr_accessor :location_api_id
+
+    # Location api key
+    # @return [String]
+    attr_accessor :location_api_key
+
+    # Can be used to store custom information for location.
+    # @return [String]
+    attr_accessor :location_c1
+
+    # Can be used to store custom information for location.
+    # @return [String]
+    attr_accessor :location_c2
+
+    # Can be used to store custom information for location.
+    # @return [String]
+    attr_accessor :location_c3
+
+    # Name of the company
+    # @return [String]
+    attr_accessor :name
+
+    # Office phone number
+    # @return [String]
+    attr_accessor :office_phone
+
+    # Office phone extension number
+    # @return [String]
+    attr_accessor :office_ext_phone
+
+    # Time zone
+    # @return [String]
+    attr_accessor :tz
+
+    # Location GUID of the parent location
+    # @return [String]
+    attr_accessor :parent_id
+
+    # If set to true will show 'Notes' tab on Contact
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_contact_notes
+
+    # If set to true will show 'Files' tab on Contact
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_contact_files
+
+    # User ID Created the register
+    # @return [String]
+    attr_accessor :created_user_id
+
+    # Location Type
+    # @return [LocationTypeEnum]
+    attr_accessor :location_type
+
+    # Name of the parent location
+    # @return [String]
+    attr_accessor :parent_name
+
+    # Ticket Hash Key
+    # @return [String]
+    attr_accessor :ticket_hash_key
+
+    # Ticket Hash Key
+    # @return [AdditionalAccess]
+    attr_accessor :additional_access
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['modified_ts'] = 'modified_ts'
+      @_hash['account_number'] = 'account_number'
+      @_hash['address'] = 'address'
+      @_hash['branding_domain_id'] = 'branding_domain_id'
+      @_hash['contact_email_trx_receipt_default'] =
+        'contact_email_trx_receipt_default'
+      @_hash['default_ach'] = 'default_ach'
+      @_hash['default_cc'] = 'default_cc'
+      @_hash['email_reply_to'] = 'email_reply_to'
+      @_hash['fax'] = 'fax'
+      @_hash['location_api_id'] = 'location_api_id'
+      @_hash['location_api_key'] = 'location_api_key'
+      @_hash['location_c1'] = 'location_c1'
+      @_hash['location_c2'] = 'location_c2'
+      @_hash['location_c3'] = 'location_c3'
+      @_hash['name'] = 'name'
+      @_hash['office_phone'] = 'office_phone'
+      @_hash['office_ext_phone'] = 'office_ext_phone'
+      @_hash['tz'] = 'tz'
+      @_hash['parent_id'] = 'parent_id'
+      @_hash['show_contact_notes'] = 'show_contact_notes'
+      @_hash['show_contact_files'] = 'show_contact_files'
+      @_hash['created_user_id'] = 'created_user_id'
+      @_hash['location_type'] = 'location_type'
+      @_hash['parent_name'] = 'parent_name'
+      @_hash['ticket_hash_key'] = 'ticket_hash_key'
+      @_hash['additional_access'] = 'additional_access'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created_ts
+        modified_ts
+        account_number
+        address
+        branding_domain_id
+        contact_email_trx_receipt_default
+        default_ach
+        default_cc
+        email_reply_to
+        fax
+        location_api_id
+        location_api_key
+        location_c1
+        location_c2
+        location_c3
+        name
+        office_phone
+        office_ext_phone
+        tz
+        parent_id
+        show_contact_notes
+        show_contact_files
+        created_user_id
+        location_type
+        parent_name
+        ticket_hash_key
+        additional_access
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_number
+        branding_domain_id
+        default_ach
+        default_cc
+        email_reply_to
+        fax
+        location_api_id
+        location_api_key
+        location_c1
+        location_c2
+        location_c3
+        office_phone
+        office_ext_phone
+        tz
+        created_user_id
+        location_type
+        parent_name
+        ticket_hash_key
+      ]
+    end
+
+    def initialize(id = SKIP, created_ts = SKIP, modified_ts = SKIP,
+                   account_number = SKIP, address = SKIP,
+                   branding_domain_id = SKIP,
+                   contact_email_trx_receipt_default = SKIP, default_ach = SKIP,
+                   default_cc = SKIP, email_reply_to = SKIP, fax = SKIP,
+                   location_api_id = SKIP, location_api_key = SKIP,
+                   location_c1 = SKIP, location_c2 = SKIP, location_c3 = SKIP,
+                   name = SKIP, office_phone = SKIP, office_ext_phone = SKIP,
+                   tz = SKIP, parent_id = SKIP, show_contact_notes = SKIP,
+                   show_contact_files = SKIP, created_user_id = SKIP,
+                   location_type = SKIP, parent_name = SKIP,
+                   ticket_hash_key = SKIP, additional_access = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @id = id unless id == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @modified_ts = modified_ts unless modified_ts == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @address = address unless address == SKIP
+      @branding_domain_id = branding_domain_id unless branding_domain_id == SKIP
+      unless contact_email_trx_receipt_default == SKIP
+        @contact_email_trx_receipt_default =
+          contact_email_trx_receipt_default
+      end
+      @default_ach = default_ach unless default_ach == SKIP
+      @default_cc = default_cc unless default_cc == SKIP
+      @email_reply_to = email_reply_to unless email_reply_to == SKIP
+      @fax = fax unless fax == SKIP
+      @location_api_id = location_api_id unless location_api_id == SKIP
+      @location_api_key = location_api_key unless location_api_key == SKIP
+      @location_c1 = location_c1 unless location_c1 == SKIP
+      @location_c2 = location_c2 unless location_c2 == SKIP
+      @location_c3 = location_c3 unless location_c3 == SKIP
+      @name = name unless name == SKIP
+      @office_phone = office_phone unless office_phone == SKIP
+      @office_ext_phone = office_ext_phone unless office_ext_phone == SKIP
+      @tz = tz unless tz == SKIP
+      @parent_id = parent_id unless parent_id == SKIP
+      @show_contact_notes = show_contact_notes unless show_contact_notes == SKIP
+      @show_contact_files = show_contact_files unless show_contact_files == SKIP
+      @created_user_id = created_user_id unless created_user_id == SKIP
+      @location_type = location_type unless location_type == SKIP
+      @parent_name = parent_name unless parent_name == SKIP
+      @ticket_hash_key = ticket_hash_key unless ticket_hash_key == SKIP
+      @additional_access = additional_access unless additional_access == 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.
+      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
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      address = Address1.from_hash(hash['address']) if hash['address']
+      branding_domain_id =
+        hash.key?('branding_domain_id') ? hash['branding_domain_id'] : SKIP
+      contact_email_trx_receipt_default =
+        hash.key?('contact_email_trx_receipt_default') ? hash['contact_email_trx_receipt_default'] : SKIP
+      default_ach = hash.key?('default_ach') ? hash['default_ach'] : SKIP
+      default_cc = hash.key?('default_cc') ? hash['default_cc'] : SKIP
+      email_reply_to =
+        hash.key?('email_reply_to') ? hash['email_reply_to'] : SKIP
+      fax = hash.key?('fax') ? hash['fax'] : SKIP
+      location_api_id =
+        hash.key?('location_api_id') ? hash['location_api_id'] : SKIP
+      location_api_key =
+        hash.key?('location_api_key') ? hash['location_api_key'] : SKIP
+      location_c1 = hash.key?('location_c1') ? hash['location_c1'] : SKIP
+      location_c2 = hash.key?('location_c2') ? hash['location_c2'] : SKIP
+      location_c3 = hash.key?('location_c3') ? hash['location_c3'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      office_phone = hash.key?('office_phone') ? hash['office_phone'] : SKIP
+      office_ext_phone =
+        hash.key?('office_ext_phone') ? hash['office_ext_phone'] : SKIP
+      tz = hash.key?('tz') ? hash['tz'] : SKIP
+      parent_id = hash.key?('parent_id') ? hash['parent_id'] : SKIP
+      show_contact_notes =
+        hash.key?('show_contact_notes') ? hash['show_contact_notes'] : SKIP
+      show_contact_files =
+        hash.key?('show_contact_files') ? hash['show_contact_files'] : SKIP
+      created_user_id =
+        hash.key?('created_user_id') ? hash['created_user_id'] : SKIP
+      location_type = hash.key?('location_type') ? hash['location_type'] : SKIP
+      parent_name = hash.key?('parent_name') ? hash['parent_name'] : SKIP
+      ticket_hash_key =
+        hash.key?('ticket_hash_key') ? hash['ticket_hash_key'] : SKIP
+      additional_access = AdditionalAccess.from_hash(hash['additional_access']) if
+        hash['additional_access']
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Parent3.new(id,
+                  created_ts,
+                  modified_ts,
+                  account_number,
+                  address,
+                  branding_domain_id,
+                  contact_email_trx_receipt_default,
+                  default_ach,
+                  default_cc,
+                  email_reply_to,
+                  fax,
+                  location_api_id,
+                  location_api_key,
+                  location_c1,
+                  location_c2,
+                  location_c3,
+                  name,
+                  office_phone,
+                  office_ext_phone,
+                  tz,
+                  parent_id,
+                  show_contact_notes,
+                  show_contact_files,
+                  created_user_id,
+                  location_type,
+                  parent_name,
+                  ticket_hash_key,
+                  additional_access,
+                  additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created_ts: #{@created_ts}, modified_ts: #{@modified_ts},"\
+      " account_number: #{@account_number}, address: #{@address}, branding_domain_id:"\
+      " #{@branding_domain_id}, contact_email_trx_receipt_default:"\
+      " #{@contact_email_trx_receipt_default}, default_ach: #{@default_ach}, default_cc:"\
+      " #{@default_cc}, email_reply_to: #{@email_reply_to}, fax: #{@fax}, location_api_id:"\
+      " #{@location_api_id}, location_api_key: #{@location_api_key}, location_c1: #{@location_c1},"\
+      " location_c2: #{@location_c2}, location_c3: #{@location_c3}, name: #{@name}, office_phone:"\
+      " #{@office_phone}, office_ext_phone: #{@office_ext_phone}, tz: #{@tz}, parent_id:"\
+      " #{@parent_id}, show_contact_notes: #{@show_contact_notes}, show_contact_files:"\
+      " #{@show_contact_files}, created_user_id: #{@created_user_id}, location_type:"\
+      " #{@location_type}, parent_name: #{@parent_name}, ticket_hash_key: #{@ticket_hash_key},"\
+      " additional_access: #{@additional_access}, 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} id: #{@id.inspect}, created_ts: #{@created_ts.inspect}, modified_ts:"\
+      " #{@modified_ts.inspect}, account_number: #{@account_number.inspect}, address:"\
+      " #{@address.inspect}, branding_domain_id: #{@branding_domain_id.inspect},"\
+      " contact_email_trx_receipt_default: #{@contact_email_trx_receipt_default.inspect},"\
+      " default_ach: #{@default_ach.inspect}, default_cc: #{@default_cc.inspect}, email_reply_to:"\
+      " #{@email_reply_to.inspect}, fax: #{@fax.inspect}, location_api_id:"\
+      " #{@location_api_id.inspect}, location_api_key: #{@location_api_key.inspect}, location_c1:"\
+      " #{@location_c1.inspect}, location_c2: #{@location_c2.inspect}, location_c3:"\
+      " #{@location_c3.inspect}, name: #{@name.inspect}, office_phone: #{@office_phone.inspect},"\
+      " office_ext_phone: #{@office_ext_phone.inspect}, tz: #{@tz.inspect}, parent_id:"\
+      " #{@parent_id.inspect}, show_contact_notes: #{@show_contact_notes.inspect},"\
+      " show_contact_files: #{@show_contact_files.inspect}, created_user_id:"\
+      " #{@created_user_id.inspect}, location_type: #{@location_type.inspect}, parent_name:"\
+      " #{@parent_name.inspect}, ticket_hash_key: #{@ticket_hash_key.inspect}, additional_access:"\
+      " #{@additional_access.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/partner_enum.rb

@@ -0,0 +1,68 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Partner
+  class PartnerEnum
+    PARTNER_ENUM = [
+      # TODO: Write general description for STANDALONE
+      STANDALONE = 'standalone'.freeze,
+
+      # TODO: Write general description for VERTICLE
+      VERTICLE = 'verticle'.freeze,
+
+      # TODO: Write general description for VERICLE
+      VERICLE = 'Vericle'.freeze,
+
+      # TODO: Write general description for AIRVOICE
+      AIRVOICE = 'AirVoice'.freeze,
+
+      # TODO: Write general description for DRCHRONO
+      DRCHRONO = 'drchrono'.freeze,
+
+      # TODO: Write general description for SCHOOLLEADER
+      SCHOOLLEADER = 'schoolleader'.freeze,
+
+      # TODO: Write general description for FRONTIER
+      FRONTIER = 'Frontier'.freeze,
+
+      # TODO: Write general description for CHIROTOUCH
+      CHIROTOUCH = 'ChiroTouch'.freeze,
+
+      # TODO: Write general description for PLATINUM
+      PLATINUM = 'Platinum'.freeze,
+
+      # TODO: Write general description for CENTRALPROCESSINGSERVICE
+      CENTRALPROCESSINGSERVICE = 'CentralProcessingService'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PARTNER_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = STANDALONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'standalone' then STANDALONE
+      when 'verticle' then VERTICLE
+      when 'vericle' then VERICLE
+      when 'airvoice' then AIRVOICE
+      when 'drchrono' then DRCHRONO
+      when 'schoolleader' then SCHOOLLEADER
+      when 'frontier' then FRONTIER
+      when 'chirotouch' then CHIROTOUCH
+      when 'platinum' then PLATINUM
+      when 'centralprocessingservice' then CENTRALPROCESSINGSERVICE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/paylink_action_enum.rb

@@ -0,0 +1,37 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # the action that will be used by the form when making the payment possible
+  # values: sale, auth-only
+  class PaylinkActionEnum
+    PAYLINK_ACTION_ENUM = [
+      # TODO: Write general description for SALE
+      SALE = 'sale'.freeze,
+
+      # TODO: Write general description for AUTHONLY
+      AUTHONLY = 'auth-only'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYLINK_ACTION_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SALE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sale' then SALE
+      when 'authonly' then AUTHONLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/payment_acc_ind_enum.rb

@@ -0,0 +1,51 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Indicates the length of time that the payment account was enrolled in the
+  # cardholder's account with the 3DS Requestor. >01 - No account (guest
+  # check-out) > >02 - During this transaction > >03 - Less than 30 days > >04 -
+  # 30 - 60 days > >05 - More than 60 days >
+  class PaymentAccIndEnum
+    PAYMENT_ACC_IND_ENUM = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze,
+
+      # TODO: Write general description for ENUM_03
+      ENUM_03 = '03'.freeze,
+
+      # TODO: Write general description for ENUM_04
+      ENUM_04 = '04'.freeze,
+
+      # TODO: Write general description for ENUM_05
+      ENUM_05 = '05'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_ACC_IND_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_01)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_01' then ENUM_01
+      when 'enum_02' then ENUM_02
+      when 'enum_03' then ENUM_03
+      when 'enum_04' then ENUM_04
+      when 'enum_05' then ENUM_05
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/payment_method16_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Must be provided as either 'cc' or 'ach'.
+  class PaymentMethod16Enum
+    PAYMENT_METHOD16_ENUM = [
+      # TODO: Write general description for CC
+      CC = 'cc'.freeze,
+
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHOD16_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cc' then CC
+      when 'ach' then ACH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/payment_method1_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Payment Method
+  class PaymentMethod1Enum
+    PAYMENT_METHOD1_ENUM = [
+      # TODO: Write general description for CC
+      CC = 'cc'.freeze,
+
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHOD1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cc' then CC
+      when 'ach' then ACH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/payment_method9_enum.rb

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

data/lib/fortis_api/models/payment_method_enum.rb

@@ -0,0 +1,40 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Payment method
+  class PaymentMethodEnum
+    PAYMENT_METHOD_ENUM = [
+      # TODO: Write general description for CC
+      CC = 'cc'.freeze,
+
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cc' then CC
+      when 'ach' then ACH
+      when 'cash' then CASH
+      else
+        default_value
+      end
+    end
+  end
+end