fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/body.rb

@@ -0,0 +1,91 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Body
+  class Body < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Settings]
+    attr_accessor :settings
+
+    # TODO: Write general description for this method
+    # @return [Array[Field18]]
+    attr_accessor :fields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['settings'] = 'settings'
+      @_hash['fields'] = 'fields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        settings
+        fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(settings = SKIP, fields = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @settings = settings unless settings == SKIP
+      @fields = fields unless fields == 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.
+      settings = Settings.from_hash(hash['settings']) if hash['settings']
+      # Parameter is an array, so we need to iterate through it
+      fields = nil
+      unless hash['fields'].nil?
+        fields = []
+        hash['fields'].each do |structure|
+          fields << (Field18.from_hash(structure) if structure)
+        end
+      end
+
+      fields = SKIP unless hash.key?('fields')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Body.new(settings,
+               fields,
+               additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} settings: #{@settings}, fields: #{@fields}, 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} settings: #{@settings.inspect}, fields: #{@fields.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/branding_domain.rb

@@ -0,0 +1,474 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Branding domain array
+  class BrandingDomain < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL
+    # @return [String]
+    attr_accessor :url
+
+    # Domain Name
+    # @return [String]
+    attr_accessor :title
+
+    # Logo
+    # @return [String]
+    attr_accessor :logo
+
+    # Support Email
+    # @return [String]
+    attr_accessor :support_email
+
+    # Allow Contact Signup.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_contact_signup
+
+    # Allow Contact Registration.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_contact_registration
+
+    # Allow Contact Login.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_contact_login
+
+    # Registration Fields
+    # @return [Array[RegistrationFieldEnum]]
+    attr_accessor :registration_fields
+
+    # Company Name.
+    # @return [String]
+    attr_accessor :company_name
+
+    # Nav Color.
+    # @return [String]
+    attr_accessor :nav_color
+
+    # Button Primary Color.
+    # @return [String]
+    attr_accessor :button_primary_color
+
+    # Logo Background Color.
+    # @return [String]
+    attr_accessor :logo_background_color
+
+    # Icon Background Color.
+    # @return [String]
+    attr_accessor :icon_background_color
+
+    # Menu Text Background Color
+    # @return [String]
+    attr_accessor :menu_text_background_color
+
+    # Menu Text Color.
+    # @return [String]
+    attr_accessor :menu_text_color
+
+    # Right Menu Background Color.
+    # @return [String]
+    attr_accessor :right_menu_background_color
+
+    # Right Menu Text Color.
+    # @return [String]
+    attr_accessor :right_menu_text_color
+
+    # Button Primary Text Color.
+    # @return [String]
+    attr_accessor :button_primary_text_color
+
+    # Nav Logo.
+    # @return [String]
+    attr_accessor :nav_logo
+
+    # Fav Icon.
+    # @return [String]
+    attr_accessor :fav_icon
+
+    # Aes Key.
+    # @return [String]
+    attr_accessor :aes_key
+
+    # Help Text.
+    # @return [String]
+    attr_accessor :help_text
+
+    # Email Reply To.
+    # @return [String]
+    attr_accessor :email_reply_to
+
+    # Email.
+    # @return [String]
+    attr_accessor :email
+
+    # Custom Javascript.
+    # @return [String]
+    attr_accessor :custom_javascript
+
+    # Custom Theme
+    # @return [String]
+    attr_accessor :custom_theme
+
+    # Custom CSS
+    # @return [String]
+    attr_accessor :custom_css
+
+    # Contact User Default Entry Page
+    # @return [ContactUserDefaultEntryPageEnum]
+    attr_accessor :contact_user_default_entry_page
+
+    # Contact User Default Auth Role
+    # @return [Array[Object]]
+    attr_accessor :contact_user_default_auth_roles
+
+    # Custom Stylesheet URL
+    # @return [String]
+    attr_accessor :custom_stylesheet_url
+
+    # Id
+    # @return [String]
+    attr_accessor :id
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # Modified Time Stamp
+    # @return [Integer]
+    attr_accessor :modified_ts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash['title'] = 'title'
+      @_hash['logo'] = 'logo'
+      @_hash['support_email'] = 'support_email'
+      @_hash['allow_contact_signup'] = 'allow_contact_signup'
+      @_hash['allow_contact_registration'] = 'allow_contact_registration'
+      @_hash['allow_contact_login'] = 'allow_contact_login'
+      @_hash['registration_fields'] = 'registration_fields'
+      @_hash['company_name'] = 'company_name'
+      @_hash['nav_color'] = 'nav_color'
+      @_hash['button_primary_color'] = 'button_primary_color'
+      @_hash['logo_background_color'] = 'logo_background_color'
+      @_hash['icon_background_color'] = 'icon_background_color'
+      @_hash['menu_text_background_color'] = 'menu_text_background_color'
+      @_hash['menu_text_color'] = 'menu_text_color'
+      @_hash['right_menu_background_color'] = 'right_menu_background_color'
+      @_hash['right_menu_text_color'] = 'right_menu_text_color'
+      @_hash['button_primary_text_color'] = 'button_primary_text_color'
+      @_hash['nav_logo'] = 'nav_logo'
+      @_hash['fav_icon'] = 'fav_icon'
+      @_hash['aes_key'] = 'aes_key'
+      @_hash['help_text'] = 'help_text'
+      @_hash['email_reply_to'] = 'email_reply_to'
+      @_hash['email'] = 'email'
+      @_hash['custom_javascript'] = 'custom_javascript'
+      @_hash['custom_theme'] = 'custom_theme'
+      @_hash['custom_css'] = 'custom_css'
+      @_hash['contact_user_default_entry_page'] =
+        'contact_user_default_entry_page'
+      @_hash['contact_user_default_auth_roles'] =
+        'contact_user_default_auth_roles'
+      @_hash['custom_stylesheet_url'] = 'custom_stylesheet_url'
+      @_hash['id'] = 'id'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['modified_ts'] = 'modified_ts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        url
+        title
+        logo
+        support_email
+        allow_contact_signup
+        allow_contact_registration
+        allow_contact_login
+        registration_fields
+        company_name
+        nav_color
+        button_primary_color
+        logo_background_color
+        icon_background_color
+        menu_text_background_color
+        menu_text_color
+        right_menu_background_color
+        right_menu_text_color
+        button_primary_text_color
+        nav_logo
+        fav_icon
+        aes_key
+        help_text
+        email_reply_to
+        email
+        custom_javascript
+        custom_theme
+        custom_css
+        contact_user_default_entry_page
+        contact_user_default_auth_roles
+        custom_stylesheet_url
+        id
+        created_ts
+        modified_ts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        logo
+        support_email
+        company_name
+        nav_color
+        button_primary_color
+        logo_background_color
+        icon_background_color
+        menu_text_background_color
+        menu_text_color
+        right_menu_background_color
+        right_menu_text_color
+        button_primary_text_color
+        nav_logo
+        fav_icon
+        aes_key
+        help_text
+        email_reply_to
+        email
+        custom_javascript
+        custom_theme
+        custom_css
+        contact_user_default_entry_page
+        custom_stylesheet_url
+      ]
+    end
+
+    def initialize(url = SKIP, title = SKIP, logo = SKIP, support_email = SKIP,
+                   allow_contact_signup = SKIP,
+                   allow_contact_registration = SKIP,
+                   allow_contact_login = SKIP, registration_fields = SKIP,
+                   company_name = SKIP, nav_color = SKIP,
+                   button_primary_color = SKIP, logo_background_color = SKIP,
+                   icon_background_color = SKIP,
+                   menu_text_background_color = SKIP, menu_text_color = SKIP,
+                   right_menu_background_color = SKIP,
+                   right_menu_text_color = SKIP,
+                   button_primary_text_color = SKIP, nav_logo = SKIP,
+                   fav_icon = SKIP, aes_key = SKIP, help_text = SKIP,
+                   email_reply_to = SKIP, email = SKIP,
+                   custom_javascript = SKIP, custom_theme = SKIP,
+                   custom_css = SKIP, contact_user_default_entry_page = SKIP,
+                   contact_user_default_auth_roles = SKIP,
+                   custom_stylesheet_url = SKIP, id = SKIP, created_ts = SKIP,
+                   modified_ts = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @url = url unless url == SKIP
+      @title = title unless title == SKIP
+      @logo = logo unless logo == SKIP
+      @support_email = support_email unless support_email == SKIP
+      @allow_contact_signup = allow_contact_signup unless allow_contact_signup == SKIP
+      unless allow_contact_registration == SKIP
+        @allow_contact_registration =
+          allow_contact_registration
+      end
+      @allow_contact_login = allow_contact_login unless allow_contact_login == SKIP
+      @registration_fields = registration_fields unless registration_fields == SKIP
+      @company_name = company_name unless company_name == SKIP
+      @nav_color = nav_color unless nav_color == SKIP
+      @button_primary_color = button_primary_color unless button_primary_color == SKIP
+      @logo_background_color = logo_background_color unless logo_background_color == SKIP
+      @icon_background_color = icon_background_color unless icon_background_color == SKIP
+      unless menu_text_background_color == SKIP
+        @menu_text_background_color =
+          menu_text_background_color
+      end
+      @menu_text_color = menu_text_color unless menu_text_color == SKIP
+      unless right_menu_background_color == SKIP
+        @right_menu_background_color =
+          right_menu_background_color
+      end
+      @right_menu_text_color = right_menu_text_color unless right_menu_text_color == SKIP
+      unless button_primary_text_color == SKIP
+        @button_primary_text_color =
+          button_primary_text_color
+      end
+      @nav_logo = nav_logo unless nav_logo == SKIP
+      @fav_icon = fav_icon unless fav_icon == SKIP
+      @aes_key = aes_key unless aes_key == SKIP
+      @help_text = help_text unless help_text == SKIP
+      @email_reply_to = email_reply_to unless email_reply_to == SKIP
+      @email = email unless email == SKIP
+      @custom_javascript = custom_javascript unless custom_javascript == SKIP
+      @custom_theme = custom_theme unless custom_theme == SKIP
+      @custom_css = custom_css unless custom_css == SKIP
+      unless contact_user_default_entry_page == SKIP
+        @contact_user_default_entry_page =
+          contact_user_default_entry_page
+      end
+      unless contact_user_default_auth_roles == SKIP
+        @contact_user_default_auth_roles =
+          contact_user_default_auth_roles
+      end
+      @custom_stylesheet_url = custom_stylesheet_url unless custom_stylesheet_url == SKIP
+      @id = id unless id == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @modified_ts = modified_ts unless modified_ts == 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.
+      url = hash.key?('url') ? hash['url'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      logo = hash.key?('logo') ? hash['logo'] : SKIP
+      support_email = hash.key?('support_email') ? hash['support_email'] : SKIP
+      allow_contact_signup =
+        hash.key?('allow_contact_signup') ? hash['allow_contact_signup'] : SKIP
+      allow_contact_registration =
+        hash.key?('allow_contact_registration') ? hash['allow_contact_registration'] : SKIP
+      allow_contact_login =
+        hash.key?('allow_contact_login') ? hash['allow_contact_login'] : SKIP
+      registration_fields =
+        hash.key?('registration_fields') ? hash['registration_fields'] : SKIP
+      company_name = hash.key?('company_name') ? hash['company_name'] : SKIP
+      nav_color = hash.key?('nav_color') ? hash['nav_color'] : SKIP
+      button_primary_color =
+        hash.key?('button_primary_color') ? hash['button_primary_color'] : SKIP
+      logo_background_color =
+        hash.key?('logo_background_color') ? hash['logo_background_color'] : SKIP
+      icon_background_color =
+        hash.key?('icon_background_color') ? hash['icon_background_color'] : SKIP
+      menu_text_background_color =
+        hash.key?('menu_text_background_color') ? hash['menu_text_background_color'] : SKIP
+      menu_text_color =
+        hash.key?('menu_text_color') ? hash['menu_text_color'] : SKIP
+      right_menu_background_color =
+        hash.key?('right_menu_background_color') ? hash['right_menu_background_color'] : SKIP
+      right_menu_text_color =
+        hash.key?('right_menu_text_color') ? hash['right_menu_text_color'] : SKIP
+      button_primary_text_color =
+        hash.key?('button_primary_text_color') ? hash['button_primary_text_color'] : SKIP
+      nav_logo = hash.key?('nav_logo') ? hash['nav_logo'] : SKIP
+      fav_icon = hash.key?('fav_icon') ? hash['fav_icon'] : SKIP
+      aes_key = hash.key?('aes_key') ? hash['aes_key'] : SKIP
+      help_text = hash.key?('help_text') ? hash['help_text'] : SKIP
+      email_reply_to =
+        hash.key?('email_reply_to') ? hash['email_reply_to'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      custom_javascript =
+        hash.key?('custom_javascript') ? hash['custom_javascript'] : SKIP
+      custom_theme = hash.key?('custom_theme') ? hash['custom_theme'] : SKIP
+      custom_css = hash.key?('custom_css') ? hash['custom_css'] : SKIP
+      contact_user_default_entry_page =
+        hash.key?('contact_user_default_entry_page') ? hash['contact_user_default_entry_page'] : SKIP
+      contact_user_default_auth_roles =
+        hash.key?('contact_user_default_auth_roles') ? hash['contact_user_default_auth_roles'] : SKIP
+      custom_stylesheet_url =
+        hash.key?('custom_stylesheet_url') ? hash['custom_stylesheet_url'] : 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
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      BrandingDomain.new(url,
+                         title,
+                         logo,
+                         support_email,
+                         allow_contact_signup,
+                         allow_contact_registration,
+                         allow_contact_login,
+                         registration_fields,
+                         company_name,
+                         nav_color,
+                         button_primary_color,
+                         logo_background_color,
+                         icon_background_color,
+                         menu_text_background_color,
+                         menu_text_color,
+                         right_menu_background_color,
+                         right_menu_text_color,
+                         button_primary_text_color,
+                         nav_logo,
+                         fav_icon,
+                         aes_key,
+                         help_text,
+                         email_reply_to,
+                         email,
+                         custom_javascript,
+                         custom_theme,
+                         custom_css,
+                         contact_user_default_entry_page,
+                         contact_user_default_auth_roles,
+                         custom_stylesheet_url,
+                         id,
+                         created_ts,
+                         modified_ts,
+                         additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} url: #{@url}, title: #{@title}, logo: #{@logo}, support_email:"\
+      " #{@support_email}, allow_contact_signup: #{@allow_contact_signup},"\
+      " allow_contact_registration: #{@allow_contact_registration}, allow_contact_login:"\
+      " #{@allow_contact_login}, registration_fields: #{@registration_fields}, company_name:"\
+      " #{@company_name}, nav_color: #{@nav_color}, button_primary_color:"\
+      " #{@button_primary_color}, logo_background_color: #{@logo_background_color},"\
+      " icon_background_color: #{@icon_background_color}, menu_text_background_color:"\
+      " #{@menu_text_background_color}, menu_text_color: #{@menu_text_color},"\
+      " right_menu_background_color: #{@right_menu_background_color}, right_menu_text_color:"\
+      " #{@right_menu_text_color}, button_primary_text_color: #{@button_primary_text_color},"\
+      " nav_logo: #{@nav_logo}, fav_icon: #{@fav_icon}, aes_key: #{@aes_key}, help_text:"\
+      " #{@help_text}, email_reply_to: #{@email_reply_to}, email: #{@email}, custom_javascript:"\
+      " #{@custom_javascript}, custom_theme: #{@custom_theme}, custom_css: #{@custom_css},"\
+      " contact_user_default_entry_page: #{@contact_user_default_entry_page},"\
+      " contact_user_default_auth_roles: #{@contact_user_default_auth_roles},"\
+      " custom_stylesheet_url: #{@custom_stylesheet_url}, id: #{@id}, created_ts: #{@created_ts},"\
+      " modified_ts: #{@modified_ts}, 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} url: #{@url.inspect}, title: #{@title.inspect}, logo: #{@logo.inspect},"\
+      " support_email: #{@support_email.inspect}, allow_contact_signup:"\
+      " #{@allow_contact_signup.inspect}, allow_contact_registration:"\
+      " #{@allow_contact_registration.inspect}, allow_contact_login:"\
+      " #{@allow_contact_login.inspect}, registration_fields: #{@registration_fields.inspect},"\
+      " company_name: #{@company_name.inspect}, nav_color: #{@nav_color.inspect},"\
+      " button_primary_color: #{@button_primary_color.inspect}, logo_background_color:"\
+      " #{@logo_background_color.inspect}, icon_background_color:"\
+      " #{@icon_background_color.inspect}, menu_text_background_color:"\
+      " #{@menu_text_background_color.inspect}, menu_text_color: #{@menu_text_color.inspect},"\
+      " right_menu_background_color: #{@right_menu_background_color.inspect},"\
+      " right_menu_text_color: #{@right_menu_text_color.inspect}, button_primary_text_color:"\
+      " #{@button_primary_text_color.inspect}, nav_logo: #{@nav_logo.inspect}, fav_icon:"\
+      " #{@fav_icon.inspect}, aes_key: #{@aes_key.inspect}, help_text: #{@help_text.inspect},"\
+      " email_reply_to: #{@email_reply_to.inspect}, email: #{@email.inspect}, custom_javascript:"\
+      " #{@custom_javascript.inspect}, custom_theme: #{@custom_theme.inspect}, custom_css:"\
+      " #{@custom_css.inspect}, contact_user_default_entry_page:"\
+      " #{@contact_user_default_entry_page.inspect}, contact_user_default_auth_roles:"\
+      " #{@contact_user_default_auth_roles.inspect}, custom_stylesheet_url:"\
+      " #{@custom_stylesheet_url.inspect}, id: #{@id.inspect}, created_ts: #{@created_ts.inspect},"\
+      " modified_ts: #{@modified_ts.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end