fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/contact.rb

@@ -0,0 +1,106 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # The Contact.
+  class Contact < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contact's first name.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Contact's last name.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Contact's email address.
+    # @return [String]
+    attr_accessor :email
+
+    # Contact's phone.
+    # @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['email'] = 'email'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        email
+        phone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        first_name
+        last_name
+        email
+      ]
+    end
+
+    def initialize(first_name = SKIP, last_name = SKIP, email = 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 unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @email = email unless email == 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'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : 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.
+      Contact.new(first_name,
+                  last_name,
+                  email,
+                  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}, email: #{@email},"\
+      " 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},"\
+      " email: #{@email.inspect}, phone_number: #{@phone_number.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/contact1.rb

@@ -0,0 +1,421 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Contact Information on `expand`
+  class Contact1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location ID
+    # @return [String]
+    attr_accessor :location_id
+
+    # Contact Account Number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Contact API Id
+    # @return [String]
+    attr_accessor :contact_api_id
+
+    # First Name
+    # @return [String]
+    attr_accessor :first_name
+
+    # Last Name
+    # @return [String]
+    attr_accessor :last_name
+
+    # Cell phone of contact
+    # @return [String]
+    attr_accessor :cell_phone
+
+    # Balance
+    # @return [Float]
+    attr_accessor :balance
+
+    # Address of contact
+    # @return [Address]
+    attr_accessor :address
+
+    # Company Name
+    # @return [String]
+    attr_accessor :company_name
+
+    # Header Message
+    # @return [String]
+    attr_accessor :header_message
+
+    # Contacts DOB, Format: yyyy-MM-dd
+    # @return [String]
+    attr_accessor :date_of_birth
+
+    # Whether or not to email all transactions receipts to contact (1 or 0)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :email_trx_receipt
+
+    # Contacts home phone
+    # @return [String]
+    attr_accessor :home_phone
+
+    # Contacts office phone
+    # @return [String]
+    attr_accessor :office_phone
+
+    # Contacts office phone extension for office phone
+    # @return [String]
+    attr_accessor :office_phone_ext
+
+    # Home phone country code
+    # @return [String]
+    attr_accessor :home_phone_country_code
+
+    # Office phone country code
+    # @return [String]
+    attr_accessor :office_phone_country_code
+
+    # Cell phone country code
+    # @return [String]
+    attr_accessor :cell_phone_country_code
+
+    # Header Message Type
+    # @return [Integer]
+    attr_accessor :header_message_type
+
+    # Update If Exists
+    # @return [UpdateIfExistsEnum]
+    attr_accessor :update_if_exists
+
+    # Custom field 1 for api users to store custom data
+    # @return [String]
+    attr_accessor :contact_c1
+
+    # Custom field 2 for api users to store custom data
+    # @return [String]
+    attr_accessor :contact_c2
+
+    # Custom field 3 for api users to store custom data
+    # @return [String]
+    attr_accessor :contact_c3
+
+    # Parent Id
+    # @return [String]
+    attr_accessor :parent_id
+
+    # Email of contact
+    # @return [String]
+    attr_accessor :email
+
+    # Token Import Id
+    # @return [String]
+    attr_accessor :token_import_id
+
+    # Contact 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['location_id'] = 'location_id'
+      @_hash['account_number'] = 'account_number'
+      @_hash['contact_api_id'] = 'contact_api_id'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['cell_phone'] = 'cell_phone'
+      @_hash['balance'] = 'balance'
+      @_hash['address'] = 'address'
+      @_hash['company_name'] = 'company_name'
+      @_hash['header_message'] = 'header_message'
+      @_hash['date_of_birth'] = 'date_of_birth'
+      @_hash['email_trx_receipt'] = 'email_trx_receipt'
+      @_hash['home_phone'] = 'home_phone'
+      @_hash['office_phone'] = 'office_phone'
+      @_hash['office_phone_ext'] = 'office_phone_ext'
+      @_hash['home_phone_country_code'] = 'home_phone_country_code'
+      @_hash['office_phone_country_code'] = 'office_phone_country_code'
+      @_hash['cell_phone_country_code'] = 'cell_phone_country_code'
+      @_hash['header_message_type'] = 'header_message_type'
+      @_hash['update_if_exists'] = 'update_if_exists'
+      @_hash['contact_c1'] = 'contact_c1'
+      @_hash['contact_c2'] = 'contact_c2'
+      @_hash['contact_c3'] = 'contact_c3'
+      @_hash['parent_id'] = 'parent_id'
+      @_hash['email'] = 'email'
+      @_hash['token_import_id'] = 'token_import_id'
+      @_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[
+        location_id
+        account_number
+        contact_api_id
+        first_name
+        last_name
+        cell_phone
+        balance
+        address
+        company_name
+        header_message
+        date_of_birth
+        email_trx_receipt
+        home_phone
+        office_phone
+        office_phone_ext
+        home_phone_country_code
+        office_phone_country_code
+        cell_phone_country_code
+        header_message_type
+        update_if_exists
+        contact_c1
+        contact_c2
+        contact_c3
+        parent_id
+        email
+        token_import_id
+        id
+        created_ts
+        modified_ts
+        active
+        created_user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_number
+        contact_api_id
+        first_name
+        cell_phone
+        balance
+        company_name
+        header_message
+        date_of_birth
+        home_phone
+        office_phone
+        office_phone_ext
+        home_phone_country_code
+        office_phone_country_code
+        cell_phone_country_code
+        update_if_exists
+        contact_c1
+        contact_c2
+        contact_c3
+        parent_id
+        email
+        token_import_id
+        created_user_id
+      ]
+    end
+
+    def initialize(location_id = SKIP, account_number = SKIP,
+                   contact_api_id = SKIP, first_name = SKIP, last_name = SKIP,
+                   cell_phone = SKIP, balance = SKIP, address = SKIP,
+                   company_name = SKIP, header_message = SKIP,
+                   date_of_birth = SKIP, email_trx_receipt = SKIP,
+                   home_phone = SKIP, office_phone = SKIP,
+                   office_phone_ext = SKIP, home_phone_country_code = SKIP,
+                   office_phone_country_code = SKIP,
+                   cell_phone_country_code = SKIP, header_message_type = SKIP,
+                   update_if_exists = SKIP, contact_c1 = SKIP,
+                   contact_c2 = SKIP, contact_c3 = SKIP, parent_id = SKIP,
+                   email = SKIP, token_import_id = 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
+
+      @location_id = location_id unless location_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @contact_api_id = contact_api_id unless contact_api_id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @cell_phone = cell_phone unless cell_phone == SKIP
+      @balance = balance unless balance == SKIP
+      @address = address unless address == SKIP
+      @company_name = company_name unless company_name == SKIP
+      @header_message = header_message unless header_message == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @email_trx_receipt = email_trx_receipt unless email_trx_receipt == SKIP
+      @home_phone = home_phone unless home_phone == SKIP
+      @office_phone = office_phone unless office_phone == SKIP
+      @office_phone_ext = office_phone_ext unless office_phone_ext == SKIP
+      @home_phone_country_code = home_phone_country_code unless home_phone_country_code == SKIP
+      unless office_phone_country_code == SKIP
+        @office_phone_country_code =
+          office_phone_country_code
+      end
+      @cell_phone_country_code = cell_phone_country_code unless cell_phone_country_code == SKIP
+      @header_message_type = header_message_type unless header_message_type == SKIP
+      @update_if_exists = update_if_exists unless update_if_exists == SKIP
+      @contact_c1 = contact_c1 unless contact_c1 == SKIP
+      @contact_c2 = contact_c2 unless contact_c2 == SKIP
+      @contact_c3 = contact_c3 unless contact_c3 == SKIP
+      @parent_id = parent_id unless parent_id == SKIP
+      @email = email unless email == SKIP
+      @token_import_id = token_import_id unless token_import_id == 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.
+      location_id = hash.key?('location_id') ? hash['location_id'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      contact_api_id =
+        hash.key?('contact_api_id') ? hash['contact_api_id'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      cell_phone = hash.key?('cell_phone') ? hash['cell_phone'] : SKIP
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      address = Address.from_hash(hash['address']) if hash['address']
+      company_name = hash.key?('company_name') ? hash['company_name'] : SKIP
+      header_message =
+        hash.key?('header_message') ? hash['header_message'] : SKIP
+      date_of_birth = hash.key?('date_of_birth') ? hash['date_of_birth'] : SKIP
+      email_trx_receipt =
+        hash.key?('email_trx_receipt') ? hash['email_trx_receipt'] : SKIP
+      home_phone = hash.key?('home_phone') ? hash['home_phone'] : SKIP
+      office_phone = hash.key?('office_phone') ? hash['office_phone'] : SKIP
+      office_phone_ext =
+        hash.key?('office_phone_ext') ? hash['office_phone_ext'] : SKIP
+      home_phone_country_code =
+        hash.key?('home_phone_country_code') ? hash['home_phone_country_code'] : SKIP
+      office_phone_country_code =
+        hash.key?('office_phone_country_code') ? hash['office_phone_country_code'] : SKIP
+      cell_phone_country_code =
+        hash.key?('cell_phone_country_code') ? hash['cell_phone_country_code'] : SKIP
+      header_message_type =
+        hash.key?('header_message_type') ? hash['header_message_type'] : SKIP
+      update_if_exists =
+        hash.key?('update_if_exists') ? hash['update_if_exists'] : SKIP
+      contact_c1 = hash.key?('contact_c1') ? hash['contact_c1'] : SKIP
+      contact_c2 = hash.key?('contact_c2') ? hash['contact_c2'] : SKIP
+      contact_c3 = hash.key?('contact_c3') ? hash['contact_c3'] : SKIP
+      parent_id = hash.key?('parent_id') ? hash['parent_id'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      token_import_id =
+        hash.key?('token_import_id') ? hash['token_import_id'] : 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.
+      Contact1.new(location_id,
+                   account_number,
+                   contact_api_id,
+                   first_name,
+                   last_name,
+                   cell_phone,
+                   balance,
+                   address,
+                   company_name,
+                   header_message,
+                   date_of_birth,
+                   email_trx_receipt,
+                   home_phone,
+                   office_phone,
+                   office_phone_ext,
+                   home_phone_country_code,
+                   office_phone_country_code,
+                   cell_phone_country_code,
+                   header_message_type,
+                   update_if_exists,
+                   contact_c1,
+                   contact_c2,
+                   contact_c3,
+                   parent_id,
+                   email,
+                   token_import_id,
+                   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} location_id: #{@location_id}, account_number: #{@account_number},"\
+      " contact_api_id: #{@contact_api_id}, first_name: #{@first_name}, last_name: #{@last_name},"\
+      " cell_phone: #{@cell_phone}, balance: #{@balance}, address: #{@address}, company_name:"\
+      " #{@company_name}, header_message: #{@header_message}, date_of_birth: #{@date_of_birth},"\
+      " email_trx_receipt: #{@email_trx_receipt}, home_phone: #{@home_phone}, office_phone:"\
+      " #{@office_phone}, office_phone_ext: #{@office_phone_ext}, home_phone_country_code:"\
+      " #{@home_phone_country_code}, office_phone_country_code: #{@office_phone_country_code},"\
+      " cell_phone_country_code: #{@cell_phone_country_code}, header_message_type:"\
+      " #{@header_message_type}, update_if_exists: #{@update_if_exists}, contact_c1:"\
+      " #{@contact_c1}, contact_c2: #{@contact_c2}, contact_c3: #{@contact_c3}, parent_id:"\
+      " #{@parent_id}, email: #{@email}, token_import_id: #{@token_import_id}, 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} location_id: #{@location_id.inspect}, account_number:"\
+      " #{@account_number.inspect}, contact_api_id: #{@contact_api_id.inspect}, first_name:"\
+      " #{@first_name.inspect}, last_name: #{@last_name.inspect}, cell_phone:"\
+      " #{@cell_phone.inspect}, balance: #{@balance.inspect}, address: #{@address.inspect},"\
+      " company_name: #{@company_name.inspect}, header_message: #{@header_message.inspect},"\
+      " date_of_birth: #{@date_of_birth.inspect}, email_trx_receipt:"\
+      " #{@email_trx_receipt.inspect}, home_phone: #{@home_phone.inspect}, office_phone:"\
+      " #{@office_phone.inspect}, office_phone_ext: #{@office_phone_ext.inspect},"\
+      " home_phone_country_code: #{@home_phone_country_code.inspect}, office_phone_country_code:"\
+      " #{@office_phone_country_code.inspect}, cell_phone_country_code:"\
+      " #{@cell_phone_country_code.inspect}, header_message_type: #{@header_message_type.inspect},"\
+      " update_if_exists: #{@update_if_exists.inspect}, contact_c1: #{@contact_c1.inspect},"\
+      " contact_c2: #{@contact_c2.inspect}, contact_c3: #{@contact_c3.inspect}, parent_id:"\
+      " #{@parent_id.inspect}, email: #{@email.inspect}, token_import_id:"\
+      " #{@token_import_id.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

data/lib/fortis_api/models/contact11.rb

@@ -0,0 +1,105 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # The Contact.
+  class Contact11 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contact's first name.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Contact's last name.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Contact's email address.
+    # @return [String]
+    attr_accessor :email
+
+    # Contact's phone.
+    # @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['email'] = 'email'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        first_name
+        last_name
+        email
+      ]
+    end
+
+    def initialize(phone_number = nil, first_name = SKIP, last_name = SKIP,
+                   email = 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 unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @email = email unless email == SKIP
+      @phone_number = phone_number
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : nil
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Contact11.new(phone_number,
+                    first_name,
+                    last_name,
+                    email,
+                    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}, email: #{@email},"\
+      " 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},"\
+      " email: #{@email.inspect}, phone_number: #{@phone_number.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/contact_user_default_entry_page_enum.rb

@@ -0,0 +1,52 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Contact User Default Entry Page
+  class ContactUserDefaultEntryPageEnum
+    CONTACT_USER_DEFAULT_ENTRY_PAGE_ENUM = [
+      # TODO: Write general description for DASHBOARD
+      DASHBOARD = 'dashboard'.freeze,
+
+      # TODO: Write general description for MAKEPAYMENT
+      MAKEPAYMENT = 'makepayment'.freeze,
+
+      # TODO: Write general description for PAYMENTHISTORY
+      PAYMENTHISTORY = 'paymenthistory'.freeze,
+
+      # TODO: Write general description for ACCOUNTS
+      ACCOUNTS = 'accounts'.freeze,
+
+      # TODO: Write general description for RECURRINGS
+      RECURRINGS = 'recurrings'.freeze,
+
+      # TODO: Write general description for INVOICES
+      INVOICES = 'invoices'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONTACT_USER_DEFAULT_ENTRY_PAGE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DASHBOARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'dashboard' then DASHBOARD
+      when 'makepayment' then MAKEPAYMENT
+      when 'paymenthistory' then PAYMENTHISTORY
+      when 'accounts' then ACCOUNTS
+      when 'recurrings' then RECURRINGS
+      when 'invoices' then INVOICES
+      else
+        default_value
+      end
+    end
+  end
+end