sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/v2_campaign_meta_info.rb

@@ -0,0 +1,215 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Campaign and campaign details.
+  class V2CampaignMetaInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Campaign identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # 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
+
+    # Old software name.
+    # @return [String]
+    attr_accessor :software_from
+
+    # New software name.
+    # @return [String]
+    attr_accessor :software_to
+
+    # Applicable make.
+    # @return [String]
+    attr_accessor :make
+
+    # Applicable model.
+    # @return [String]
+    attr_accessor :model
+
+    # 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['account_name'] = 'accountName'
+      @_hash['id'] = 'id'
+      @_hash['campaign_name'] = 'campaignName'
+      @_hash['software_name'] = 'softwareName'
+      @_hash['distribution_type'] = 'distributionType'
+      @_hash['software_from'] = 'softwareFrom'
+      @_hash['software_to'] = 'softwareTo'
+      @_hash['make'] = 'make'
+      @_hash['model'] = 'model'
+      @_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(account_name = nil,
+                   id = nil,
+                   software_name = nil,
+                   distribution_type = nil,
+                   software_from = nil,
+                   software_to = nil,
+                   make = nil,
+                   model = 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)
+      @account_name = account_name
+      @id = id
+      @campaign_name = campaign_name unless campaign_name == SKIP
+      @software_name = software_name
+      @distribution_type = distribution_type
+      @software_from = software_from
+      @software_to = software_to
+      @make = make
+      @model = model
+      @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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      software_name = hash.key?('softwareName') ? hash['softwareName'] : nil
+      distribution_type =
+        hash.key?('distributionType') ? hash['distributionType'] : nil
+      software_from = hash.key?('softwareFrom') ? hash['softwareFrom'] : nil
+      software_to = hash.key?('softwareTo') ? hash['softwareTo'] : nil
+      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
+      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.
+      V2CampaignMetaInfo.new(account_name,
+                             id,
+                             software_name,
+                             distribution_type,
+                             software_from,
+                             software_to,
+                             make,
+                             model,
+                             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/v2_change_campaign_dates_request.rb

@@ -0,0 +1,125 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # New dates and time windows.
+  class V2ChangeCampaignDatesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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. Removing of existing windows is not
+    # allowed.
+    # @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. Removing of existing windows is not
+    # allowed.
+    # @return [Array[V2TimeWindow]]
+    attr_accessor :install_time_window_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        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(start_date = nil,
+                   end_date = nil,
+                   download_after_date = SKIP,
+                   download_time_window_list = SKIP,
+                   install_after_date = SKIP,
+                   install_time_window_list = SKIP)
+      @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
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      start_date = hash.key?('startDate') ? hash['startDate'] : nil
+      end_date = hash.key?('endDate') ? hash['endDate'] : nil
+      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.
+      V2ChangeCampaignDatesRequest.new(start_date,
+                                       end_date,
+                                       download_after_date,
+                                       download_time_window_list,
+                                       install_after_date,
+                                       install_time_window_list)
+    end
+  end
+end

data/lib/verizon/models/v2_device_status.rb

@@ -0,0 +1,68 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device with id in IMEI.
+  class V2DeviceStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Success or failure.
+    # @return [String]
+    attr_accessor :status
+
+    # Result reason.
+    # @return [String]
+    attr_accessor :result_reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['status'] = 'status'
+      @_hash['result_reason'] = 'resultReason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        result_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   status = nil,
+                   result_reason = SKIP)
+      @device_id = device_id
+      @status = status
+      @result_reason = result_reason unless result_reason == 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
+      status = hash.key?('status') ? hash['status'] : nil
+      result_reason = hash.key?('resultReason') ? hash['resultReason'] : SKIP
+
+      # Create object from extracted values.
+      V2DeviceStatus.new(device_id,
+                         status,
+                         result_reason)
+    end
+  end
+end

data/lib/verizon/models/v2_license_device.rb

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

data/lib/verizon/models/v2_license_imei.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # IMEIs of the devices to assign or remove licenses.
+  class V2LicenseIMEI < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account name.
+    # @return [String]
+    attr_accessor :account_name
+
+    # 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['account_name'] = 'accountName'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_list = nil,
+                   account_name = SKIP)
+      @account_name = account_name unless account_name == 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.
+      device_list = hash.key?('deviceList') ? hash['deviceList'] : nil
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+
+      # Create object from extracted values.
+      V2LicenseIMEI.new(device_list,
+                        account_name)
+    end
+  end
+end

data/lib/verizon/models/v2_license_summary.rb

@@ -0,0 +1,117 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Summary of license assignment.
+  class V2LicenseSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Total FOTA license count.
+    # @return [Integer]
+    attr_accessor :total_license
+
+    # Assigned FOTA license count.
+    # @return [Integer]
+    attr_accessor :assigned_licenses
+
+    # True if there are more devices to retrieve.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # Last seen device identifier.
+    # @return [String]
+    attr_accessor :last_seen_device_id
+
+    # Maximum page size.
+    # @return [Integer]
+    attr_accessor :max_page_size
+
+    # Device IMEI list.
+    # @return [Array[V2LicenseDevice]]
+    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['total_license'] = 'totalLicense'
+      @_hash['assigned_licenses'] = 'assignedLicenses'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['last_seen_device_id'] = 'lastSeenDeviceId'
+      @_hash['max_page_size'] = 'maxPageSize'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_license
+        last_seen_device_id
+        device_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   assigned_licenses = nil,
+                   has_more_data = nil,
+                   max_page_size = nil,
+                   total_license = SKIP,
+                   last_seen_device_id = SKIP,
+                   device_list = SKIP)
+      @account_name = account_name
+      @total_license = total_license unless total_license == SKIP
+      @assigned_licenses = assigned_licenses
+      @has_more_data = has_more_data
+      @last_seen_device_id = last_seen_device_id unless last_seen_device_id == SKIP
+      @max_page_size = max_page_size
+      @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'] : nil
+      assigned_licenses =
+        hash.key?('assignedLicenses') ? hash['assignedLicenses'] : nil
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : nil
+      max_page_size = hash.key?('maxPageSize') ? hash['maxPageSize'] : nil
+      total_license = hash.key?('totalLicense') ? hash['totalLicense'] : SKIP
+      last_seen_device_id =
+        hash.key?('lastSeenDeviceId') ? hash['lastSeenDeviceId'] : 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 << (V2LicenseDevice.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = SKIP unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      V2LicenseSummary.new(account_name,
+                           assigned_licenses,
+                           has_more_data,
+                           max_page_size,
+                           total_license,
+                           last_seen_device_id,
+                           device_list)
+    end
+  end
+end