specs-sdk 1.3.0

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

data/lib/verizon/models/v3_license_summary.rb

@@ -0,0 +1,117 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Information for FOTA licenses assigned to devices.
+  class V3LicenseSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Total FOTA license count.
+    # @return [Integer]
+    attr_accessor :total_licenses
+
+    # Assigned FOTA license count.
+    # @return [Integer]
+    attr_accessor :assigned_licenses
+
+    # True if there are more devices to retrieve.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # Last seen device identifier.
+    # @return [String]
+    attr_accessor :last_seen_device_id
+
+    # Maximum page size.
+    # @return [Integer]
+    attr_accessor :max_page_size
+
+    # Device IMEI list.
+    # @return [Array[V3LicenseDevice]]
+    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['total_licenses'] = 'totalLicenses'
+      @_hash['assigned_licenses'] = 'assignedLicenses'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['last_seen_device_id'] = 'lastSeenDeviceId'
+      @_hash['max_page_size'] = 'maxPageSize'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_licenses
+        last_seen_device_id
+        device_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   assigned_licenses = nil,
+                   has_more_data = nil,
+                   max_page_size = nil,
+                   total_licenses = SKIP,
+                   last_seen_device_id = SKIP,
+                   device_list = SKIP)
+      @account_name = account_name
+      @total_licenses = total_licenses unless total_licenses == SKIP
+      @assigned_licenses = assigned_licenses
+      @has_more_data = has_more_data
+      @last_seen_device_id = last_seen_device_id unless last_seen_device_id == SKIP
+      @max_page_size = max_page_size
+      @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'] : nil
+      assigned_licenses =
+        hash.key?('assignedLicenses') ? hash['assignedLicenses'] : nil
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : nil
+      max_page_size = hash.key?('maxPageSize') ? hash['maxPageSize'] : nil
+      total_licenses = hash.key?('totalLicenses') ? hash['totalLicenses'] : 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 << (V3LicenseDevice.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = SKIP unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      V3LicenseSummary.new(account_name,
+                           assigned_licenses,
+                           has_more_data,
+                           max_page_size,
+                           total_licenses,
+                           last_seen_device_id,
+                           device_list)
+    end
+  end
+end

data/lib/verizon/models/v3_software_info.rb

@@ -0,0 +1,66 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Software information.
+  class V3SoftwareInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Software name.
+    # @return [String]
+    attr_accessor :name
+
+    # Software version.
+    # @return [String]
+    attr_accessor :version
+
+    # Upgrade time.
+    # @return [String]
+    attr_accessor :upgrade_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['version'] = 'version'
+      @_hash['upgrade_time'] = 'upgradeTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   version = nil,
+                   upgrade_time = nil)
+      @name = name
+      @version = version
+      @upgrade_time = upgrade_time
+    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
+      version = hash.key?('version') ? hash['version'] : nil
+      upgrade_time = hash.key?('upgradeTime') ? hash['upgradeTime'] : nil
+
+      # Create object from extracted values.
+      V3SoftwareInfo.new(name,
+                         version,
+                         upgrade_time)
+    end
+  end
+end

data/lib/verizon/models/v3_time_window.rb

@@ -0,0 +1,57 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Time window.
+  class V3TimeWindow < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Start hour in range [0..23], current hour >= startTime.
+    # @return [Integer]
+    attr_accessor :start_time
+
+    # End hour in range [1..24], current hour < endTime.
+    # @return [Integer]
+    attr_accessor :end_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_time'] = 'startTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_time = nil,
+                   end_time = nil)
+      @start_time = start_time
+      @end_time = end_time
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      start_time = hash.key?('startTime') ? hash['startTime'] : nil
+      end_time = hash.key?('endTime') ? hash['endTime'] : nil
+
+      # Create object from extracted values.
+      V3TimeWindow.new(start_time,
+                       end_time)
+    end
+  end
+end

data/lib/verizon/models/wnp_request_response.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Wireless network performance request response.
+  class WNPRequestResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Request id.
+    # @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.
+      WNPRequestResponse.new(request_id)
+    end
+  end
+end

data/lib/verizon/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/verizon/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end