specs-sdk 1.3.0

data/lib/verizon/models/create_trigger_request.rb

@@ -0,0 +1,135 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # CreateTriggerRequest Model.
+  class CreateTriggerRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # The details of the UsageAnomaly trigger.
+    # @return [AnomalyTriggerRequest]
+    attr_accessor :anomaly_trigger_request
+
+    # The details of the UsageAnomaly trigger.
+    # @return [DataTriggerRequest]
+    attr_accessor :data_trigger_request
+
+    # The details of the UsageAnomaly trigger.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The details of the UsageAnomaly trigger.
+    # @return [String]
+    attr_accessor :name
+
+    # The details of the UsageAnomaly trigger.
+    # @return [SessionTriggerRequest]
+    attr_accessor :session_trigger_request
+
+    # The details of the UsageAnomaly trigger.
+    # @return [SMSTriggerRequest]
+    attr_accessor :sms_trigger_request
+
+    # The details of the UsageAnomaly trigger.
+    # @return [String]
+    attr_accessor :trigger_category
+
+    # The details of the UsageAnomaly trigger.
+    # @return [String]
+    attr_accessor :trigger_cycle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['anomaly_trigger_request'] = 'anomalyTriggerRequest'
+      @_hash['data_trigger_request'] = 'dataTriggerRequest'
+      @_hash['group_name'] = 'groupName'
+      @_hash['name'] = 'name'
+      @_hash['session_trigger_request'] = 'sessionTriggerRequest'
+      @_hash['sms_trigger_request'] = 'smsTriggerRequest'
+      @_hash['trigger_category'] = 'triggerCategory'
+      @_hash['trigger_cycle'] = 'triggerCycle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        anomaly_trigger_request
+        data_trigger_request
+        group_name
+        name
+        session_trigger_request
+        sms_trigger_request
+        trigger_category
+        trigger_cycle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   anomaly_trigger_request = SKIP,
+                   data_trigger_request = SKIP,
+                   group_name = SKIP,
+                   name = SKIP,
+                   session_trigger_request = SKIP,
+                   sms_trigger_request = SKIP,
+                   trigger_category = SKIP,
+                   trigger_cycle = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @anomaly_trigger_request = anomaly_trigger_request unless anomaly_trigger_request == SKIP
+      @data_trigger_request = data_trigger_request unless data_trigger_request == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @name = name unless name == SKIP
+      @session_trigger_request = session_trigger_request unless session_trigger_request == SKIP
+      @sms_trigger_request = sms_trigger_request unless sms_trigger_request == SKIP
+      @trigger_category = trigger_category unless trigger_category == SKIP
+      @trigger_cycle = trigger_cycle unless trigger_cycle == 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
+      anomaly_trigger_request = AnomalyTriggerRequest.from_hash(hash['anomalyTriggerRequest']) if
+        hash['anomalyTriggerRequest']
+      data_trigger_request = DataTriggerRequest.from_hash(hash['dataTriggerRequest']) if
+        hash['dataTriggerRequest']
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      session_trigger_request = SessionTriggerRequest.from_hash(hash['sessionTriggerRequest']) if
+        hash['sessionTriggerRequest']
+      sms_trigger_request = SMSTriggerRequest.from_hash(hash['smsTriggerRequest']) if
+        hash['smsTriggerRequest']
+      trigger_category =
+        hash.key?('triggerCategory') ? hash['triggerCategory'] : SKIP
+      trigger_cycle = hash.key?('triggerCycle') ? hash['triggerCycle'] : SKIP
+
+      # Create object from extracted values.
+      CreateTriggerRequest.new(account_name,
+                               anomaly_trigger_request,
+                               data_trigger_request,
+                               group_name,
+                               name,
+                               session_trigger_request,
+                               sms_trigger_request,
+                               trigger_category,
+                               trigger_cycle)
+    end
+  end
+end

data/lib/verizon/models/create_trigger_request_options.rb

@@ -0,0 +1,105 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # CreateTriggerRequestOptions Model.
+  class CreateTriggerRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Trigger name.
+    # @return [String]
+    attr_accessor :name
+
+    # This is the value to use in the request body to detect anomalous
+    # behaivior. The values in this table will only be relevant when this
+    # parameter is set to this value.
+    # @return [String]
+    attr_accessor :trigger_category
+
+    # Account name.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The details of the UsageAnomaly trigger.
+    # @return [AnomalyTriggerRequest]
+    attr_accessor :anomaly_trigger_request
+
+    # The notification details of the trigger.
+    # @return [Notification]
+    attr_accessor :notification
+
+    # Indicates anomaly detection is active<br />True - Anomaly detection is
+    # active.<br />False - Anomaly detection is not active.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['trigger_category'] = 'triggerCategory'
+      @_hash['account_name'] = 'accountName'
+      @_hash['anomaly_trigger_request'] = 'anomalyTriggerRequest'
+      @_hash['notification'] = 'notification'
+      @_hash['active'] = 'active'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        trigger_category
+        account_name
+        anomaly_trigger_request
+        notification
+        active
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP,
+                   trigger_category = SKIP,
+                   account_name = SKIP,
+                   anomaly_trigger_request = SKIP,
+                   notification = SKIP,
+                   active = SKIP)
+      @name = name unless name == SKIP
+      @trigger_category = trigger_category unless trigger_category == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @anomaly_trigger_request = anomaly_trigger_request unless anomaly_trigger_request == SKIP
+      @notification = notification unless notification == SKIP
+      @active = active unless active == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      trigger_category =
+        hash.key?('triggerCategory') ? hash['triggerCategory'] : SKIP
+      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']
+      active = hash.key?('active') ? hash['active'] : SKIP
+
+      # Create object from extracted values.
+      CreateTriggerRequestOptions.new(name,
+                                      trigger_category,
+                                      account_name,
+                                      anomaly_trigger_request,
+                                      notification,
+                                      active)
+    end
+  end
+end

