sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/daily_usage.rb

@@ -0,0 +1,68 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DailyUsage Model.
+  class DailyUsage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [GIODeviceId]
+    attr_accessor :device_id
+
+    # The start date of the time period queried as "$datetime"
+    # @return [String]
+    attr_accessor :earliest
+
+    # The end date of the time period being queried as "$datetime"
+    # @return [String]
+    attr_accessor :latest
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['earliest'] = 'earliest'
+      @_hash['latest'] = 'latest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_id
+        earliest
+        latest
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP, earliest = SKIP, latest = SKIP)
+      @device_id = device_id unless device_id == SKIP
+      @earliest = earliest unless earliest == SKIP
+      @latest = latest unless latest == 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.
+      device_id = GIODeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      earliest = hash.key?('earliest') ? hash['earliest'] : SKIP
+      latest = hash.key?('latest') ? hash['latest'] : SKIP
+
+      # Create object from extracted values.
+      DailyUsage.new(device_id,
+                     earliest,
+                     latest)
+    end
+  end
+end

data/lib/verizon/models/daily_usage_history.rb

@@ -0,0 +1,106 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DailyUsageHistory Model.
+  class DailyUsageHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # the total data usage recorded in Bytes
+    # @return [String]
+    attr_accessor :bytes_used
+
+    # the total data usage recorded in Bytes
+    # @return [Array[ExtendedAttribute]]
+    attr_accessor :extended_attributes
+
+    # the total data usage recorded in Bytes
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The total number of SMS messages from and to the device
+    # @return [String]
+    attr_accessor :sms_used
+
+    # Where the collected data is being gathered from
+    # @return [String]
+    attr_accessor :source
+
+    # Timestamp of when the retrieved record was completed ($datetime)
+    # @return [String]
+    attr_accessor :timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bytes_used'] = 'bytesUsed'
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['sms_used'] = 'smsUsed'
+      @_hash['source'] = 'source'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bytes_used
+        extended_attributes
+        service_plan
+        sms_used
+        source
+        timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bytes_used = SKIP, extended_attributes = SKIP,
+                   service_plan = SKIP, sms_used = SKIP, source = SKIP,
+                   timestamp = SKIP)
+      @bytes_used = bytes_used unless bytes_used == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @sms_used = sms_used unless sms_used == SKIP
+      @source = source unless source == SKIP
+      @timestamp = timestamp unless timestamp == 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.
+      bytes_used = hash.key?('bytesUsed') ? hash['bytesUsed'] : 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 << (ExtendedAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extendedAttributes')
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      sms_used = hash.key?('smsUsed') ? hash['smsUsed'] : SKIP
+      source = hash.key?('source') ? hash['source'] : SKIP
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+
+      # Create object from extracted values.
+      DailyUsageHistory.new(bytes_used,
+                            extended_attributes,
+                            service_plan,
+                            sms_used,
+                            source,
+                            timestamp)
+    end
+  end
+end

data/lib/verizon/models/daily_usage_item.rb

@@ -0,0 +1,68 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Contains only dates when device had sessions.
+  class DailyUsageItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Start date of session. ISO 8601 format.
+    # @return [String]
+    attr_accessor :start_time
+
+    # End date of session. ISO 8601 format.
+    # @return [String]
+    attr_accessor :end_time
+
+    # Amount of data transferred, measured in Bytes.
+    # @return [Integer]
+    attr_accessor :num_bytes
+
+    # 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['num_bytes'] = 'numBytes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_time
+        end_time
+        num_bytes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_time = SKIP, end_time = SKIP, num_bytes = SKIP)
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == SKIP
+      @num_bytes = num_bytes unless num_bytes == 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
+      num_bytes = hash.key?('numBytes') ? hash['numBytes'] : SKIP
+
+      # Create object from extracted values.
+      DailyUsageItem.new(start_time,
+                         end_time,
+                         num_bytes)
+    end
+  end
+end

