sdksio-verizon-apis-sdk 1.0.0 → 1.4.0

data/lib/verizon/models/v3_add_or_remove_device_request.rb

@@ -0,0 +1,57 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Devices to add or remove from existing software upgrade information.
+  class V3AddOrRemoveDeviceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Operation either 'append' or 'remove'
+    # @return [String]
+    attr_accessor :type
+
+    # 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['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.
+      V3AddOrRemoveDeviceRequest.new(type,
+                                     device_list)
+    end
+  end
+end

data/lib/verizon/models/v3_add_or_remove_device_result.rb

@@ -0,0 +1,75 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Add or remove devices to existing upgrade information.
+  class V3AddOrRemoveDeviceResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Campaign identifier.
+    # @return [String]
+    attr_accessor :campaign_id
+
+    # Array of devices changed.
+    # @return [Array[V3DeviceListItem]]
+    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['campaign_id'] = 'campaignId'
+      @_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(account_name = nil,
+                   campaign_id = nil,
+                   device_list = nil)
+      @account_name = account_name
+      @campaign_id = campaign_id
+      @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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      campaign_id = hash.key?('campaignId') ? hash['campaignId'] : nil
+      # 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 << (V3DeviceListItem.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      V3AddOrRemoveDeviceResult.new(account_name,
+                                    campaign_id,
+                                    device_list)
+    end
+  end
+end

data/lib/verizon/models/v3_campaign_device.rb

@@ -0,0 +1,97 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Campaign history.
+  class V3CampaignDevice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total device count.
+    # @return [Integer]
+    attr_accessor :total_device
+
+    # Has more report flag.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # Device identifier.
+    # @return [String]
+    attr_accessor :last_seen_device_id
+
+    # Maximum page size.
+    # @return [Integer]
+    attr_accessor :max_page_size
+
+    # List of devices with id in IMEI.
+    # @return [Array[V3DeviceStatus]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_device'] = 'totalDevice'
+      @_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_device
+        last_seen_device_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(has_more_data = nil,
+                   max_page_size = nil,
+                   device_list = nil,
+                   total_device = SKIP,
+                   last_seen_device_id = SKIP)
+      @total_device = total_device unless total_device == SKIP
+      @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
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : nil
+      max_page_size = hash.key?('maxPageSize') ? hash['maxPageSize'] : nil
+      # 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 << (V3DeviceStatus.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+      total_device = hash.key?('totalDevice') ? hash['totalDevice'] : SKIP
+      last_seen_device_id =
+        hash.key?('lastSeenDeviceId') ? hash['lastSeenDeviceId'] : SKIP
+
+      # Create object from extracted values.
+      V3CampaignDevice.new(has_more_data,
+                           max_page_size,
+                           device_list,
+                           total_device,
+                           last_seen_device_id)
+    end
+  end
+end

data/lib/verizon/models/v3_campaign_history.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Campaign history.
+  class V3CampaignHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Has more report flag?
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # Campaign identifier.
+    # @return [String]
+    attr_accessor :last_seen_campaign_id
+
+    # Firmware upgrade list.
+    # @return [Array[V3CampaignMetaInfo]]
+    attr_accessor :campaign_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['last_seen_campaign_id'] = 'lastSeenCampaignId'
+      @_hash['campaign_list'] = 'campaignList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last_seen_campaign_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        campaign_list
+      ]
+    end
+
+    def initialize(has_more_data = nil,
+                   campaign_list = nil,
+                   last_seen_campaign_id = SKIP)
+      @has_more_data = has_more_data
+      @last_seen_campaign_id = last_seen_campaign_id unless last_seen_campaign_id == SKIP
+      @campaign_list = campaign_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.
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : nil
+      # Parameter is an array, so we need to iterate through it
+      campaign_list = nil
+      unless hash['campaignList'].nil?
+        campaign_list = []
+        hash['campaignList'].each do |structure|
+          campaign_list << (V3CampaignMetaInfo.from_hash(structure) if structure)
+        end
+      end
+
+      campaign_list = nil unless hash.key?('campaignList')
+      last_seen_campaign_id =
+        hash.key?('lastSeenCampaignId') ? hash['lastSeenCampaignId'] : SKIP
+
+      # Create object from extracted values.
+      V3CampaignHistory.new(has_more_data,
+                            campaign_list,
+                            last_seen_campaign_id)
+    end
+  end
+end

