sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/addressquery.rb

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

data/lib/verizon/models/aggregate_session_report.rb

@@ -0,0 +1,92 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Session and usage details for up to 10 devices.
+  class AggregateSessionReport < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique string that associates the request with the location report
+    # information that is sent in asynchronous callback message.ThingSpace will
+    # send a separate callback message for each device that was in the request.
+    # All of the callback messages will have the same txid.
+    # @return [String]
+    attr_accessor :txid
+
+    # Contains usage per device.
+    # @return [Array[AggregateUsageItem]]
+    attr_accessor :usage
+
+    # An object containing any errors reported by the device.
+    # @return [Array[AggregateUsageError]]
+    attr_accessor :errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['txid'] = 'txid'
+      @_hash['usage'] = 'usage'
+      @_hash['errors'] = 'errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        usage
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        txid
+      ]
+    end
+
+    def initialize(txid = nil,
+                   usage = SKIP,
+                   errors = SKIP)
+      @txid = txid
+      @usage = usage unless usage == SKIP
+      @errors = errors unless errors == 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.
+      txid = hash.key?('txid') ? hash['txid'] : nil
+      # Parameter is an array, so we need to iterate through it
+      usage = nil
+      unless hash['usage'].nil?
+        usage = []
+        hash['usage'].each do |structure|
+          usage << (AggregateUsageItem.from_hash(structure) if structure)
+        end
+      end
+
+      usage = SKIP unless hash.key?('usage')
+      # Parameter is an array, so we need to iterate through it
+      errors = nil
+      unless hash['errors'].nil?
+        errors = []
+        hash['errors'].each do |structure|
+          errors << (AggregateUsageError.from_hash(structure) if structure)
+        end
+      end
+
+      errors = SKIP unless hash.key?('errors')
+
+      # Create object from extracted values.
+      AggregateSessionReport.new(txid,
+                                 usage,
+                                 errors)
+    end
+  end
+end

data/lib/verizon/models/aggregate_session_report_request.rb

@@ -0,0 +1,129 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request for getting an aggregated session report.
+  class AggregateSessionReportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the account.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Start date of session to include. If not specified  information will be
+    # shown from the earliest available (180 days). Can be either date in ISO
+    # 8601 format or predefined constants.
+    # @return [String]
+    attr_accessor :start_date
+
+    # End date of session to include. If not specified  information will be
+    # shown to the latest available. Can be either date in ISO 8601 format or
+    # predefined constants.
+    # @return [String]
+    attr_accessor :end_date
+
+    # Devices for which return usage info. Could be 0, 1 or more. In case of 0
+    # will return all devices belonging to customer (except of filtered by other
+    # parameters).
+    # @return [Array[String]]
+    attr_accessor :imei
+
+    # User defined group name the devices are a member of.
+    # @return [String]
+    attr_accessor :device_group
+
+    # Optional filter parameter.
+    # @return [String]
+    attr_accessor :device_label
+
+    # The data plan the devices beign queried belong to.
+    # @return [String]
+    attr_accessor :data_plan
+
+    # Optional filter parameter which return only devices with no sessions.
+    # @return [String]
+    attr_accessor :no_session_flag
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['imei'] = 'imei'
+      @_hash['device_group'] = 'deviceGroup'
+      @_hash['device_label'] = 'deviceLabel'
+      @_hash['data_plan'] = 'dataPlan'
+      @_hash['no_session_flag'] = 'noSessionFlag'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+        device_group
+        device_label
+        data_plan
+        no_session_flag
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        device_group
+        device_label
+        data_plan
+      ]
+    end
+
+    def initialize(account_number = nil,
+                   imei = nil,
+                   start_date = SKIP,
+                   end_date = SKIP,
+                   device_group = SKIP,
+                   device_label = SKIP,
+                   data_plan = SKIP,
+                   no_session_flag = SKIP)
+      @account_number = account_number
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @imei = imei
+      @device_group = device_group unless device_group == SKIP
+      @device_label = device_label unless device_label == SKIP
+      @data_plan = data_plan unless data_plan == SKIP
+      @no_session_flag = no_session_flag unless no_session_flag == 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_number = hash.key?('accountNumber') ? hash['accountNumber'] : nil
+      imei = hash.key?('imei') ? hash['imei'] : nil
+      start_date = hash.key?('startDate') ? hash['startDate'] : SKIP
+      end_date = hash.key?('endDate') ? hash['endDate'] : SKIP
+      device_group = hash.key?('deviceGroup') ? hash['deviceGroup'] : SKIP
+      device_label = hash.key?('deviceLabel') ? hash['deviceLabel'] : SKIP
+      data_plan = hash.key?('dataPlan') ? hash['dataPlan'] : SKIP
+      no_session_flag =
+        hash.key?('noSessionFlag') ? hash['noSessionFlag'] : SKIP
+
+      # Create object from extracted values.
+      AggregateSessionReportRequest.new(account_number,
+                                        imei,
+                                        start_date,
+                                        end_date,
+                                        device_group,
+                                        device_label,
+                                        data_plan,
+                                        no_session_flag)
+    end
+  end
+end

