sdksio-verizon-apis-sdk 1.4.0 → 1.5.0

data/lib/verizon/models/notification.rb

@@ -4,55 +4,52 @@
 # ( https://apimatic.io ).
 
 module Verizon
-  # The notification details of the trigger.
+  # Notification Model.
   class Notification < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # The type of notification, i.e. 'DailySummary'.
+    # TODO: Write general description for this method
     # @return [String]
     attr_accessor :notification_type
 
-    # Whether or not the notification should be sent via callback.<br />true<br
-    # />false.
+    # TODO: Write general description for this method
     # @return [TrueClass | FalseClass]
     attr_accessor :callback
 
-    # Whether or not the notification should be sent via e-mail.<br />true<br
-    # />false.
+    # TODO: Write general description for this method
     # @return [TrueClass | FalseClass]
     attr_accessor :email_notification
 
-    # Name for the notification group.
+    # TODO: Write general description for this method
     # @return [String]
     attr_accessor :notification_group_name
 
-    # Frequency factor for notification.
+    # TODO: Write general description for this method
     # @return [Integer]
     attr_accessor :notification_frequency_factor
 
-    # Frequency interval for notification.
+    # TODO: Write general description for this method
     # @return [String]
     attr_accessor :notification_frequency_interval
 
-    # E-mail address(es) where the notification should be delivered.
+    # TODO: Write general description for this method
     # @return [String]
     attr_accessor :external_email_recipients
 
-    # SMS notification.
+    # TODO: Write general description for this method
     # @return [TrueClass | FalseClass]
     attr_accessor :sms_notification
 
-    # List of SMS numbers.
-    # @return [Array[SMSNumber]]
+    # TODO: Write general description for this method
+    # @return [Array[SmsNumbers]]
     attr_accessor :sms_numbers
 
-    # List of SMS numbers.
+    # TODO: Write general description for this method
     # @return [TrueClass | FalseClass]
     attr_accessor :reminder
 
-    # Severity level associated with the notification. Examples would be:<br
-    # />Major<br />Minor<br />Critical<br />NotApplicable.
+    # TODO: Write general description for this method
     # @return [String]
     attr_accessor :severity
 
@@ -154,7 +151,7 @@ module Verizon
       unless hash['smsNumbers'].nil?
         sms_numbers = []
         hash['smsNumbers'].each do |structure|
-          sms_numbers << (SMSNumber.from_hash(structure) if structure)
+          sms_numbers << (SmsNumbers.from_hash(structure) if structure)
         end
       end
 

data/lib/verizon/models/{oauth_scope_enum.rb → oauth_scope_thingspace_oauth_enum.rb}

@@ -5,8 +5,8 @@
 
 module Verizon
   # OAuth 2 scopes supported by the API
