sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/usage_trigger_response.rb

@@ -0,0 +1,146 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # UsageTriggerResponse Model.
+  class UsageTriggerResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique usage triggerId
+    # @return [String]
+    attr_accessor :trigger_id
+
+    # 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
+
+    # Percent of subscription at which trigger will send an alert
+    # @return [String]
+    attr_accessor :threshold_value
+
+    # allowExcess determines whether to restrict usage after exceeds limits
+    # @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 seperated value of list of Phone numbers for SMS notifications
+    # @return [String]
+    attr_accessor :sms_phone_numbers
+
+    # Send email alerts when the thresholdValue is reached.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_email_notification
+
+    # comma seperated value of list of Email addresses for Email notifications
+    # @return [String]
+    attr_accessor :email_addresses
+
+    # UTC Date when the usage trigger was created
+    # @return [String]
+    attr_accessor :create_date
+
+    # UTC Date when the usage trigger was last updated
+    # @return [String]
+    attr_accessor :update_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['trigger_id'] = 'triggerId'
+      @_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['create_date'] = 'createDate'
+      @_hash['update_date'] = 'updateDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(trigger_id = nil, trigger_name = nil, account_name = nil,
+                   service_name = ServiceNameEnum::LOCATION,
+                   threshold_value = nil, allow_excess = nil,
+                   send_sms_notification = nil, sms_phone_numbers = nil,
+                   send_email_notification = nil, email_addresses = nil,
+                   create_date = nil, update_date = nil)
+      @trigger_id = trigger_id
+      @trigger_name = trigger_name
+      @account_name = account_name
+      @service_name = service_name
+      @threshold_value = threshold_value
+      @allow_excess = allow_excess
+      @send_sms_notification = send_sms_notification
+      @sms_phone_numbers = sms_phone_numbers
+      @send_email_notification = send_email_notification
+      @email_addresses = email_addresses
+      @create_date = create_date
+      @update_date = update_date
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      trigger_id = hash.key?('triggerId') ? hash['triggerId'] : nil
+      trigger_name = hash.key?('triggerName') ? hash['triggerName'] : nil
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      service_name = hash['serviceName'] ||= ServiceNameEnum::LOCATION
+      threshold_value =
+        hash.key?('thresholdValue') ? hash['thresholdValue'] : nil
+      allow_excess = hash.key?('allowExcess') ? hash['allowExcess'] : nil
+      send_sms_notification =
+        hash.key?('sendSmsNotification') ? hash['sendSmsNotification'] : nil
+      sms_phone_numbers =
+        hash.key?('smsPhoneNumbers') ? hash['smsPhoneNumbers'] : nil
+      send_email_notification =
+        hash.key?('sendEmailNotification') ? hash['sendEmailNotification'] : nil
+      email_addresses =
+        hash.key?('emailAddresses') ? hash['emailAddresses'] : nil
+      create_date = hash.key?('createDate') ? hash['createDate'] : nil
+      update_date = hash.key?('updateDate') ? hash['updateDate'] : nil
+
+      # Create object from extracted values.
+      UsageTriggerResponse.new(trigger_id,
+                               trigger_name,
+                               account_name,
+                               service_name,
+                               threshold_value,
+                               allow_excess,
+                               send_sms_notification,
+                               sms_phone_numbers,
+                               send_email_notification,
+                               email_addresses,
+                               create_date,
+                               update_date)
+    end
+  end
+end

data/lib/verizon/models/usage_trigger_update_request.rb

