specs-sdk 1.3.0

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

data/lib/verizon/models/v3_device.rb

@@ -0,0 +1,248 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Device information.
+  class V3Device < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Success or failure.
+    # @return [String]
+    attr_accessor :request_status
+
+    # Success or failure.
+    # @return [String]
+    attr_accessor :result_reason
+
+    # MDN.
+    # @return [String]
+    attr_accessor :mdn
+
+    # Device model.
+    # @return [String]
+    attr_accessor :model
+
+    # Device make.
+    # @return [String]
+    attr_accessor :make
+
+    # Device firmware version.
+    # @return [String]
+    attr_accessor :firmware
+
+    # Value=true if the device software can be upgraded over the air using the
+    # Software Management Services API.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :fota_eligible
+
+    # Device status.
+    # @return [String]
+    attr_accessor :status
+
+    # License assigned device.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :license_assigned
+
+    # Firmware protocol. Valid values include: LWM2M, OMADM, HTTP or NONE.
+    # @return [String]
+    attr_accessor :protocol
+
+    # List of sofware.
+    # @return [Array[V3SoftwareInfo]]
+    attr_accessor :software_list
+
+    # List of files.
+    # @return [Array[V3SoftwareInfo]]
+    attr_accessor :file_list
+
+    # The date and time of when the device is created.
+    # @return [String]
+    attr_accessor :create_time
+
+    # The date and time of when the device firmware or software is updated.
+    # @return [String]
+    attr_accessor :status_time
+
+    # The date and time of when the device is updated.
+    # @return [String]
+    attr_accessor :update_time
+
+    # The date and time of when the device is refreshed.
+    # @return [String]
+    attr_accessor :refresh_time
+
+    # The date and time of when the device reachability is checked.
+    # @return [DateTime]
+    attr_accessor :last_connection_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['request_status'] = 'requestStatus'
+      @_hash['result_reason'] = 'resultReason'
+      @_hash['mdn'] = 'mdn'
+      @_hash['model'] = 'model'
+      @_hash['make'] = 'make'
+      @_hash['firmware'] = 'firmware'
+      @_hash['fota_eligible'] = 'fotaEligible'
+      @_hash['status'] = 'status'
+      @_hash['license_assigned'] = 'licenseAssigned'
+      @_hash['protocol'] = 'protocol'
+      @_hash['software_list'] = 'softwareList'
+      @_hash['file_list'] = 'fileList'
+      @_hash['create_time'] = 'createTime'
+      @_hash['status_time'] = 'statusTime'
+      @_hash['update_time'] = 'updateTime'
+      @_hash['refresh_time'] = 'refreshTime'
+      @_hash['last_connection_time'] = 'lastConnectionTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_status
+        result_reason
+        mdn
+        model
+        make
+        firmware
+        fota_eligible
+        status
+        license_assigned
+        protocol
+        software_list
+        file_list
+        create_time
+        status_time
+        update_time
+        refresh_time
+        last_connection_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   request_status = SKIP,
+                   result_reason = SKIP,
+                   mdn = SKIP,
+                   model = SKIP,
+                   make = SKIP,
+                   firmware = SKIP,
+                   fota_eligible = SKIP,
+                   status = SKIP,
+                   license_assigned = SKIP,
+                   protocol = SKIP,
+                   software_list = SKIP,
+                   file_list = SKIP,
+                   create_time = SKIP,
+                   status_time = SKIP,
+                   update_time = SKIP,
+                   refresh_time = SKIP,
+                   last_connection_time = SKIP)
+      @device_id = device_id
+      @request_status = request_status unless request_status == SKIP
+      @result_reason = result_reason unless result_reason == SKIP
+      @mdn = mdn unless mdn == SKIP
+      @model = model unless model == SKIP
+      @make = make unless make == SKIP
+      @firmware = firmware unless firmware == SKIP
+      @fota_eligible = fota_eligible unless fota_eligible == SKIP
+      @status = status unless status == SKIP
+      @license_assigned = license_assigned unless license_assigned == SKIP
+      @protocol = protocol unless protocol == SKIP
+      @software_list = software_list unless software_list == SKIP
+      @file_list = file_list unless file_list == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @status_time = status_time unless status_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+      @refresh_time = refresh_time unless refresh_time == SKIP
+      @last_connection_time = last_connection_time unless last_connection_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
+      request_status = hash.key?('requestStatus') ? hash['requestStatus'] : SKIP
+      result_reason = hash.key?('resultReason') ? hash['resultReason'] : SKIP
+      mdn = hash.key?('mdn') ? hash['mdn'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      make = hash.key?('make') ? hash['make'] : SKIP
+      firmware = hash.key?('firmware') ? hash['firmware'] : SKIP
+      fota_eligible = hash.key?('fotaEligible') ? hash['fotaEligible'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      license_assigned =
+        hash.key?('licenseAssigned') ? hash['licenseAssigned'] : SKIP
+      protocol = hash.key?('protocol') ? hash['protocol'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      software_list = nil
+      unless hash['softwareList'].nil?
+        software_list = []
+        hash['softwareList'].each do |structure|
+          software_list << (V3SoftwareInfo.from_hash(structure) if structure)
+        end
+      end
+
+      software_list = SKIP unless hash.key?('softwareList')
+      # Parameter is an array, so we need to iterate through it
+      file_list = nil
+      unless hash['fileList'].nil?
+        file_list = []
+        hash['fileList'].each do |structure|
+          file_list << (V3SoftwareInfo.from_hash(structure) if structure)
+        end
+      end
+
+      file_list = SKIP unless hash.key?('fileList')
+      create_time = hash.key?('createTime') ? hash['createTime'] : SKIP
+      status_time = hash.key?('statusTime') ? hash['statusTime'] : SKIP
+      update_time = hash.key?('updateTime') ? hash['updateTime'] : SKIP
+      refresh_time = hash.key?('refreshTime') ? hash['refreshTime'] : SKIP
+      last_connection_time = if hash.key?('lastConnectionTime')
+                               (DateTimeHelper.from_rfc3339(hash['lastConnectionTime']) if hash['lastConnectionTime'])
+                             else
+                               SKIP
+                             end
+
+      # Create object from extracted values.
+      V3Device.new(device_id,
+                   request_status,
+                   result_reason,
+                   mdn,
+                   model,
+                   make,
+                   firmware,
+                   fota_eligible,
+                   status,
+                   license_assigned,
+                   protocol,
+                   software_list,
+                   file_list,
+                   create_time,
+                   status_time,
+                   update_time,
+                   refresh_time,
+                   last_connection_time)
+    end
+
+    def to_custom_last_connection_time
+      DateTimeHelper.to_rfc3339(last_connection_time)
+    end
+  end
+end

data/lib/verizon/models/v3_device_list_item.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device changed.
+  class V3DeviceListItem < 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 :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['reason'] = 'Reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_id
+        status
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP,
+                   status = SKIP,
+                   reason = SKIP)
+      @device_id = device_id unless device_id == SKIP
+      @status = status unless status == SKIP
+      @reason = reason unless 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'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason = hash.key?('Reason') ? hash['Reason'] : SKIP
+
+      # Create object from extracted values.
+      V3DeviceListItem.new(device_id,
+                           status,
+                           reason)
+    end
+  end
+end