sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/device_mismatch_list_request.rb

@@ -0,0 +1,92 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to list of all 4G devices with an ICCID (SIM) that was not activated
+  # with the expected IMEI (hardware) during a specified time frame.
+  class DeviceMismatchListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Filter out the dates.
+    # @return [DateFilter]
+    attr_accessor :filter
+
+    # A list of specific devices that you want to check, specified by ICCID or
+    # MDN.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # The account that you want to search for mismatched devices. If you don't
+    # specify an accountName, the search includes all devices to which you have
+    # access.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of a device group, to only include devices in that group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['filter'] = 'filter'
+      @_hash['devices'] = 'devices'
+      @_hash['account_name'] = 'accountName'
+      @_hash['group_name'] = 'groupName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        devices
+        account_name
+        group_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(filter = nil,
+                   devices = SKIP,
+                   account_name = SKIP,
+                   group_name = SKIP)
+      @filter = filter
+      @devices = devices unless devices == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @group_name = group_name unless 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.
+      filter = DateFilter.from_hash(hash['filter']) if hash['filter']
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (AccountDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+
+      # Create object from extracted values.
+      DeviceMismatchListRequest.new(filter,
+                                    devices,
+                                    account_name,
+                                    group_name)
+    end
+  end
+end

data/lib/verizon/models/device_mismatch_list_result.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to list of all 4G devices with an ICCID (SIM) that was not
+  # activated with the expected IMEI (hardware) during a specified time frame.
+  class DeviceMismatchListResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of specific devices that you want to check, specified by ICCID or
+    # MDN.
+    # @return [Array[MismatchedDevice]]
+    attr_accessor :devices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['devices'] = 'devices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        devices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(devices = SKIP)
+      @devices = devices unless devices == 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 = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (MismatchedDevice.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+
+      # Create object from extracted values.
+      DeviceMismatchListResult.new(devices)
+    end
+  end
+end

data/lib/verizon/models/device_prl_list_request.rb

@@ -0,0 +1,119 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Requests the current PRL (Preferred Roaming List) version for 2G or 3G
+  # devices, which can help determine which devices need a PRL update. (4G and
+  # GSM devices do not have a PRL.).
+  class DevicePrlListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The devices for which you want the PRL version, specified by device
+    # identifier. You only need to provide one identifier per device. Do not use
+    # any of the other parameters if you specify device IDs.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # The name of a billing account. This parameter is only required if you are
+    # passing groupName and the UWS account used for the current API session has
+    # access to multiple billing accounts, because the same device group name
+    # can exist in multiple accounts.An account name is usually numeric, and
+    # must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The names and values of custom fields, if you want to only include devices
+    # that have matching custom fields.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # The name of a device group, if you want to only include devices in that
+    # group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The name of a service plan, if you want to only include devices that have
+    # that service plan.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['account_name'] = 'accountName'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['group_name'] = 'groupName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+        account_name
+        custom_fields
+        group_name
+        service_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = SKIP,
+                   account_name = SKIP,
+                   custom_fields = SKIP,
+                   group_name = SKIP,
+                   service_plan = SKIP)
+      @device_ids = device_ids unless device_ids == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @service_plan = service_plan unless service_plan == 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')
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      custom_fields = nil
+      unless hash['customFields'].nil?
+        custom_fields = []
+        hash['customFields'].each do |structure|
+          custom_fields << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      custom_fields = SKIP unless hash.key?('customFields')
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+
+      # Create object from extracted values.
+      DevicePrlListRequest.new(device_ids,
+                               account_name,
+                               custom_fields,
+                               group_name,
+                               service_plan)
+    end
+  end
+end

data/lib/verizon/models/device_profile_request.rb

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

data/lib/verizon/models/device_propertylocation.rb

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

data/lib/verizon/models/device_provisioning_history_list_request.rb

@@ -0,0 +1,67 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to return the provisioning history of a specified device during a
+  # specified time period.
+  class DeviceProvisioningHistoryListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An identifier for a single device.
+    # @return [DeviceId]
+    attr_accessor :device_id
+
+    # The earliest date and time for which you want provisioning data.
+    # @return [String]
+    attr_accessor :earliest
+
+    # The last date and time for which you want provisioning data.
+    # @return [String]
+    attr_accessor :latest
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['earliest'] = 'earliest'
+      @_hash['latest'] = 'latest'
+      @_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,
+                   earliest = nil,
+                   latest = nil)
+      @device_id = device_id
+      @earliest = earliest
+      @latest = latest
+    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 = DeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      earliest = hash.key?('earliest') ? hash['earliest'] : nil
+      latest = hash.key?('latest') ? hash['latest'] : nil
+
+      # Create object from extracted values.
+      DeviceProvisioningHistoryListRequest.new(device_id,
+                                               earliest,
+                                               latest)
+    end
+  end
+end

