specs-sdk 1.3.0

data/lib/verizon/models/device_list_query_result.rb

@@ -0,0 +1,91 @@
+# 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,75 @@
+# 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_location_callback.rb

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

data/lib/verizon/models/device_log.rb

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