sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/search_sensor_history_response_list.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A success response includes an array of all matching events.
+  class SearchSensorHistoryResponseList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[SearchDeviceResponse]]
+    attr_accessor :search_sensor_history
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['search_sensor_history'] = 'SearchSensorHistory'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        search_sensor_history
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(search_sensor_history = SKIP)
+      @search_sensor_history = search_sensor_history unless search_sensor_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.
+      # Parameter is an array, so we need to iterate through it
+      search_sensor_history = nil
+      unless hash['SearchSensorHistory'].nil?
+        search_sensor_history = []
+        hash['SearchSensorHistory'].each do |structure|
+          search_sensor_history << (SearchDeviceResponse.from_hash(structure) if structure)
+        end
+      end
+
+      search_sensor_history = SKIP unless hash.key?('SearchSensorHistory')
+
+      # Create object from extracted values.
+      SearchSensorHistoryResponseList.new(search_sensor_history)
+    end
+  end
+end

data/lib/verizon/models/security_subscription.rb

@@ -0,0 +1,114 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Subscription of the device.
+  class SecuritySubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Attributes of the subscription.
+    # @return [Array[ExtendedAttributes]]
+    attr_accessor :extended_attributes
+
+    # The total number of licenses for this license type that are assigned to
+    # device SIMs.
+    # @return [Integer]
+    attr_accessor :license_assigned
+
+    # The total number of licenses for this license type that are available to
+    # assign to device SIMs.
+    # @return [Integer]
+    attr_accessor :license_available
+
+    # The total number of licenses purchased for the license type.
+    # @return [Integer]
+    attr_accessor :license_purchased
+
+    # The license type associated with the skuNumber.
+    # @return [String]
+    attr_accessor :license_type
+
+    # The skuNumber that identifies the license type.
+    # @return [String]
+    attr_accessor :sku_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash['license_assigned'] = 'licenseAssigned'
+      @_hash['license_available'] = 'licenseAvailable'
+      @_hash['license_purchased'] = 'licensePurchased'
+      @_hash['license_type'] = 'licenseType'
+      @_hash['sku_number'] = 'skuNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        extended_attributes
+        license_assigned
+        license_available
+        license_purchased
+        license_type
+        sku_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(extended_attributes = SKIP,
+                   license_assigned = SKIP,
+                   license_available = SKIP,
+                   license_purchased = SKIP,
+                   license_type = SKIP,
+                   sku_number = SKIP)
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @license_assigned = license_assigned unless license_assigned == SKIP
+      @license_available = license_available unless license_available == SKIP
+      @license_purchased = license_purchased unless license_purchased == SKIP
+      @license_type = license_type unless license_type == SKIP
+      @sku_number = sku_number unless sku_number == 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.
+      # 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 << (ExtendedAttributes.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extendedAttributes')
+      license_assigned =
+        hash.key?('licenseAssigned') ? hash['licenseAssigned'] : SKIP
+      license_available =
+        hash.key?('licenseAvailable') ? hash['licenseAvailable'] : SKIP
+      license_purchased =
+        hash.key?('licensePurchased') ? hash['licensePurchased'] : SKIP
+      license_type = hash.key?('licenseType') ? hash['licenseType'] : SKIP
+      sku_number = hash.key?('skuNumber') ? hash['skuNumber'] : SKIP
+
+      # Create object from extracted values.
+      SecuritySubscription.new(extended_attributes,
+                               license_assigned,
+                               license_available,
+                               license_purchased,
+                               license_type,
+                               sku_number)
+    end
+  end
+end

data/lib/verizon/models/security_subscription_request.rb

@@ -0,0 +1,67 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request for a subscription.
+  class SecuritySubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The Stock Keeping Unit (SKU). Valid skuNumbers for SIM-Secure for IoT
+    # are:SIMSec-IoT-Lt”. (Lifetime) Once a license is assigned to a SIM, the
+    # SIM-Secure feature is enabled for the life of the
+    # SIM.“TS-BUNDLE-KTO-SIMSEC-MRC”. (Bundle) The SIM-Secure Flex license can
+    # be assigned to or removed from a SIM at any time. This SKU is bundled with
+    # other ThingSpace Services.*“SIMSec-IoT”. (Flex) The SIM-Secure Flex
+    # license can be assigned to or removed from a SIM at any time. This SKU is
+    # purchased a la carte.
+    # @return [String]
+    attr_accessor :sku_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['sku_number'] = 'skuNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        sku_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   sku_number = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @sku_number = sku_number unless sku_number == 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
+      sku_number = hash.key?('skuNumber') ? hash['skuNumber'] : SKIP
+
+      # Create object from extracted values.
+      SecuritySubscriptionRequest.new(account_name,
+                                      sku_number)
+    end
+  end
+end

data/lib/verizon/models/security_subscription_result.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response for a subscription request.
+  class SecuritySubscriptionResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The list of SKU numbers and counts for each license type specified in the
+    # request.
+    # @return [Array[SecuritySubscription]]
+    attr_accessor :subscription_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['subscription_list'] = 'subscriptionList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        subscription_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   subscription_list = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @subscription_list = subscription_list unless subscription_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
+      # Parameter is an array, so we need to iterate through it
+      subscription_list = nil
+      unless hash['subscriptionList'].nil?
+        subscription_list = []
+        hash['subscriptionList'].each do |structure|
+          subscription_list << (SecuritySubscription.from_hash(structure) if structure)
+        end
+      end
+
+      subscription_list = SKIP unless hash.key?('subscriptionList')
+
+      # Create object from extracted values.
+      SecuritySubscriptionResult.new(account_name,
+                                     subscription_list)
+    end
+  end
+end

