sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/device_log.rb

@@ -0,0 +1,100 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Device logging information.
+  class DeviceLog < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Time of log.
+    # @return [DateTime]
+    attr_accessor :log_time
+
+    # Log type (one of SoftwareUpdate, Event, UserNotification, AgentService,
+    # Wireless, WirelessWeb, MobileBroadbandModem, WindowsMDM).
+    # @return [String]
+    attr_accessor :log_type
+
+    # Event log.
+    # @return [String]
+    attr_accessor :event_log
+
+    # Base64-encoded contents of binary log file.
+    # @return [String]
+    attr_accessor :binary_log_file_base64
+
+    # File name of binary log file.
+    # @return [String]
+    attr_accessor :binary_log_filename
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['log_time'] = 'logTime'
+      @_hash['log_type'] = 'logType'
+      @_hash['event_log'] = 'eventLog'
+      @_hash['binary_log_file_base64'] = 'binaryLogFileBase64'
+      @_hash['binary_log_filename'] = 'binaryLogFilename'
+      @_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, log_time = nil, log_type = nil,
+                   event_log = nil, binary_log_file_base64 = nil,
+                   binary_log_filename = nil)
+      @device_id = device_id
+      @log_time = log_time
+      @log_type = log_type
+      @event_log = event_log
+      @binary_log_file_base64 = binary_log_file_base64
+      @binary_log_filename = binary_log_filename
+    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'] : nil
+      log_time = if hash.key?('logTime')
+                   (DateTimeHelper.from_rfc3339(hash['logTime']) if hash['logTime'])
+                 end
+      log_type = hash.key?('logType') ? hash['logType'] : nil
+      event_log = hash.key?('eventLog') ? hash['eventLog'] : nil
+      binary_log_file_base64 =
+        hash.key?('binaryLogFileBase64') ? hash['binaryLogFileBase64'] : nil
+      binary_log_filename =
+        hash.key?('binaryLogFilename') ? hash['binaryLogFilename'] : nil
+
+      # Create object from extracted values.
+      DeviceLog.new(device_id,
+                    log_time,
+                    log_type,
+                    event_log,
+                    binary_log_file_base64,
+                    binary_log_filename)
+    end
+
+    def to_custom_log_time
+      DateTimeHelper.to_rfc3339(log_time)
+    end
+  end
+end

data/lib/verizon/models/device_logging_request.rb

@@ -0,0 +1,48 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device logging information.
+  class DeviceLoggingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of device IMEI identifiers.
+    # @return [Array[String]]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = nil)
+      @device_ids = device_ids
+    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_ids = hash.key?('deviceIds') ? hash['deviceIds'] : nil
+
+      # Create object from extracted values.
+      DeviceLoggingRequest.new(device_ids)
+    end
+  end
+end

data/lib/verizon/models/device_logging_status.rb

@@ -0,0 +1,56 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device logging status information.
+  class DeviceLoggingStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # The date when device logging expires.
+    # @return [Date]
+    attr_accessor :expiry_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['expiry_date'] = 'expiryDate'
+      @_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, expiry_date = nil)
+      @device_id = device_id
+      @expiry_date = expiry_date
+    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'] : nil
+      expiry_date = hash.key?('expiryDate') ? hash['expiryDate'] : nil
+
+      # Create object from extracted values.
+      DeviceLoggingStatus.new(device_id,
+                              expiry_date)
+    end
+  end
+end

data/lib/verizon/models/device_management_result.rb

@@ -0,0 +1,52 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to activate service for one or more devices so that they can send
+  # and receive data.
+  class DeviceManagementResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique string that associates the request with the results that are sent
+    # via a callback service.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'requestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP)
+      @request_id = request_id unless request_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.
+      request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+
+      # Create object from extracted values.
+      DeviceManagementResult.new(request_id)
+    end
+  end
+end

data/lib/verizon/models/device_mismatch_list_request.rb

@@ -0,0 +1,90 @@
+# 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,116 @@
+# 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,77 @@
+# 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,59 @@
+# 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