sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/uploads_activates_device_request.rb

@@ -0,0 +1,123 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The request body identifies the devices to upload.
+  class UploadsActivatesDeviceRequest < 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 email address that the report should be sent to when the upload is
+    # complete.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The stock keeping unit that identifies the type of devices in the upload
+    # and activation.
+    # @return [String]
+    attr_accessor :device_sku
+
+    # The format of the device identifiers in the upload and activation.
+    # @return [String]
+    attr_accessor :upload_type
+
+    # The service plan code that you want to assign to all specified devices.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The pool from which your device IP addresses is derived.
+    # @return [String]
+    attr_accessor :carrier_ip_pool_name
+
+    # The Zip code of the location where the line of service is primarily used,
+    # or a Zip code that you have been told to use with these devices.
+    # @return [String]
+    attr_accessor :mdn_zip_code
+
+    # The devices to upload, specified by device IDs in a format matching
+    # uploadType.
+    # @return [Array[DeviceList]]
+    attr_accessor :devices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['email_address'] = 'emailAddress'
+      @_hash['device_sku'] = 'deviceSku'
+      @_hash['upload_type'] = 'uploadType'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['carrier_ip_pool_name'] = 'carrierIpPoolName'
+      @_hash['mdn_zip_code'] = 'mdnZipCode'
+      @_hash['devices'] = 'devices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_ip_pool_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, email_address = nil, device_sku = nil,
+                   upload_type = nil, service_plan = nil, mdn_zip_code = nil,
+                   devices = nil, carrier_ip_pool_name = SKIP)
+      @account_name = account_name
+      @email_address = email_address
+      @device_sku = device_sku
+      @upload_type = upload_type
+      @service_plan = service_plan
+      @carrier_ip_pool_name = carrier_ip_pool_name unless carrier_ip_pool_name == SKIP
+      @mdn_zip_code = mdn_zip_code
+      @devices = devices
+    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
+      email_address = hash.key?('emailAddress') ? hash['emailAddress'] : nil
+      device_sku = hash.key?('deviceSku') ? hash['deviceSku'] : nil
+      upload_type = hash.key?('uploadType') ? hash['uploadType'] : nil
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : nil
+      mdn_zip_code = hash.key?('mdnZipCode') ? hash['mdnZipCode'] : 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')
+      carrier_ip_pool_name =
+        hash.key?('carrierIpPoolName') ? hash['carrierIpPoolName'] : SKIP
+
+      # Create object from extracted values.
+      UploadsActivatesDeviceRequest.new(account_name,
+                                        email_address,
+                                        device_sku,
+                                        upload_type,
+                                        service_plan,
+                                        mdn_zip_code,
+                                        devices,
+                                        carrier_ip_pool_name)
+    end
+  end
+end

data/lib/verizon/models/usage.rb

@@ -0,0 +1,108 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The daily network data usage of a single device during a specified time
+  # period.
+  class Usage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of bytes that the device sent or received on the report date.
+    # @return [Integer]
+    attr_accessor :bytes_used
+
+    # The number of mobile-originated and mobile-terminated SMS messages on the
+    # report date.
+    # @return [Array[CustomFields]]
+    attr_accessor :extended_attributes
+
+    # The list of service plans associated with the device/account.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The number of SMS messages that were sent or received on the report date.
+    # @return [Integer]
+    attr_accessor :sms_used
+
+    # The source of the information for the reported usage.
+    # @return [String]
+    attr_accessor :source
+
+    # The date of the recorded usage.
+    # @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 << (CustomFields.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.
+      Usage.new(bytes_used,
+                extended_attributes,
+                service_plan,
+                sms_used,
+                source,
+                timestamp)
+    end
+  end
+end

data/lib/verizon/models/usage_anomaly_attributes.rb

