fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/data11.rb

@@ -0,0 +1,491 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Data11 Model.
+  class Data11 < 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
+
+    # Branding domain URL
+    # @return [String]
+    attr_accessor :branding_domain_url
+
+    # Branding domain array
+    # @return [BrandingDomain]
+    attr_accessor :branding_domain
+
+    # Product Transactions array
+    # @return [Array[ProductTransaction1]]
+    attr_accessor :product_transactions
+
+    # Product file array
+    # @return [ProductFile]
+    attr_accessor :product_file
+
+    # Product Token array (legacy)
+    # @return [ProductAccountvault]
+    attr_accessor :product_accountvault
+
+    # Product Token array
+    # @return [ProductToken]
+    attr_accessor :product_token
+
+    # Product recurring array
+    # @return [ProductRecurring]
+    attr_accessor :product_recurring
+
+    # Tags array
+    # @return [Array[Tag]]
+    attr_accessor :tags
+
+    # Terminals array
+    # @return [Array[Terminal2]]
+    attr_accessor :terminals
+
+    # Terminals array
+    # @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['branding_domain_url'] = 'branding_domain_url'
+      @_hash['branding_domain'] = 'branding_domain'
+      @_hash['product_transactions'] = 'product_transactions'
+      @_hash['product_file'] = 'product_file'
+      @_hash['product_accountvault'] = 'product_accountvault'
+      @_hash['product_token'] = 'product_token'
+      @_hash['product_recurring'] = 'product_recurring'
+      @_hash['tags'] = 'tags'
+      @_hash['terminals'] = 'terminals'
+      @_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
+        branding_domain_url
+        branding_domain
+        product_transactions
+        product_file
+        product_accountvault
+        product_token
+        product_recurring
+        tags
+        terminals
+        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
+        parent_id
+        created_user_id
+        location_type
+        branding_domain_url
+      ]
+    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, branding_domain_url = SKIP,
+                   branding_domain = SKIP, product_transactions = SKIP,
+                   product_file = SKIP, product_accountvault = SKIP,
+                   product_token = SKIP, product_recurring = SKIP, tags = SKIP,
+                   terminals = 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
+      @branding_domain_url = branding_domain_url unless branding_domain_url == SKIP
+      @branding_domain = branding_domain unless branding_domain == SKIP
+      @product_transactions = product_transactions unless product_transactions == SKIP
+      @product_file = product_file unless product_file == SKIP
+      @product_accountvault = product_accountvault unless product_accountvault == SKIP
+      @product_token = product_token unless product_token == SKIP
+      @product_recurring = product_recurring unless product_recurring == SKIP
+      @tags = tags unless tags == SKIP
+      @terminals = terminals unless terminals == 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
+      branding_domain_url =
+        hash.key?('branding_domain_url') ? hash['branding_domain_url'] : SKIP
+      branding_domain = BrandingDomain.from_hash(hash['branding_domain']) if
+        hash['branding_domain']
+      # Parameter is an array, so we need to iterate through it
+      product_transactions = nil
+      unless hash['product_transactions'].nil?
+        product_transactions = []
+        hash['product_transactions'].each do |structure|
+          product_transactions << (ProductTransaction1.from_hash(structure) if structure)
+        end
+      end
+
+      product_transactions = SKIP unless hash.key?('product_transactions')
+      product_file = ProductFile.from_hash(hash['product_file']) if hash['product_file']
+      product_accountvault = ProductAccountvault.from_hash(hash['product_accountvault']) if
+        hash['product_accountvault']
+      product_token = ProductToken.from_hash(hash['product_token']) if hash['product_token']
+      product_recurring = ProductRecurring.from_hash(hash['product_recurring']) if
+        hash['product_recurring']
+      # Parameter is an array, so we need to iterate through it
+      tags = nil
+      unless hash['tags'].nil?
+        tags = []
+        hash['tags'].each do |structure|
+          tags << (Tag.from_hash(structure) if structure)
+        end
+      end
+
+      tags = SKIP unless hash.key?('tags')
+      # Parameter is an array, so we need to iterate through it
+      terminals = nil
+      unless hash['terminals'].nil?
+        terminals = []
+        hash['terminals'].each do |structure|
+          terminals << (Terminal2.from_hash(structure) if structure)
+        end
+      end
+
+      terminals = SKIP unless hash.key?('terminals')
+      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.
+      Data11.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,
+                 branding_domain_url,
+                 branding_domain,
+                 product_transactions,
+                 product_file,
+                 product_accountvault,
+                 product_token,
+                 product_recurring,
+                 tags,
+                 terminals,
+                 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}, branding_domain_url: #{@branding_domain_url}, branding_domain:"\
+      " #{@branding_domain}, product_transactions: #{@product_transactions}, product_file:"\
+      " #{@product_file}, product_accountvault: #{@product_accountvault}, product_token:"\
+      " #{@product_token}, product_recurring: #{@product_recurring}, tags: #{@tags}, terminals:"\
+      " #{@terminals}, 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},"\
+      " branding_domain_url: #{@branding_domain_url.inspect}, branding_domain:"\
+      " #{@branding_domain.inspect}, product_transactions: #{@product_transactions.inspect},"\
+      " product_file: #{@product_file.inspect}, product_accountvault:"\
+      " #{@product_accountvault.inspect}, product_token: #{@product_token.inspect},"\
+      " product_recurring: #{@product_recurring.inspect}, tags: #{@tags.inspect}, terminals:"\
+      " #{@terminals.inspect}, additional_access: #{@additional_access.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end