sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/device_id_search.rb

@@ -0,0 +1,81 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Search by device id.
+  class DeviceIdSearch < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The string appears anywhere in the identifer.
+    # @return [String]
+    attr_accessor :contains
+
+    # The identifer must start with the specified string.
+    # @return [String]
+    attr_accessor :startswith
+
+    # The identifier must end with the specified string.
+    # @return [String]
+    attr_accessor :endswith
+
+    # The type of the device identifier. Valid types of identifiers are:ESN
+    # (decimal),EID,ICCID (up to 20 digits),IMEI (up to 16 digits),MDN,MEID
+    # (hexadecimal),MSISDN.
+    # @return [String]
+    attr_accessor :kind
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contains'] = 'contains'
+      @_hash['startswith'] = 'startswith'
+      @_hash['endswith'] = 'endswith'
+      @_hash['kind'] = 'kind'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contains
+        startswith
+        endswith
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(kind = nil,
+                   contains = SKIP,
+                   startswith = SKIP,
+                   endswith = SKIP)
+      @contains = contains unless contains == SKIP
+      @startswith = startswith unless startswith == SKIP
+      @endswith = endswith unless endswith == SKIP
+      @kind = kind
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      kind = hash.key?('kind') ? hash['kind'] : nil
+      contains = hash.key?('contains') ? hash['contains'] : SKIP
+      startswith = hash.key?('startswith') ? hash['startswith'] : SKIP
+      endswith = hash.key?('endswith') ? hash['endswith'] : SKIP
+
+      # Create object from extracted values.
+      DeviceIdSearch.new(kind,
+                         contains,
+                         startswith,
+                         endswith)
+    end
+  end
+end

data/lib/verizon/models/device_identifier.rb

@@ -0,0 +1,68 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device Id details.
+  class DeviceIdentifier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Kind of device.
+    # @return [String]
+    attr_accessor :kind
+
+    # Device Identity number.
+    # @return [String]
+    attr_accessor :id
+
+    # Device MDN number.
+    # @return [String]
+    attr_accessor :mdn
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['kind'] = 'kind'
+      @_hash['id'] = 'id'
+      @_hash['mdn'] = 'mdn'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mdn
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(kind = nil,
+                   id = nil,
+                   mdn = SKIP)
+      @kind = kind
+      @id = id
+      @mdn = mdn unless mdn == 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.
+      kind = hash.key?('kind') ? hash['kind'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      mdn = hash.key?('mdn') ? hash['mdn'] : SKIP
+
+      # Create object from extracted values.
+      DeviceIdentifier.new(kind,
+                           id,
+                           mdn)
+    end
+  end
+end

data/lib/verizon/models/device_imei.rb

@@ -0,0 +1,48 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device IMEI list.
+  class DeviceIMEI < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI list.
+    # @return [Array[String]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_list = nil)
+      @device_list = device_list
+    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_list = hash.key?('deviceList') ? hash['deviceList'] : nil
+
+      # Create object from extracted values.
+      DeviceIMEI.new(device_list)
+    end
+  end
+end

data/lib/verizon/models/device_info.rb

@@ -0,0 +1,67 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The devices that you want to locate. The array cannot contain more than 20
+  # devices.
+  class DeviceInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # Device identifier kind.
+    # @return [String]
+    attr_accessor :kind
+
+    # Device MDN.
+    # @return [String]
+    attr_accessor :mdn
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['kind'] = 'kind'
+      @_hash['mdn'] = 'mdn'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   kind = nil,
+                   mdn = nil)
+      @id = id
+      @kind = kind
+      @mdn = mdn
+    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'] : nil
+      kind = hash.key?('kind') ? hash['kind'] : nil
+      mdn = hash.key?('mdn') ? hash['mdn'] : nil
+
+      # Create object from extracted values.
+      DeviceInfo.new(id,
+                     kind,
+                     mdn)
+    end
+  end
+end

data/lib/verizon/models/device_labels.rb

@@ -0,0 +1,57 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A label for a single device.
+  class DeviceLabels < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The label you want to associate with the device.
+    # @return [String]
+    attr_accessor :name
+
+    # The value of label
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   value = nil)
+      @name = name
+      @value = value
+    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
+      value = hash.key?('value') ? hash['value'] : nil
+
+      # Create object from extracted values.
+      DeviceLabels.new(name,
+                       value)
+    end
+  end
+end

data/lib/verizon/models/device_list.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceList Model.
+  class DeviceList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = SKIP)
+      @device_ids = device_ids unless device_ids == 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.
+      # Parameter is an array, so we need to iterate through it
+      device_ids = nil
+      unless hash['deviceIds'].nil?
+        device_ids = []
+        hash['deviceIds'].each do |structure|
+          device_ids << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+
+      # Create object from extracted values.
+      DeviceList.new(device_ids)
+    end
+  end
+end

data/lib/verizon/models/device_list1.rb

