juniper-mist-sdk 0.0.1

data/lib/mist_api/models/psk.rb

@@ -0,0 +1,333 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # PSK
+  class Psk < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # sso id for psk created from psk portal
+    # @return [String]
+    attr_accessor :admin_sso_id
+
+    # When the object has been created, in epoch
+    # @return [Float]
+    attr_accessor :created_time
+
+    # email to send psk expiring notifications to
+    # @return [String]
+    attr_accessor :email
+
+    # Expire time for this PSK key (epoch time in seconds). Default `null` (as
+    # no expiration)
+    # @return [Integer]
+    attr_accessor :expire_time
+
+    # Number of days before psk is expired. Used as to when to start sending
+    # reminder notification when the psk is about to expire
+    # @return [Integer]
+    attr_accessor :expiry_notification_time
+
+    # Unique ID of the object instance in the Mist Organization
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # If `usage`==`single`, the mac that this PSK ties to, empty if
+    # `auto-binding`
+    # @return [String]
+    attr_accessor :mac
+
+    # If `usage`==`macs`, this list contains N number of client mac addresses or
+    # mac patterns(1122*) or both. This list is capped at 5000
+    # @return [Array[String]]
+    attr_accessor :macs
+
+    # For Org PSK Only. Max concurrent users for this PSK key. Default is 0
+    # (unlimited)
+    # @return [Integer]
+    attr_accessor :max_usage
+
+    # When the object has been modified for the last time, in epoch
+    # @return [Float]
+    attr_accessor :modified_time
+
+    # When the object has been modified for the last time, in epoch
+    # @return [String]
+    attr_accessor :name
+
+    # When the object has been modified for the last time, in epoch
+    # @return [String]
+    attr_accessor :note
+
+    # If set to true, reminder notification will be sent when psk is about to
+    # expire
+    # @return [TrueClass | FalseClass]
+    attr_accessor :notify_expiry
+
+    # If set to true, notification will be sent when psk is created or edited
+    # @return [TrueClass | FalseClass]
+    attr_accessor :notify_on_create_or_edit
+
+    # previous passphrase of the PSK if it has been rotated
+    # @return [String]
+    attr_accessor :old_passphrase
+
+    # previous passphrase of the PSK if it has been rotated
+    # @return [UUID | String]
+    attr_accessor :org_id
+
+    # passphrase of the PSK (8-63 character or 64 in hex)
+    # @return [String]
+    attr_accessor :passphrase
+
+    # passphrase of the PSK (8-63 character or 64 in hex)
+    # @return [String]
+    attr_accessor :role
+
+    # passphrase of the PSK (8-63 character or 64 in hex)
+    # @return [UUID | String]
+    attr_accessor :site_id
+
+    # SSID this PSK should be applicable to
+    # @return [String]
+    attr_accessor :ssid
+
+    # enum: `macs`, `multi`, `single`
+    # @return [PskUsageEnum]
+    attr_accessor :usage
+
+    # VLAN for this PSK key
+    # @return [Object]
+    attr_accessor :vlan_id
+
+    # VLAN name to be assigned. Optional, `vlan_id` takes precedence if both are
+    # provided
+    # @return [String]
+    attr_accessor :vlan_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['admin_sso_id'] = 'admin_sso_id'
+      @_hash['created_time'] = 'created_time'
+      @_hash['email'] = 'email'
+      @_hash['expire_time'] = 'expire_time'
+      @_hash['expiry_notification_time'] = 'expiry_notification_time'
+      @_hash['id'] = 'id'
+      @_hash['mac'] = 'mac'
+      @_hash['macs'] = 'macs'
+      @_hash['max_usage'] = 'max_usage'
+      @_hash['modified_time'] = 'modified_time'
+      @_hash['name'] = 'name'
+      @_hash['note'] = 'note'
+      @_hash['notify_expiry'] = 'notify_expiry'
+      @_hash['notify_on_create_or_edit'] = 'notify_on_create_or_edit'
+      @_hash['old_passphrase'] = 'old_passphrase'
+      @_hash['org_id'] = 'org_id'
+      @_hash['passphrase'] = 'passphrase'
+      @_hash['role'] = 'role'
+      @_hash['site_id'] = 'site_id'
+      @_hash['ssid'] = 'ssid'
+      @_hash['usage'] = 'usage'
+      @_hash['vlan_id'] = 'vlan_id'
+      @_hash['vlan_name'] = 'vlan_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        admin_sso_id
+        created_time
+        email
+        expire_time
+        expiry_notification_time
+        id
+        mac
+        macs
+        max_usage
+        modified_time
+        note
+        notify_expiry
+        notify_on_create_or_edit
+        old_passphrase
+        org_id
+        role
+        site_id
+        usage
+        vlan_id
+        vlan_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        expire_time
+      ]
+    end
+
+    def initialize(name = nil, passphrase = nil, ssid = nil,
+                   admin_sso_id = SKIP, created_time = SKIP, email = SKIP,
+                   expire_time = SKIP, expiry_notification_time = SKIP,
+                   id = SKIP, mac = SKIP, macs = SKIP, max_usage = 0,
+                   modified_time = SKIP, note = SKIP, notify_expiry = false,
+                   notify_on_create_or_edit = SKIP, old_passphrase = SKIP,
+                   org_id = SKIP, role = SKIP, site_id = SKIP,
+                   usage = PskUsageEnum::MULTI, vlan_id = SKIP,
+                   vlan_name = SKIP, additional_properties = nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @admin_sso_id = admin_sso_id unless admin_sso_id == SKIP
+      @created_time = created_time unless created_time == SKIP
+      @email = email unless email == SKIP
+      @expire_time = expire_time unless expire_time == SKIP
+      @expiry_notification_time = expiry_notification_time unless expiry_notification_time == SKIP
+      @id = id unless id == SKIP
+      @mac = mac unless mac == SKIP
+      @macs = macs unless macs == SKIP
+      @max_usage = max_usage unless max_usage == SKIP
+      @modified_time = modified_time unless modified_time == SKIP
+      @name = name
+      @note = note unless note == SKIP
+      @notify_expiry = notify_expiry unless notify_expiry == SKIP
+      @notify_on_create_or_edit = notify_on_create_or_edit unless notify_on_create_or_edit == SKIP
+      @old_passphrase = old_passphrase unless old_passphrase == SKIP
+      @org_id = org_id unless org_id == SKIP
+      @passphrase = passphrase
+      @role = role unless role == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @ssid = ssid
+      @usage = usage unless usage == SKIP
+      @vlan_id = vlan_id unless vlan_id == SKIP
+      @vlan_name = vlan_name unless vlan_name == 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
+      passphrase = hash.key?('passphrase') ? hash['passphrase'] : nil
+      ssid = hash.key?('ssid') ? hash['ssid'] : nil
+      admin_sso_id = hash.key?('admin_sso_id') ? hash['admin_sso_id'] : SKIP
+      created_time = hash.key?('created_time') ? hash['created_time'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      expire_time = hash.key?('expire_time') ? hash['expire_time'] : SKIP
+      expiry_notification_time =
+        hash.key?('expiry_notification_time') ? hash['expiry_notification_time'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      mac = hash.key?('mac') ? hash['mac'] : SKIP
+      macs = hash.key?('macs') ? hash['macs'] : SKIP
+      max_usage = hash['max_usage'] ||= 0
+      modified_time = hash.key?('modified_time') ? hash['modified_time'] : SKIP
+      note = hash.key?('note') ? hash['note'] : SKIP
+      notify_expiry = hash['notify_expiry'] ||= false
+      notify_on_create_or_edit =
+        hash.key?('notify_on_create_or_edit') ? hash['notify_on_create_or_edit'] : SKIP
+      old_passphrase =
+        hash.key?('old_passphrase') ? hash['old_passphrase'] : SKIP
+      org_id = hash.key?('org_id') ? hash['org_id'] : SKIP
+      role = hash.key?('role') ? hash['role'] : SKIP
+      site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
+      usage = hash['usage'] ||= PskUsageEnum::MULTI
+      vlan_id = hash.key?('vlan_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PskVlanId), hash['vlan_id']
+      ) : SKIP
+      vlan_name = hash.key?('vlan_name') ? hash['vlan_name'] : 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.
+      Psk.new(name,
+              passphrase,
+              ssid,
+              admin_sso_id,
+              created_time,
+              email,
+              expire_time,
+              expiry_notification_time,
+              id,
+              mac,
+              macs,
+              max_usage,
+              modified_time,
+              note,
+              notify_expiry,
+              notify_on_create_or_edit,
+              old_passphrase,
+              org_id,
+              role,
+              site_id,
+              usage,
+              vlan_id,
+              vlan_name,
+              additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Psk | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.name,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.passphrase,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.ssid,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['passphrase'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['ssid'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} admin_sso_id: #{@admin_sso_id}, created_time: #{@created_time}, email:"\
+      " #{@email}, expire_time: #{@expire_time}, expiry_notification_time:"\
+      " #{@expiry_notification_time}, id: #{@id}, mac: #{@mac}, macs: #{@macs}, max_usage:"\
+      " #{@max_usage}, modified_time: #{@modified_time}, name: #{@name}, note: #{@note},"\
+      " notify_expiry: #{@notify_expiry}, notify_on_create_or_edit: #{@notify_on_create_or_edit},"\
+      " old_passphrase: #{@old_passphrase}, org_id: #{@org_id}, passphrase: #{@passphrase}, role:"\
+      " #{@role}, site_id: #{@site_id}, ssid: #{@ssid}, usage: #{@usage}, vlan_id: #{@vlan_id},"\
+      " vlan_name: #{@vlan_name}, 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} admin_sso_id: #{@admin_sso_id.inspect}, created_time:"\
+      " #{@created_time.inspect}, email: #{@email.inspect}, expire_time: #{@expire_time.inspect},"\
+      " expiry_notification_time: #{@expiry_notification_time.inspect}, id: #{@id.inspect}, mac:"\
+      " #{@mac.inspect}, macs: #{@macs.inspect}, max_usage: #{@max_usage.inspect}, modified_time:"\
+      " #{@modified_time.inspect}, name: #{@name.inspect}, note: #{@note.inspect}, notify_expiry:"\
+      " #{@notify_expiry.inspect}, notify_on_create_or_edit: #{@notify_on_create_or_edit.inspect},"\
+      " old_passphrase: #{@old_passphrase.inspect}, org_id: #{@org_id.inspect}, passphrase:"\
+      " #{@passphrase.inspect}, role: #{@role.inspect}, site_id: #{@site_id.inspect}, ssid:"\
+      " #{@ssid.inspect}, usage: #{@usage.inspect}, vlan_id: #{@vlan_id.inspect}, vlan_name:"\
+      " #{@vlan_name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mist_api/models/psk_id_list.rb

@@ -0,0 +1,75 @@
+# mist_api
+#
+# This file was automatically generated for Juniper Networks by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module MistApi
+  # PskIdList Model.
+  class PskIdList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[UUID | String]]
+    attr_accessor :psk_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['psk_ids'] = 'psk_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        psk_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(psk_ids = SKIP, additional_properties = nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @psk_ids = psk_ids unless psk_ids == 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.
+      psk_ids = hash.key?('psk_ids') ? hash['psk_ids'] : 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.
+      PskIdList.new(psk_ids,
+                    additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} psk_ids: #{@psk_ids}, 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} psk_ids: #{@psk_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end