sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/device_upload_request.rb

@@ -0,0 +1,90 @@
+# 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,76 @@
+# 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,70 @@
+# 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

data/lib/verizon/models/devices_consent_result.rb

@@ -0,0 +1,96 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DevicesConsentResult Model.
+  class DevicesConsentResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # Exclude all devices or not?
+    # @return [TrueClass | FalseClass]
+    attr_accessor :all_device
+
+    # Are there more devices to retrieve or not?
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # Total number of excluded devices in the account.
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Last update time.
+    # @return [String]
+    attr_accessor :update_time
+
+    # Device ID list.
+    # @return [Array[String]]
+    attr_accessor :exclusion
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['all_device'] = 'allDevice'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['total_count'] = 'totalCount'
+      @_hash['update_time'] = 'updateTime'
+      @_hash['exclusion'] = 'exclusion'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        all_device
+        has_more_data
+        total_count
+        update_time
+        exclusion
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, all_device = SKIP, has_more_data = SKIP,
+                   total_count = SKIP, update_time = SKIP, exclusion = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @all_device = all_device unless all_device == SKIP
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @total_count = total_count unless total_count == SKIP
+      @update_time = update_time unless update_time == SKIP
+      @exclusion = exclusion unless exclusion == 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
+      all_device = hash.key?('allDevice') ? hash['allDevice'] : SKIP
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
+      update_time = hash.key?('updateTime') ? hash['updateTime'] : SKIP
+      exclusion = hash.key?('exclusion') ? hash['exclusion'] : SKIP
+
+      # Create object from extracted values.
+      DevicesConsentResult.new(account_name,
+                               all_device,
+                               has_more_data,
+                               total_count,
+                               update_time,
+                               exclusion)
+    end
+  end
+end

data/lib/verizon/models/devices_protocol_enum.rb

