sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/campaign_firmware_upgrade.rb

@@ -0,0 +1,135 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Firmware upgrade for devices.
+  class CampaignFirmwareUpgrade < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Campaign name.
+    # @return [String]
+    attr_accessor :campaign_name
+
+    # Firmware name to upgrade to.
+    # @return [String]
+    attr_accessor :firmware_name
+
+    # Old firmware version.
+    # @return [String]
+    attr_accessor :firmware_from
+
+    # New firmware version.
+    # @return [String]
+    attr_accessor :firmware_to
+
+    # Valid values include: LWM2M, OMA and HTTP.
+    # @return [String]
+    attr_accessor :protocol
+
+    # 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
+
+    # 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['campaign_name'] = 'campaignName'
+      @_hash['firmware_name'] = 'firmwareName'
+      @_hash['firmware_from'] = 'firmwareFrom'
+      @_hash['firmware_to'] = 'firmwareTo'
+      @_hash['protocol'] = 'protocol'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['campaign_time_window_list'] = 'campaignTimeWindowList'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        campaign_name
+        campaign_time_window_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(firmware_name = nil,
+                   firmware_from = nil,
+                   firmware_to = nil,
+                   protocol = 'LWM2M',
+                   start_date = nil,
+                   end_date = nil,
+                   device_list = nil,
+                   campaign_name = SKIP,
+                   campaign_time_window_list = SKIP)
+      @campaign_name = campaign_name unless campaign_name == SKIP
+      @firmware_name = firmware_name
+      @firmware_from = firmware_from
+      @firmware_to = firmware_to
+      @protocol = protocol
+      @start_date = start_date
+      @end_date = end_date
+      unless campaign_time_window_list == SKIP
+        @campaign_time_window_list =
+          campaign_time_window_list
+      end
+      @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.
+      firmware_name = hash.key?('firmwareName') ? hash['firmwareName'] : nil
+      firmware_from = hash.key?('firmwareFrom') ? hash['firmwareFrom'] : nil
+      firmware_to = hash.key?('firmwareTo') ? hash['firmwareTo'] : nil
+      protocol = hash['protocol'] ||= 'LWM2M'
+      start_date = hash.key?('startDate') ? hash['startDate'] : nil
+      end_date = hash.key?('endDate') ? hash['endDate'] : nil
+      device_list = hash.key?('deviceList') ? hash['deviceList'] : nil
+      campaign_name = hash.key?('campaignName') ? hash['campaignName'] : 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.
+      CampaignFirmwareUpgrade.new(firmware_name,
+                                  firmware_from,
+                                  firmware_to,
+                                  protocol,
+                                  start_date,
+                                  end_date,
+                                  device_list,
+                                  campaign_name,
+                                  campaign_time_window_list)
+    end
+  end
+end

data/lib/verizon/models/campaign_meta_info_protocol_enum.rb

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

data/lib/verizon/models/campaign_software.rb