data/lib/verizon/models/aggregate_usage_error.rb

@@ -0,0 +1,71 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Error reported by a device.
+  class AggregateUsageError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # International Mobile Equipment Identifier. This is the ID of the device
+    # reporting errors.
+    # @return [String]
+    attr_accessor :imei
+
+    # A general error message.
+    # @return [String]
+    attr_accessor :error_message
+
+    # Error message.
+    # @return [IErrorMessage]
+    attr_accessor :error_response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['imei'] = 'imei'
+      @_hash['error_message'] = 'errorMessage'
+      @_hash['error_response'] = 'errorResponse'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        imei
+        error_message
+        error_response
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(imei = SKIP,
+                   error_message = SKIP,
+                   error_response = SKIP)
+      @imei = imei unless imei == SKIP
+      @error_message = error_message unless error_message == SKIP
+      @error_response = error_response unless error_response == 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.
+      imei = hash.key?('imei') ? hash['imei'] : SKIP
+      error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      error_response = IErrorMessage.from_hash(hash['errorResponse']) if hash['errorResponse']
+
+      # Create object from extracted values.
+      AggregateUsageError.new(imei,
+                              error_message,
+                              error_response)
+    end
+  end
+end

data/lib/verizon/models/aggregate_usage_item.rb

@@ -0,0 +1,74 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Contains usage information per device.
+  class AggregateUsageItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # International Mobile Equipment Identifier. This is the ID of the device
+    # reporting usage.
+    # @return [String]
+    attr_accessor :imei
+
+    # Number of sessions established by the device reporting usage.
+    # @return [Integer]
+    attr_accessor :number_of_sessions
+
+    # The amount of data transferred by the device reporting usage, measured in
+    # Bytes.
+    # @return [Integer]
+    attr_accessor :bytes_transferred
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['imei'] = 'imei'
+      @_hash['number_of_sessions'] = 'numberOfSessions'
+      @_hash['bytes_transferred'] = 'bytesTransferred'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        imei
+        number_of_sessions
+        bytes_transferred
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(imei = SKIP,
+                   number_of_sessions = SKIP,
+                   bytes_transferred = SKIP)
+      @imei = imei unless imei == SKIP
+      @number_of_sessions = number_of_sessions unless number_of_sessions == SKIP
+      @bytes_transferred = bytes_transferred unless bytes_transferred == 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.
+      imei = hash.key?('imei') ? hash['imei'] : SKIP
+      number_of_sessions =
+        hash.key?('numberOfSessions') ? hash['numberOfSessions'] : SKIP
+      bytes_transferred =
+        hash.key?('bytesTransferred') ? hash['bytesTransferred'] : SKIP
+
+      # Create object from extracted values.
+      AggregateUsageItem.new(imei,
+                             number_of_sessions,
+                             bytes_transferred)
+    end
+  end
+end

