sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/no_of_days_b4_promo_exp.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # NoOfDaysB4PromoExp Model.
+  class NoOfDaysB4PromoExp < 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 [Integer]
+    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.
+      NoOfDaysB4PromoExp.new(key,
+                             value)
+    end
+  end
+end

data/lib/verizon/models/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 Notification < 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.
+      Notification.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/notification_group_name_trigger_attribute.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Notification group name trigger attribute.
+  class NotificationGroupNameTriggerAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If present, the NotificationGroupName 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.
+      NotificationGroupNameTriggerAttribute.new(key)
+    end
+  end
+end

data/lib/verizon/models/notification_report_request.rb

@@ -0,0 +1,85 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # NotificationReportRequest Model.
+  class NotificationReportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :request_type
+
+    # TODO: Write general description for this method
+    # @return [Array[DeviceList]]
+    attr_accessor :devices
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :monitor_expiration_time
+
+    # 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['devices'] = 'devices'
+      @_hash['monitor_expiration_time'] = 'monitorExpirationTime'
+      @_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,
+                   request_type = nil,
+                   devices = nil,
+                   monitor_expiration_time = nil)
+      @account_name = account_name
+      @request_type = request_type
+      @devices = devices
+      @monitor_expiration_time = monitor_expiration_time
+    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
+      request_type = hash.key?('requestType') ? hash['requestType'] : nil
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (DeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = nil unless hash.key?('devices')
+      monitor_expiration_time =
+        hash.key?('monitorExpirationTime') ? hash['monitorExpirationTime'] : nil
+
+      # Create object from extracted values.
+      NotificationReportRequest.new(account_name,
+                                    request_type,
+                                    devices,
+                                    monitor_expiration_time)
+    end
+  end
+end

data/lib/verizon/models/notification_report_status_request.rb

@@ -0,0 +1,78 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # NotificationReportStatusRequest Model.
+  class NotificationReportStatusRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # An identifier for a single device.
+    # @return [DeviceId]
+    attr_accessor :device
+
+    # The type of request.
+    # @return [String]
+    attr_accessor :request_type
+
+    # The time at which the request expires.
+    # @return [String]
+    attr_accessor :request_expiration_time
+
+    # 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['request_type'] = 'requestType'
+      @_hash['request_expiration_time'] = 'requestExpirationTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_expiration_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   device = nil,
+                   request_type = nil,
+                   request_expiration_time = SKIP)
+      @account_name = account_name
+      @device = device
+      @request_type = request_type
+      @request_expiration_time = request_expiration_time unless request_expiration_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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      device = DeviceId.from_hash(hash['device']) if hash['device']
+      request_type = hash.key?('requestType') ? hash['requestType'] : nil
+      request_expiration_time =
+        hash.key?('requestExpirationTime') ? hash['requestExpirationTime'] : SKIP
+
+      # Create object from extracted values.
+      NotificationReportStatusRequest.new(account_name,
+                                          device,
+                                          request_type,
+                                          request_expiration_time)
+    end
+  end
+end

data/lib/verizon/models/numerical_data.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Describes value and unit of time.
+  class NumericalData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Numerical value.
+    # @return [Integer]
+    attr_accessor :value
+
+    # Unit of time.
+    # @return [NumericalDataUnitEnum]
+    attr_accessor :unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_hash['unit'] = 'unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        value
+        unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value = SKIP,
+                   unit = SKIP)
+      @value = value unless value == SKIP
+      @unit = unit unless 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.
+      value = hash.key?('value') ? hash['value'] : SKIP
+      unit = hash.key?('unit') ? hash['unit'] : SKIP
+
+      # Create object from extracted values.
+      NumericalData.new(value,
+                        unit)
+    end
+  end
+end

data/lib/verizon/models/numerical_data_unit_enum.rb

@@ -0,0 +1,29 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Unit of time.
+  class NumericalDataUnitEnum
+    NUMERICAL_DATA_UNIT_ENUM = [
+      # TODO: Write general description for SECOND
+      SECOND = 'SECOND'.freeze,
+
+      # TODO: Write general description for MINUTE
+      MINUTE = 'MINUTE'.freeze,
+
+      # TODO: Write general description for HOUR
+      HOUR = 'HOUR'.freeze,
+
+      # TODO: Write general description for DAY
+      DAY = 'DAY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NUMERICAL_DATA_UNIT_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/oauth_provider_error_enum.rb

@@ -0,0 +1,45 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # OAuth 2 Authorization error codes
+  class OauthProviderErrorEnum
+    OAUTH_PROVIDER_ERROR_ENUM = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OAUTH_PROVIDER_ERROR_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/oauth_scope_enum.rb

@@ -0,0 +1,48 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # OAuth 2 scopes supported by the API
+  class OauthScopeEnum
+    OAUTH_SCOPE_ENUM = [
+      # Grant read-only access to discovery data
+      DISCOVERYREAD = 'discovery:read'.freeze,
+
+      # Grant read-only access to service profile data
+      SERVICEPROFILEREAD = 'serviceprofile:read'.freeze,
+
+      # Grant write access to service profile data
+      SERVICEPROFILEWRITE = 'serviceprofile:write'.freeze,
+
+      # Grant read-only access to Service registry data
+      SERVICEREGISTRYREAD = 'serviceregistry:read'.freeze,
+
+      # Grant write access to Service registry data
+      SERVICEREGISTRYWRITE = 'serviceregistry:write'.freeze,
+
+      # Full access for /serviceprofiles and /serviceendpoints.
+      TS_MEC_FULLACCESS = 'ts.mec.fullaccess'.freeze,
+
+      # Limited access. Will not allow use of /serviceprofiles and
+      # /serviceendpoints but will allow discovery.
+      TS_MEC_LIMITACCESS = 'ts.mec.limitaccess'.freeze,
+
+      # TODO: Write general description for TS_APPLICATION_RO
+      TS_APPLICATION_RO = 'ts.application.ro'.freeze,
+
+      # read access
+      READ = 'read'.freeze,
+
+      # read/write access
+      WRITE = 'write'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OAUTH_SCOPE_ENUM.include?(value)
+    end
+  end
+end