sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/v3_device.rb

@@ -0,0 +1,248 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Device information.
+  class V3Device < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Success or failure.
+    # @return [String]
+    attr_accessor :request_status
+
+    # Success or failure.
+    # @return [String]
+    attr_accessor :result_reason
+
+    # MDN.
+    # @return [String]
+    attr_accessor :mdn
+
+    # Device model.
+    # @return [String]
+    attr_accessor :model
+
+    # Device make.
+    # @return [String]
+    attr_accessor :make
+
+    # Device firmware version.
+    # @return [String]
+    attr_accessor :firmware
+
+    # Value=true if the device software can be upgraded over the air using the
+    # Software Management Services API.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :fota_eligible
+
+    # Device status.
+    # @return [String]
+    attr_accessor :status
+
+    # License assigned device.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :license_assigned
+
+    # Firmware protocol. Valid values include: LWM2M, OMADM, HTTP or NONE.
+    # @return [String]
+    attr_accessor :protocol
+
+    # List of sofware.
+    # @return [Array[V3SoftwareInfo]]
+    attr_accessor :software_list
+
+    # List of files.
+    # @return [Array[V3SoftwareInfo]]
+    attr_accessor :file_list
+
+    # The date and time of when the device is created.
+    # @return [String]
+    attr_accessor :create_time
+
+    # The date and time of when the device firmware or software is updated.
+    # @return [String]
+    attr_accessor :status_time
+
+    # The date and time of when the device is updated.
+    # @return [String]
+    attr_accessor :update_time
+
+    # The date and time of when the device is refreshed.
+    # @return [String]
+    attr_accessor :refresh_time
+
+    # The date and time of when the device reachability is checked.
+    # @return [DateTime]
+    attr_accessor :last_connection_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['request_status'] = 'requestStatus'
+      @_hash['result_reason'] = 'resultReason'
+      @_hash['mdn'] = 'mdn'
+      @_hash['model'] = 'model'
+      @_hash['make'] = 'make'
+      @_hash['firmware'] = 'firmware'
+      @_hash['fota_eligible'] = 'fotaEligible'
+      @_hash['status'] = 'status'
+      @_hash['license_assigned'] = 'licenseAssigned'
+      @_hash['protocol'] = 'protocol'
+      @_hash['software_list'] = 'softwareList'
+      @_hash['file_list'] = 'fileList'
+      @_hash['create_time'] = 'createTime'
+      @_hash['status_time'] = 'statusTime'
+      @_hash['update_time'] = 'updateTime'
+      @_hash['refresh_time'] = 'refreshTime'
+      @_hash['last_connection_time'] = 'lastConnectionTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_status
+        result_reason
+        mdn
+        model
+        make
+        firmware
+        fota_eligible
+        status
+        license_assigned
+        protocol
+        software_list
+        file_list
+        create_time
+        status_time
+        update_time
+        refresh_time
+        last_connection_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   request_status = SKIP,
+                   result_reason = SKIP,
+                   mdn = SKIP,
+                   model = SKIP,
+                   make = SKIP,
+                   firmware = SKIP,
+                   fota_eligible = SKIP,
+                   status = SKIP,
+                   license_assigned = SKIP,
+                   protocol = SKIP,
+                   software_list = SKIP,
+                   file_list = SKIP,
+                   create_time = SKIP,
+                   status_time = SKIP,
+                   update_time = SKIP,
+                   refresh_time = SKIP,
+                   last_connection_time = SKIP)
+      @device_id = device_id
+      @request_status = request_status unless request_status == SKIP
+      @result_reason = result_reason unless result_reason == 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
+      @status = status unless status == SKIP
+      @license_assigned = license_assigned unless license_assigned == SKIP
+      @protocol = protocol unless protocol == SKIP
+      @software_list = software_list unless software_list == SKIP
+      @file_list = file_list unless file_list == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @status_time = status_time unless status_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+      @refresh_time = refresh_time unless refresh_time == SKIP
+      @last_connection_time = last_connection_time unless last_connection_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'] : nil
+      request_status = hash.key?('requestStatus') ? hash['requestStatus'] : SKIP
+      result_reason = hash.key?('resultReason') ? hash['resultReason'] : 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
+      status = hash.key?('status') ? hash['status'] : SKIP
+      license_assigned =
+        hash.key?('licenseAssigned') ? hash['licenseAssigned'] : SKIP
+      protocol = hash.key?('protocol') ? hash['protocol'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      software_list = nil
+      unless hash['softwareList'].nil?
+        software_list = []
+        hash['softwareList'].each do |structure|
+          software_list << (V3SoftwareInfo.from_hash(structure) if structure)
+        end
+      end
+
+      software_list = SKIP unless hash.key?('softwareList')
+      # Parameter is an array, so we need to iterate through it
+      file_list = nil
+      unless hash['fileList'].nil?
+        file_list = []
+        hash['fileList'].each do |structure|
+          file_list << (V3SoftwareInfo.from_hash(structure) if structure)
+        end
+      end
+
+      file_list = SKIP unless hash.key?('fileList')
+      create_time = hash.key?('createTime') ? hash['createTime'] : SKIP
+      status_time = hash.key?('statusTime') ? hash['statusTime'] : SKIP
+      update_time = hash.key?('updateTime') ? hash['updateTime'] : SKIP
+      refresh_time = hash.key?('refreshTime') ? hash['refreshTime'] : SKIP
+      last_connection_time = if hash.key?('lastConnectionTime')
+                               (DateTimeHelper.from_rfc3339(hash['lastConnectionTime']) if hash['lastConnectionTime'])
+                             else
+                               SKIP
+                             end
+
+      # Create object from extracted values.
+      V3Device.new(device_id,
+                   request_status,
+                   result_reason,
+                   mdn,
+                   model,
+                   make,
+                   firmware,
+                   fota_eligible,
+                   status,
+                   license_assigned,
+                   protocol,
+                   software_list,
+                   file_list,
+                   create_time,
+                   status_time,
+                   update_time,
+                   refresh_time,
+                   last_connection_time)
+    end
+
+    def to_custom_last_connection_time
+      DateTimeHelper.to_rfc3339(last_connection_time)
+    end
+  end
+end

data/lib/verizon/models/v3_device_list_item.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device changed.
+  class V3DeviceListItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Success or failure.
+    # @return [String]
+    attr_accessor :status
+
+    # 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['status'] = 'status'
+      @_hash['reason'] = 'Reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_id
+        status
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP,
+                   status = SKIP,
+                   reason = SKIP)
+      @device_id = device_id unless device_id == 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
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason = hash.key?('Reason') ? hash['Reason'] : SKIP
+
+      # Create object from extracted values.
+      V3DeviceListItem.new(device_id,
+                           status,
+                           reason)
+    end
+  end
+end