@@ -0,0 +1,92 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # UsageTriggerUpdateRequest Model.
+  class UsageTriggerUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Usage trigger name
+    # @return [String]
+    attr_accessor :trigger_name
+
+    # Account name
+    # @return [String]
+    attr_accessor :account_name
+
+    # The percent of subscribed usage required to activate the trigger, such as
+    # 90 or 100.
+    # @return [String]
+    attr_accessor :threshold_value
+
+    # 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
+
+    # 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['threshold_value'] = 'thresholdValue'
+      @_hash['sms_phone_numbers'] = 'smsPhoneNumbers'
+      @_hash['email_addresses'] = 'emailAddresses'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        trigger_name
+        threshold_value
+        sms_phone_numbers
+        email_addresses
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, trigger_name = SKIP,
+                   threshold_value = SKIP, sms_phone_numbers = SKIP,
+                   email_addresses = SKIP)
+      @trigger_name = trigger_name unless trigger_name == SKIP
+      @account_name = account_name
+      @threshold_value = threshold_value unless threshold_value == SKIP
+      @sms_phone_numbers = sms_phone_numbers unless sms_phone_numbers == 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
+      trigger_name = hash.key?('triggerName') ? hash['triggerName'] : SKIP
+      threshold_value =
+        hash.key?('thresholdValue') ? hash['thresholdValue'] : SKIP
+      sms_phone_numbers =
+        hash.key?('smsPhoneNumbers') ? hash['smsPhoneNumbers'] : SKIP
+      email_addresses =
+        hash.key?('emailAddresses') ? hash['emailAddresses'] : SKIP
+
+      # Create object from extracted values.
+      UsageTriggerUpdateRequest.new(account_name,
+                                    trigger_name,
+                                    threshold_value,
+                                    sms_phone_numbers,
+                                    email_addresses)
+    end
+  end
+end

data/lib/verizon/models/user_equipment_identity_type_enum.rb

