specs-sdk 1.3.0

data/lib/verizon/models/firmware_upgrade_device_list_item.rb

@@ -0,0 +1,73 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A JSON object for each device that was included in the upgrade, showing the
+  # device IMEI, the status of the upgrade, and additional information about the
+  # status.
+  class FirmwareUpgradeDeviceListItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # The status of the upgrade for this device.
+    # @return [String]
+    attr_accessor :status
+
+    # Additional details about the status. Not included when status='Request
+    # Pending.'
+    # @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[
+        device_id
+        status
+        result_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP,
+                   status = SKIP,
+                   result_reason = SKIP)
+      @device_id = device_id unless device_id == SKIP
+      @status = status unless status == SKIP
+      @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'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      result_reason = hash.key?('resultReason') ? hash['resultReason'] : SKIP
+
+      # Create object from extracted values.
+      FirmwareUpgradeDeviceListItem.new(device_id,
+                                        status,
+                                        result_reason)
+    end
+  end
+end

data/lib/verizon/models/firmware_upgrade_request.rb

@@ -0,0 +1,93 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Details of the firmware upgrade request.
+  class FirmwareUpgradeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of the firmware image that will be used for the upgrade, from a
+    # GET /firmware response.
+    # @return [String]
+    attr_accessor :firmware_name
+
+    # The name of the firmware version that will be on the devices after a
+    # successful upgrade.
+    # @return [String]
+    attr_accessor :firmware_to
+
+    # The date that the upgrade should begin.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The IMEIs of the devices.
+    # @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['firmware_name'] = 'firmwareName'
+      @_hash['firmware_to'] = 'firmwareTo'
+      @_hash['start_date'] = 'startDate'
+      @_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,
+                   firmware_name = nil,
+                   firmware_to = nil,
+                   start_date = nil,
+                   device_list = nil)
+      @account_name = account_name
+      @firmware_name = firmware_name
+      @firmware_to = firmware_to
+      @start_date = start_date
+      @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
+      firmware_name = hash.key?('firmwareName') ? hash['firmwareName'] : nil
+      firmware_to = hash.key?('firmwareTo') ? hash['firmwareTo'] : nil
+      start_date = if hash.key?('startDate')
+                     (DateTimeHelper.from_rfc3339(hash['startDate']) if hash['startDate'])
+                   end
+      device_list = hash.key?('deviceList') ? hash['deviceList'] : nil
+
+      # Create object from extracted values.
+      FirmwareUpgradeRequest.new(account_name,
+                                 firmware_name,
+                                 firmware_to,
+                                 start_date,
+                                 device_list)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+  end
+end

data/lib/verizon/models/flow_info.rb

@@ -0,0 +1,90 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # FlowInfo Model.
+  class FlowInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :flow_server
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :flow_device
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :flow_direction
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :flow_protocol
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :qci_option
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['flow_server'] = 'flowServer'
+      @_hash['flow_device'] = 'flowDevice'
+      @_hash['flow_direction'] = 'flowDirection'
+      @_hash['flow_protocol'] = 'flowProtocol'
+      @_hash['qci_option'] = 'qciOption'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        flow_server
+        flow_device
+        flow_direction
+        flow_protocol
+        qci_option
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(flow_server = SKIP,
+                   flow_device = SKIP,
+                   flow_direction = SKIP,
+                   flow_protocol = SKIP,
+                   qci_option = SKIP)
+      @flow_server = flow_server unless flow_server == SKIP
+      @flow_device = flow_device unless flow_device == SKIP
+      @flow_direction = flow_direction unless flow_direction == SKIP
+      @flow_protocol = flow_protocol unless flow_protocol == SKIP
+      @qci_option = qci_option unless qci_option == 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.
+      flow_server = hash.key?('flowServer') ? hash['flowServer'] : SKIP
+      flow_device = hash.key?('flowDevice') ? hash['flowDevice'] : SKIP
+      flow_direction = hash.key?('flowDirection') ? hash['flowDirection'] : SKIP
+      flow_protocol = hash.key?('flowProtocol') ? hash['flowProtocol'] : SKIP
+      qci_option = hash.key?('qciOption') ? hash['qciOption'] : SKIP
+
+      # Create object from extracted values.
+      FlowInfo.new(flow_server,
+                   flow_device,
+                   flow_direction,
+                   flow_protocol,
+                   qci_option)
+    end
+  end
+end