data/lib/verizon/models/aggregated_report_callback_result.rb

@@ -0,0 +1,63 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Aggregated usage report (Asynchronous).
+  class AggregatedReportCallbackResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique string that associates the request with the location report
+    # information that is sent in asynchronous callback message.ThingSpace will
+    # send a separate callback message for each device that was in the request.
+    # All of the callback messages will have the same txid.
+    # @return [String]
+    attr_accessor :txid
+
+    # QUEUED or COMPLETED. Requests for IoT devices with cacheMode=0 (cached)
+    # have status=COMPLETED; all other requests are QUEUED.
+    # @return [AggregatedReportCallbackStatusEnum]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['txid'] = 'txid'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(txid = nil,
+                   status = SKIP)
+      @txid = txid
+      @status = status unless status == 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.
+      txid = hash.key?('txid') ? hash['txid'] : nil
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      AggregatedReportCallbackResult.new(txid,
+                                         status)
+    end
+  end
+end

data/lib/verizon/models/aggregated_report_callback_status_enum.rb

@@ -0,0 +1,24 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # QUEUED or COMPLETED. Requests for IoT devices with cacheMode=0 (cached) have
+  # status=COMPLETED; all other requests are QUEUED.
+  class AggregatedReportCallbackStatusEnum
+    AGGREGATED_REPORT_CALLBACK_STATUS_ENUM = [
+      # TODO: Write general description for QUEUED
+      QUEUED = 'QUEUED'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'COMPLETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AGGREGATED_REPORT_CALLBACK_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/anomaly_detection_request.rb

@@ -0,0 +1,73 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Anomaly detection request.
+  class AnomalyDetectionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account. An account name is usually numeric, and
+    # must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The type of request being made. anomaly is the request to activate anomaly
+    # detection.
+    # @return [String]
+    attr_accessor :request_type
+
+    # Details for sensitivity parameters.
+    # @return [SensitivityParameters]
+    attr_accessor :sensitivity_parameter
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['request_type'] = 'requestType'
+      @_hash['sensitivity_parameter'] = 'sensitivityParameter'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        request_type
+        sensitivity_parameter
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   request_type = SKIP,
+                   sensitivity_parameter = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @request_type = request_type unless request_type == SKIP
+      @sensitivity_parameter = sensitivity_parameter unless sensitivity_parameter == 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
+      request_type = hash.key?('requestType') ? hash['requestType'] : SKIP
+      sensitivity_parameter = SensitivityParameters.from_hash(hash['sensitivityParameter']) if
+        hash['sensitivityParameter']
+
+      # Create object from extracted values.
+      AnomalyDetectionRequest.new(account_name,
+                                  request_type,
+                                  sensitivity_parameter)
+    end
+  end
+end

data/lib/verizon/models/anomaly_detection_settings.rb

@@ -0,0 +1,75 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Settings for anomaly detection.
+  class AnomalyDetectionSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates if the account name used has anomaly detection.<br />Success -
+    # The account has anomaly detection.<br />Failure - The account does not
+    # have anomaly detection.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Details for sensitivity parameters.
+    # @return [SensitivityParameters]
+    attr_accessor :sensitivity_parameter
+
+    # Indicates if anomaly detection is active on the account<br />Active -
+    # Anomaly detection is active<br />Disabled- Anomaly detection is not
+    # active.
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['sensitivity_parameter'] = 'sensitivityParameter'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        sensitivity_parameter
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   sensitivity_parameter = SKIP,
+                   status = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @sensitivity_parameter = sensitivity_parameter unless sensitivity_parameter == SKIP
+      @status = status unless status == 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
+      sensitivity_parameter = SensitivityParameters.from_hash(hash['sensitivityParameter']) if
+        hash['sensitivityParameter']
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      AnomalyDetectionSettings.new(account_name,
+                                   sensitivity_parameter,
+                                   status)
+    end
+  end
+end