juniper-mist-sdk 0.0.1

data/lib/mist_api/models/rssi_zone.rb

@@ -0,0 +1,154 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # RSSI Zone
+  class RssiZone < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the object has been created, in epoch
+    # @return [Float]
+    attr_accessor :created_time
+
+    # List of devices and the respective RSSI values to be considered in the
+    # zone
+    # @return [Array[RssiZoneDevice]]
+    attr_accessor :devices
+
+    # List of devices and the respective RSSI values to be considered in the
+    # zone
+    # @return [TrueClass | FalseClass]
+    attr_accessor :for_site
+
+    # Unique ID of the object instance in the Mist Organization
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # When the object has been modified for the last time, in epoch
+    # @return [Float]
+    attr_accessor :modified_time
+
+    # The name of the zone
+    # @return [String]
+    attr_accessor :name
+
+    # The name of the zone
+    # @return [UUID | String]
+    attr_accessor :org_id
+
+    # The name of the zone
+    # @return [UUID | String]
+    attr_accessor :site_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_time'] = 'created_time'
+      @_hash['devices'] = 'devices'
+      @_hash['for_site'] = 'for_site'
+      @_hash['id'] = 'id'
+      @_hash['modified_time'] = 'modified_time'
+      @_hash['name'] = 'name'
+      @_hash['org_id'] = 'org_id'
+      @_hash['site_id'] = 'site_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_time
+        for_site
+        id
+        modified_time
+        name
+        org_id
+        site_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(devices = nil, created_time = SKIP, for_site = SKIP,
+                   id = SKIP, modified_time = SKIP, name = SKIP, org_id = SKIP,
+                   site_id = SKIP, additional_properties = nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_time = created_time unless created_time == SKIP
+      @devices = devices
+      @for_site = for_site unless for_site == SKIP
+      @id = id unless id == SKIP
+      @modified_time = modified_time unless modified_time == SKIP
+      @name = name unless name == SKIP
+      @org_id = org_id unless org_id == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (RssiZoneDevice.from_hash(structure) if structure)
+        end
+      end
+
+      devices = nil unless hash.key?('devices')
+      created_time = hash.key?('created_time') ? hash['created_time'] : SKIP
+      for_site = hash.key?('for_site') ? hash['for_site'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      modified_time = hash.key?('modified_time') ? hash['modified_time'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      org_id = hash.key?('org_id') ? hash['org_id'] : SKIP
+      site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RssiZone.new(devices,
+                   created_time,
+                   for_site,
+                   id,
+                   modified_time,
+                   name,
+                   org_id,
+                   site_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} created_time: #{@created_time}, devices: #{@devices}, for_site:"\
+      " #{@for_site}, id: #{@id}, modified_time: #{@modified_time}, name: #{@name}, org_id:"\
+      " #{@org_id}, site_id: #{@site_id}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_time: #{@created_time.inspect}, devices: #{@devices.inspect},"\
+      " for_site: #{@for_site.inspect}, id: #{@id.inspect}, modified_time:"\
+      " #{@modified_time.inspect}, name: #{@name.inspect}, org_id: #{@org_id.inspect}, site_id:"\
+      " #{@site_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mist_api/models/rssi_zone_device.rb

@@ -0,0 +1,68 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # RssiZoneDevice Model.
+  class RssiZoneDevice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :device_id
+
+    # RSSI threshold
+    # @return [Integer]
+    attr_accessor :rssi
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'device_id'
+      @_hash['rssi'] = 'rssi'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil, rssi = nil)
+      @device_id = device_id
+      @rssi = rssi
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      device_id = hash.key?('device_id') ? hash['device_id'] : nil
+      rssi = hash.key?('rssi') ? hash['rssi'] : nil
+
+      # Create object from extracted values.
+      RssiZoneDevice.new(device_id,
+                         rssi)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} device_id: #{@device_id}, rssi: #{@rssi}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} device_id: #{@device_id.inspect}, rssi: #{@rssi.inspect}>"
+    end
+  end
+end

data/lib/mist_api/models/saml_metadata.rb

@@ -0,0 +1,102 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # SamlMetadata Model.
+  class SamlMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If `idp_type`==`saml`
+    # @return [String]
+    attr_accessor :acs_url
+
+    # If `idp_type`==`saml`
+    # @return [String]
+    attr_accessor :entity_id
+
+    # If `idp_type`==`saml`
+    # @return [String]
+    attr_accessor :logout_url
+
+    # If `idp_type`==`saml`
+    # @return [String]
+    attr_accessor :metadata
+
+    # If `idp_type`==`oauth` and `scim_enabled`==`true`
+    # @return [String]
+    attr_accessor :scim_base_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['acs_url'] = 'acs_url'
+      @_hash['entity_id'] = 'entity_id'
+      @_hash['logout_url'] = 'logout_url'
+      @_hash['metadata'] = 'metadata'
+      @_hash['scim_base_url'] = 'scim_base_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        acs_url
+        entity_id
+        logout_url
+        metadata
+        scim_base_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(acs_url = SKIP, entity_id = SKIP, logout_url = SKIP,
+                   metadata = SKIP, scim_base_url = SKIP)
+      @acs_url = acs_url unless acs_url == SKIP
+      @entity_id = entity_id unless entity_id == SKIP
+      @logout_url = logout_url unless logout_url == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @scim_base_url = scim_base_url unless scim_base_url == 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.
+      acs_url = hash.key?('acs_url') ? hash['acs_url'] : SKIP
+      entity_id = hash.key?('entity_id') ? hash['entity_id'] : SKIP
+      logout_url = hash.key?('logout_url') ? hash['logout_url'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      scim_base_url = hash.key?('scim_base_url') ? hash['scim_base_url'] : SKIP
+
+      # Create object from extracted values.
+      SamlMetadata.new(acs_url,
+                       entity_id,
+                       logout_url,
+                       metadata,
+                       scim_base_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} acs_url: #{@acs_url}, entity_id: #{@entity_id}, logout_url: #{@logout_url},"\
+      " metadata: #{@metadata}, scim_base_url: #{@scim_base_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} acs_url: #{@acs_url.inspect}, entity_id: #{@entity_id.inspect}, logout_url:"\
+      " #{@logout_url.inspect}, metadata: #{@metadata.inspect}, scim_base_url:"\
+      " #{@scim_base_url.inspect}>"
+    end
+  end
+end

data/lib/mist_api/models/scan_data_item_band_enum.rb

@@ -0,0 +1,36 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # 5GHz or 2.4GHz band, associated with the BSSID scanned. enum: `2.4`, `5`
+  class ScanDataItemBandEnum
+    SCAN_DATA_ITEM_BAND_ENUM = [
+      # TODO: Write general description for ENUM_24
+      ENUM_24 = '2.4'.freeze,
+
+      # TODO: Write general description for ENUM_5
+      ENUM_5 = '5'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SCAN_DATA_ITEM_BAND_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_24)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_24' then ENUM_24
+      when 'enum_5' then ENUM_5
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mist_api/models/sdk_invite_sms.rb

@@ -0,0 +1,73 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # SdkInviteSms Model.
+  class SdkInviteSms < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number = nil, additional_properties = nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @number = number
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      number = hash.key?('number') ? hash['number'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      SdkInviteSms.new(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} number: #{@number}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mist_api/models/sdkinvite.rb

@@ -0,0 +1,164 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # SDK invite
+  class Sdkinvite < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the object has been created, in epoch
+    # @return [Float]
+    attr_accessor :created_time
+
+    # When the object has been created, in epoch
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enabled
+
+    # When the object has been created, in epoch
+    # @return [Integer]
+    attr_accessor :expire_time
+
+    # Unique ID of the object instance in the Mist Organization
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # When the object has been modified for the last time, in epoch
+    # @return [Float]
+    attr_accessor :modified_time
+
+    # Name, will show up in mobile
+    # @return [String]
+    attr_accessor :name
+
+    # Name, will show up in mobile
+    # @return [UUID | String]
+    attr_accessor :org_id
+
+    # Number of time this invite can be used
+    # @return [Integer]
+    attr_accessor :quota
+
+    # Whether quota limiting is enabled
+    # @return [TrueClass | FalseClass]
+    attr_accessor :quota_limited
+
+    # Whether quota limiting is enabled
+    # @return [UUID | String]
+    attr_accessor :site_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_time'] = 'created_time'
+      @_hash['enabled'] = 'enabled'
+      @_hash['expire_time'] = 'expire_time'
+      @_hash['id'] = 'id'
+      @_hash['modified_time'] = 'modified_time'
+      @_hash['name'] = 'name'
+      @_hash['org_id'] = 'org_id'
+      @_hash['quota'] = 'quota'
+      @_hash['quota_limited'] = 'quota_limited'
+      @_hash['site_id'] = 'site_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_time
+        enabled
+        expire_time
+        id
+        modified_time
+        org_id
+        quota
+        quota_limited
+        site_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, created_time = SKIP, enabled = true,
+                   expire_time = SKIP, id = SKIP, modified_time = SKIP,
+                   org_id = SKIP, quota = SKIP, quota_limited = false,
+                   site_id = SKIP, additional_properties = nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_time = created_time unless created_time == SKIP
+      @enabled = enabled unless enabled == SKIP
+      @expire_time = expire_time unless expire_time == SKIP
+      @id = id unless id == SKIP
+      @modified_time = modified_time unless modified_time == SKIP
+      @name = name
+      @org_id = org_id unless org_id == SKIP
+      @quota = quota unless quota == SKIP
+      @quota_limited = quota_limited unless quota_limited == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      created_time = hash.key?('created_time') ? hash['created_time'] : SKIP
+      enabled = hash['enabled'] ||= true
+      expire_time = hash.key?('expire_time') ? hash['expire_time'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      modified_time = hash.key?('modified_time') ? hash['modified_time'] : SKIP
+      org_id = hash.key?('org_id') ? hash['org_id'] : SKIP
+      quota = hash.key?('quota') ? hash['quota'] : SKIP
+      quota_limited = hash['quota_limited'] ||= false
+      site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Sdkinvite.new(name,
+                    created_time,
+                    enabled,
+                    expire_time,
+                    id,
+                    modified_time,
+                    org_id,
+                    quota,
+                    quota_limited,
+                    site_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} created_time: #{@created_time}, enabled: #{@enabled}, expire_time:"\
+      " #{@expire_time}, id: #{@id}, modified_time: #{@modified_time}, name: #{@name}, org_id:"\
+      " #{@org_id}, quota: #{@quota}, quota_limited: #{@quota_limited}, site_id: #{@site_id},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_time: #{@created_time.inspect}, enabled: #{@enabled.inspect},"\
+      " expire_time: #{@expire_time.inspect}, id: #{@id.inspect}, modified_time:"\
+      " #{@modified_time.inspect}, name: #{@name.inspect}, org_id: #{@org_id.inspect}, quota:"\
+      " #{@quota.inspect}, quota_limited: #{@quota_limited.inspect}, site_id: #{@site_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end