sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/anomaly_trigger_value.rb

@@ -0,0 +1,120 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Trigger details.
+  class AnomalyTriggerValue < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The system assigned name of the trigger being updated.
+    # @return [String]
+    attr_accessor :trigger_id
+
+    # The user defined name of the trigger.
+    # @return [String]
+    attr_accessor :trigger_name
+
+    # The user assigned name of the organization associated with the trigger.
+    # @return [String]
+    attr_accessor :organization_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
+
+    # Additional details and keys for the trigger.
+    # @return [Array[TriggerAttributesOptions]]
+    attr_accessor :trigger_attributes
+
+    # Timestamp for whe the trigger was created.
+    # @return [String]
+    attr_accessor :created_at
+
+    # Timestamp for the most recent time the trigger was modified.
+    # @return [String]
+    attr_accessor :modified_at
+
+    # 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['organization_name'] = 'organizationName'
+      @_hash['trigger_category'] = 'triggerCategory'
+      @_hash['trigger_attributes'] = 'triggerAttributes'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['modified_at'] = 'modifiedAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        trigger_id
+        trigger_name
+        organization_name
+        trigger_category
+        trigger_attributes
+        created_at
+        modified_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(trigger_id = SKIP, trigger_name = SKIP,
+                   organization_name = SKIP, trigger_category = SKIP,
+                   trigger_attributes = SKIP, created_at = SKIP,
+                   modified_at = SKIP)
+      @trigger_id = trigger_id unless trigger_id == SKIP
+      @trigger_name = trigger_name unless trigger_name == SKIP
+      @organization_name = organization_name unless organization_name == SKIP
+      @trigger_category = trigger_category unless trigger_category == SKIP
+      @trigger_attributes = trigger_attributes unless trigger_attributes == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @modified_at = modified_at unless modified_at == 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.
+      trigger_id = hash.key?('triggerId') ? hash['triggerId'] : SKIP
+      trigger_name = hash.key?('triggerName') ? hash['triggerName'] : SKIP
+      organization_name =
+        hash.key?('organizationName') ? hash['organizationName'] : SKIP
+      trigger_category =
+        hash.key?('triggerCategory') ? hash['triggerCategory'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      trigger_attributes = nil
+      unless hash['triggerAttributes'].nil?
+        trigger_attributes = []
+        hash['triggerAttributes'].each do |structure|
+          trigger_attributes << (TriggerAttributesOptions.from_hash(structure) if structure)
+        end
+      end
+
+      trigger_attributes = SKIP unless hash.key?('triggerAttributes')
+      created_at = hash.key?('createdAt') ? hash['createdAt'] : SKIP
+      modified_at = hash.key?('modifiedAt') ? hash['modifiedAt'] : SKIP
+
+      # Create object from extracted values.
+      AnomalyTriggerValue.new(trigger_id,
+                              trigger_name,
+                              organization_name,
+                              trigger_category,
+                              trigger_attributes,
+                              created_at,
+                              modified_at)
+    end
+  end
+end

data/lib/verizon/models/api_response_code.rb

@@ -0,0 +1,56 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ResponseCode and/or a message indicating success or failure of the request.
+  class ApiResponseCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Possible response codes.
+    # @return [ResponseCodeEnum]
+    attr_accessor :response_code
+
+    # More details about the responseCode received.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response_code'] = 'responseCode'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response_code = nil, message = nil)
+      @response_code = response_code
+      @message = message
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      response_code = hash.key?('responseCode') ? hash['responseCode'] : nil
+      message = hash.key?('message') ? hash['message'] : nil
+
+      # Create object from extracted values.
+      ApiResponseCode.new(response_code,
+                          message)
+    end
+  end
+end

data/lib/verizon/models/assign_license_request.rb

@@ -0,0 +1,86 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to assign license.
+  class AssignLicenseRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.This parameter is required only if the UWS
+    # account used for the current API session has access to multiple accounts.
+    # An account name is usually numeric, and must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # A list of 4G devices.
+    # @return [Array[LicenseDeviceList]]
+    attr_accessor :devices
+
+    # The Stock Keeping Unit (SKU). Valid skuNumbers for license types:
+    # “SIMSec-IoT-Lt”. (Lifetime) Once a license is assigned to a SIM, the
+    # SIM-Secure feature is enabled for the life of the
+    # SIM.“TS-BUNDLE-KTO-SIMSEC-MRC”. (Bundle) The SIM-Secure Flex license can
+    # be assigned to or removed from a SIM at any time. This SKU is bundled with
+    # other ThingSpace Services.“SIMSec-IoT”. (Flex) The SIM-Secure Flex license
+    # can be assigned to or removed from a SIM at any time. This SKU is
+    # purchased a la carte.
+    # @return [String]
+    attr_accessor :sku_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['devices'] = 'devices'
+      @_hash['sku_number'] = 'skuNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        devices
+        sku_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, devices = SKIP, sku_number = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @devices = devices unless devices == SKIP
+      @sku_number = sku_number unless sku_number == 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
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (LicenseDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+      sku_number = hash.key?('skuNumber') ? hash['skuNumber'] : SKIP
+
+      # Create object from extracted values.
+      AssignLicenseRequest.new(account_name,
+                               devices,
+                               sku_number)
+    end
+  end
+end

data/lib/verizon/models/associate_label_request.rb

@@ -0,0 +1,57 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # AssociateLabelRequest Model.
+  class AssociateLabelRequest < 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
+
+    # Maximum of 2,000 objects are allowed in the array.
+    # @return [AccountLabels]
+    attr_accessor :labels
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['labels'] = 'labels'
+      @_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, labels = nil)
+      @account_name = account_name
+      @labels = labels
+    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
+      labels = AccountLabels.from_hash(hash['labels']) if hash['labels']
+
+      # Create object from extracted values.
+      AssociateLabelRequest.new(account_name,
+                                labels)
+    end
+  end
+end

data/lib/verizon/models/asynchronous_location_request_result.rb

@@ -0,0 +1,69 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # AsynchronousLocationRequestResult Model.
+  class AsynchronousLocationRequestResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The transaction ID of the report.
+    # @return [String]
+    attr_accessor :txid
+
+    # Status of the report.
+    # @return [ReportStatusEnum]
+    attr_accessor :status
+
+    # Estimated number of minutes required to complete the report.
+    # @return [String]
+    attr_accessor :estimated_duration
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['txid'] = 'txid'
+      @_hash['status'] = 'status'
+      @_hash['estimated_duration'] = 'estimatedDuration'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        txid
+        status
+        estimated_duration
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(txid = SKIP, status = SKIP, estimated_duration = SKIP)
+      @txid = txid unless txid == SKIP
+      @status = status unless status == SKIP
+      @estimated_duration = estimated_duration unless estimated_duration == 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.
+      txid = hash.key?('txid') ? hash['txid'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      estimated_duration =
+        hash.key?('estimatedDuration') ? hash['estimatedDuration'] : SKIP
+
+      # Create object from extracted values.
+      AsynchronousLocationRequestResult.new(txid,
+                                            status,
+                                            estimated_duration)
+    end
+  end
+end

data/lib/verizon/models/asynchronous_request_result.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A successful request returns the request ID and the current status.
+  class AsynchronousRequestResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID of the asynchronous request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # The current status of the callback response.
+    # @return [RequestStatusEnum]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'requestId'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP, status = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == 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
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      AsynchronousRequestResult.new(request_id,
+                                    status)
+    end
+  end
+end

data/lib/verizon/models/attribute_identifier_enum.rb

@@ -0,0 +1,32 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Attribute identifier.
+  class AttributeIdentifierEnum
+    ATTRIBUTE_IDENTIFIER_ENUM = [
+      # TODO: Write general description for NETWORK_BEARER
+      NETWORK_BEARER = 'NETWORK_BEARER'.freeze,
+
+      # TODO: Write general description for RADIO_SIGNAL_STRENGTH
+      RADIO_SIGNAL_STRENGTH = 'RADIO_SIGNAL_STRENGTH'.freeze,
+
+      # TODO: Write general description for LINK_QUALITY
+      LINK_QUALITY = 'LINK_QUALITY'.freeze,
+
+      # TODO: Write general description for CELL_ID
+      CELL_ID = 'CELL_ID'.freeze,
+
+      # TODO: Write general description for MANUFACTURER
+      MANUFACTURER = 'MANUFACTURER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ATTRIBUTE_IDENTIFIER_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/attribute_setting.rb

@@ -0,0 +1,106 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Describes an attribute being observed and the frequency with which the
+  # attribute is being observed.
+  class AttributeSetting < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Attribute identifier.
+    # @return [AttributeIdentifierEnum]
+    attr_accessor :name
+
+    # Attribute value.
+    # @return [String]
+    attr_accessor :value
+
+    # Date and time request was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Is the attribute observable?
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_observable
+
+    # Is the attribute being observed?
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_observing
+
+    # Describes value and unit of time.
+    # @return [NumericalData]
+    attr_accessor :frequency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_hash['created_on'] = 'createdOn'
+      @_hash['is_observable'] = 'isObservable'
+      @_hash['is_observing'] = 'isObserving'
+      @_hash['frequency'] = 'frequency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        value
+        created_on
+        is_observable
+        is_observing
+        frequency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, value = SKIP, created_on = SKIP,
+                   is_observable = SKIP, is_observing = SKIP, frequency = SKIP)
+      @name = name unless name == SKIP
+      @value = value unless value == SKIP
+      @created_on = created_on unless created_on == SKIP
+      @is_observable = is_observable unless is_observable == SKIP
+      @is_observing = is_observing unless is_observing == SKIP
+      @frequency = frequency unless frequency == 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
+      value = hash.key?('value') ? hash['value'] : SKIP
+      created_on = if hash.key?('createdOn')
+                     (DateTimeHelper.from_rfc3339(hash['createdOn']) if hash['createdOn'])
+                   else
+                     SKIP
+                   end
+      is_observable = hash.key?('isObservable') ? hash['isObservable'] : SKIP
+      is_observing = hash.key?('isObserving') ? hash['isObserving'] : SKIP
+      frequency = NumericalData.from_hash(hash['frequency']) if hash['frequency']
+
+      # Create object from extracted values.
+      AttributeSetting.new(name,
+                           value,
+                           created_on,
+                           is_observable,
+                           is_observing,
+                           frequency)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+  end
+end

data/lib/{verizon_thing_space_quality_of_service_api_endpoints → verizon}/models/base_model.rb

@@ -1,9 +1,9 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
+module Verizon
   # Base model.
   class BaseModel < CoreLibrary::BaseModel
     # Returns a Hash representation of the current object.

data/lib/verizon/models/bill_usage_request.rb

@@ -0,0 +1,76 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Bill usage request.
+  class BillUsageRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Start date to search for billable usage, mm-dd-yyyy.
+    # @return [String]
+    attr_accessor :start_date
+
+    # End date to search for billable usage, mm-dd-yyyy.
+    # @return [String]
+    attr_accessor :end_date
+
+    # Request usage for single or multiple accounts.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :usage_for_all_accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['usage_for_all_accounts'] = 'usageForAllAccounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        usage_for_all_accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, start_date = nil, end_date = nil,
+                   usage_for_all_accounts = SKIP)
+      @account_name = account_name
+      @start_date = start_date
+      @end_date = end_date
+      @usage_for_all_accounts = usage_for_all_accounts unless usage_for_all_accounts == 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
+      start_date = hash.key?('startDate') ? hash['startDate'] : nil
+      end_date = hash.key?('endDate') ? hash['endDate'] : nil
+      usage_for_all_accounts =
+        hash.key?('usageForAllAccounts') ? hash['usageForAllAccounts'] : SKIP
+
+      # Create object from extracted values.
+      BillUsageRequest.new(account_name,
+                           start_date,
+                           end_date,
+                           usage_for_all_accounts)
+    end
+  end
+end