fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/primary_location.rb

@@ -0,0 +1,387 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Primary Location Information on `expand`
+  class PrimaryLocation < 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.
+      PrimaryLocation.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/primary_principal.rb

@@ -0,0 +1,211 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # The Primary Principal.
+  class PrimaryPrincipal < 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[
+        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
+      ]
+    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 = SKIP, last_name = SKIP, 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 unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @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'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      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.
+      PrimaryPrincipal.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