data/lib/verizon/models/custom_fields.rb

@@ -0,0 +1,57 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Custom data that can be included using key-value pairs.
+  class CustomFields < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The key for an extended attribute.
+    # @return [String]
+    attr_accessor :key
+
+    # The value of an extended attribute.
+    # @return [String]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = nil,
+                   value = nil)
+      @key = key
+      @value = value
+    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'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+
+      # Create object from extracted values.
+      CustomFields.new(key,
+                       value)
+    end
+  end
+end

data/lib/verizon/models/custom_fields_update_request.rb

@@ -0,0 +1,133 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to assign or change custom field values for one or more devices.
+  class CustomFieldsUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.This parameter is only required if the UWS
+    # account used for the current API session has access to multiple billing
+    # accounts.An account name is usually numeric, and must include any leading
+    # zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Custom field names and values, if you want to only include devices that
+    # have matching values.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # The names and new values of any custom fields that you want to change.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields_to_update
+
+    # The devices that you want to change.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # The name of a device group, if you want to only include devices in that
+    # group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The name of a service plan, if you want to only include devices that have
+    # that service plan.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['custom_fields_to_update'] = 'customFieldsToUpdate'
+      @_hash['devices'] = 'devices'
+      @_hash['group_name'] = 'groupName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        custom_fields
+        custom_fields_to_update
+        devices
+        group_name
+        service_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   custom_fields = SKIP,
+                   custom_fields_to_update = SKIP,
+                   devices = SKIP,
+                   group_name = SKIP,
+                   service_plan = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @custom_fields_to_update = custom_fields_to_update unless custom_fields_to_update == SKIP
+      @devices = devices unless devices == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @service_plan = service_plan unless service_plan == 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
+      # Parameter is an array, so we need to iterate through it
+      custom_fields = nil
+      unless hash['customFields'].nil?
+        custom_fields = []
+        hash['customFields'].each do |structure|
+          custom_fields << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      custom_fields = SKIP unless hash.key?('customFields')
+      # Parameter is an array, so we need to iterate through it
+      custom_fields_to_update = nil
+      unless hash['customFieldsToUpdate'].nil?
+        custom_fields_to_update = []
+        hash['customFieldsToUpdate'].each do |structure|
+          custom_fields_to_update << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      custom_fields_to_update = SKIP unless hash.key?('customFieldsToUpdate')
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (AccountDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+
+      # Create object from extracted values.
+      CustomFieldsUpdateRequest.new(account_name,
+                                    custom_fields,
+                                    custom_fields_to_update,
+                                    devices,
+                                    group_name,
+                                    service_plan)
+    end
+  end
+end

data/lib/verizon/models/customer_name.rb

@@ -0,0 +1,88 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The customer name to be used for line usage taxation.
+  class CustomerName < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An optional title for the customer, such as “Mr.” or “Dr.”
+    # @return [String]
+    attr_accessor :title
+
+    # The customer's first name.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The customer's middle name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # The customer's last name.
+    # @return [String]
+    attr_accessor :last_name
+
+    # An optional suffix for the customer name, such as “Jr.” or “III.”
+    # @return [String]
+    attr_accessor :suffix
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['first_name'] = 'firstName'
+      @_hash['middle_name'] = 'middleName'
+      @_hash['last_name'] = 'lastName'
+      @_hash['suffix'] = 'suffix'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        title
+        middle_name
+        suffix
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first_name = nil,
+                   last_name = nil,
+                   title = SKIP,
+                   middle_name = SKIP,
+                   suffix = SKIP)
+      @title = title unless title == SKIP
+      @first_name = first_name
+      @middle_name = middle_name unless middle_name == SKIP
+      @last_name = last_name
+      @suffix = suffix unless suffix == 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.
+      first_name = hash.key?('firstName') ? hash['firstName'] : nil
+      last_name = hash.key?('lastName') ? hash['lastName'] : nil
+      title = hash.key?('title') ? hash['title'] : SKIP
+      middle_name = hash.key?('middleName') ? hash['middleName'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+
+      # Create object from extracted values.
+      CustomerName.new(first_name,
+                       last_name,
+                       title,
+                       middle_name,
+                       suffix)
+    end
+  end
+end

data/lib/verizon/models/customernamequery.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Customernamequery Model.
+  class Customernamequery < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CustomerName]]
+    attr_accessor :customer_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_name'] = 'customerName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer_name = SKIP)
+      @customer_name = customer_name unless customer_name == 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.
+      # Parameter is an array, so we need to iterate through it
+      customer_name = nil
+      unless hash['customerName'].nil?
+        customer_name = []
+        hash['customerName'].each do |structure|
+          customer_name << (CustomerName.from_hash(structure) if structure)
+        end
+      end
+
+      customer_name = SKIP unless hash.key?('customerName')
+
+      # Create object from extracted values.
+      Customernamequery.new(customer_name)
+    end
+  end
+end

data/lib/verizon/models/cycle_type_enum.rb

@@ -0,0 +1,23 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # CycleType.
+  class CycleTypeEnum
+    CYCLE_TYPE_ENUM = [
+      # TODO: Write general description for CYCLEONE
+      CYCLEONE = 'cycleone'.freeze,
+
+      # TODO: Write general description for CYCLETWO
+      CYCLETWO = 'cycletwo'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CYCLE_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/daily_usage_item.rb

@@ -0,0 +1,70 @@
+# 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