sdksio-verizon-apis-sdk 1.0.0 → 1.4.0

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,110 @@
+# 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/models/base_model.rb

@@ -0,0 +1,62 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Base model.
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        optional_fields = self.class.optionals
+        nullable_fields = self.class.nullables
+        if value.nil?
+          next unless nullable_fields.include?(name)
+
+          if !optional_fields.include?(name) && !nullable_fields.include?(name)
+            raise ArgumentError,
+                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+          end
+        end
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_custom_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_custom_#{name}", *params)
+            else
+              hash[key] = send("to_custom_#{name}")
+            end
+          elsif respond_to?("to_union_type_#{name}")
+            hash[key] = send("to_union_type_#{name}")
+          elsif value.instance_of? Array
+            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+          elsif value.instance_of? Hash
+            hash[key] = {}
+            value.each do |k, v|
+              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+            end
+          else
+            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+          end
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/verizon/models/bill_usage_request.rb

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

data/lib/verizon/models/billable_usage_report.rb

@@ -0,0 +1,124 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Bill usage report.
+  class BillableUsageReport < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The usage is for a single or multiple accounts.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :usage_for_all_accounts
+
+    # SKU Name of the service subscription.
+    # @return [String]
+    attr_accessor :sku_name
+
+    # The number of location requests included with the subscription type.
+    # @return [String]
+    attr_accessor :transactions_allowed
+
+    # The total number of billable device location requests during the reporting
+    # period from all included accounts.
+    # @return [String]
+    attr_accessor :total_transaction_count
+
+    # The total number of billable device location requests during the reporting
+    # period from all included accounts.
+    # @return [ServiceUsage]
+    attr_accessor :primary_account
+
+    # Zero or more managed accounts.
+    # @return [Array[ServiceUsage]]
+    attr_accessor :managed_accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['usage_for_all_accounts'] = 'usageForAllAccounts'
+      @_hash['sku_name'] = 'skuName'
+      @_hash['transactions_allowed'] = 'transactionsAllowed'
+      @_hash['total_transaction_count'] = 'totalTransactionCount'
+      @_hash['primary_account'] = 'PrimaryAccount'
+      @_hash['managed_accounts'] = 'ManagedAccounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        usage_for_all_accounts
+        sku_name
+        transactions_allowed
+        total_transaction_count
+        primary_account
+        managed_accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   usage_for_all_accounts = SKIP,
+                   sku_name = SKIP,
+                   transactions_allowed = SKIP,
+                   total_transaction_count = SKIP,
+                   primary_account = SKIP,
+                   managed_accounts = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @usage_for_all_accounts = usage_for_all_accounts unless usage_for_all_accounts == SKIP
+      @sku_name = sku_name unless sku_name == SKIP
+      @transactions_allowed = transactions_allowed unless transactions_allowed == SKIP
+      @total_transaction_count = total_transaction_count unless total_transaction_count == SKIP
+      @primary_account = primary_account unless primary_account == SKIP
+      @managed_accounts = managed_accounts unless managed_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'] : SKIP
+      usage_for_all_accounts =
+        hash.key?('usageForAllAccounts') ? hash['usageForAllAccounts'] : SKIP
+      sku_name = hash.key?('skuName') ? hash['skuName'] : SKIP
+      transactions_allowed =
+        hash.key?('transactionsAllowed') ? hash['transactionsAllowed'] : SKIP
+      total_transaction_count =
+        hash.key?('totalTransactionCount') ? hash['totalTransactionCount'] : SKIP
+      primary_account = ServiceUsage.from_hash(hash['PrimaryAccount']) if hash['PrimaryAccount']
+      # Parameter is an array, so we need to iterate through it
+      managed_accounts = nil
+      unless hash['ManagedAccounts'].nil?
+        managed_accounts = []
+        hash['ManagedAccounts'].each do |structure|
+          managed_accounts << (ServiceUsage.from_hash(structure) if structure)
+        end
+      end
+
+      managed_accounts = SKIP unless hash.key?('ManagedAccounts')
+
+      # Create object from extracted values.
+      BillableUsageReport.new(account_name,
+                              usage_for_all_accounts,
+                              sku_name,
+                              transactions_allowed,
+                              total_transaction_count,
+                              primary_account,
+                              managed_accounts)
+    end
+  end
+end