@@ -0,0 +1,215 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Software upgrade information.
+  class CampaignSoftware < 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
+
+    # Software name.
+    # @return [String]
+    attr_accessor :software_name
+
+    # LWM2M, OMD-DM or HTTP.
+    # @return [String]
+    attr_accessor :distribution_type
+
+    # Applicable make.
+    # @return [String]
+    attr_accessor :make
+
+    # Applicable model.
+    # @return [String]
+    attr_accessor :model
+
+    # Old software name.
+    # @return [String]
+    attr_accessor :software_from
+
+    # New software name.
+    # @return [String]
+    attr_accessor :software_to
+
+    # Campaign start date.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # Campaign end date.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # Specifies starting date client should download package. If null, client
+    # will download as soon as possible.
+    # @return [Date]
+    attr_accessor :download_after_date
+
+    # List of allowed download time windows.
+    # @return [Array[V2TimeWindow]]
+    attr_accessor :download_time_window_list
+
+    # Client will install package after date. If null, client will install as
+    # soon as possible.
+    # @return [Date]
+    attr_accessor :install_after_date
+
+    # List of allowed install time windows.
+    # @return [Array[V2TimeWindow]]
+    attr_accessor :install_time_window_list
+
+    # Software upgrade 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['software_name'] = 'softwareName'
+      @_hash['distribution_type'] = 'distributionType'
+      @_hash['make'] = 'make'
+      @_hash['model'] = 'model'
+      @_hash['software_from'] = 'softwareFrom'
+      @_hash['software_to'] = 'softwareTo'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['download_after_date'] = 'downloadAfterDate'
+      @_hash['download_time_window_list'] = 'downloadTimeWindowList'
+      @_hash['install_after_date'] = 'installAfterDate'
+      @_hash['install_time_window_list'] = 'installTimeWindowList'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        campaign_name
+        download_after_date
+        download_time_window_list
+        install_after_date
+        install_time_window_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   account_name = nil,
+                   software_name = nil,
+                   distribution_type = nil,
+                   make = nil,
+                   model = nil,
+                   software_from = nil,
+                   software_to = nil,
+                   start_date = nil,
+                   end_date = nil,
+                   status = nil,
+                   campaign_name = SKIP,
+                   download_after_date = SKIP,
+                   download_time_window_list = SKIP,
+                   install_after_date = SKIP,
+                   install_time_window_list = SKIP)
+      @id = id
+      @account_name = account_name
+      @campaign_name = campaign_name unless campaign_name == SKIP
+      @software_name = software_name
+      @distribution_type = distribution_type
+      @make = make
+      @model = model
+      @software_from = software_from
+      @software_to = software_to
+      @start_date = start_date
+      @end_date = end_date
+      @download_after_date = download_after_date unless download_after_date == SKIP
+      unless download_time_window_list == SKIP
+        @download_time_window_list =
+          download_time_window_list
+      end
+      @install_after_date = install_after_date unless install_after_date == SKIP
+      @install_time_window_list = install_time_window_list unless install_time_window_list == SKIP
+      @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
+      software_name = hash.key?('softwareName') ? hash['softwareName'] : nil
+      distribution_type =
+        hash.key?('distributionType') ? hash['distributionType'] : nil
+      make = hash.key?('make') ? hash['make'] : nil
+      model = hash.key?('model') ? hash['model'] : nil
+      software_from = hash.key?('softwareFrom') ? hash['softwareFrom'] : nil
+      software_to = hash.key?('softwareTo') ? hash['softwareTo'] : 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
+      download_after_date =
+        hash.key?('downloadAfterDate') ? hash['downloadAfterDate'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      download_time_window_list = nil
+      unless hash['downloadTimeWindowList'].nil?
+        download_time_window_list = []
+        hash['downloadTimeWindowList'].each do |structure|
+          download_time_window_list << (V2TimeWindow.from_hash(structure) if structure)
+        end
+      end
+
+      download_time_window_list = SKIP unless hash.key?('downloadTimeWindowList')
+      install_after_date =
+        hash.key?('installAfterDate') ? hash['installAfterDate'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      install_time_window_list = nil
+      unless hash['installTimeWindowList'].nil?
+        install_time_window_list = []
+        hash['installTimeWindowList'].each do |structure|
+          install_time_window_list << (V2TimeWindow.from_hash(structure) if structure)
+        end
+      end
+
+      install_time_window_list = SKIP unless hash.key?('installTimeWindowList')
+
+      # Create object from extracted values.
+      CampaignSoftware.new(id,
+                           account_name,
+                           software_name,
+                           distribution_type,
+                           make,
+                           model,
+                           software_from,
+                           software_to,
+                           start_date,
+                           end_date,
+                           status,
+                           campaign_name,
+                           download_after_date,
+                           download_time_window_list,
+                           install_after_date,
+                           install_time_window_list)
+    end
+  end
+end

data/lib/verizon/models/campaign_software_upgrade.rb

@@ -0,0 +1,179 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Software upgrade information.
+  class CampaignSoftwareUpgrade < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Campaign name.
+    # @return [String]
+    attr_accessor :campaign_name
+
+    # Software name to upgrade to.
+    # @return [String]
+    attr_accessor :software_name
+
+    # Old software name.
+    # @return [String]
+    attr_accessor :software_from
+
+    # New software name.
+    # @return [String]
+    attr_accessor :software_to
+
+    # OMA or HTTP.
+    # @return [String]
+    attr_accessor :distribution_type
+
+    # Campaign start date.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # Campaign end date.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # Specifies starting date client should download package. If null, client
+    # will download as soon as possible.
+    # @return [Date]
+    attr_accessor :download_after_date
+
+    # List of allowed download time windows.
+    # @return [Array[V2TimeWindow]]
+    attr_accessor :download_time_window_list
+
+    # Client will install package after date. If null, client will install as
+    # soon as possible.
+    # @return [Date]
+    attr_accessor :install_after_date
+
+    # List of allowed install time windows.
+    # @return [Array[V2TimeWindow]]
+    attr_accessor :install_time_window_list
+
+    # 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['campaign_name'] = 'campaignName'
+      @_hash['software_name'] = 'softwareName'
+      @_hash['software_from'] = 'softwareFrom'
+      @_hash['software_to'] = 'softwareTo'
+      @_hash['distribution_type'] = 'distributionType'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['download_after_date'] = 'downloadAfterDate'
+      @_hash['download_time_window_list'] = 'downloadTimeWindowList'
+      @_hash['install_after_date'] = 'installAfterDate'
+      @_hash['install_time_window_list'] = 'installTimeWindowList'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        campaign_name
+        download_after_date
+        download_time_window_list
+        install_after_date
+        install_time_window_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(software_name = nil,
+                   software_from = nil,
+                   software_to = nil,
+                   distribution_type = nil,
+                   start_date = nil,
+                   end_date = nil,
+                   device_list = nil,
+                   campaign_name = SKIP,
+                   download_after_date = SKIP,
+                   download_time_window_list = SKIP,
+                   install_after_date = SKIP,
+                   install_time_window_list = SKIP)
+      @campaign_name = campaign_name unless campaign_name == SKIP
+      @software_name = software_name
+      @software_from = software_from
+      @software_to = software_to
+      @distribution_type = distribution_type
+      @start_date = start_date
+      @end_date = end_date
+      @download_after_date = download_after_date unless download_after_date == SKIP
+      unless download_time_window_list == SKIP
+        @download_time_window_list =
+          download_time_window_list
+      end
+      @install_after_date = install_after_date unless install_after_date == SKIP
+      @install_time_window_list = install_time_window_list unless install_time_window_list == SKIP
+      @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.
+      software_name = hash.key?('softwareName') ? hash['softwareName'] : nil
+      software_from = hash.key?('softwareFrom') ? hash['softwareFrom'] : nil
+      software_to = hash.key?('softwareTo') ? hash['softwareTo'] : nil
+      distribution_type =
+        hash.key?('distributionType') ? hash['distributionType'] : nil
+      start_date = hash.key?('startDate') ? hash['startDate'] : nil
+      end_date = hash.key?('endDate') ? hash['endDate'] : nil
+      device_list = hash.key?('deviceList') ? hash['deviceList'] : nil
+      campaign_name = hash.key?('campaignName') ? hash['campaignName'] : SKIP
+      download_after_date =
+        hash.key?('downloadAfterDate') ? hash['downloadAfterDate'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      download_time_window_list = nil
+      unless hash['downloadTimeWindowList'].nil?
+        download_time_window_list = []
+        hash['downloadTimeWindowList'].each do |structure|
+          download_time_window_list << (V2TimeWindow.from_hash(structure) if structure)
+        end
+      end
+
+      download_time_window_list = SKIP unless hash.key?('downloadTimeWindowList')
+      install_after_date =
+        hash.key?('installAfterDate') ? hash['installAfterDate'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      install_time_window_list = nil
+      unless hash['installTimeWindowList'].nil?
+        install_time_window_list = []
+        hash['installTimeWindowList'].each do |structure|
+          install_time_window_list << (V2TimeWindow.from_hash(structure) if structure)
+        end
+      end
+
+      install_time_window_list = SKIP unless hash.key?('installTimeWindowList')
+
+      # Create object from extracted values.
+      CampaignSoftwareUpgrade.new(software_name,
+                                  software_from,
+                                  software_to,
+                                  distribution_type,
+                                  start_date,
+                                  end_date,
+                                  device_list,
+                                  campaign_name,
+                                  download_after_date,
+                                  download_time_window_list,
+                                  install_after_date,
+                                  install_time_window_list)
+    end
+  end
+end

data/lib/verizon/models/campaign_status_enum.rb

@@ -0,0 +1,41 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Current status of the campaign.
+  class CampaignStatusEnum
+    CAMPAIGN_STATUS_ENUM = [
+      # TODO: Write general description for CAMPAIGNREQUESTPENDING
+      CAMPAIGNREQUESTPENDING = 'CampaignRequestPending'.freeze,
+
+      # TODO: Write general description for CAMPAIGNREQUESTFAILED
+      CAMPAIGNREQUESTFAILED = 'CampaignRequestFailed'.freeze,
+
+      # TODO: Write general description for CAMPAIGNREQUESTQUEUED
+      CAMPAIGNREQUESTQUEUED = 'CampaignRequestQueued'.freeze,
+
+      # TODO: Write general description for CAMPAIGNCANCELLED
+      CAMPAIGNCANCELLED = 'CampaignCancelled'.freeze,
+
+      # TODO: Write general description for CAMPAIGNABORTED
+      CAMPAIGNABORTED = 'CampaignAborted'.freeze,
+
+      # TODO: Write general description for CAMPAIGNFAILED
+      CAMPAIGNFAILED = 'CampaignFailed'.freeze,
+
+      # TODO: Write general description for CAMPAIGNSCHEDULED
+      CAMPAIGNSCHEDULED = 'CampaignScheduled'.freeze,
+
+      # TODO: Write general description for CAMPAIGNENDED
+      CAMPAIGNENDED = 'CampaignEnded'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CAMPAIGN_STATUS_ENUM.include?(value)
+    end
+  end
+end