data/lib/verizon/models/daily_usage_response.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DailyUsageResponse Model.
+  class DailyUsageResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A flag set to indicate if there is more than one page of data returned by
+    # the query (true) or if only one page of data returned (false)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # A flag set to indicate if there is more than one page of data returned by
+    # the query (true) or if only one page of data returned (false)
+    # @return [GIODeviceId]
+    attr_accessor :device_id
+
+    # A flag set to indicate if there is more than one page of data returned by
+    # the query (true) or if only one page of data returned (false)
+    # @return [Array[DailyUsageHistory]]
+    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['device_id'] = 'deviceId'
+      @_hash['usage_history'] = 'usageHistory'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        has_more_data
+        device_id
+        usage_history
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(has_more_data = SKIP, device_id = SKIP, usage_history = SKIP)
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @device_id = device_id unless device_id == 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
+      device_id = GIODeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      # 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 << (DailyUsageHistory.from_hash(structure) if structure)
+        end
+      end
+
+      usage_history = SKIP unless hash.key?('usageHistory')
+
+      # Create object from extracted values.
+      DailyUsageResponse.new(has_more_data,
+                             device_id,
+                             usage_history)
+    end
+  end
+end

data/lib/verizon/models/data_percentage100_trigger_attribute.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Trigger attribute for when data percentage is over 100% used.
+  class DataPercentage100TriggerAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Key data percentage 100.
+    # @return [String]
+    attr_accessor :key
+
+    # DataPercentage100<br />True - Trigger on Data percentage is over 100%
+    # used<br />False - Do not trigger when over 100% used.
+    # @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.
+      DataPercentage100TriggerAttribute.new(key,
+                                            value)
+    end
+  end
+end

data/lib/verizon/models/data_percentage50_trigger_attribute.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Trigger attribute for when data percentage is over 50% used.
+  class DataPercentage50TriggerAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Key data percentage 50.
+    # @return [String]
+    attr_accessor :key
+
+    # DataPercentage50<br />True - Trigger on Data percentage is over 50%
+    # used<br />False - Do not trigger when over 50% used.
+    # @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.
+      DataPercentage50TriggerAttribute.new(key,
+                                           value)
+    end
+  end
+end

data/lib/verizon/models/data_percentage75_trigger_attribute.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Trigger attribute for when data percentage is over 75% used.
+  class DataPercentage75TriggerAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Key data percentage 75.
+    # @return [String]
+    attr_accessor :key
+
+    # DataPercentage75<br />True - Trigger on Data percentage is over 75%
+    # used<br />False - Do not trigger when over 75% used.
+    # @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.
+      DataPercentage75TriggerAttribute.new(key,
+                                           value)
+    end
+  end
+end

data/lib/verizon/models/data_percentage90_trigger_attribute.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Trigger attribute for when data percentage is over 90% used.
+  class DataPercentage90TriggerAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Key data percentage 90.
+    # @return [String]
+    attr_accessor :key
+
+    # DataPercentage90<br />True - Trigger on Data percentage is over 90%
+    # used<br />False - Do not trigger when over 90% used.
+    # @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.
+      DataPercentage90TriggerAttribute.new(key,
+                                           value)
+    end
+  end
+end

data/lib/verizon/models/data_trigger_request.rb

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

data/lib/verizon/models/date_filter.rb

@@ -0,0 +1,56 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Filter out the dates.
+  class DateFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Only include devices that were added after this date and time.
+    # @return [String]
+    attr_accessor :earliest
+
+    # Only include devices that were added before this date and time.
+    # @return [String]
+    attr_accessor :latest
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['earliest'] = 'earliest'
+      @_hash['latest'] = 'latest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(earliest = nil, latest = nil)
+      @earliest = earliest
+      @latest = latest
+    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
+
+      # Create object from extracted values.
+      DateFilter.new(earliest,
+                     latest)
+    end
+  end
+end