specs-sdk 1.3.0

data/lib/verizon/models/firmware_campaign.rb

@@ -0,0 +1,172 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Firmware upgrade information.
+  class FirmwareCampaign < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Upgrade identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Campaign name.
+    # @return [String]
+    attr_accessor :campaign_name
+
+    # Firmware name (for firmware upgrade only).
+    # @return [String]
+    attr_accessor :firmware_name
+
+    # Old firmware version (for firmware upgrade only).
+    # @return [String]
+    attr_accessor :firmware_from
+
+    # New firmware version (for firmware upgrade only).
+    # @return [String]
+    attr_accessor :firmware_to
+
+    # Available values: LWM2M.
+    # @return [String]
+    attr_accessor :protocol
+
+    # Available values: LWM2M.
+    # @return [String]
+    attr_accessor :make
+
+    # Available values: LWM2M.
+    # @return [String]
+    attr_accessor :model
+
+    # Campaign start date.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # Campaign end date.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # List of allowed campaign time windows.
+    # @return [Array[V3TimeWindow]]
+    attr_accessor :campaign_time_window_list
+
+    # Campaign status.
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['account_name'] = 'accountName'
+      @_hash['campaign_name'] = 'campaignName'
+      @_hash['firmware_name'] = 'firmwareName'
+      @_hash['firmware_from'] = 'firmwareFrom'
+      @_hash['firmware_to'] = 'firmwareTo'
+      @_hash['protocol'] = 'protocol'
+      @_hash['make'] = 'make'
+      @_hash['model'] = 'model'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['campaign_time_window_list'] = 'campaignTimeWindowList'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        campaign_name
+        firmware_name
+        campaign_time_window_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   account_name = nil,
+                   firmware_from = nil,
+                   firmware_to = nil,
+                   protocol = 'LWM2M',
+                   make = nil,
+                   model = nil,
+                   start_date = nil,
+                   end_date = nil,
+                   status = nil,
+                   campaign_name = SKIP,
+                   firmware_name = SKIP,
+                   campaign_time_window_list = SKIP)
+      @id = id
+      @account_name = account_name
+      @campaign_name = campaign_name unless campaign_name == SKIP
+      @firmware_name = firmware_name unless firmware_name == SKIP
+      @firmware_from = firmware_from
+      @firmware_to = firmware_to
+      @protocol = protocol
+      @make = make
+      @model = model
+      @start_date = start_date
+      @end_date = end_date
+      unless campaign_time_window_list == SKIP
+        @campaign_time_window_list =
+          campaign_time_window_list
+      end
+      @status = status
+    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
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      firmware_from = hash.key?('firmwareFrom') ? hash['firmwareFrom'] : nil
+      firmware_to = hash.key?('firmwareTo') ? hash['firmwareTo'] : nil
+      protocol = hash['protocol'] ||= 'LWM2M'
+      make = hash.key?('make') ? hash['make'] : nil
+      model = hash.key?('model') ? hash['model'] : nil
+      start_date = hash.key?('startDate') ? hash['startDate'] : nil
+      end_date = hash.key?('endDate') ? hash['endDate'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      campaign_name = hash.key?('campaignName') ? hash['campaignName'] : SKIP
+      firmware_name = hash.key?('firmwareName') ? hash['firmwareName'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      campaign_time_window_list = nil
+      unless hash['campaignTimeWindowList'].nil?
+        campaign_time_window_list = []
+        hash['campaignTimeWindowList'].each do |structure|
+          campaign_time_window_list << (V3TimeWindow.from_hash(structure) if structure)
+        end
+      end
+
+      campaign_time_window_list = SKIP unless hash.key?('campaignTimeWindowList')
+
+      # Create object from extracted values.
+      FirmwareCampaign.new(id,
+                           account_name,
+                           firmware_from,
+                           firmware_to,
+                           protocol,
+                           make,
+                           model,
+                           start_date,
+                           end_date,
+                           status,
+                           campaign_name,
+                           firmware_name,
+                           campaign_time_window_list)
+    end
+  end
+end

data/lib/verizon/models/firmware_imei.rb

@@ -0,0 +1,49 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A list of IMEIs for devices to be synchronized between ThingSpace and the
+  # FOTA server.
+  class FirmwareIMEI < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI 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['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_list = nil)
+      @device_list = device_list
+    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_list = hash.key?('deviceList') ? hash['deviceList'] : nil
+
+      # Create object from extracted values.
+      FirmwareIMEI.new(device_list)
+    end
+  end
+end

data/lib/verizon/models/firmware_package.rb

@@ -0,0 +1,118 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Available firmware.
+  class FirmwarePackage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Firmware name.
+    # @return [String]
+    attr_accessor :firmware_name
+
+    # Firmware from version.
+    # @return [String]
+    attr_accessor :firmware_from
+
+    # Firmware to version.
+    # @return [String]
+    attr_accessor :firmware_to
+
+    # Firmware launch date.
+    # @return [DateTime]
+    attr_accessor :launch_date
+
+    # Firmware release note.
+    # @return [String]
+    attr_accessor :release_note
+
+    # Firmware applicable device model.
+    # @return [String]
+    attr_accessor :model
+
+    # Firmware applicable device make.
+    # @return [String]
+    attr_accessor :make
+
+    # Firmware protocol. Valid values include: LWM2M, OMD-DM.
+    # @return [CampaignMetaInfoProtocolEnum]
+    attr_accessor :protocol
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['firmware_name'] = 'firmwareName'
+      @_hash['firmware_from'] = 'firmwareFrom'
+      @_hash['firmware_to'] = 'firmwareTo'
+      @_hash['launch_date'] = 'launchDate'
+      @_hash['release_note'] = 'releaseNote'
+      @_hash['model'] = 'model'
+      @_hash['make'] = 'make'
+      @_hash['protocol'] = 'protocol'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(firmware_name = nil,
+                   firmware_from = nil,
+                   firmware_to = nil,
+                   launch_date = nil,
+                   release_note = nil,
+                   model = nil,
+                   make = nil,
+                   protocol = CampaignMetaInfoProtocolEnum::LW_M2M)
+      @firmware_name = firmware_name
+      @firmware_from = firmware_from
+      @firmware_to = firmware_to
+      @launch_date = launch_date
+      @release_note = release_note
+      @model = model
+      @make = make
+      @protocol = protocol
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      firmware_name = hash.key?('firmwareName') ? hash['firmwareName'] : nil
+      firmware_from = hash.key?('firmwareFrom') ? hash['firmwareFrom'] : nil
+      firmware_to = hash.key?('firmwareTo') ? hash['firmwareTo'] : nil
+      launch_date = if hash.key?('launchDate')
+                      (DateTimeHelper.from_rfc3339(hash['launchDate']) if hash['launchDate'])
+                    end
+      release_note = hash.key?('releaseNote') ? hash['releaseNote'] : nil
+      model = hash.key?('model') ? hash['model'] : nil
+      make = hash.key?('make') ? hash['make'] : nil
+      protocol = hash['protocol'] ||= CampaignMetaInfoProtocolEnum::LW_M2M
+
+      # Create object from extracted values.
+      FirmwarePackage.new(firmware_name,
+                          firmware_from,
+                          firmware_to,
+                          launch_date,
+                          release_note,
+                          model,
+                          make,
+                          protocol)
+    end
+
+    def to_custom_launch_date
+      DateTimeHelper.to_rfc3339(launch_date)
+    end
+  end
+end

data/lib/verizon/models/firmware_protocol_enum.rb

@@ -0,0 +1,26 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Firmware protocol. Valid values include: LWM2M, OMD-DM, all.
+  class FirmwareProtocolEnum
+    FIRMWARE_PROTOCOL_ENUM = [
+      # TODO: Write general description for LW_M2M
+      LW_M2M = 'LWM2M'.freeze,
+
+      # TODO: Write general description for OMDDM
+      OMDDM = 'OMD-DM'.freeze,
+
+      # TODO: Write general description for ALL
+      ALL = 'all'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FIRMWARE_PROTOCOL_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/firmware_type_list_enum.rb

@@ -0,0 +1,23 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Possible values are `append` or `remove`
+  class FirmwareTypeListEnum
+    FIRMWARE_TYPE_LIST_ENUM = [
+      # TODO: Write general description for APPEND
+      APPEND = 'append'.freeze,
+
+      # TODO: Write general description for REMOVE
+      REMOVE = 'remove'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FIRMWARE_TYPE_LIST_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/firmware_upgrade.rb

@@ -0,0 +1,122 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Array of upgrade objects with the specified status.
+  class FirmwareUpgrade < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for this upgrade.
+    # @return [String]
+    attr_accessor :id
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of the firmware image that will be used for the upgrade.
+    # @return [String]
+    attr_accessor :firmware_name
+
+    # The name of the firmware version that will be on the devices after a
+    # successful upgrade.
+    # @return [String]
+    attr_accessor :firmware_to
+
+    # The intended start date for the upgrade.
+    # @return [String]
+    attr_accessor :start_date
+
+    # The current status of the upgrade.
+    # @return [String]
+    attr_accessor :status
+
+    # A JSON object for each device that was included in the upgrade, showing
+    # the device IMEI, the status of the upgrade, and additional information
+    # about the status.
+    # @return [Array[FirmwareUpgradeDeviceListItem]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['account_name'] = 'accountName'
+      @_hash['firmware_name'] = 'firmwareName'
+      @_hash['firmware_to'] = 'firmwareTo'
+      @_hash['start_date'] = 'startDate'
+      @_hash['status'] = 'status'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        account_name
+        firmware_name
+        firmware_to
+        start_date
+        status
+        device_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   account_name = SKIP,
+                   firmware_name = SKIP,
+                   firmware_to = SKIP,
+                   start_date = SKIP,
+                   status = SKIP,
+                   device_list = SKIP)
+      @id = id unless id == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @firmware_name = firmware_name unless firmware_name == SKIP
+      @firmware_to = firmware_to unless firmware_to == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @status = status unless status == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      firmware_name = hash.key?('firmwareName') ? hash['firmwareName'] : SKIP
+      firmware_to = hash.key?('firmwareTo') ? hash['firmwareTo'] : SKIP
+      start_date = hash.key?('startDate') ? hash['startDate'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      device_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (FirmwareUpgradeDeviceListItem.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = SKIP unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      FirmwareUpgrade.new(id,
+                          account_name,
+                          firmware_name,
+                          firmware_to,
+                          start_date,
+                          status,
+                          device_list)
+    end
+  end
+end

data/lib/verizon/models/firmware_upgrade_change_request.rb

@@ -0,0 +1,57 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # List of devices to add or remove.
+  class FirmwareUpgradeChangeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Possible values are `append` or `remove`
+    # @return [FirmwareTypeListEnum]
+    attr_accessor :type
+
+    # The IMEIs of the devices.
+    # @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['type'] = 'type'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = nil,
+                   device_list = nil)
+      @type = type
+      @device_list = device_list
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : nil
+      device_list = hash.key?('deviceList') ? hash['deviceList'] : nil
+
+      # Create object from extracted values.
+      FirmwareUpgradeChangeRequest.new(type,
+                                       device_list)
+    end
+  end
+end

data/lib/verizon/models/firmware_upgrade_change_result.rb

@@ -0,0 +1,81 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Upgrade information.
+  class FirmwareUpgradeChangeResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # The unique identifier for this upgrade.
+    # @return [String]
+    attr_accessor :id
+
+    # A JSON object for each device that was included in the request, showing
+    # the device IMEI, the status of the addition or removal, and additional
+    # information about the status.
+    # @return [Array[V1DeviceListItem]]
+    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['id'] = 'id'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        id
+        device_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   id = SKIP,
+                   device_list = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @id = id unless id == 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
+      id = hash.key?('id') ? hash['id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      device_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (V1DeviceListItem.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = SKIP unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      FirmwareUpgradeChangeResult.new(account_name,
+                                      id,
+                                      device_list)
+    end
+  end
+end