specs-sdk 1.3.0

data/lib/verizon/models/device_firmware_upgrade.rb

@@ -0,0 +1,135 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Firmware upgrades information.
+  class DeviceFirmwareUpgrade < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device identifier.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Campaign identifier.
+    # @return [String]
+    attr_accessor :campaign_id
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Firmware name.
+    # @return [String]
+    attr_accessor :firmware_name
+
+    # Old firmware version.
+    # @return [String]
+    attr_accessor :firmware_from
+
+    # New firmware version.
+    # @return [String]
+    attr_accessor :firmware_to
+
+    # Firmware upgrade start date.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # Firmware upgrade status.
+    # @return [String]
+    attr_accessor :status
+
+    # Software upgrade result reason.
+    # @return [String]
+    attr_accessor :reason
+
+    # Report updated time.
+    # @return [String]
+    attr_accessor :report_updated_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['campaign_id'] = 'campaignId'
+      @_hash['account_name'] = 'accountName'
+      @_hash['firmware_name'] = 'firmwareName'
+      @_hash['firmware_from'] = 'firmwareFrom'
+      @_hash['firmware_to'] = 'firmwareTo'
+      @_hash['start_date'] = 'startDate'
+      @_hash['status'] = 'status'
+      @_hash['reason'] = 'reason'
+      @_hash['report_updated_time'] = 'reportUpdatedTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        firmware_name
+        firmware_from
+        firmware_to
+        report_updated_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   campaign_id = nil,
+                   account_name = nil,
+                   start_date = nil,
+                   status = nil,
+                   reason = nil,
+                   firmware_name = SKIP,
+                   firmware_from = SKIP,
+                   firmware_to = SKIP,
+                   report_updated_time = SKIP)
+      @device_id = device_id
+      @campaign_id = campaign_id
+      @account_name = account_name
+      @firmware_name = firmware_name unless firmware_name == SKIP
+      @firmware_from = firmware_from unless firmware_from == SKIP
+      @firmware_to = firmware_to unless firmware_to == SKIP
+      @start_date = start_date
+      @status = status
+      @reason = reason
+      @report_updated_time = report_updated_time unless report_updated_time == 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 = hash.key?('deviceId') ? hash['deviceId'] : nil
+      campaign_id = hash.key?('campaignId') ? hash['campaignId'] : nil
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      start_date = hash.key?('startDate') ? hash['startDate'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      firmware_name = hash.key?('firmwareName') ? hash['firmwareName'] : SKIP
+      firmware_from = hash.key?('firmwareFrom') ? hash['firmwareFrom'] : SKIP
+      firmware_to = hash.key?('firmwareTo') ? hash['firmwareTo'] : SKIP
+      report_updated_time =
+        hash.key?('reportUpdatedTime') ? hash['reportUpdatedTime'] : SKIP
+
+      # Create object from extracted values.
+      DeviceFirmwareUpgrade.new(device_id,
+                                campaign_id,
+                                account_name,
+                                start_date,
+                                status,
+                                reason,
+                                firmware_name,
+                                firmware_from,
+                                firmware_to,
+                                report_updated_time)
+    end
+  end
+end

data/lib/verizon/models/device_firmware_version.rb

@@ -0,0 +1,101 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Device and firmware information.
+  class DeviceFirmwareVersion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Device Firmware Version.
+    # @return [String]
+    attr_accessor :firmware_version
+
+    # Device Firmware Version.
+    # @return [DateTime]
+    attr_accessor :firmware_version_update_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['reason'] = 'reason'
+      @_hash['device_id'] = 'deviceId'
+      @_hash['firmware_version'] = 'firmwareVersion'
+      @_hash['firmware_version_update_time'] = 'firmwareVersionUpdateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        reason
+        firmware_version_update_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   firmware_version = nil,
+                   status = SKIP,
+                   reason = SKIP,
+                   firmware_version_update_time = SKIP)
+      @status = status unless status == SKIP
+      @reason = reason unless reason == SKIP
+      @device_id = device_id
+      @firmware_version = firmware_version
+      unless firmware_version_update_time == SKIP
+        @firmware_version_update_time =
+          firmware_version_update_time
+      end
+    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 = hash.key?('deviceId') ? hash['deviceId'] : nil
+      firmware_version =
+        hash.key?('firmwareVersion') ? hash['firmwareVersion'] : nil
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      firmware_version_update_time = if hash.key?('firmwareVersionUpdateTime')
+                                       (DateTimeHelper.from_rfc3339(hash['firmwareVersionUpdateTime']) if hash['firmwareVersionUpdateTime'])
+                                     else
+                                       SKIP
+                                     end
+
+      # Create object from extracted values.
+      DeviceFirmwareVersion.new(device_id,
+                                firmware_version,
+                                status,
+                                reason,
+                                firmware_version_update_time)
+    end
+
+    def to_custom_firmware_version_update_time
+      DateTimeHelper.to_rfc3339(firmware_version_update_time)
+    end
+  end
+end

data/lib/verizon/models/device_firmware_version_update_result.rb

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

data/lib/verizon/models/device_group.rb

