sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/device_group_update_request.rb

@@ -0,0 +1,103 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Make changes to a device group, including changing the name and description,
+  # and adding or removing devices.
+  class DeviceGroupUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Zero or more devices to add to the device group, specified by device ID.
+    # The devices will be removed from their current device groups. You can use
+    # POST /devices/actions/list to get a list of all devices in the account.
+    # @return [Array[DeviceId]]
+    attr_accessor :devices_to_add
+
+    # Zero or more devices to remove from the device group, specified by device
+    # ID. The devices will be added to the default device group.
+    # @return [Array[DeviceId]]
+    attr_accessor :devices_to_remove
+
+    # A new description for the device group. Do not include this parameter to
+    # leave the group description unchanged.
+    # @return [String]
+    attr_accessor :new_group_description
+
+    # A new name for the device group. Do not include this parameter if you want
+    # to leave the group name unchanged.
+    # @return [String]
+    attr_accessor :new_group_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['devices_to_add'] = 'devicesToAdd'
+      @_hash['devices_to_remove'] = 'devicesToRemove'
+      @_hash['new_group_description'] = 'newGroupDescription'
+      @_hash['new_group_name'] = 'newGroupName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        devices_to_add
+        devices_to_remove
+        new_group_description
+        new_group_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(devices_to_add = SKIP, devices_to_remove = SKIP,
+                   new_group_description = SKIP, new_group_name = SKIP)
+      @devices_to_add = devices_to_add unless devices_to_add == SKIP
+      @devices_to_remove = devices_to_remove unless devices_to_remove == SKIP
+      @new_group_description = new_group_description unless new_group_description == SKIP
+      @new_group_name = new_group_name unless new_group_name == 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
+      devices_to_add = nil
+      unless hash['devicesToAdd'].nil?
+        devices_to_add = []
+        hash['devicesToAdd'].each do |structure|
+          devices_to_add << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      devices_to_add = SKIP unless hash.key?('devicesToAdd')
+      # Parameter is an array, so we need to iterate through it
+      devices_to_remove = nil
+      unless hash['devicesToRemove'].nil?
+        devices_to_remove = []
+        hash['devicesToRemove'].each do |structure|
+          devices_to_remove << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      devices_to_remove = SKIP unless hash.key?('devicesToRemove')
+      new_group_description =
+        hash.key?('newGroupDescription') ? hash['newGroupDescription'] : SKIP
+      new_group_name = hash.key?('newGroupName') ? hash['newGroupName'] : SKIP
+
+      # Create object from extracted values.
+      DeviceGroupUpdateRequest.new(devices_to_add,
+                                   devices_to_remove,
+                                   new_group_description,
+                                   new_group_name)
+    end
+  end
+end

data/lib/verizon/models/device_id.rb

@@ -0,0 +1,58 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # An identifier for a single device.
+  class DeviceId < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value of the device identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # 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['id'] = 'id'
+      @_hash['kind'] = 'kind'
+      @_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)
+      @id = id
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      kind = hash.key?('kind') ? hash['kind'] : nil
+
+      # Create object from extracted values.
+      DeviceId.new(id,
+                   kind)
+    end
+  end
+end

data/lib/{verizon_thing_space_quality_of_service_api_endpoints/models/device_id.rb → verizon/models/device_id2.rb}

@@ -1,21 +1,19 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
-  # device identifiers consisting of an ID value and what that value represents
-  # (kind)
-  class DeviceId < BaseModel
+module Verizon
+  # DeviceId2 Model.
+  class DeviceId2 < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # The numeric or alphanumeric ID value
+    # TODO: Write general description for this method
     # @return [String]
     attr_accessor :id
 
-    # What the ID value represents, which could be a Mobile Directory Number
-    # (MDN) or an International Mobile Equipment Identifier (IMEI) as an example
+    # TODO: Write general description for this method
     # @return [String]
     attr_accessor :kind
 
@@ -54,8 +52,8 @@ module VerizonThingSpaceQualityOfServiceApiEndpoints
       kind = hash.key?('kind') ? hash['kind'] : SKIP
 
       # Create object from extracted values.
-      DeviceId.new(id,
-                   kind)
+      DeviceId2.new(id,
+                    kind)
     end
   end
 end

data/lib/verizon/models/device_id_search.rb

@@ -0,0 +1,78 @@
+# 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[
+        startswith
+        endswith
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contains = nil, kind = nil, startswith = SKIP,
+                   endswith = SKIP)
+      @contains = contains
+      @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.
+      contains = hash.key?('contains') ? hash['contains'] : nil
+      kind = hash.key?('kind') ? hash['kind'] : nil
+      startswith = hash.key?('startswith') ? hash['startswith'] : SKIP
+      endswith = hash.key?('endswith') ? hash['endswith'] : SKIP
+
+      # Create object from extracted values.
+      DeviceIdSearch.new(contains,
+                         kind,
+                         startswith,
+                         endswith)
+    end
+  end
+end

data/lib/verizon/models/device_idarray.rb

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

data/lib/verizon/models/device_identifier.rb

@@ -0,0 +1,66 @@
+# 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,65 @@
+# 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,56 @@
+# 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_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[DeviceId2]]
+    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 << (DeviceId2.from_hash(structure) if structure)
+        end
+      end
+
+      ids = SKIP unless hash.key?('ids')
+
+      # Create object from extracted values.
+      DeviceList2.new(ids)
+    end
+  end
+end