@@ -0,0 +1,117 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The details of the UsageAnomaly trigger.
+  class UsageAnomalyAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Verizon billing account associated with the anomaly triggers for this
+    # trigger to be active for devices in those accounts. An account name is
+    # usually numeric, and must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_names
+
+    # The names of device groups associated with the anomaly triggers for this
+    # trigger to be active for devices in those groups.
+    # @return [String]
+    attr_accessor :device_group
+
+    # Whether or not to include anomalies classified as 'abnormal'.<br />true<br
+    # />false<br />Classification is set as part of ThingSpace Intelligence
+    # anomaly detection settings.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_abnormal
+
+    # Whether or not to include anomalies classified as 'very abnormal'.<br
+    # />true<br />false<br />Classification is set as part of ThingSpace
+    # Intelligence anomaly detection settings.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_very_abnormal
+
+    # Whether or not to include anomalies that are directionally under the
+    # expected usage.<br />true<br />false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_under_expected_usage
+
+    # Whether or not to include anomalies that are directionally over the
+    # expected usage. <br />true<br />false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_over_expected_usage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_names'] = 'accountNames'
+      @_hash['device_group'] = 'deviceGroup'
+      @_hash['include_abnormal'] = 'includeAbnormal'
+      @_hash['include_very_abnormal'] = 'includeVeryAbnormal'
+      @_hash['include_under_expected_usage'] = 'includeUnderExpectedUsage'
+      @_hash['include_over_expected_usage'] = 'includeOverExpectedUsage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_names
+        device_group
+        include_abnormal
+        include_very_abnormal
+        include_under_expected_usage
+        include_over_expected_usage
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_names = SKIP, device_group = SKIP,
+                   include_abnormal = SKIP, include_very_abnormal = SKIP,
+                   include_under_expected_usage = SKIP,
+                   include_over_expected_usage = SKIP)
+      @account_names = account_names unless account_names == SKIP
+      @device_group = device_group unless device_group == SKIP
+      @include_abnormal = include_abnormal unless include_abnormal == SKIP
+      @include_very_abnormal = include_very_abnormal unless include_very_abnormal == SKIP
+      unless include_under_expected_usage == SKIP
+        @include_under_expected_usage =
+          include_under_expected_usage
+      end
+      unless include_over_expected_usage == SKIP
+        @include_over_expected_usage =
+          include_over_expected_usage
+      end
+    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_names = hash.key?('accountNames') ? hash['accountNames'] : SKIP
+      device_group = hash.key?('deviceGroup') ? hash['deviceGroup'] : SKIP
+      include_abnormal =
+        hash.key?('includeAbnormal') ? hash['includeAbnormal'] : SKIP
+      include_very_abnormal =
+        hash.key?('includeVeryAbnormal') ? hash['includeVeryAbnormal'] : SKIP
+      include_under_expected_usage =
+        hash.key?('includeUnderExpectedUsage') ? hash['includeUnderExpectedUsage'] : SKIP
+      include_over_expected_usage =
+        hash.key?('includeOverExpectedUsage') ? hash['includeOverExpectedUsage'] : SKIP
+
+      # Create object from extracted values.
+      UsageAnomalyAttributes.new(account_names,
+                                 device_group,
+                                 include_abnormal,
+                                 include_very_abnormal,
+                                 include_under_expected_usage,
+                                 include_over_expected_usage)
+    end
+  end
+end

data/lib/verizon/models/usage_history.rb

@@ -0,0 +1,115 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # UsageHistory Model.
+  class UsageHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :bytes_used
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :serviceplan
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sms_used
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :mo_sms
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :mt_sms
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :source
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :event_date_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bytes_used'] = 'bytesUsed'
+      @_hash['serviceplan'] = 'serviceplan'
+      @_hash['sms_used'] = 'smsUsed'
+      @_hash['mo_sms'] = 'moSMS'
+      @_hash['mt_sms'] = 'mtSMS'
+      @_hash['source'] = 'source'
+      @_hash['event_date_time'] = 'eventDateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bytes_used
+        serviceplan
+        sms_used
+        mo_sms
+        mt_sms
+        source
+        event_date_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bytes_used = SKIP, serviceplan = SKIP, sms_used = SKIP,
+                   mo_sms = SKIP, mt_sms = SKIP, source = SKIP,
+                   event_date_time = SKIP)
+      @bytes_used = bytes_used unless bytes_used == SKIP
+      @serviceplan = serviceplan unless serviceplan == SKIP
+      @sms_used = sms_used unless sms_used == SKIP
+      @mo_sms = mo_sms unless mo_sms == SKIP
+      @mt_sms = mt_sms unless mt_sms == SKIP
+      @source = source unless source == SKIP
+      @event_date_time = event_date_time unless event_date_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.
+      bytes_used = hash.key?('bytesUsed') ? hash['bytesUsed'] : SKIP
+      serviceplan = hash.key?('serviceplan') ? hash['serviceplan'] : SKIP
+      sms_used = hash.key?('smsUsed') ? hash['smsUsed'] : SKIP
+      mo_sms = hash.key?('moSMS') ? hash['moSMS'] : SKIP
+      mt_sms = hash.key?('mtSMS') ? hash['mtSMS'] : SKIP
+      source = hash.key?('source') ? hash['source'] : SKIP
+      event_date_time = if hash.key?('eventDateTime')
+                          (DateTimeHelper.from_rfc3339(hash['eventDateTime']) if hash['eventDateTime'])
+                        else
+                          SKIP
+                        end
+
+      # Create object from extracted values.
+      UsageHistory.new(bytes_used,
+                       serviceplan,
+                       sms_used,
+                       mo_sms,
+                       mt_sms,
+                       source,
+                       event_date_time)
+    end
+
+    def to_custom_event_date_time
+      DateTimeHelper.to_rfc3339(event_date_time)
+    end
+  end
+end