@@ -0,0 +1,90 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Returns a list of all device groups in a specified account.
+  class DeviceGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description of the device group.
+    # @return [String]
+    attr_accessor :description
+
+    # Any extended attributes for the device group, as Key and Value pairs.
+    # @return [Array[CustomFields]]
+    attr_accessor :extended_attributes
+
+    # Identifies the default device group.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_default_group
+
+    # The name of the device group.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash['is_default_group'] = 'isDefaultGroup'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        extended_attributes
+        is_default_group
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description = SKIP,
+                   extended_attributes = SKIP,
+                   is_default_group = SKIP,
+                   name = SKIP)
+      @description = description unless description == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @is_default_group = is_default_group unless is_default_group == 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.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      extended_attributes = nil
+      unless hash['extendedAttributes'].nil?
+        extended_attributes = []
+        hash['extendedAttributes'].each do |structure|
+          extended_attributes << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extendedAttributes')
+      is_default_group =
+        hash.key?('isDefaultGroup') ? hash['isDefaultGroup'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      DeviceGroup.new(description,
+                      extended_attributes,
+                      is_default_group,
+                      name)
+    end
+  end
+end

data/lib/verizon/models/device_group_devices_data.rb

@@ -0,0 +1,90 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Returns the name, description, and list of devices in a device group.
+  class DeviceGroupDevicesData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description of the device group.
+    # @return [String]
+    attr_accessor :description
+
+    # The devices in the device group.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # False for a status 200 response.True for a status 202 response, indicating
+    # that there is more data to be retrieved.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # The name of the device group.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['devices'] = 'devices'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        devices
+        has_more_data
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description = SKIP,
+                   devices = SKIP,
+                   has_more_data = SKIP,
+                   name = SKIP)
+      @description = description unless description == SKIP
+      @devices = devices unless devices == SKIP
+      @has_more_data = has_more_data unless has_more_data == 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.
+      description = hash.key?('description') ? hash['description'] : 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')
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      DeviceGroupDevicesData.new(description,
+                                 devices,
+                                 has_more_data,
+                                 name)
+    end
+  end
+end

data/lib/verizon/models/device_group_update_request.rb

@@ -0,0 +1,105 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Make changes to a device group, including changing the name and description,
+  # and adding or removing devices.
+  class DeviceGroupUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Zero or more devices to add to the device group, specified by device ID.
+    # The devices will be removed from their current device groups. 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
+
+    # Zero or more devices to remove from the device group, specified by device
+    # ID. The devices will be added to the default device group.
+    # @return [Array[DeviceId]]
+    attr_accessor :devices_to_remove
+
+    # A new description for the device group. Do not include this parameter to
+    # leave the group description unchanged.
+    # @return [String]
+    attr_accessor :new_group_description
+
+    # A new name for the device group. Do not include this parameter if you want
+    # to leave the group name unchanged.
+    # @return [String]
+    attr_accessor :new_group_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['devices_to_add'] = 'devicesToAdd'
+      @_hash['devices_to_remove'] = 'devicesToRemove'
+      @_hash['new_group_description'] = 'newGroupDescription'
+      @_hash['new_group_name'] = 'newGroupName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        devices_to_add
+        devices_to_remove
+        new_group_description
+        new_group_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(devices_to_add = SKIP,
+                   devices_to_remove = SKIP,
+                   new_group_description = SKIP,
+                   new_group_name = SKIP)
+      @devices_to_add = devices_to_add unless devices_to_add == SKIP
+      @devices_to_remove = devices_to_remove unless devices_to_remove == SKIP
+      @new_group_description = new_group_description unless new_group_description == SKIP
+      @new_group_name = new_group_name unless new_group_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.
+      # 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')
+      # Parameter is an array, so we need to iterate through it
+      devices_to_remove = nil
+      unless hash['devicesToRemove'].nil?
+        devices_to_remove = []
+        hash['devicesToRemove'].each do |structure|
+          devices_to_remove << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      devices_to_remove = SKIP unless hash.key?('devicesToRemove')
+      new_group_description =
+        hash.key?('newGroupDescription') ? hash['newGroupDescription'] : SKIP
+      new_group_name = hash.key?('newGroupName') ? hash['newGroupName'] : SKIP
+
+      # Create object from extracted values.
+      DeviceGroupUpdateRequest.new(devices_to_add,
+                                   devices_to_remove,
+                                   new_group_description,
+                                   new_group_name)
+    end
+  end
+end

data/lib/verizon/models/device_id.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # An identifier for a single device.
+  class DeviceId < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value of the device identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # The type of the device identifier. Valid types of identifiers are:ESN
+    # (decimal),EID,ICCID (up to 20 digits),IMEI (up to 16 digits),MDN,MEID
+    # (hexadecimal),MSISDN.
+    # @return [String]
+    attr_accessor :kind
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['kind'] = 'kind'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   kind = nil)
+      @id = id
+      @kind = kind
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      kind = hash.key?('kind') ? hash['kind'] : nil
+
+      # Create object from extracted values.
+      DeviceId.new(id,
+                   kind)
+    end
+  end
+end

data/lib/verizon/models/device_id2.rb

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