data/lib/verizon/models/v3_device_status.rb

@@ -0,0 +1,123 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Device status.
+  class V3DeviceStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Success or failure.
+    # @return [String]
+    attr_accessor :status
+
+    # Result reason.
+    # @return [String]
+    attr_accessor :result_reason
+
+    # Updated Time.
+    # @return [DateTime]
+    attr_accessor :updated_time
+
+    # The most recent attempt time.
+    # @return [DateTime]
+    attr_accessor :recent_attempt_time
+
+    # Next attempt time.
+    # @return [DateTime]
+    attr_accessor :next_attempt_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['status'] = 'status'
+      @_hash['result_reason'] = 'resultReason'
+      @_hash['updated_time'] = 'updatedTime'
+      @_hash['recent_attempt_time'] = 'recentAttemptTime'
+      @_hash['next_attempt_time'] = 'nextAttemptTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        result_reason
+        updated_time
+        recent_attempt_time
+        next_attempt_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   status = nil,
+                   result_reason = SKIP,
+                   updated_time = SKIP,
+                   recent_attempt_time = SKIP,
+                   next_attempt_time = SKIP)
+      @device_id = device_id
+      @status = status
+      @result_reason = result_reason unless result_reason == SKIP
+      @updated_time = updated_time unless updated_time == SKIP
+      @recent_attempt_time = recent_attempt_time unless recent_attempt_time == SKIP
+      @next_attempt_time = next_attempt_time unless next_attempt_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'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      result_reason = hash.key?('resultReason') ? hash['resultReason'] : SKIP
+      updated_time = if hash.key?('updatedTime')
+                       (DateTimeHelper.from_rfc3339(hash['updatedTime']) if hash['updatedTime'])
+                     else
+                       SKIP
+                     end
+      recent_attempt_time = if hash.key?('recentAttemptTime')
+                              (DateTimeHelper.from_rfc3339(hash['recentAttemptTime']) if hash['recentAttemptTime'])
+                            else
+                              SKIP
+                            end
+      next_attempt_time = if hash.key?('nextAttemptTime')
+                            (DateTimeHelper.from_rfc3339(hash['nextAttemptTime']) if hash['nextAttemptTime'])
+                          else
+                            SKIP
+                          end
+
+      # Create object from extracted values.
+      V3DeviceStatus.new(device_id,
+                         status,
+                         result_reason,
+                         updated_time,
+                         recent_attempt_time,
+                         next_attempt_time)
+    end
+
+    def to_custom_updated_time
+      DateTimeHelper.to_rfc3339(updated_time)
+    end
+
+    def to_custom_recent_attempt_time
+      DateTimeHelper.to_rfc3339(recent_attempt_time)
+    end
+
+    def to_custom_next_attempt_time
+      DateTimeHelper.to_rfc3339(next_attempt_time)
+    end
+  end
+end