data/lib/verizon/models/security_success_result.rb

@@ -0,0 +1,54 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Success response.
+  class SecuritySuccessResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique string that associates the request with the results that are sent
+    # via a callback message.The ThingSpace Platform sends a separate callback
+    # message for each device that matches the request criteria, indicating
+    # whether the operation succeeded for that device and containing any
+    # requested information. All callback messages will have the same requestId.
+    # @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.
+      SecuritySuccessResult.new(request_id)
+    end
+  end
+end

data/lib/verizon/models/sensitivity_parameters.rb

@@ -0,0 +1,86 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Details for sensitivity parameters.
+  class SensitivityParameters < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The maximum value of the threshold in the units being measured.
+    # @return [Float]
+    attr_accessor :abnormal_max_value
+
+    # If abnormal values are being monitored.<br />true - Monitor for abnormal
+    # values<br />false - Do not monitor for abnormal values.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_abnormal
+
+    # If very abnormal values are being monitored.<br />true - Monitor for very
+    # abnormal values<br />false - Do not monitor for very abnormal values.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_very_abnormal
+
+    # The maximum value of the threshold in the units being measured.
+    # @return [Float]
+    attr_accessor :very_abnormal_max_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['abnormal_max_value'] = 'abnormalMaxValue'
+      @_hash['enable_abnormal'] = 'enableAbnormal'
+      @_hash['enable_very_abnormal'] = 'enableVeryAbnormal'
+      @_hash['very_abnormal_max_value'] = 'veryAbnormalMaxValue'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        abnormal_max_value
+        enable_abnormal
+        enable_very_abnormal
+        very_abnormal_max_value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(abnormal_max_value = SKIP,
+                   enable_abnormal = SKIP,
+                   enable_very_abnormal = SKIP,
+                   very_abnormal_max_value = SKIP)
+      @abnormal_max_value = abnormal_max_value unless abnormal_max_value == SKIP
+      @enable_abnormal = enable_abnormal unless enable_abnormal == SKIP
+      @enable_very_abnormal = enable_very_abnormal unless enable_very_abnormal == SKIP
+      @very_abnormal_max_value = very_abnormal_max_value unless very_abnormal_max_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.
+      abnormal_max_value =
+        hash.key?('abnormalMaxValue') ? hash['abnormalMaxValue'] : SKIP
+      enable_abnormal =
+        hash.key?('enableAbnormal') ? hash['enableAbnormal'] : SKIP
+      enable_very_abnormal =
+        hash.key?('enableVeryAbnormal') ? hash['enableVeryAbnormal'] : SKIP
+      very_abnormal_max_value =
+        hash.key?('veryAbnormalMaxValue') ? hash['veryAbnormalMaxValue'] : SKIP
+
+      # Create object from extracted values.
+      SensitivityParameters.new(abnormal_max_value,
+                                enable_abnormal,
+                                enable_very_abnormal,
+                                very_abnormal_max_value)
+    end
+  end
+end

data/lib/verizon/models/service_name_enum.rb

@@ -0,0 +1,23 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Service name
+  class ServiceNameEnum
+    SERVICE_NAME_ENUM = [
+      # TODO: Write general description for LOCATION
+      LOCATION = 'Location'.freeze,
+
+      # TODO: Write general description for FOTA
+      FOTA = 'fota'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SERVICE_NAME_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/service_plan.rb

@@ -0,0 +1,103 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Details of the service plan.
+  class ServicePlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The code that is used by the carrier for the service plan.
+    # @return [String]
+    attr_accessor :carrier_service_plan_code
+
+    # The code of the service plan, which may not be the same as the name.
+    # @return [String]
+    attr_accessor :code
+
+    # Any extended attributes for the service plan, as Key and Value pairs.
+    # @return [Array[CustomFields]]
+    attr_accessor :extended_attributes
+
+    # The name of the service plan.
+    # @return [String]
+    attr_accessor :name
+
+    # The size of the service plan in kilobytes.
+    # @return [Integer]
+    attr_accessor :size_kb
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_service_plan_code'] = 'carrierServicePlanCode'
+      @_hash['code'] = 'code'
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash['name'] = 'name'
+      @_hash['size_kb'] = 'sizeKb'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_service_plan_code
+        code
+        extended_attributes
+        name
+        size_kb
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(carrier_service_plan_code = SKIP,
+                   code = SKIP,
+                   extended_attributes = SKIP,
+                   name = SKIP,
+                   size_kb = SKIP)
+      unless carrier_service_plan_code == SKIP
+        @carrier_service_plan_code =
+          carrier_service_plan_code
+      end
+      @code = code unless code == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @name = name unless name == SKIP
+      @size_kb = size_kb unless size_kb == 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.
+      carrier_service_plan_code =
+        hash.key?('carrierServicePlanCode') ? hash['carrierServicePlanCode'] : SKIP
+      code = hash.key?('code') ? hash['code'] : 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')
+      name = hash.key?('name') ? hash['name'] : SKIP
+      size_kb = hash.key?('sizeKb') ? hash['sizeKb'] : SKIP
+
+      # Create object from extracted values.
+      ServicePlan.new(carrier_service_plan_code,
+                      code,
+                      extended_attributes,
+                      name,
+                      size_kb)
+    end
+  end
+end

data/lib/verizon/models/service_plan_trigger_attribute.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Key service plan trigger attribute.
+  class ServicePlanTriggerAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ServicePlan name will be listed here.
+    # @return [String]
+    attr_accessor :key
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        key
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = SKIP)
+      @key = key unless key == 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
+
+      # Create object from extracted values.
+      ServicePlanTriggerAttribute.new(key)
+    end
+  end
+end