specs-sdk 1.3.0

data/lib/verizon/models/add_devices_request.rb

@@ -0,0 +1,131 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to add the devices.
+  class AddDevicesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The initial service state for the devices. The only valid state is
+    # “Preactive.”
+    # @return [String]
+    attr_accessor :state
+
+    # The devices that you want to add.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices_to_add
+
+    # The billing account to which the devices are added.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The names and values for any custom fields that you want set for the
+    # devices as they are added to the account.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # The name of a device group to add the devices to. They are added to the
+    # default device group if you don't include this parameter.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The Stock Keeping Unit (SKU) number of a 4G device type with an embedded
+    # SIM.
+    # @return [String]
+    attr_accessor :sku_number
+
+    # The Stock Keeping Unit (SKU) number of a 4G device type with an embedded
+    # SIM.
+    # @return [String]
+    attr_accessor :smsr_oid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['state'] = 'state'
+      @_hash['devices_to_add'] = 'devicesToAdd'
+      @_hash['account_name'] = 'accountName'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['group_name'] = 'groupName'
+      @_hash['sku_number'] = 'skuNumber'
+      @_hash['smsr_oid'] = 'smsrOid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        custom_fields
+        group_name
+        sku_number
+        smsr_oid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(state = nil,
+                   devices_to_add = nil,
+                   account_name = SKIP,
+                   custom_fields = SKIP,
+                   group_name = SKIP,
+                   sku_number = SKIP,
+                   smsr_oid = SKIP)
+      @state = state
+      @devices_to_add = devices_to_add
+      @account_name = account_name unless account_name == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @sku_number = sku_number unless sku_number == SKIP
+      @smsr_oid = smsr_oid unless smsr_oid == 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.
+      state = hash.key?('state') ? hash['state'] : nil
+      # Parameter is an array, so we need to iterate through it
+      devices_to_add = nil
+      unless hash['devicesToAdd'].nil?
+        devices_to_add = []
+        hash['devicesToAdd'].each do |structure|
+          devices_to_add << (AccountDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices_to_add = nil unless hash.key?('devicesToAdd')
+      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')
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      sku_number = hash.key?('skuNumber') ? hash['skuNumber'] : SKIP
+      smsr_oid = hash.key?('smsrOid') ? hash['smsrOid'] : SKIP
+
+      # Create object from extracted values.
+      AddDevicesRequest.new(state,
+                            devices_to_add,
+                            account_name,
+                            custom_fields,
+                            group_name,
+                            sku_number,
+                            smsr_oid)
+    end
+  end
+end

data/lib/verizon/models/add_devices_result.rb

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