data/lib/verizon/models/usage_request_response.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # UsageRequestResponse Model.
+  class UsageRequestResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @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.
+      UsageRequestResponse.new(request_id)
+    end
+  end
+end

data/lib/verizon/models/usage_trigger_add_request.rb

@@ -0,0 +1,131 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # UsageTriggerAddRequest Model.
+  class UsageTriggerAddRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Usage trigger name
+    # @return [String]
+    attr_accessor :trigger_name
+
+    # Account name
+    # @return [String]
+    attr_accessor :account_name
+
+    # Service name
+    # @return [ServiceNameEnum]
+    attr_accessor :service_name
+
+    # The percent of subscribed usage required to activate the trigger, such as
+    # 90 or 100.
+    # @return [String]
+    attr_accessor :threshold_value
+
+    # Allow additional requests after thresholdValue is reached. (currently not
+    # functional)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_excess
+
+    # Send SMS (text) alerts when the thresholdValue is reached.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_sms_notification
+
+    # Comma-separated list of phone numbers to send SMS alerts to. Digits only;
+    # no dashes or parentheses, etc.
+    # @return [String]
+    attr_accessor :sms_phone_numbers
+
+    # Send email alerts when the thresholdValue is reached.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_email_notification
+
+    # Comma-separated list of email addresses to send alerts to.
+    # @return [String]
+    attr_accessor :email_addresses
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['trigger_name'] = 'triggerName'
+      @_hash['account_name'] = 'accountName'
+      @_hash['service_name'] = 'serviceName'
+      @_hash['threshold_value'] = 'thresholdValue'
+      @_hash['allow_excess'] = 'allowExcess'
+      @_hash['send_sms_notification'] = 'sendSmsNotification'
+      @_hash['sms_phone_numbers'] = 'smsPhoneNumbers'
+      @_hash['send_email_notification'] = 'sendEmailNotification'
+      @_hash['email_addresses'] = 'emailAddresses'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        trigger_name
+        allow_excess
+        send_sms_notification
+        sms_phone_numbers
+        send_email_notification
+        email_addresses
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, service_name = ServiceNameEnum::LOCATION,
+                   threshold_value = nil, trigger_name = SKIP,
+                   allow_excess = SKIP, send_sms_notification = SKIP,
+                   sms_phone_numbers = SKIP, send_email_notification = SKIP,
+                   email_addresses = SKIP)
+      @trigger_name = trigger_name unless trigger_name == SKIP
+      @account_name = account_name
+      @service_name = service_name
+      @threshold_value = threshold_value
+      @allow_excess = allow_excess unless allow_excess == SKIP
+      @send_sms_notification = send_sms_notification unless send_sms_notification == SKIP
+      @sms_phone_numbers = sms_phone_numbers unless sms_phone_numbers == SKIP
+      @send_email_notification = send_email_notification unless send_email_notification == SKIP
+      @email_addresses = email_addresses unless email_addresses == 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
+      service_name = hash['serviceName'] ||= ServiceNameEnum::LOCATION
+      threshold_value =
+        hash.key?('thresholdValue') ? hash['thresholdValue'] : nil
+      trigger_name = hash.key?('triggerName') ? hash['triggerName'] : SKIP
+      allow_excess = hash.key?('allowExcess') ? hash['allowExcess'] : SKIP
+      send_sms_notification =
+        hash.key?('sendSmsNotification') ? hash['sendSmsNotification'] : SKIP
+      sms_phone_numbers =
+        hash.key?('smsPhoneNumbers') ? hash['smsPhoneNumbers'] : SKIP
+      send_email_notification =
+        hash.key?('sendEmailNotification') ? hash['sendEmailNotification'] : SKIP
+      email_addresses =
+        hash.key?('emailAddresses') ? hash['emailAddresses'] : SKIP
+
+      # Create object from extracted values.
+      UsageTriggerAddRequest.new(account_name,
+                                 service_name,
+                                 threshold_value,
+                                 trigger_name,
+                                 allow_excess,
+                                 send_sms_notification,
+                                 sms_phone_numbers,
+                                 send_email_notification,
+                                 email_addresses)
+    end
+  end
+end