sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/device_service_request.rb

@@ -0,0 +1,58 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device information.
+  class DeviceServiceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # International Mobile Equipment Identifier. The unique ID of a device.
+    # @return [String]
+    attr_accessor :imei
+
+    # Set to Enable (true) or Disable (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['imei'] = 'imei'
+      @_hash['bullseye_enable'] = 'BullseyeEnable'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(imei = nil,
+                   bullseye_enable = nil)
+      @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
+
+      # Create object from extracted values.
+      DeviceServiceRequest.new(imei,
+                               bullseye_enable)
+    end
+  end
+end

data/lib/verizon/models/device_software_upgrade.rb

@@ -0,0 +1,104 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Array of software upgrade objects with the specified status.
+  class DeviceSoftwareUpgrade < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device identifier.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Upgrade identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Software name.
+    # @return [String]
+    attr_accessor :software_name
+
+    # Software upgrade start date.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # Software upgrade status.
+    # @return [String]
+    attr_accessor :status
+
+    # Software upgrade result reason.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['id'] = 'id'
+      @_hash['account_name'] = 'accountName'
+      @_hash['software_name'] = 'softwareName'
+      @_hash['start_date'] = 'startDate'
+      @_hash['status'] = 'status'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        software_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   id = nil,
+                   account_name = nil,
+                   start_date = nil,
+                   status = nil,
+                   reason = nil,
+                   software_name = SKIP)
+      @device_id = device_id
+      @id = id
+      @account_name = account_name
+      @software_name = software_name unless software_name == SKIP
+      @start_date = start_date
+      @status = status
+      @reason = reason
+    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
+      id = hash.key?('id') ? hash['id'] : nil
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      start_date = hash.key?('startDate') ? hash['startDate'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      software_name = hash.key?('softwareName') ? hash['softwareName'] : SKIP
+
+      # Create object from extracted values.
+      DeviceSoftwareUpgrade.new(device_id,
+                                id,
+                                account_name,
+                                start_date,
+                                status,
+                                reason,
+                                software_name)
+    end
+  end
+end

data/lib/verizon/models/device_suspension_status_request.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to return service suspension information about one or more devices.
+  class DeviceSuspensionStatusRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The devices that you want to include in the request, specified by device
+    # identifier. You only need to provide one identifier per device.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # Filter for devices without account.
+    # @return [DeviceFilterWithoutAccount]
+    attr_accessor :filter
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['filter'] = 'filter'
+      @_hash['account_name'] = 'accountName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+        filter
+        account_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = SKIP,
+                   filter = SKIP,
+                   account_name = SKIP)
+      @device_ids = device_ids unless device_ids == SKIP
+      @filter = filter unless filter == SKIP
+      @account_name = account_name unless account_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
+      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')
+      filter = DeviceFilterWithoutAccount.from_hash(hash['filter']) if hash['filter']
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+
+      # Create object from extracted values.
+      DeviceSuspensionStatusRequest.new(device_ids,
+                                        filter,
+                                        account_name)
+    end
+  end
+end

data/lib/verizon/models/device_upgrade_history.rb