@@ -0,0 +1,20 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Type of User Equipment identifier used in `UEIdentity`.
+  class UserEquipmentIdentityTypeEnum
+    USER_EQUIPMENT_IDENTITY_TYPE_ENUM = [
+      # TODO: Write general description for IPADDRESS
+      IPADDRESS = 'IPAddress'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      USER_EQUIPMENT_IDENTITY_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/v1_account_subscription.rb

@@ -0,0 +1,89 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Account subscription information.
+  class V1AccountSubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # Subscription models used by the account.
+    # @return [String]
+    attr_accessor :purchase_type
+
+    # Number of monthly licenses in an MRC subscription.
+    # @return [Integer]
+    attr_accessor :license_count
+
+    # Number of licenses currently assigned to devices.
+    # @return [Integer]
+    attr_accessor :license_used_count
+
+    # The date and time of when the subscription was last updated.
+    # @return [String]
+    attr_accessor :update_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['purchase_type'] = 'purchaseType'
+      @_hash['license_count'] = 'licenseCount'
+      @_hash['license_used_count'] = 'licenseUsedCount'
+      @_hash['update_time'] = 'updateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        purchase_type
+        license_count
+        license_used_count
+        update_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, purchase_type = SKIP,
+                   license_count = SKIP, license_used_count = SKIP,
+                   update_time = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @purchase_type = purchase_type unless purchase_type == SKIP
+      @license_count = license_count unless license_count == SKIP
+      @license_used_count = license_used_count unless license_used_count == SKIP
+      @update_time = update_time unless update_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'] : SKIP
+      purchase_type = hash.key?('purchaseType') ? hash['purchaseType'] : SKIP
+      license_count = hash.key?('licenseCount') ? hash['licenseCount'] : SKIP
+      license_used_count =
+        hash.key?('licenseUsedCount') ? hash['licenseUsedCount'] : SKIP
+      update_time = hash.key?('updateTime') ? hash['updateTime'] : SKIP
+
+      # Create object from extracted values.
+      V1AccountSubscription.new(account_name,
+                                purchase_type,
+                                license_count,
+                                license_used_count,
+                                update_time)
+    end
+  end
+end

data/lib/verizon/models/v1_device_list_item.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A JSON object for each device that was included in the request, showing the
+  # device IMEI, the status of the addition or removal, and additional
+  # information about the status.
+  class V1DeviceListItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Whether the device was successfully added or removed from the campaign.
+    # @return [String]
+    attr_accessor :status
+
+    # Additional details about the status.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['status'] = 'status'
+      @_hash['reason'] = 'Reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_id
+        status
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP, status = SKIP, reason = SKIP)
+      @device_id = device_id unless device_id == SKIP
+      @status = status unless status == SKIP
+      @reason = reason unless reason == 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 = hash.key?('deviceId') ? hash['deviceId'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason = hash.key?('Reason') ? hash['Reason'] : SKIP
+
+      # Create object from extracted values.
+      V1DeviceListItem.new(device_id,
+                           status,
+                           reason)
+    end
+  end
+end

data/lib/verizon/models/v1_licenses_assigned_removed_request.rb

@@ -0,0 +1,48 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # IMEIs of the devices to assign licenses to.
+  class V1LicensesAssignedRemovedRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The IMEIs of the devices.
+    # @return [Array[String]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_list = nil)
+      @device_list = device_list
+    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_list = hash.key?('deviceList') ? hash['deviceList'] : nil
+
+      # Create object from extracted values.
+      V1LicensesAssignedRemovedRequest.new(device_list)
+    end
+  end
+end

data/lib/verizon/models/v1_licenses_assigned_removed_result.rb

@@ -0,0 +1,87 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # License assignment or removal confirmation.
+  class V1LicensesAssignedRemovedResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # Total number of monthly licenses in an MRC subscription.
+    # @return [Integer]
+    attr_accessor :lic_count
+
+    # Number of licenses assigned to devices after the request completed.
+    # @return [Integer]
+    attr_accessor :lic_used_count
+
+    # A JSON object for each device that was in the request.
+    # @return [Array[V1DeviceListItem]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['lic_count'] = 'licCount'
+      @_hash['lic_used_count'] = 'licUsedCount'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        lic_count
+        lic_used_count
+        device_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, lic_count = SKIP, lic_used_count = SKIP,
+                   device_list = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @lic_count = lic_count unless lic_count == SKIP
+      @lic_used_count = lic_used_count unless lic_used_count == SKIP
+      @device_list = device_list unless device_list == 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
+      lic_count = hash.key?('licCount') ? hash['licCount'] : SKIP
+      lic_used_count = hash.key?('licUsedCount') ? hash['licUsedCount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      device_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (V1DeviceListItem.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = SKIP unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      V1LicensesAssignedRemovedResult.new(account_name,
+                                          lic_count,
+                                          lic_used_count,
+                                          device_list)
+    end
+  end
+end

data/lib/verizon/models/v1_list_of_licenses_to_remove.rb

@@ -0,0 +1,87 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # List of cancellation candidate devices.
+  class V1ListOfLicensesToRemove < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total number of devices on the list.
+    # @return [Integer]
+    attr_accessor :count
+
+    # True if there are more devices to retrieve.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # The date and time that the list was last updated.
+    # @return [DateTime]
+    attr_accessor :update_time
+
+    # The IMEIs of the devices.
+    # @return [Array[String]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['count'] = 'count'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['update_time'] = 'updateTime'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        count
+        has_more_data
+        update_time
+        device_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(count = SKIP, has_more_data = SKIP, update_time = SKIP,
+                   device_list = SKIP)
+      @count = count unless count == SKIP
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @update_time = update_time unless update_time == SKIP
+      @device_list = device_list unless device_list == 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.
+      count = hash.key?('count') ? hash['count'] : SKIP
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+      update_time = if hash.key?('updateTime')
+                      (DateTimeHelper.from_rfc3339(hash['updateTime']) if hash['updateTime'])
+                    else
+                      SKIP
+                    end
+      device_list = hash.key?('deviceList') ? hash['deviceList'] : SKIP
+
+      # Create object from extracted values.
+      V1ListOfLicensesToRemove.new(count,
+                                   has_more_data,
+                                   update_time,
+                                   device_list)
+    end
+
+    def to_custom_update_time
+      DateTimeHelper.to_rfc3339(update_time)
+    end
+  end
+end

data/lib/verizon/models/v1_list_of_licenses_to_remove_request.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # List of devices to removes.
+  class V1ListOfLicensesToRemoveRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Set to 'append' to append the devices in the current request to the
+    # existing list. If there is no existing list then it will be created with
+    # only these devices. Leave this parameter out when you want to replace the
+    # existing list with the devices in the current request.
+    # @return [String]
+    attr_accessor :type
+
+    # The IMEIs of the devices.
+    # @return [Array[String]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_list = nil, type = SKIP)
+      @type = type unless type == SKIP
+      @device_list = device_list
+    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_list = hash.key?('deviceList') ? hash['deviceList'] : nil
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      V1ListOfLicensesToRemoveRequest.new(device_list,
+                                          type)
+    end
+  end
+end