specs-sdk 1.3.0

data/lib/verizon/models/connection_history_result.rb

@@ -0,0 +1,74 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response containing the connection history. It is a list of Network
+  # Connection Events for a device.
+  class ConnectionHistoryResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device connection events, sorted by the occurredAt timestamp, oldest
+    # first.
+    # @return [Array[ConnectionEvent]]
+    attr_accessor :connection_history
+
+    # False for a status 200 response.True for a status 202 response, indicating
+    # that there is more data to be retrieved. Send another request, adjusting
+    # the earliest value in the request based on the occuredAt value for the
+    # last device in the current response.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['connection_history'] = 'connectionHistory'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        connection_history
+        has_more_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(connection_history = SKIP,
+                   has_more_data = SKIP)
+      @connection_history = connection_history unless connection_history == SKIP
+      @has_more_data = has_more_data unless has_more_data == 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
+      connection_history = nil
+      unless hash['connectionHistory'].nil?
+        connection_history = []
+        hash['connectionHistory'].each do |structure|
+          connection_history << (ConnectionEvent.from_hash(structure) if structure)
+        end
+      end
+
+      connection_history = SKIP unless hash.key?('connectionHistory')
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+
+      # Create object from extracted values.
+      ConnectionHistoryResult.new(connection_history,
+                                  has_more_data)
+    end
+  end
+end

data/lib/verizon/models/connectivity_management_callback.rb

@@ -0,0 +1,95 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Includes callback listeners that were registered through the Connectivity
+  # Management API.
+  class ConnectivityManagementCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the billing account for which callback messages will be sent.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The password defined when a URL was registered for the callback service,
+    # or an empty string if no password was defined.
+    # @return [String]
+    attr_accessor :password
+
+    # The name of the callback service, which identifies the type and format of
+    # messages that will be sent to the registered URL.
+    # @return [String]
+    attr_accessor :service_name
+
+    # The address of the callback listening service where the ThingSpace
+    # Platform will send callback messages for the service type.
+    # @return [String]
+    attr_accessor :url
+
+    # The username defined when a URL was registered for the callback service,
+    # or an empty string if no username was defined.
+    # @return [String]
+    attr_accessor :username
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['password'] = 'password'
+      @_hash['service_name'] = 'serviceName'
+      @_hash['url'] = 'url'
+      @_hash['username'] = 'username'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        password
+        service_name
+        url
+        username
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   password = SKIP,
+                   service_name = SKIP,
+                   url = SKIP,
+                   username = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @password = password unless password == SKIP
+      @service_name = service_name unless service_name == SKIP
+      @url = url unless url == SKIP
+      @username = username unless username == 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
+      password = hash.key?('password') ? hash['password'] : SKIP
+      service_name = hash.key?('serviceName') ? hash['serviceName'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      username = hash.key?('username') ? hash['username'] : SKIP
+
+      # Create object from extracted values.
+      ConnectivityManagementCallback.new(account_name,
+                                         password,
+                                         service_name,
+                                         url,
+                                         username)
+    end
+  end
+end

data/lib/verizon/models/connectivity_management_success_result.rb

@@ -0,0 +1,51 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to successful request.
+  class ConnectivityManagementSuccessResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A value of “true” indicates that the device group was created
+    # successfully.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'success'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        success
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(success = SKIP)
+      @success = success unless success == 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.
+      success = hash.key?('success') ? hash['success'] : SKIP
+
+      # Create object from extracted values.
+      ConnectivityManagementSuccessResult.new(success)
+    end
+  end
+end

data/lib/verizon/models/consent_delete_request.rb

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

data/lib/verizon/models/consent_request.rb

@@ -0,0 +1,79 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ConsentRequest Model.
+  class ConsentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # Exclude all devices or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :all_device
+
+    # The change to make: append or replace.
+    # @return [String]
+    attr_accessor :type
+
+    # Device ID list.
+    # @return [Array[String]]
+    attr_accessor :exclusion
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['all_device'] = 'allDevice'
+      @_hash['type'] = 'type'
+      @_hash['exclusion'] = 'exclusion'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        all_device
+        type
+        exclusion
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   all_device = SKIP,
+                   type = SKIP,
+                   exclusion = SKIP)
+      @account_name = account_name
+      @all_device = all_device unless all_device == SKIP
+      @type = type unless type == SKIP
+      @exclusion = exclusion unless exclusion == 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
+      all_device = hash.key?('allDevice') ? hash['allDevice'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      exclusion = hash.key?('exclusion') ? hash['exclusion'] : SKIP
+
+      # Create object from extracted values.
+      ConsentRequest.new(account_name,
+                         all_device,
+                         type,
+                         exclusion)
+    end
+  end
+end

data/lib/verizon/models/contact_info_update_request.rb

@@ -0,0 +1,88 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to update contact information.
+  class ContactInfoUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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.
+    # @return [PlaceOfUse]
+    attr_accessor :primary_place_of_use
+
+    # The name of the billing account that the devices belong to. An account
+    # name is usually numeric, and must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # A list of the devices that you want to change, specified by device
+    # identifier. You only need to provide one identifier per device. Do not
+    # include accountName, groupName, customFields, or servicePlan if you use
+    # this parameter.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['primary_place_of_use'] = 'primaryPlaceOfUse'
+      @_hash['account_name'] = 'accountName'
+      @_hash['devices'] = 'devices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        devices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(primary_place_of_use = nil,
+                   account_name = SKIP,
+                   devices = SKIP)
+      @primary_place_of_use = primary_place_of_use
+      @account_name = account_name unless account_name == SKIP
+      @devices = devices unless devices == 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.
+      primary_place_of_use = PlaceOfUse.from_hash(hash['primaryPlaceOfUse']) if
+        hash['primaryPlaceOfUse']
+      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 << (AccountDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+
+      # Create object from extracted values.
+      ContactInfoUpdateRequest.new(primary_place_of_use,
+                                   account_name,
+                                   devices)
+    end
+  end
+end

data/lib/verizon/models/coordinates.rb

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

data/lib/verizon/models/create_device_group_request.rb

@@ -0,0 +1,91 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Create request for a new device group and optionally add devices to the
+  # group.
+  class CreateDeviceGroupRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Verizon billing account that the device group will belong to. An
+    # account name is usually numeric, and must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # A description for the device group.
+    # @return [String]
+    attr_accessor :group_description
+
+    # The name for the new device group. This name must be unique within the
+    # specified account.
+    # @return [String]
+    attr_accessor :group_name
+
+    # Zero or more devices to add to the device group. You can use POST
+    # /devices/actions/list to get a list of all devices in the account.
+    # @return [Array[DeviceId]]
+    attr_accessor :devices_to_add
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['group_description'] = 'groupDescription'
+      @_hash['group_name'] = 'groupName'
+      @_hash['devices_to_add'] = 'devicesToAdd'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        devices_to_add
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   group_description = nil,
+                   group_name = nil,
+                   devices_to_add = SKIP)
+      @account_name = account_name
+      @group_description = group_description
+      @group_name = group_name
+      @devices_to_add = devices_to_add unless devices_to_add == 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
+      group_description =
+        hash.key?('groupDescription') ? hash['groupDescription'] : nil
+      group_name = hash.key?('groupName') ? hash['groupName'] : 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 << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      devices_to_add = SKIP unless hash.key?('devicesToAdd')
+
+      # Create object from extracted values.
+      CreateDeviceGroupRequest.new(account_name,
+                                   group_description,
+                                   group_name,
+                                   devices_to_add)
+    end
+  end
+end