sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/add_devices_result.rb

@@ -0,0 +1,69 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Contains the device identifiers and a success or failure response for each
+  # device in the request.
+  class AddDevicesResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifiers for the device.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # The success message or error message for the current device.
+    # @return [String]
+    attr_accessor :response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['response'] = 'response'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+        response
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = SKIP, response = SKIP)
+      @device_ids = device_ids unless device_ids == SKIP
+      @response = response unless response == 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
+      device_ids = nil
+      unless hash['deviceIds'].nil?
+        device_ids = []
+        hash['deviceIds'].each do |structure|
+          device_ids << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+      response = hash.key?('response') ? hash['response'] : SKIP
+
+      # Create object from extracted values.
+      AddDevicesResult.new(device_ids,
+                           response)
+    end
+  end
+end

data/lib/verizon/models/address.rb

@@ -0,0 +1,130 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The customer address for the line's primary place of use, for line usage
+  # taxation.
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The street address for the line's primary place of use. This must be a
+    # physical address for taxation; it cannot be a P.O. box.
+    # @return [String]
+    attr_accessor :address_line1
+
+    # Optional additional street address information.
+    # @return [String]
+    attr_accessor :address_line2
+
+    # The city for the line's primary place of use.
+    # @return [String]
+    attr_accessor :city
+
+    # The state for the line's primary place of use.
+    # @return [String]
+    attr_accessor :state
+
+    # The ZIP code for the line's primary place of use.
+    # @return [String]
+    attr_accessor :zip
+
+    # The ZIP+4 for the line's primary place of use.
+    # @return [String]
+    attr_accessor :zip4
+
+    # Either “US” or “USA” for the country of the line's primary place of use.
+    # @return [String]
+    attr_accessor :country
+
+    # A phone number where the customer can be reached.
+    # @return [String]
+    attr_accessor :phone
+
+    # A single letter to indicate the customer phone type.
+    # @return [String]
+    attr_accessor :phone_type
+
+    # An email address for the customer.
+    # @return [String]
+    attr_accessor :email_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_line1'] = 'addressLine1'
+      @_hash['address_line2'] = 'addressLine2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['zip4'] = 'zip4'
+      @_hash['country'] = 'country'
+      @_hash['phone'] = 'phone'
+      @_hash['phone_type'] = 'phoneType'
+      @_hash['email_address'] = 'emailAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_line2
+        zip4
+        phone
+        phone_type
+        email_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address_line1 = nil, city = nil, state = nil, zip = nil,
+                   country = nil, address_line2 = SKIP, zip4 = SKIP,
+                   phone = SKIP, phone_type = SKIP, email_address = SKIP)
+      @address_line1 = address_line1
+      @address_line2 = address_line2 unless address_line2 == SKIP
+      @city = city
+      @state = state
+      @zip = zip
+      @zip4 = zip4 unless zip4 == SKIP
+      @country = country
+      @phone = phone unless phone == SKIP
+      @phone_type = phone_type unless phone_type == SKIP
+      @email_address = email_address unless email_address == 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.
+      address_line1 = hash.key?('addressLine1') ? hash['addressLine1'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      state = hash.key?('state') ? hash['state'] : nil
+      zip = hash.key?('zip') ? hash['zip'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      address_line2 = hash.key?('addressLine2') ? hash['addressLine2'] : SKIP
+      zip4 = hash.key?('zip4') ? hash['zip4'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      phone_type = hash.key?('phoneType') ? hash['phoneType'] : SKIP
+      email_address = hash.key?('emailAddress') ? hash['emailAddress'] : SKIP
+
+      # Create object from extracted values.
+      Address.new(address_line1,
+                  city,
+                  state,
+                  zip,
+                  country,
+                  address_line2,
+                  zip4,
+                  phone,
+                  phone_type,
+                  email_address)
+    end
+  end
+end

data/lib/verizon/models/address_item.rb

@@ -0,0 +1,105 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Address details.
+  class AddressItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Street Address.
+    # @return [String]
+    attr_accessor :address_line1
+
+    # Optional address information.
+    # @return [String]
+    attr_accessor :address_line2
+
+    # Name of the city.
+    # @return [String]
+    attr_accessor :city
+
+    # State code.
+    # @return [String]
+    attr_accessor :state
+
+    # Country.
+    # @return [String]
+    attr_accessor :country
+
+    # Five digit zipcode.
+    # @return [String]
+    attr_accessor :zip
+
+    # Four digit zip code.
+    # @return [String]
+    attr_accessor :zip4
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_line1'] = 'addressLine1'
+      @_hash['address_line2'] = 'addressLine2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['country'] = 'country'
+      @_hash['zip'] = 'zip'
+      @_hash['zip4'] = 'zip4'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_line1
+        address_line2
+        city
+        state
+        country
+        zip
+        zip4
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address_line1 = SKIP, address_line2 = SKIP, city = SKIP,
+                   state = SKIP, country = SKIP, zip = SKIP, zip4 = SKIP)
+      @address_line1 = address_line1 unless address_line1 == SKIP
+      @address_line2 = address_line2 unless address_line2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @country = country unless country == SKIP
+      @zip = zip unless zip == SKIP
+      @zip4 = zip4 unless zip4 == 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.
+      address_line1 = hash.key?('addressLine1') ? hash['addressLine1'] : SKIP
+      address_line2 = hash.key?('addressLine2') ? hash['addressLine2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      zip4 = hash.key?('zip4') ? hash['zip4'] : SKIP
+
+      # Create object from extracted values.
+      AddressItem.new(address_line1,
+                      address_line2,
+                      city,
+                      state,
+                      country,
+                      zip,
+                      zip4)
+    end
+  end
+end

data/lib/verizon/models/addressquery.rb

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

data/lib/verizon/models/aggregate_session_report.rb

@@ -0,0 +1,90 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Session and usage details for up to 10 devices.
+  class AggregateSessionReport < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique string that associates the request with the location report
+    # information that is sent in asynchronous callback message.ThingSpace will
+    # send a separate callback message for each device that was in the request.
+    # All of the callback messages will have the same txid.
+    # @return [String]
+    attr_accessor :txid
+
+    # Contains usage per device.
+    # @return [Array[AggregateUsageItem]]
+    attr_accessor :usage
+
+    # An object containing any errors reported by the device.
+    # @return [Array[AggregateUsageError]]
+    attr_accessor :errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['txid'] = 'txid'
+      @_hash['usage'] = 'usage'
+      @_hash['errors'] = 'errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        usage
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        txid
+      ]
+    end
+
+    def initialize(txid = nil, usage = SKIP, errors = SKIP)
+      @txid = txid
+      @usage = usage unless usage == SKIP
+      @errors = errors unless errors == 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'] : nil
+      # Parameter is an array, so we need to iterate through it
+      usage = nil
+      unless hash['usage'].nil?
+        usage = []
+        hash['usage'].each do |structure|
+          usage << (AggregateUsageItem.from_hash(structure) if structure)
+        end
+      end
+
+      usage = SKIP unless hash.key?('usage')
+      # Parameter is an array, so we need to iterate through it
+      errors = nil
+      unless hash['errors'].nil?
+        errors = []
+        hash['errors'].each do |structure|
+          errors << (AggregateUsageError.from_hash(structure) if structure)
+        end
+      end
+
+      errors = SKIP unless hash.key?('errors')
+
+      # Create object from extracted values.
+      AggregateSessionReport.new(txid,
+                                 usage,
+                                 errors)
+    end
+  end
+end

data/lib/verizon/models/aggregate_session_report_request.rb

@@ -0,0 +1,124 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request for getting an aggregated session report.
+  class AggregateSessionReportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the account.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Start date of session to include. If not specified  information will be
+    # shown from the earliest available (180 days). Can be either date in ISO
+    # 8601 format or predefined constants.
+    # @return [String]
+    attr_accessor :start_date
+
+    # End date of session to include. If not specified  information will be
+    # shown to the latest available. Can be either date in ISO 8601 format or
+    # predefined constants.
+    # @return [String]
+    attr_accessor :end_date
+
+    # Devices for which return usage info. Could be 0, 1 or more. In case of 0
+    # will return all devices belonging to customer (except of filtered by other
+    # parameters).
+    # @return [Array[String]]
+    attr_accessor :imei
+
+    # User defined group name the devices are a member of.
+    # @return [String]
+    attr_accessor :device_group
+
+    # Optional filter parameter.
+    # @return [String]
+    attr_accessor :device_label
+
+    # The data plan the devices beign queried belong to.
+    # @return [String]
+    attr_accessor :data_plan
+
+    # Optional filter parameter which return only devices with no sessions.
+    # @return [String]
+    attr_accessor :no_session_flag
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['imei'] = 'imei'
+      @_hash['device_group'] = 'deviceGroup'
+      @_hash['device_label'] = 'deviceLabel'
+      @_hash['data_plan'] = 'dataPlan'
+      @_hash['no_session_flag'] = 'noSessionFlag'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+        device_group
+        device_label
+        data_plan
+        no_session_flag
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        device_group
+        device_label
+        data_plan
+      ]
+    end
+
+    def initialize(account_number = nil, imei = nil, start_date = SKIP,
+                   end_date = SKIP, device_group = SKIP, device_label = SKIP,
+                   data_plan = SKIP, no_session_flag = SKIP)
+      @account_number = account_number
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @imei = imei
+      @device_group = device_group unless device_group == SKIP
+      @device_label = device_label unless device_label == SKIP
+      @data_plan = data_plan unless data_plan == SKIP
+      @no_session_flag = no_session_flag unless no_session_flag == 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'] : nil
+      imei = hash.key?('imei') ? hash['imei'] : nil
+      start_date = hash.key?('startDate') ? hash['startDate'] : SKIP
+      end_date = hash.key?('endDate') ? hash['endDate'] : SKIP
+      device_group = hash.key?('deviceGroup') ? hash['deviceGroup'] : SKIP
+      device_label = hash.key?('deviceLabel') ? hash['deviceLabel'] : SKIP
+      data_plan = hash.key?('dataPlan') ? hash['dataPlan'] : SKIP
+      no_session_flag =
+        hash.key?('noSessionFlag') ? hash['noSessionFlag'] : SKIP
+
+      # Create object from extracted values.
+      AggregateSessionReportRequest.new(account_number,
+                                        imei,
+                                        start_date,
+                                        end_date,
+                                        device_group,
+                                        device_label,
+                                        data_plan,
+                                        no_session_flag)
+    end
+  end
+end

data/lib/verizon/models/aggregate_usage.rb

@@ -0,0 +1,79 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # AggregateUsage Model.
+  class AggregateUsage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [GIODeviceId]
+    attr_accessor :device_id
+
+    # The numeric name of the account, in the format "0000123456-00001". Leading
+    # zeros must be included.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The start date of the time period queried as "$datetime"
+    # @return [String]
+    attr_accessor :earliest
+
+    # The end date of the time period being queried as "$datetime"
+    # @return [String]
+    attr_accessor :latest
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['account_name'] = 'accountName'
+      @_hash['earliest'] = 'earliest'
+      @_hash['latest'] = 'latest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_id
+        account_name
+        earliest
+        latest
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP, account_name = SKIP, earliest = SKIP,
+                   latest = SKIP)
+      @device_id = device_id unless device_id == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @earliest = earliest unless earliest == SKIP
+      @latest = latest unless latest == 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 = GIODeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      earliest = hash.key?('earliest') ? hash['earliest'] : SKIP
+      latest = hash.key?('latest') ? hash['latest'] : SKIP
+
+      # Create object from extracted values.
+      AggregateUsage.new(device_id,
+                         account_name,
+                         earliest,
+                         latest)
+    end
+  end
+end