@@ -0,0 +1,26 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Firmware protocol. Valid values include: LWM2M, OMADM, HTTP.
+  class DevicesProtocolEnum
+    DEVICES_PROTOCOL_ENUM = [
+      # TODO: Write general description for LW_M2M
+      LW_M2M = 'LWM2M'.freeze,
+
+      # TODO: Write general description for OMDADM
+      OMDADM = 'OMDADM'.freeze,
+
+      # TODO: Write general description for HTTP
+      HTTP = 'HTTP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DEVICES_PROTOCOL_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/diagnostic_observation_setting.rb

@@ -0,0 +1,79 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Diagnostic observation settings and attributes for a device.
+  class DiagnosticObservationSetting < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the billing account for which callback messages will be sent.
+    # Format: "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # Identifies a particular IoT device.
+    # @return [Device]
+    attr_accessor :device
+
+    # Streaming RF parameters for which you want to retrieve diagnostic
+    # settings.
+    # @return [Array[AttributeSetting]]
+    attr_accessor :attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['device'] = 'device'
+      @_hash['attributes'] = 'attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        device
+        attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, device = SKIP, attributes = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @device = device unless device == SKIP
+      @attributes = attributes unless attributes == 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
+      device = Device.from_hash(hash['device']) if hash['device']
+      # Parameter is an array, so we need to iterate through it
+      attributes = nil
+      unless hash['attributes'].nil?
+        attributes = []
+        hash['attributes'].each do |structure|
+          attributes << (AttributeSetting.from_hash(structure) if structure)
+        end
+      end
+
+      attributes = SKIP unless hash.key?('attributes')
+
+      # Create object from extracted values.
+      DiagnosticObservationSetting.new(account_name,
+                                       device,
+                                       attributes)
+    end
+  end
+end

data/lib/verizon/models/diagnostics_category.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Various types of information about the device, grouped into categories. Each
+  # category object contains the category name and a list of Extended Attribute
+  # objects as key-value pairs.
+  class DiagnosticsCategory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the category.
+    # @return [String]
+    attr_accessor :category_name
+
+    # A list of Extended Attribute objects as key-value pairs.
+    # @return [Array[CustomFields]]
+    attr_accessor :extended_attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['category_name'] = 'categoryName'
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category_name
+        extended_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(category_name = SKIP, extended_attributes = SKIP)
+      @category_name = category_name unless category_name == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == 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.
+      category_name = hash.key?('categoryName') ? hash['categoryName'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      extended_attributes = nil
+      unless hash['extendedAttributes'].nil?
+        extended_attributes = []
+        hash['extendedAttributes'].each do |structure|
+          extended_attributes << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extendedAttributes')
+
+      # Create object from extracted values.
+      DiagnosticsCategory.new(category_name,
+                              extended_attributes)
+    end
+  end
+end

data/lib/verizon/models/diagnostics_observation_result.rb

@@ -0,0 +1,71 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # A success response containing the current status of the request.
+  class DiagnosticsObservationResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction identifier.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Status of the request.
+    # @return [String]
+    attr_accessor :status
+
+    # The date and time of when this request was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'transactionID'
+      @_hash['status'] = 'status'
+      @_hash['created_on'] = 'createdOn'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_id = nil, status = nil, created_on = nil)
+      @transaction_id = transaction_id
+      @status = status
+      @created_on = created_on
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      transaction_id = hash.key?('transactionID') ? hash['transactionID'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      created_on = if hash.key?('createdOn')
+                     (DateTimeHelper.from_rfc3339(hash['createdOn']) if hash['createdOn'])
+                   end
+
+      # Create object from extracted values.
+      DiagnosticsObservationResult.new(transaction_id,
+                                       status,
+                                       created_on)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+  end
+end

data/lib/verizon/models/diagnostics_subscription.rb

@@ -0,0 +1,103 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Status of the diagnostic services subscription.
+  class DiagnosticsSubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####". An account name is usually
+    # numeric, and must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The date and time of when the subscription was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # The date and time of when the subscription was last updated.
+    # @return [DateTime]
+    attr_accessor :last_updated
+
+    # Number of licenses currently assigned to devices.
+    # @return [Integer]
+    attr_accessor :total_allowed
+
+    # Number of licenses currently used by the devices.
+    # @return [Integer]
+    attr_accessor :total_used
+
+    # Name of the SKU for the account.
+    # @return [String]
+    attr_accessor :sku_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['created_on'] = 'createdOn'
+      @_hash['last_updated'] = 'lastUpdated'
+      @_hash['total_allowed'] = 'totalAllowed'
+      @_hash['total_used'] = 'totalUsed'
+      @_hash['sku_name'] = 'skuName'
+      @_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, created_on = nil, last_updated = nil,
+                   total_allowed = nil, total_used = nil, sku_name = nil)
+      @account_name = account_name
+      @created_on = created_on
+      @last_updated = last_updated
+      @total_allowed = total_allowed
+      @total_used = total_used
+      @sku_name = sku_name
+    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
+      created_on = if hash.key?('createdOn')
+                     (DateTimeHelper.from_rfc3339(hash['createdOn']) if hash['createdOn'])
+                   end
+      last_updated = if hash.key?('lastUpdated')
+                       (DateTimeHelper.from_rfc3339(hash['lastUpdated']) if hash['lastUpdated'])
+                     end
+      total_allowed = hash.key?('totalAllowed') ? hash['totalAllowed'] : nil
+      total_used = hash.key?('totalUsed') ? hash['totalUsed'] : nil
+      sku_name = hash.key?('skuName') ? hash['skuName'] : nil
+
+      # Create object from extracted values.
+      DiagnosticsSubscription.new(account_name,
+                                  created_on,
+                                  last_updated,
+                                  total_allowed,
+                                  total_used,
+                                  sku_name)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    def to_custom_last_updated
+      DateTimeHelper.to_rfc3339(last_updated)
+    end
+  end
+end