data/lib/verizon/models/device_provisioning_history_list_result.rb

@@ -0,0 +1,72 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to return the provisioning history of a specified device during a
+  # specified time period.
+  class DeviceProvisioningHistoryListResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # False for a status 200 response.True for a status 202 response, indicating
+    # that there is more data to be retrieved.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # The provisioning history of a specified device during a specified time
+    # period.
+    # @return [Array[ProvisioningHistory]]
+    attr_accessor :provisioning_history
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['provisioning_history'] = 'provisioningHistory'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        has_more_data
+        provisioning_history
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(has_more_data = SKIP,
+                   provisioning_history = SKIP)
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @provisioning_history = provisioning_history unless provisioning_history == 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.
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      provisioning_history = nil
+      unless hash['provisioningHistory'].nil?
+        provisioning_history = []
+        hash['provisioningHistory'].each do |structure|
+          provisioning_history << (ProvisioningHistory.from_hash(structure) if structure)
+        end
+      end
+
+      provisioning_history = SKIP unless hash.key?('provisioningHistory')
+
+      # Create object from extracted values.
+      DeviceProvisioningHistoryListResult.new(has_more_data,
+                                              provisioning_history)
+    end
+  end
+end

data/lib/verizon/models/device_reset_request.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request body to Performs a device reboot.
+  class DeviceResetRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the account. An account name is usually numeric, and must
+    # include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The action you want to take on the device.
+    # @return [String]
+    attr_accessor :action
+
+    # The devices for which you want to perform a factory reset or reboot.
+    # @return [Array[Device]]
+    attr_accessor :devices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['action'] = 'action'
+      @_hash['devices'] = 'devices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        action
+        devices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   action = SKIP,
+                   devices = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @action = action unless action == SKIP
+      @devices = devices unless devices == 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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      action = hash.key?('action') ? hash['action'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (Device.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+
+      # Create object from extracted values.
+      DeviceResetRequest.new(account_name,
+                             action,
+                             devices)
+    end
+  end
+end

data/lib/verizon/models/device_service_information.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device service information.
+  class DeviceServiceInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ResponseCode and/or a message indicating success or failure of the
+    # request.
+    # @return [ApiResponseCode]
+    attr_accessor :response_type
+
+    # The International Mobile Equipment Identifier of the device.
+    # @return [String]
+    attr_accessor :imei
+
+    # Shows if Hyper Precise is enabled (true) or disabled (false).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :bullseye_enable
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response_type'] = 'responseType'
+      @_hash['imei'] = 'imei'
+      @_hash['bullseye_enable'] = 'BullseyeEnable'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(imei = nil,
+                   bullseye_enable = nil,
+                   response_type = SKIP)
+      @response_type = response_type unless response_type == SKIP
+      @imei = imei
+      @bullseye_enable = bullseye_enable
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      imei = hash.key?('imei') ? hash['imei'] : nil
+      bullseye_enable =
+        hash.key?('BullseyeEnable') ? hash['BullseyeEnable'] : nil
+      response_type = ApiResponseCode.from_hash(hash['responseType']) if hash['responseType']
+
+      # Create object from extracted values.
+      DeviceServiceInformation.new(imei,
+                                   bullseye_enable,
+                                   response_type)
+    end
+  end
+end