-  class OauthScopeEnum
-    OAUTH_SCOPE_ENUM = [
+  class OauthScopeThingspaceOauthEnum
+    OAUTH_SCOPE_THINGSPACE_OAUTH_ENUM = [
       # Grant read-only access to discovery data
       DISCOVERYREAD = 'discovery:read'.freeze,
 
@@ -32,6 +32,21 @@ module Verizon
       # TODO: Write general description for TS_APPLICATION_RO
       TS_APPLICATION_RO = 'ts.application.ro'.freeze,
 
+      # TODO: Write general description for EDGEDISCOVERYREAD
+      EDGEDISCOVERYREAD = 'edge:discovery:read'.freeze,
+
+      # TODO: Write general description for EDGESERVICEPROFILEREAD
+      EDGESERVICEPROFILEREAD = 'edge:serviceprofile:read'.freeze,
+
+      # TODO: Write general description for EDGESERVICEPROFILEWRITE
+      EDGESERVICEPROFILEWRITE = 'edge:serviceprofile:write'.freeze,
+
+      # TODO: Write general description for EDGESERVICEREGISTRYREAD
+      EDGESERVICEREGISTRYREAD = 'edge:serviceregistry:read'.freeze,
+
+      # TODO: Write general description for EDGESERVICEREGISTRYWRITE
+      EDGESERVICEREGISTRYWRITE = 'edge:serviceregistry:write'.freeze,
+
       # read access
       READ = 'read'.freeze,
 
@@ -42,7 +57,7 @@ module Verizon
     def self.validate(value)
       return false if value.nil?
 
-      OAUTH_SCOPE_ENUM.include?(value)
+      OAUTH_SCOPE_THINGSPACE_OAUTH_ENUM.include?(value)
     end
   end
 end

data/lib/verizon/models/price_plan_trigger.rb

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

data/lib/verizon/models/request_body_for_usage.rb

@@ -10,6 +10,10 @@ module Verizon
     SKIP = Object.new
     private_constant :SKIP
 
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_id
+
     # TODO: Write general description for this method
     # @return [Array[ReadySimDeviceId]]
     attr_accessor :device_id
@@ -25,6 +29,7 @@ module Verizon
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
       @_hash['device_id'] = 'deviceId'
       @_hash['start_time'] = 'startTime'
       @_hash['end_time'] = 'endTime'
@@ -34,6 +39,7 @@ module Verizon
     # An array for optional fields
     def self.optionals
       %w[
+        account_id
         device_id
         start_time
         end_time
@@ -45,9 +51,11 @@ module Verizon
       []
     end
 
-    def initialize(device_id = SKIP,
+    def initialize(account_id = SKIP,
+                   device_id = SKIP,
                    start_time = SKIP,
                    end_time = SKIP)
+      @account_id = account_id unless account_id == SKIP
       @device_id = device_id unless device_id == SKIP
       @start_time = start_time unless start_time == SKIP
       @end_time = end_time unless end_time == SKIP
@@ -58,6 +66,7 @@ module Verizon
       return nil unless hash
 
       # Extract variables from the hash.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
       # Parameter is an array, so we need to iterate through it
       device_id = nil
       unless hash['deviceId'].nil?
@@ -80,7 +89,8 @@ module Verizon
                  end
 
       # Create object from extracted values.
-      RequestBodyForUsage.new(device_id,
+      RequestBodyForUsage.new(account_id,
+                              device_id,
                               start_time,
                               end_time)
     end

data/lib/verizon/models/{usage_request_body.rb → request_body_for_usage1.rb}

@@ -5,15 +5,11 @@
 
 require 'date'
 module Verizon
-  # UsageRequestBody Model.
-  class UsageRequestBody < BaseModel
+  # RequestBodyForUsage1 Model.
+  class RequestBodyForUsage1 < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :account_id
-
     # TODO: Write general description for this method
     # @return [Array[ReadySimDeviceId]]
     attr_accessor :device_id
@@ -29,7 +25,6 @@ module Verizon
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['account_id'] = 'accountId'
       @_hash['device_id'] = 'deviceId'
       @_hash['start_time'] = 'startTime'
       @_hash['end_time'] = 'endTime'
@@ -39,7 +34,6 @@ module Verizon
     # An array for optional fields
     def self.optionals
       %w[
-        account_id
         device_id
         start_time
         end_time
@@ -51,11 +45,9 @@ module Verizon
       []
     end
 
-    def initialize(account_id = SKIP,
-                   device_id = SKIP,
+    def initialize(device_id = SKIP,
                    start_time = SKIP,
                    end_time = SKIP)
-      @account_id = account_id unless account_id == SKIP
       @device_id = device_id unless device_id == SKIP
       @start_time = start_time unless start_time == SKIP
       @end_time = end_time unless end_time == SKIP
@@ -66,7 +58,6 @@ module Verizon
       return nil unless hash
 
       # Extract variables from the hash.
-      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
       # Parameter is an array, so we need to iterate through it
       device_id = nil
       unless hash['deviceId'].nil?
@@ -89,10 +80,9 @@ module Verizon
                  end
 
       # Create object from extracted values.
-      UsageRequestBody.new(account_id,
-                           device_id,
-                           start_time,
-                           end_time)
+      RequestBodyForUsage1.new(device_id,
+                               start_time,
+                               end_time)
     end
 
     def to_custom_start_time

data/lib/verizon/models/session_report.rb

@@ -25,12 +25,20 @@ module Verizon
     # @return [String]
     attr_accessor :txid
 
+    # 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 [Object]
+    attr_accessor :example
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['sessions'] = 'sessions'
       @_hash['id'] = 'id'
       @_hash['txid'] = 'txid'
+      @_hash['example'] = 'example'
       @_hash
     end
 
@@ -38,6 +46,7 @@ module Verizon
     def self.optionals
       %w[
         sessions
+        example
       ]
     end
 
@@ -50,10 +59,12 @@ module Verizon
 
     def initialize(id = nil,
                    txid = nil,
-                   sessions = SKIP)
+                   sessions = SKIP,
+                   example = SKIP)
       @sessions = sessions unless sessions == SKIP
       @id = id
       @txid = txid
+      @example = example unless example == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -73,11 +84,13 @@ module Verizon
       end
 
       sessions = SKIP unless hash.key?('sessions')
+      example = hash.key?('example') ? hash['example'] : SKIP
 
       # Create object from extracted values.
       SessionReport.new(id,
                         txid,
-                        sessions)
+                        sessions,
+                        example)
     end
   end
 end

data/lib/verizon/models/share_plan.rb

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

data/lib/verizon/models/sms_numbers.rb

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

data/lib/verizon/models/trigger_notification.rb

@@ -0,0 +1,179 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The notification details of the trigger.
+  class TriggerNotification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of notification, i.e. 'DailySummary'.
+    # @return [String]
+    attr_accessor :notification_type
+
+    # Whether or not the notification should be sent via callback.<br />true<br
+    # />false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :callback
+
+    # Whether or not the notification should be sent via e-mail.<br />true<br
+    # />false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :email_notification
+
+    # Name for the notification group.
+    # @return [String]
+    attr_accessor :notification_group_name
+
+    # Frequency factor for notification.
+    # @return [Integer]
+    attr_accessor :notification_frequency_factor
+
+    # Frequency interval for notification.
+    # @return [String]
+    attr_accessor :notification_frequency_interval
+
+    # E-mail address(es) where the notification should be delivered.
+    # @return [String]
+    attr_accessor :external_email_recipients
+
+    # SMS notification.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :sms_notification
+
+    # List of SMS numbers.
+    # @return [Array[SMSNumber]]
+    attr_accessor :sms_numbers
+
+    # List of SMS numbers.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reminder
+
+    # Severity level associated with the notification. Examples would be:<br
+    # />Major<br />Minor<br />Critical<br />NotApplicable.
+    # @return [String]
+    attr_accessor :severity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['notification_type'] = 'notificationType'
+      @_hash['callback'] = 'callback'
+      @_hash['email_notification'] = 'emailNotification'
+      @_hash['notification_group_name'] = 'notificationGroupName'
+      @_hash['notification_frequency_factor'] = 'notificationFrequencyFactor'
+      @_hash['notification_frequency_interval'] =
+        'notificationFrequencyInterval'
+      @_hash['external_email_recipients'] = 'externalEmailRecipients'
+      @_hash['sms_notification'] = 'smsNotification'
+      @_hash['sms_numbers'] = 'smsNumbers'
+      @_hash['reminder'] = 'reminder'
+      @_hash['severity'] = 'severity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        notification_type
+        callback
+        email_notification
+        notification_group_name
+        notification_frequency_factor
+        notification_frequency_interval
+        external_email_recipients
+        sms_notification
+        sms_numbers
+        reminder
+        severity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(notification_type = SKIP,
+                   callback = SKIP,
+                   email_notification = SKIP,
+                   notification_group_name = SKIP,
+                   notification_frequency_factor = SKIP,
+                   notification_frequency_interval = SKIP,
+                   external_email_recipients = SKIP,
+                   sms_notification = SKIP,
+                   sms_numbers = SKIP,
+                   reminder = SKIP,
+                   severity = SKIP)
+      @notification_type = notification_type unless notification_type == SKIP
+      @callback = callback unless callback == SKIP
+      @email_notification = email_notification unless email_notification == SKIP
+      @notification_group_name = notification_group_name unless notification_group_name == SKIP
+      unless notification_frequency_factor == SKIP
+        @notification_frequency_factor =
+          notification_frequency_factor
+      end
+      unless notification_frequency_interval == SKIP
+        @notification_frequency_interval =
+          notification_frequency_interval
+      end
+      unless external_email_recipients == SKIP
+        @external_email_recipients =
+          external_email_recipients
+      end
+      @sms_notification = sms_notification unless sms_notification == SKIP
+      @sms_numbers = sms_numbers unless sms_numbers == SKIP
+      @reminder = reminder unless reminder == SKIP
+      @severity = severity unless severity == 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.
+      notification_type =
+        hash.key?('notificationType') ? hash['notificationType'] : SKIP
+      callback = hash.key?('callback') ? hash['callback'] : SKIP
+      email_notification =
+        hash.key?('emailNotification') ? hash['emailNotification'] : SKIP
+      notification_group_name =
+        hash.key?('notificationGroupName') ? hash['notificationGroupName'] : SKIP
+      notification_frequency_factor =
+        hash.key?('notificationFrequencyFactor') ? hash['notificationFrequencyFactor'] : SKIP
+      notification_frequency_interval =
+        hash.key?('notificationFrequencyInterval') ? hash['notificationFrequencyInterval'] : SKIP
+      external_email_recipients =
+        hash.key?('externalEmailRecipients') ? hash['externalEmailRecipients'] : SKIP
+      sms_notification =
+        hash.key?('smsNotification') ? hash['smsNotification'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      sms_numbers = nil
+      unless hash['smsNumbers'].nil?
+        sms_numbers = []
+        hash['smsNumbers'].each do |structure|
+          sms_numbers << (SMSNumber.from_hash(structure) if structure)
+        end
+      end
+
+      sms_numbers = SKIP unless hash.key?('smsNumbers')
+      reminder = hash.key?('reminder') ? hash['reminder'] : SKIP
+      severity = hash.key?('severity') ? hash['severity'] : SKIP
+
+      # Create object from extracted values.
+      TriggerNotification.new(notification_type,
+                              callback,
+                              email_notification,
+                              notification_group_name,
+                              notification_frequency_factor,
+                              notification_frequency_interval,
+                              external_email_recipients,
+                              sms_notification,
+                              sms_numbers,
+                              reminder,
+                              severity)
+    end
+  end
+end

data/lib/verizon/models/trigger_type1.rb

@@ -28,7 +28,7 @@ module Verizon
     attr_accessor :anomaly_trigger_request
 
     # The notification details of the trigger.
-    # @return [Notification]
+    # @return [TriggerNotification]
     attr_accessor :notification
 
     # A mapping from model property names to API property names.
@@ -81,7 +81,7 @@ module Verizon
       account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
       anomaly_trigger_request = AnomalyTriggerRequest.from_hash(hash['anomalyTriggerRequest']) if
         hash['anomalyTriggerRequest']
-      notification = Notification.from_hash(hash['notification']) if hash['notification']
+      notification = TriggerNotification.from_hash(hash['notification']) if hash['notification']
 
       # Create object from extracted values.
       TriggerType1.new(name,