sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/device_list_ip.rb

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

data/lib/verizon/models/device_list_query_item.rb

@@ -0,0 +1,118 @@
+# 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

data/lib/verizon/models/device_list_query_result.rb

@@ -0,0 +1,89 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # List of devices.
+  class DeviceListQueryResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # True if there are more devices to retrieve.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # If hasMoreData=true, the startIndex to use for the next request. 0 if
+    # hasMoreData=false.
+    # @return [Integer]
+    attr_accessor :last_seen_device_id
+
+    # The list of devices in the account.
+    # @return [Array[DeviceListQueryItem]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['last_seen_device_id'] = 'lastSeenDeviceId'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        has_more_data
+        last_seen_device_id
+        device_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, has_more_data = SKIP,
+                   last_seen_device_id = SKIP, device_list = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @last_seen_device_id = last_seen_device_id unless last_seen_device_id == SKIP
+      @device_list = device_list unless device_list == 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
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+      last_seen_device_id =
+        hash.key?('lastSeenDeviceId') ? hash['lastSeenDeviceId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      device_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (DeviceListQueryItem.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = SKIP unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      DeviceListQueryResult.new(account_name,
+                                has_more_data,
+                                last_seen_device_id,
+                                device_list)
+    end
+  end
+end

data/lib/verizon/models/device_list_result.rb

@@ -0,0 +1,73 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device list information.
+  class DeviceListResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account name.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Total device count.
+    # @return [Integer]
+    attr_accessor :device_count
+
+    # List of devices with id in IMEI.
+    # @return [Array[V3Device]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['device_count'] = 'deviceCount'
+      @_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(account_name = nil, device_count = nil, device_list = nil)
+      @account_name = account_name
+      @device_count = device_count
+      @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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      device_count = hash.key?('deviceCount') ? hash['deviceCount'] : nil
+      # Parameter is an array, so we need to iterate through it
+      device_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (V3Device.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      DeviceListResult.new(account_name,
+                           device_count,
+                           device_list)
+    end
+  end
+end

data/lib/verizon/models/device_list_with_service_address.rb

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

data/lib/verizon/models/device_list_with_service_address1.rb

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

data/lib/verizon/models/device_location_callback.rb

@@ -0,0 +1,56 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceLocationCallback Model.
+  class DeviceLocationCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the callback service.
+    # @return [CallbackServiceNameEnum]
+    attr_accessor :name
+
+    # The location of your callback listener.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, url = nil)
+      @name = name
+      @url = url
+    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
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # Create object from extracted values.
+      DeviceLocationCallback.new(name,
+                                 url)
+    end
+  end
+end

data/lib/verizon/models/device_location_subscription.rb

@@ -0,0 +1,78 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceLocationSubscription Model.
+  class DeviceLocationSubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # Location service license type.
+    # @return [String]
+    attr_accessor :loc_type
+
+    # The number of billable location requests allowed per billing cycle.
+    # @return [String]
+    attr_accessor :max_allowance
+
+    # Location service purchase time.
+    # @return [String]
+    attr_accessor :purchase_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['loc_type'] = 'locType'
+      @_hash['max_allowance'] = 'maxAllowance'
+      @_hash['purchase_time'] = 'purchaseTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        loc_type
+        max_allowance
+        purchase_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, loc_type = SKIP, max_allowance = SKIP,
+                   purchase_time = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @loc_type = loc_type unless loc_type == SKIP
+      @max_allowance = max_allowance unless max_allowance == SKIP
+      @purchase_time = purchase_time unless purchase_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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      loc_type = hash.key?('locType') ? hash['locType'] : SKIP
+      max_allowance = hash.key?('maxAllowance') ? hash['maxAllowance'] : SKIP
+      purchase_time = hash.key?('purchaseTime') ? hash['purchaseTime'] : SKIP
+
+      # Create object from extracted values.
+      DeviceLocationSubscription.new(account_name,
+                                     loc_type,
+                                     max_allowance,
+                                     purchase_time)
+    end
+  end
+end

data/lib/verizon/models/device_location_success_result.rb

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