specs-sdk 1.3.0

data/lib/verizon/models/oauth_token.rb

@@ -0,0 +1,100 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # OAuth 2 Authorization endpoint response
+  class OauthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token = nil,
+                   token_type = nil,
+                   expires_in = SKIP,
+                   scope = SKIP,
+                   expiry = SKIP,
+                   refresh_token = SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Create object from extracted values.
+      OauthToken.new(access_token,
+                     token_type,
+                     expires_in,
+                     scope,
+                     expiry,
+                     refresh_token)
+    end
+  end
+end

data/lib/verizon/models/observation_request.rb

@@ -0,0 +1,107 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Used to define callbacks including the device identity, the attribute names,
+  # corresponding attribute values and the date/timestamp of when the
+  # observation was made.
+  class ObservationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # List of devices.
+    # @return [Array[Device]]
+    attr_accessor :devices
+
+    # Attributes are streaming RF parameters that you want to observe.
+    # @return [Array[ObservationRequestAttribute]]
+    attr_accessor :attributes
+
+    # Describes value and unit of time.
+    # @return [NumericalData]
+    attr_accessor :frequency
+
+    # Describes value and unit of time.
+    # @return [NumericalData]
+    attr_accessor :duration
+
+    # 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['attributes'] = 'attributes'
+      @_hash['frequency'] = 'frequency'
+      @_hash['duration'] = 'duration'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        frequency
+        duration
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   devices = nil,
+                   attributes = nil,
+                   frequency = SKIP,
+                   duration = SKIP)
+      @account_name = account_name
+      @devices = devices
+      @attributes = attributes
+      @frequency = frequency unless frequency == SKIP
+      @duration = duration unless 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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (Device.from_hash(structure) if structure)
+        end
+      end
+
+      devices = nil unless hash.key?('devices')
+      # Parameter is an array, so we need to iterate through it
+      attributes = nil
+      unless hash['attributes'].nil?
+        attributes = []
+        hash['attributes'].each do |structure|
+          attributes << (ObservationRequestAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      attributes = nil unless hash.key?('attributes')
+      frequency = NumericalData.from_hash(hash['frequency']) if hash['frequency']
+      duration = NumericalData.from_hash(hash['duration']) if hash['duration']
+
+      # Create object from extracted values.
+      ObservationRequest.new(account_name,
+                             devices,
+                             attributes,
+                             frequency,
+                             duration)
+    end
+  end
+end

data/lib/verizon/models/observation_request_attribute.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Streaming RF parameter that you want to observe.
+  class ObservationRequestAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Attribute identifier.
+    # @return [AttributeIdentifierEnum]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP)
+      @name = name unless 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      ObservationRequestAttribute.new(name)
+    end
+  end
+end

data/lib/verizon/models/place_of_use.rb

@@ -0,0 +1,63 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The customer name and the address of the device's primary place of use.
+  # Leave these fields empty to use the account profile address as the primary
+  # place of use. These values will be applied to all devices in the request.If
+  # the account is enabled for non-geographic MDNs and the device supports it,
+  # the primaryPlaceOfUse address will also be used to derive the MDN for the
+  # device.
+  class PlaceOfUse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The customer address for the line's primary place of use, for line usage
+    # taxation.
+    # @return [Address]
+    attr_accessor :address
+
+    # The customer name to be used for line usage taxation.
+    # @return [CustomerName]
+    attr_accessor :customer_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['customer_name'] = 'customerName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address = nil,
+                   customer_name = nil)
+      @address = address
+      @customer_name = customer_name
+    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 = Address.from_hash(hash['address']) if hash['address']
+      customer_name = CustomerName.from_hash(hash['customerName']) if hash['customerName']
+
+      # Create object from extracted values.
+      PlaceOfUse.new(address,
+                     customer_name)
+    end
+  end
+end

data/lib/verizon/models/position_data.rb

@@ -0,0 +1,100 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Position data.
+  class PositionData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Time location obtained.
+    # @return [String]
+    attr_accessor :time
+
+    # UTC offset of time.
+    # @return [String]
+    attr_accessor :utcoffset
+
+    # X coordinate of location.
+    # @return [String]
+    attr_accessor :x
+
+    # Y coordinate of location.
+    # @return [String]
+    attr_accessor :y
+
+    # Radius of the location in meters.
+    # @return [String]
+    attr_accessor :radius
+
+    # Whether requested accurary is met or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :qos
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['time'] = 'time'
+      @_hash['utcoffset'] = 'utcoffset'
+      @_hash['x'] = 'x'
+      @_hash['y'] = 'y'
+      @_hash['radius'] = 'radius'
+      @_hash['qos'] = 'qos'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        time
+        utcoffset
+        x
+        y
+        radius
+        qos
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(time = SKIP,
+                   utcoffset = SKIP,
+                   x = SKIP,
+                   y = SKIP,
+                   radius = SKIP,
+                   qos = SKIP)
+      @time = time unless time == SKIP
+      @utcoffset = utcoffset unless utcoffset == SKIP
+      @x = x unless x == SKIP
+      @y = y unless y == SKIP
+      @radius = radius unless radius == SKIP
+      @qos = qos unless qos == 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.
+      time = hash.key?('time') ? hash['time'] : SKIP
+      utcoffset = hash.key?('utcoffset') ? hash['utcoffset'] : SKIP
+      x = hash.key?('x') ? hash['x'] : SKIP
+      y = hash.key?('y') ? hash['y'] : SKIP
+      radius = hash.key?('radius') ? hash['radius'] : SKIP
+      qos = hash.key?('qos') ? hash['qos'] : SKIP
+
+      # Create object from extracted values.
+      PositionData.new(time,
+                       utcoffset,
+                       x,
+                       y,
+                       radius,
+                       qos)
+    end
+  end
+end

data/lib/verizon/models/position_error.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Position error.
+  class PositionError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Time location obtained.
+    # @return [String]
+    attr_accessor :time
+
+    # UTC offset of time.
+    # @return [String]
+    attr_accessor :utcoffset
+
+    # Error type returned from location server.
+    # @return [String]
+    attr_accessor :type
+
+    # Additional information about the error.
+    # @return [String]
+    attr_accessor :info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['time'] = 'time'
+      @_hash['utcoffset'] = 'utcoffset'
+      @_hash['type'] = 'type'
+      @_hash['info'] = 'info'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        time
+        utcoffset
+        type
+        info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(time = SKIP,
+                   utcoffset = SKIP,
+                   type = SKIP,
+                   info = SKIP)
+      @time = time unless time == SKIP
+      @utcoffset = utcoffset unless utcoffset == SKIP
+      @type = type unless type == SKIP
+      @info = info unless info == 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.
+      time = hash.key?('time') ? hash['time'] : SKIP
+      utcoffset = hash.key?('utcoffset') ? hash['utcoffset'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      info = hash.key?('info') ? hash['info'] : SKIP
+
+      # Create object from extracted values.
+      PositionError.new(time,
+                        utcoffset,
+                        type,
+                        info)
+    end
+  end
+end

data/lib/verizon/models/primary_place_of_use.rb

@@ -0,0 +1,78 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # PrimaryPlaceOfUse Model.
+  class PrimaryPlaceOfUse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CustomerName]]
+    attr_accessor :customer_name
+
+    # 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['customer_name'] = 'customerName'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_name
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer_name = SKIP,
+                   address = SKIP)
+      @customer_name = customer_name unless customer_name == 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
+      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')
+      # 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.
+      PrimaryPlaceOfUse.new(customer_name,
+                            address)
+    end
+  end
+end

data/lib/verizon/models/profile_change_state_request.rb

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