@@ -0,0 +1,131 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Firmware upgrade information.
+  class DeviceUpgradeHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # The unique identifier for the upgrade.
+    # @return [String]
+    attr_accessor :id
+
+    # The name (number) of the billing account that the device belongs to.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The firmware version that was on the device before the upgrade.
+    # @return [String]
+    attr_accessor :firmware_from
+
+    # The name of the firmware version that was on the device after the upgrade.
+    # @return [String]
+    attr_accessor :firmware_to
+
+    # The date of the upgrade.
+    # @return [String]
+    attr_accessor :start_date
+
+    # The date and time that the upgrade actually started for this device.
+    # @return [String]
+    attr_accessor :upgrade_start_time
+
+    # The status of the upgrade for this device.
+    # @return [String]
+    attr_accessor :status
+
+    # More information about the status.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['id'] = 'id'
+      @_hash['account_name'] = 'accountName'
+      @_hash['firmware_from'] = 'firmwareFrom'
+      @_hash['firmware_to'] = 'firmwareTo'
+      @_hash['start_date'] = 'startDate'
+      @_hash['upgrade_start_time'] = 'upgradeStartTime'
+      @_hash['status'] = 'status'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_id
+        id
+        account_name
+        firmware_from
+        firmware_to
+        start_date
+        upgrade_start_time
+        status
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP,
+                   id = SKIP,
+                   account_name = SKIP,
+                   firmware_from = SKIP,
+                   firmware_to = SKIP,
+                   start_date = SKIP,
+                   upgrade_start_time = SKIP,
+                   status = SKIP,
+                   reason = SKIP)
+      @device_id = device_id unless device_id == SKIP
+      @id = id unless id == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @firmware_from = firmware_from unless firmware_from == SKIP
+      @firmware_to = firmware_to unless firmware_to == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @upgrade_start_time = upgrade_start_time unless upgrade_start_time == SKIP
+      @status = status unless status == SKIP
+      @reason = reason unless reason == 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
+      id = hash.key?('id') ? hash['id'] : SKIP
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      firmware_from = hash.key?('firmwareFrom') ? hash['firmwareFrom'] : SKIP
+      firmware_to = hash.key?('firmwareTo') ? hash['firmwareTo'] : SKIP
+      start_date = hash.key?('startDate') ? hash['startDate'] : SKIP
+      upgrade_start_time =
+        hash.key?('upgradeStartTime') ? hash['upgradeStartTime'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      DeviceUpgradeHistory.new(device_id,
+                               id,
+                               account_name,
+                               firmware_from,
+                               firmware_to,
+                               start_date,
+                               upgrade_start_time,
+                               status,
+                               reason)
+    end
+  end
+end

data/lib/verizon/models/device_upload_request.rb

@@ -0,0 +1,93 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceUploadRequest Model.
+  class DeviceUploadRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [Array[DeviceList]]
+    attr_accessor :devices
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email_address
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :device_sku
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :upload_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['devices'] = 'devices'
+      @_hash['email_address'] = 'emailAddress'
+      @_hash['device_sku'] = 'deviceSku'
+      @_hash['upload_type'] = 'uploadType'
+      @_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,
+                   devices = nil,
+                   email_address = nil,
+                   device_sku = nil,
+                   upload_type = nil)
+      @account_name = account_name
+      @devices = devices
+      @email_address = email_address
+      @device_sku = device_sku
+      @upload_type = upload_type
+    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
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (DeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = nil unless hash.key?('devices')
+      email_address = hash.key?('emailAddress') ? hash['emailAddress'] : nil
+      device_sku = hash.key?('deviceSku') ? hash['deviceSku'] : nil
+      upload_type = hash.key?('uploadType') ? hash['uploadType'] : nil
+
+      # Create object from extracted values.
+      DeviceUploadRequest.new(account_name,
+                              devices,
+                              email_address,
+                              device_sku,
+                              upload_type)
+    end
+  end
+end

data/lib/verizon/models/device_usage_list_request.rb

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

data/lib/verizon/models/device_usage_list_result.rb

@@ -0,0 +1,71 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to return the daily network data usage of a single device during a
+  # specified time period.
+  class DeviceUsageListResult < 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
+
+    # Placeholder.
+    # @return [Array[Usage]]
+    attr_accessor :usage_history
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['usage_history'] = 'usageHistory'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        has_more_data
+        usage_history
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(has_more_data = SKIP,
+                   usage_history = SKIP)
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @usage_history = usage_history unless usage_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
+      usage_history = nil
+      unless hash['usageHistory'].nil?
+        usage_history = []
+        hash['usageHistory'].each do |structure|
+          usage_history << (Usage.from_hash(structure) if structure)
+        end
+      end
+
+      usage_history = SKIP unless hash.key?('usageHistory')
+
+      # Create object from extracted values.
+      DeviceUsageListResult.new(has_more_data,
+                                usage_history)
+    end
+  end
+end