data/lib/verizon/models/fota_v1_callback_registration_request.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Callback endpoint information.
+  class FotaV1CallbackRegistrationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the callback service that you want to subscribe to, which must
+    # be 'Fota' for Software Management Services callbacks.
+    # @return [String]
+    attr_accessor :name
+
+    # The address on your server where you have enabled a listening service for
+    # Software Management Services callback messages.
+    # @return [String]
+    attr_accessor :url
+
+    # The user name that ThingSpace should return in the callback messages.
+    # @return [String]
+    attr_accessor :username
+
+    # The password that ThingSpace should return in the callback messages.
+    # @return [String]
+    attr_accessor :password
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['url'] = 'url'
+      @_hash['username'] = 'username'
+      @_hash['password'] = 'password'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        username
+        password
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   url = nil,
+                   username = SKIP,
+                   password = SKIP)
+      @name = name
+      @url = url
+      @username = username unless username == SKIP
+      @password = password unless password == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+      username = hash.key?('username') ? hash['username'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+
+      # Create object from extracted values.
+      FotaV1CallbackRegistrationRequest.new(name,
+                                            url,
+                                            username,
+                                            password)
+    end
+  end
+end

data/lib/verizon/models/fota_v1_callback_registration_result.rb

@@ -0,0 +1,62 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Registered callback account name and service name.
+  class FotaV1CallbackRegistrationResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the billing account for which callback messages will be sent.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of the callback service, which identifies the type and format of
+    # messages that will be sent to the registered URL. This will be 'Fota' for
+    # the Software Management Services callback.
+    # @return [String]
+    attr_accessor :service_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['service_name'] = 'serviceName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        service_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   service_name = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @service_name = service_name unless service_name == 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'] : SKIP
+      service_name = hash.key?('serviceName') ? hash['serviceName'] : SKIP
+
+      # Create object from extracted values.
+      FotaV1CallbackRegistrationResult.new(account_name,
+                                           service_name)
+    end
+  end
+end

data/lib/verizon/models/fota_v1_success_result.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A response to a successful request contains a single Boolean value.
+  class FotaV1SuccessResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # True is returned in case of success.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'success'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        success
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(success = SKIP)
+      @success = success unless success == 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.
+      success = hash.key?('success') ? hash['success'] : SKIP
+
+      # Create object from extracted values.
+      FotaV1SuccessResult.new(success)
+    end
+  end
+end

data/lib/verizon/models/fota_v2_callback_registration_request.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Callback URL registration.
+  class FotaV2CallbackRegistrationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Callback URL for an subscribed service.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(url = SKIP)
+      @url = url unless url == 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.
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create object from extracted values.
+      FotaV2CallbackRegistrationRequest.new(url)
+    end
+  end
+end

data/lib/verizon/models/fota_v2_callback_registration_result.rb

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

data/lib/verizon/models/fota_v2_subscription.rb

@@ -0,0 +1,91 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # FOTA Subscription.
+  class FotaV2Subscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # Subscription models used by the account.
+    # @return [String]
+    attr_accessor :purchase_type
+
+    # Number of monthly licenses in an MRC subscription.
+    # @return [Integer]
+    attr_accessor :license_count
+
+    # Number of licenses currently assigned to devices.
+    # @return [Integer]
+    attr_accessor :license_used_count
+
+    # The date and time of when the subscription was last updated.
+    # @return [String]
+    attr_accessor :update_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['purchase_type'] = 'purchaseType'
+      @_hash['license_count'] = 'licenseCount'
+      @_hash['license_used_count'] = 'licenseUsedCount'
+      @_hash['update_time'] = 'updateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        purchase_type
+        license_count
+        license_used_count
+        update_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   purchase_type = SKIP,
+                   license_count = SKIP,
+                   license_used_count = SKIP,
+                   update_time = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @purchase_type = purchase_type unless purchase_type == SKIP
+      @license_count = license_count unless license_count == SKIP
+      @license_used_count = license_used_count unless license_used_count == SKIP
+      @update_time = update_time unless update_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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      purchase_type = hash.key?('purchaseType') ? hash['purchaseType'] : SKIP
+      license_count = hash.key?('licenseCount') ? hash['licenseCount'] : SKIP
+      license_used_count =
+        hash.key?('licenseUsedCount') ? hash['licenseUsedCount'] : SKIP
+      update_time = hash.key?('updateTime') ? hash['updateTime'] : SKIP
+
+      # Create object from extracted values.
+      FotaV2Subscription.new(account_name,
+                             purchase_type,
+                             license_count,
+                             license_used_count,
+                             update_time)
+    end
+  end
+end

data/lib/verizon/models/fota_v2_success_result.rb

@@ -0,0 +1,48 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to a successful request.
+  class FotaV2SuccessResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'success'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(success = nil)
+      @success = success
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      success = hash.key?('success') ? hash['success'] : nil
+
+      # Create object from extracted values.
+      FotaV2SuccessResult.new(success)
+    end
+  end
+end