data/lib/verizon/models/v3_campaign_meta_info.rb

@@ -0,0 +1,175 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Campaign and campaign details.
+  class V3CampaignMetaInfo < 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
+
+    # Firmware name.
+    # @return [String]
+    attr_accessor :firmware_name
+
+    # Old firmware version.
+    # @return [String]
+    attr_accessor :firmware_from
+
+    # New software version.
+    # @return [String]
+    attr_accessor :firmware_to
+
+    # Firmware protocol. Valid values include: LWM2M, OMD-DM.
+    # @return [CampaignMetaInfoProtocolEnum]
+    attr_accessor :protocol
+
+    # Device make.
+    # @return [String]
+    attr_accessor :make
+
+    # Device model.
+    # @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
+
+    # Firmware 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['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
+        firmware_from
+        firmware_to
+        protocol
+        campaign_time_window_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   id = nil,
+                   make = nil,
+                   model = nil,
+                   start_date = nil,
+                   end_date = nil,
+                   status = nil,
+                   campaign_name = SKIP,
+                   firmware_name = SKIP,
+                   firmware_from = SKIP,
+                   firmware_to = SKIP,
+                   protocol = CampaignMetaInfoProtocolEnum::LW_M2M,
+                   campaign_time_window_list = SKIP)
+      @account_name = account_name
+      @id = id
+      @campaign_name = campaign_name unless campaign_name == SKIP
+      @firmware_name = firmware_name unless firmware_name == SKIP
+      @firmware_from = firmware_from unless firmware_from == SKIP
+      @firmware_to = firmware_to unless firmware_to == SKIP
+      @protocol = protocol unless protocol == SKIP
+      @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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      id = hash.key?('id') ? hash['id'] : 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
+      firmware_name = hash.key?('firmwareName') ? hash['firmwareName'] : SKIP
+      firmware_from = hash.key?('firmwareFrom') ? hash['firmwareFrom'] : SKIP
+      firmware_to = hash.key?('firmwareTo') ? hash['firmwareTo'] : SKIP
+      protocol = hash['protocol'] ||= CampaignMetaInfoProtocolEnum::LW_M2M
+      # 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.
+      V3CampaignMetaInfo.new(account_name,
+                             id,
+                             make,
+                             model,
+                             start_date,
+                             end_date,
+                             status,
+                             campaign_name,
+                             firmware_name,
+                             firmware_from,
+                             firmware_to,
+                             protocol,
+                             campaign_time_window_list)
+    end
+  end
+end

data/lib/verizon/models/v3_change_campaign_dates_request.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Campaign dates and time windows.
+  class V3ChangeCampaignDatesRequest < 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
+
+    # List of allowed campaign time windows.
+    # @return [Array[V3TimeWindow]]
+    attr_accessor :campaign_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['campaign_time_window_list'] = 'campaignTimeWindowList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        campaign_time_window_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_date = nil,
+                   end_date = nil,
+                   campaign_time_window_list = SKIP)
+      @start_date = start_date
+      @end_date = end_date
+      unless campaign_time_window_list == SKIP
+        @campaign_time_window_list =
+          campaign_time_window_list
+      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.
+      start_date = hash.key?('startDate') ? hash['startDate'] : nil
+      end_date = hash.key?('endDate') ? hash['endDate'] : nil
+      # 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.
+      V3ChangeCampaignDatesRequest.new(start_date,
+                                       end_date,
+                                       campaign_time_window_list)
+    end
+  end
+end