data/lib/verizon/models/v3_license_assigned_removed_result.rb

@@ -0,0 +1,84 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # License assignment/removal response.
+  class V3LicenseAssignedRemovedResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account name.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Total license count.
+    # @return [Integer]
+    attr_accessor :lic_count
+
+    # Assigned license count.
+    # @return [Integer]
+    attr_accessor :lic_used_count
+
+    # List of devices with id in IMEI.
+    # @return [Array[V3DeviceStatus]]
+    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['lic_count'] = 'licCount'
+      @_hash['lic_used_count'] = 'licUsedCount'
+      @_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,
+                   lic_count = nil,
+                   lic_used_count = nil,
+                   device_list = nil)
+      @account_name = account_name
+      @lic_count = lic_count
+      @lic_used_count = lic_used_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
+      lic_count = hash.key?('licCount') ? hash['licCount'] : nil
+      lic_used_count = hash.key?('licUsedCount') ? hash['licUsedCount'] : 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 << (V3DeviceStatus.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      V3LicenseAssignedRemovedResult.new(account_name,
+                                         lic_count,
+                                         lic_used_count,
+                                         device_list)
+    end
+  end
+end

data/lib/verizon/models/v3_license_device.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device IMEI.
+  class V3LicenseDevice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # License assignment time.
+    # @return [String]
+    attr_accessor :assignment_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['assignment_time'] = 'assignmentTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        assignment_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   assignment_time = SKIP)
+      @device_id = device_id
+      @assignment_time = assignment_time unless assignment_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'] : nil
+      assignment_time =
+        hash.key?('assignmentTime') ? hash['assignmentTime'] : SKIP
+
+      # Create object from extracted values.
+      V3LicenseDevice.new(device_id,
+                          assignment_time)
+    end
+  end
+end

data/lib/verizon/models/v3_license_imei.rb

@@ -0,0 +1,48 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # List of devices.
+  class V3LicenseIMEI < 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.
+      V3LicenseIMEI.new(device_list)
+    end
+  end
+end