@@ -0,0 +1,75 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceList1 Model.
+  class DeviceList1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[MECDeviceId]]
+    attr_accessor :device_ids
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :ip_address
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :apn
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['ip_address'] = 'ipAddress'
+      @_hash['apn'] = 'apn'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = nil,
+                   ip_address = nil,
+                   apn = nil)
+      @device_ids = device_ids
+      @ip_address = ip_address
+      @apn = apn
+    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
+      device_ids = nil
+      unless hash['deviceIds'].nil?
+        device_ids = []
+        hash['deviceIds'].each do |structure|
+          device_ids << (MECDeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = nil unless hash.key?('deviceIds')
+      ip_address = hash.key?('ipAddress') ? hash['ipAddress'] : nil
+      apn = hash.key?('apn') ? hash['apn'] : nil
+
+      # Create object from extracted values.
+      DeviceList1.new(device_ids,
+                      ip_address,
+                      apn)
+    end
+  end
+end

data/lib/verizon/models/device_list2.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceList2 Model.
+  class DeviceList2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ESIMDeviceId]]
+    attr_accessor :ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = SKIP)
+      @ids = ids unless ids == 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.
+      # Parameter is an array, so we need to iterate through it
+      ids = nil
+      unless hash['ids'].nil?
+        ids = []
+        hash['ids'].each do |structure|
+          ids << (ESIMDeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      ids = SKIP unless hash.key?('ids')
+
+      # Create object from extracted values.
+      DeviceList2.new(ids)
+    end
+  end
+end

data/lib/verizon/models/device_list7.rb

@@ -0,0 +1,66 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceList7 Model.
+  class DeviceList7 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[MECDeviceId]]
+    attr_accessor :device_ids
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :ip_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['ip_address'] = 'ipAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = nil,
+                   ip_address = nil)
+      @device_ids = device_ids
+      @ip_address = ip_address
+    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
+      device_ids = nil
+      unless hash['deviceIds'].nil?
+        device_ids = []
+        hash['deviceIds'].each do |structure|
+          device_ids << (MECDeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = nil unless hash.key?('deviceIds')
+      ip_address = hash.key?('ipAddress') ? hash['ipAddress'] : nil
+
+      # Create object from extracted values.
+      DeviceList7.new(device_ids,
+                      ip_address)
+    end
+  end
+end

data/lib/verizon/models/device_list_query_item.rb

@@ -0,0 +1,123 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The list of devices in the account.
+  class DeviceListQueryItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # The MDN (phone number) of the device.
+    # @return [String]
+    attr_accessor :mdn
+
+    # The device model name.
+    # @return [String]
+    attr_accessor :model
+
+    # The device make.
+    # @return [String]
+    attr_accessor :make
+
+    # The name of the firmware image currently installed on the device.
+    # @return [String]
+    attr_accessor :firmware
+
+    # True if the device firmware can be upgraded over the air using the
+    # Software Management Services API.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :fota_eligible
+
+    # True if an MRC license has been assigned to this device.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :license_assigned
+
+    # The date and time that the device firmware was last upgraded. If a device
+    # has never been upgraded, the upgradeTime will be 01/01/1900 0:0:0.
+    # @return [String]
+    attr_accessor :upgrade_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['mdn'] = 'mdn'
+      @_hash['model'] = 'model'
+      @_hash['make'] = 'make'
+      @_hash['firmware'] = 'firmware'
+      @_hash['fota_eligible'] = 'fotaEligible'
+      @_hash['license_assigned'] = 'licenseAssigned'
+      @_hash['upgrade_time'] = 'upgradeTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_id
+        mdn
+        model
+        make
+        firmware
+        fota_eligible
+        license_assigned
+        upgrade_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP,
+                   mdn = SKIP,
+                   model = SKIP,
+                   make = SKIP,
+                   firmware = SKIP,
+                   fota_eligible = SKIP,
+                   license_assigned = SKIP,
+                   upgrade_time = SKIP)
+      @device_id = device_id unless device_id == SKIP
+      @mdn = mdn unless mdn == SKIP
+      @model = model unless model == SKIP
+      @make = make unless make == SKIP
+      @firmware = firmware unless firmware == SKIP
+      @fota_eligible = fota_eligible unless fota_eligible == SKIP
+      @license_assigned = license_assigned unless license_assigned == SKIP
+      @upgrade_time = upgrade_time unless upgrade_time == 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.
+      device_id = hash.key?('deviceId') ? hash['deviceId'] : SKIP
+      mdn = hash.key?('mdn') ? hash['mdn'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      make = hash.key?('make') ? hash['make'] : SKIP
+      firmware = hash.key?('firmware') ? hash['firmware'] : SKIP
+      fota_eligible = hash.key?('fotaEligible') ? hash['fotaEligible'] : SKIP
+      license_assigned =
+        hash.key?('licenseAssigned') ? hash['licenseAssigned'] : SKIP
+      upgrade_time = hash.key?('upgradeTime') ? hash['upgradeTime'] : SKIP
+
+      # Create object from extracted values.
+      DeviceListQueryItem.new(device_id,
+                              mdn,
+                              model,
+                              make,
+                              firmware,
+                              fota_eligible,
+                              license_assigned,
+                              upgrade_time)
+    end
+  end
+end