sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/devices_consent_result.rb

@@ -0,0 +1,100 @@
+# 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,81 @@
+# 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,71 @@
+# 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,73 @@
+# 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,107 @@
+# 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

data/lib/verizon/models/download_time_window.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DownloadTimeWindow Model.
+  class DownloadTimeWindow < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI list.
+    # @return [String]
+    attr_accessor :start_time
+
+    # Device IMEI list.
+    # @return [String]
+    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
+      %w[
+        start_time
+        end_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_time = SKIP,
+                   end_time = SKIP)
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_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.
+      start_time = hash.key?('startTime') ? hash['startTime'] : SKIP
+      end_time = hash.key?('endTime') ? hash['endTime'] : SKIP
+
+      # Create object from extracted values.
+      DownloadTimeWindow.new(start_time,
+                             end_time)
+    end
+  end
+end

data/lib/verizon/models/edge_discovery_result_data.rb

@@ -0,0 +1,52 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # For cases where user input exceeds the boundary values an additional 'data'
+  # key will be returned with a relevant description.
+  class EdgeDiscoveryResultData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :additional_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['additional_message'] = 'additionalMessage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        additional_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(additional_message = SKIP)
+      @additional_message = additional_message unless additional_message == 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.
+      additional_message =
+        hash.key?('additionalMessage') ? hash['additionalMessage'] : SKIP
+
+      # Create object from extracted values.
+      EdgeDiscoveryResultData.new(additional_message)
+    end
+  end
+end

data/lib/verizon/models/enable_promo_exp.rb

@@ -0,0 +1,51 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # EnablePromoExp Model.
+  class EnablePromoExp < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_promo_exp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['enable_promo_exp'] = 'enablePromoExp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        enable_promo_exp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(enable_promo_exp = SKIP)
+      @enable_promo_exp = enable_promo_exp unless enable_promo_exp == 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.
+      enable_promo_exp =
+        hash.key?('enablePromoExp') ? hash['enablePromoExp'] : SKIP
+
+      # Create object from extracted values.
+      EnablePromoExp.new(enable_promo_exp)
+    end
+  end
+end

data/lib/verizon/models/enable_promo_exp1.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # EnablePromoExp1 Model.
+  class EnablePromoExp1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        key
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = SKIP,
+                   value = SKIP)
+      @key = key unless key == SKIP
+      @value = value unless value == 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.
+      key = hash.key?('key') ? hash['key'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      EnablePromoExp1.new(key,
+                          value)
+    end
+  end
+end