sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/upload_and_schedule_file_response.rb

@@ -0,0 +1,256 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # UploadAndScheduleFileResponse Model.
+  class UploadAndScheduleFileResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Updgrade identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # Account identifer.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The campaign name.
+    # @return [String]
+    attr_accessor :campaign_name
+
+    # Software name.
+    # @return [String]
+    attr_accessor :software_name
+
+    # Old software name.
+    # @return [String]
+    attr_accessor :software_from
+
+    # New software name.
+    # @return [String]
+    attr_accessor :software_to
+
+    # The name of the file you are upgrading to.
+    # @return [String]
+    attr_accessor :file_name
+
+    # The version of the file you are upgrading to.
+    # @return [String]
+    attr_accessor :file_version
+
+    # Valid values
+    # @return [String]
+    attr_accessor :distribution_type
+
+    # Applicable make.
+    # @return [String]
+    attr_accessor :make
+
+    # Applicable model.
+    # @return [String]
+    attr_accessor :model
+
+    # Campaign start date.
+    # @return [String]
+    attr_accessor :start_date
+
+    # Campaign end date.
+    # @return [String]
+    attr_accessor :end_date
+
+    # Specifies the starting date the client should download the package. If
+    # null, client downloads as soon as possible.
+    # @return [String]
+    attr_accessor :download_after_date
+
+    # List of allowed download time windows.
+    # @return [Array[DownloadTimeWindow]]
+    attr_accessor :download_time_window_list
+
+    # The date after which you install the package. If null, install as soon as
+    # possible.
+    # @return [String]
+    attr_accessor :install_after_date
+
+    # List of allowed install time windows.
+    # @return [Array[DownloadTimeWindow]]
+    attr_accessor :install_time_window_list
+
+    # Device IMEI list.
+    # @return [Array[String]]
+    attr_accessor :device_list
+
+    # Software update 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['software_from'] = 'softwareFrom'
+      @_hash['software_to'] = 'softwareTo'
+      @_hash['file_name'] = 'fileName'
+      @_hash['file_version'] = 'fileVersion'
+      @_hash['distribution_type'] = 'distributionType'
+      @_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['device_list'] = 'deviceList'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        account_name
+        campaign_name
+        software_name
+        software_from
+        software_to
+        file_name
+        file_version
+        distribution_type
+        make
+        model
+        start_date
+        end_date
+        download_after_date
+        download_time_window_list
+        install_after_date
+        install_time_window_list
+        device_list
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   account_name = SKIP,
+                   campaign_name = SKIP,
+                   software_name = SKIP,
+                   software_from = SKIP,
+                   software_to = SKIP,
+                   file_name = SKIP,
+                   file_version = SKIP,
+                   distribution_type = SKIP,
+                   make = SKIP,
+                   model = SKIP,
+                   start_date = SKIP,
+                   end_date = SKIP,
+                   download_after_date = SKIP,
+                   download_time_window_list = SKIP,
+                   install_after_date = SKIP,
+                   install_time_window_list = SKIP,
+                   device_list = SKIP,
+                   status = SKIP)
+      @id = id unless id == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @campaign_name = campaign_name unless campaign_name == SKIP
+      @software_name = software_name unless software_name == SKIP
+      @software_from = software_from unless software_from == SKIP
+      @software_to = software_to unless software_to == SKIP
+      @file_name = file_name unless file_name == SKIP
+      @file_version = file_version unless file_version == SKIP
+      @distribution_type = distribution_type unless distribution_type == SKIP
+      @make = make unless make == SKIP
+      @model = model unless model == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @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 unless device_list == SKIP
+      @status = status unless status == 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
+      campaign_name = hash.key?('campaignName') ? hash['campaignName'] : SKIP
+      software_name = hash.key?('softwareName') ? hash['softwareName'] : SKIP
+      software_from = hash.key?('softwareFrom') ? hash['softwareFrom'] : SKIP
+      software_to = hash.key?('softwareTo') ? hash['softwareTo'] : SKIP
+      file_name = hash.key?('fileName') ? hash['fileName'] : SKIP
+      file_version = hash.key?('fileVersion') ? hash['fileVersion'] : SKIP
+      distribution_type =
+        hash.key?('distributionType') ? hash['distributionType'] : SKIP
+      make = hash.key?('make') ? hash['make'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      start_date = hash.key?('startDate') ? hash['startDate'] : SKIP
+      end_date = hash.key?('endDate') ? hash['endDate'] : 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 << (DownloadTimeWindow.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 << (DownloadTimeWindow.from_hash(structure) if structure)
+        end
+      end
+
+      install_time_window_list = SKIP unless hash.key?('installTimeWindowList')
+      device_list = hash.key?('deviceList') ? hash['deviceList'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      UploadAndScheduleFileResponse.new(id,
+                                        account_name,
+                                        campaign_name,
+                                        software_name,
+                                        software_from,
+                                        software_to,
+                                        file_name,
+                                        file_version,
+                                        distribution_type,
+                                        make,
+                                        model,
+                                        start_date,
+                                        end_date,
+                                        download_after_date,
+                                        download_time_window_list,
+                                        install_after_date,
+                                        install_time_window_list,
+                                        device_list,
+                                        status)
+    end
+  end
+end

data/lib/verizon/models/upload_configuration_files_response.rb

@@ -0,0 +1,133 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # UploadConfigurationFilesResponse Model.
+  class UploadConfigurationFilesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the file you are upgrading to.
+    # @return [String]
+    attr_accessor :file_name
+
+    # The version of the file you are upgrading to.
+    # @return [String]
+    attr_accessor :file_version
+
+    # Software launch date.
+    # @return [Date]
+    attr_accessor :launch_date
+
+    # Software release note.
+    # @return [String]
+    attr_accessor :release_note
+
+    # Software applicable device model.
+    # @return [String]
+    attr_accessor :model
+
+    # Software applicable device make.
+    # @return [String]
+    attr_accessor :make
+
+    # LWM2M, OMD-DM or HTTP.
+    # @return [String]
+    attr_accessor :distribution_type
+
+    # The platform (Android, iOS, etc.) that the software can be applied to.
+    # @return [String]
+    attr_accessor :device_platform_id
+
+    # Local target path on the device.
+    # @return [String]
+    attr_accessor :local_target_path
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file_name'] = 'fileName'
+      @_hash['file_version'] = 'fileVersion'
+      @_hash['launch_date'] = 'launchDate'
+      @_hash['release_note'] = 'releaseNote'
+      @_hash['model'] = 'model'
+      @_hash['make'] = 'make'
+      @_hash['distribution_type'] = 'distributionType'
+      @_hash['device_platform_id'] = 'devicePlatformId'
+      @_hash['local_target_path'] = 'localTargetPath'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        file_name
+        file_version
+        launch_date
+        release_note
+        model
+        make
+        distribution_type
+        device_platform_id
+        local_target_path
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(file_name = SKIP,
+                   file_version = SKIP,
+                   launch_date = SKIP,
+                   release_note = SKIP,
+                   model = SKIP,
+                   make = SKIP,
+                   distribution_type = SKIP,
+                   device_platform_id = SKIP,
+                   local_target_path = SKIP)
+      @file_name = file_name unless file_name == SKIP
+      @file_version = file_version unless file_version == SKIP
+      @launch_date = launch_date unless launch_date == SKIP
+      @release_note = release_note unless release_note == SKIP
+      @model = model unless model == SKIP
+      @make = make unless make == SKIP
+      @distribution_type = distribution_type unless distribution_type == SKIP
+      @device_platform_id = device_platform_id unless device_platform_id == SKIP
+      @local_target_path = local_target_path unless local_target_path == 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.
+      file_name = hash.key?('fileName') ? hash['fileName'] : SKIP
+      file_version = hash.key?('fileVersion') ? hash['fileVersion'] : SKIP
+      launch_date = hash.key?('launchDate') ? hash['launchDate'] : SKIP
+      release_note = hash.key?('releaseNote') ? hash['releaseNote'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      make = hash.key?('make') ? hash['make'] : SKIP
+      distribution_type =
+        hash.key?('distributionType') ? hash['distributionType'] : SKIP
+      device_platform_id =
+        hash.key?('devicePlatformId') ? hash['devicePlatformId'] : SKIP
+      local_target_path =
+        hash.key?('localTargetPath') ? hash['localTargetPath'] : SKIP
+
+      # Create object from extracted values.
+      UploadConfigurationFilesResponse.new(file_name,
+                                           file_version,
+                                           launch_date,
+                                           release_note,
+                                           model,
+                                           make,
+                                           distribution_type,
+                                           device_platform_id,
+                                           local_target_path)
+    end
+  end
+end

data/lib/verizon/models/uploads_activates_device_request.rb

@@ -0,0 +1,128 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The request body identifies the devices to upload.
+  class UploadsActivatesDeviceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account. An account name is usually numeric, and
+    # must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The email address that the report should be sent to when the upload is
+    # complete.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The stock keeping unit that identifies the type of devices in the upload
+    # and activation.
+    # @return [String]
+    attr_accessor :device_sku
+
+    # The format of the device identifiers in the upload and activation.
+    # @return [String]
+    attr_accessor :upload_type
+
+    # The service plan code that you want to assign to all specified devices.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The pool from which your device IP addresses is derived.
+    # @return [String]
+    attr_accessor :carrier_ip_pool_name
+
+    # The Zip code of the location where the line of service is primarily used,
+    # or a Zip code that you have been told to use with these devices.
+    # @return [String]
+    attr_accessor :mdn_zip_code
+
+    # The devices to upload, specified by device IDs in a format matching
+    # uploadType.
+    # @return [Array[DeviceList]]
+    attr_accessor :devices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['email_address'] = 'emailAddress'
+      @_hash['device_sku'] = 'deviceSku'
+      @_hash['upload_type'] = 'uploadType'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['carrier_ip_pool_name'] = 'carrierIpPoolName'
+      @_hash['mdn_zip_code'] = 'mdnZipCode'
+      @_hash['devices'] = 'devices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_ip_pool_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   email_address = nil,
+                   device_sku = nil,
+                   upload_type = nil,
+                   service_plan = nil,
+                   mdn_zip_code = nil,
+                   devices = nil,
+                   carrier_ip_pool_name = SKIP)
+      @account_name = account_name
+      @email_address = email_address
+      @device_sku = device_sku
+      @upload_type = upload_type
+      @service_plan = service_plan
+      @carrier_ip_pool_name = carrier_ip_pool_name unless carrier_ip_pool_name == SKIP
+      @mdn_zip_code = mdn_zip_code
+      @devices = devices
+    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
+      email_address = hash.key?('emailAddress') ? hash['emailAddress'] : nil
+      device_sku = hash.key?('deviceSku') ? hash['deviceSku'] : nil
+      upload_type = hash.key?('uploadType') ? hash['uploadType'] : nil
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : nil
+      mdn_zip_code = hash.key?('mdnZipCode') ? hash['mdnZipCode'] : nil
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (DeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = nil unless hash.key?('devices')
+      carrier_ip_pool_name =
+        hash.key?('carrierIpPoolName') ? hash['carrierIpPoolName'] : SKIP
+
+      # Create object from extracted values.
+      UploadsActivatesDeviceRequest.new(account_name,
+                                        email_address,
+                                        device_sku,
+                                        upload_type,
+                                        service_plan,
+                                        mdn_zip_code,
+                                        devices,
+                                        carrier_ip_pool_name)
+    end
+  end
+end

data/lib/verizon/models/usage.rb

@@ -0,0 +1,111 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The daily network data usage of a single device during a specified time
+  # period.
+  class Usage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of bytes that the device sent or received on the report date.
+    # @return [Integer]
+    attr_accessor :bytes_used
+
+    # The number of mobile-originated and mobile-terminated SMS messages on the
+    # report date.
+    # @return [Array[CustomFields]]
+    attr_accessor :extended_attributes
+
+    # The list of service plans associated with the device/account.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The number of SMS messages that were sent or received on the report date.
+    # @return [Integer]
+    attr_accessor :sms_used
+
+    # The source of the information for the reported usage.
+    # @return [String]
+    attr_accessor :source
+
+    # The date of the recorded usage.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bytes_used'] = 'bytesUsed'
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['sms_used'] = 'smsUsed'
+      @_hash['source'] = 'source'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bytes_used
+        extended_attributes
+        service_plan
+        sms_used
+        source
+        timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bytes_used = SKIP,
+                   extended_attributes = SKIP,
+                   service_plan = SKIP,
+                   sms_used = SKIP,
+                   source = SKIP,
+                   timestamp = SKIP)
+      @bytes_used = bytes_used unless bytes_used == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @sms_used = sms_used unless sms_used == SKIP
+      @source = source unless source == SKIP
+      @timestamp = timestamp unless timestamp == 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.
+      bytes_used = hash.key?('bytesUsed') ? hash['bytesUsed'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      extended_attributes = nil
+      unless hash['extendedAttributes'].nil?
+        extended_attributes = []
+        hash['extendedAttributes'].each do |structure|
+          extended_attributes << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extendedAttributes')
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      sms_used = hash.key?('smsUsed') ? hash['smsUsed'] : SKIP
+      source = hash.key?('source') ? hash['source'] : SKIP
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+
+      # Create object from extracted values.
+      Usage.new(bytes_used,
+                extended_attributes,
+                service_plan,
+                sms_used,
+                source,
+                timestamp)
+    end
+  end
+end