data/lib/verizon/models/billedusage_list_request.rb

@@ -0,0 +1,89 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Information required to associate a usage segmentation label with a device
+  # to retrieve billing.
+  class BilledusageListRequest < 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 [LabelsList]
+    attr_accessor :labels
+
+    # TODO: Write general description for this method
+    # @return [Array[DeviceList]]
+    attr_accessor :device_ids
+
+    # TODO: Write general description for this method
+    # @return [BillingCycle]
+    attr_accessor :billing_cycle
+
+    # 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['device_ids'] = 'deviceIds'
+      @_hash['billing_cycle'] = 'billingCycle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        labels
+        device_ids
+        billing_cycle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   labels = SKIP,
+                   device_ids = SKIP,
+                   billing_cycle = SKIP)
+      @account_name = account_name
+      @labels = labels unless labels == SKIP
+      @device_ids = device_ids unless device_ids == SKIP
+      @billing_cycle = billing_cycle unless billing_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'] : nil
+      labels = LabelsList.from_hash(hash['labels']) if hash['labels']
+      # Parameter is an array, so we need to iterate through it
+      device_ids = nil
+      unless hash['deviceIds'].nil?
+        device_ids = []
+        hash['deviceIds'].each do |structure|
+          device_ids << (DeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+      billing_cycle = BillingCycle.from_hash(hash['billingCycle']) if hash['billingCycle']
+
+      # Create object from extracted values.
+      BilledusageListRequest.new(account_name,
+                                 labels,
+                                 device_ids,
+                                 billing_cycle)
+    end
+  end
+end

data/lib/verizon/models/billing_cycle.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # BillingCycle Model.
+  class BillingCycle < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :year
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :month
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['year'] = 'year'
+      @_hash['month'] = 'month'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        year
+        month
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(year = SKIP,
+                   month = SKIP)
+      @year = year unless year == SKIP
+      @month = month unless month == 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.
+      year = hash.key?('year') ? hash['year'] : SKIP
+      month = hash.key?('month') ? hash['month'] : SKIP
+
+      # Create object from extracted values.
+      BillingCycle.new(year,
+                       month)
+    end
+  end
+end

data/lib/verizon/models/bullseye_service_request.rb

@@ -0,0 +1,66 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Account number and list of devices.
+  class BullseyeServiceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of devices.
+    # @return [Array[DeviceServiceRequest]]
+    attr_accessor :device_list
+
+    # A unique identifier for an account.
+    # @return [String]
+    attr_accessor :account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_list'] = 'deviceList'
+      @_hash['account_number'] = 'accountNumber'
+      @_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,
+                   account_number = nil)
+      @device_list = device_list
+      @account_number = account_number
+    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
+      device_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (DeviceServiceRequest.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : nil
+
+      # Create object from extracted values.
+      BullseyeServiceRequest.new(device_list,
+                                 account_number)
+    end
+  end
+end

data/lib/verizon/models/bullseye_service_result.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Status of Hyper Precise Location on the device.
+  class BullseyeServiceResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account the device belongs to.
+    # @return [String]
+    attr_accessor :account_number
+
+    # List of devices.
+    # @return [Array[DeviceServiceInformation]]
+    attr_accessor :device_list
+
+    # ResponseCode and/or a message indicating success or failure of the
+    # request.
+    # @return [ApiResponseCode]
+    attr_accessor :response_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['device_list'] = 'deviceList'
+      @_hash['response_type'] = 'responseType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        device_list
+        response_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number = SKIP,
+                   device_list = SKIP,
+                   response_type = SKIP)
+      @account_number = account_number unless account_number == SKIP
+      @device_list = device_list unless device_list == SKIP
+      @response_type = response_type unless response_type == 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_number = hash.key?('accountNumber') ? hash['accountNumber'] : 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 << (DeviceServiceInformation.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = SKIP unless hash.key?('deviceList')
+      response_type = ApiResponseCode.from_hash(hash['responseType']) if hash['responseType']
+
+      # Create object from extracted values.
+      BullseyeServiceResult.new(account_number,
+                                device_list,
+                                response_type)
+    end
+  end
+end