sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/sms_send_request.rb

@@ -0,0 +1,128 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to send SMS.
+  class SMSSendRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The contents of the SMS message. The SMS message is limited to 160
+    # characters in 7-bit format, or 140 characters in 8-bit format.
+    # @return [String]
+    attr_accessor :sms_message
+
+    # The names and values of custom fields, if you want to only include devices
+    # that have matching custom fields.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # The SMS message encoding, which can be 7-bit (default), 8-bit-ASCII,
+    # 8-bit-UTF-8, 8-bit-DATA.
+    # @return [String]
+    attr_accessor :data_encoding
+
+    # The devices that you want to send the message to, specified by device
+    # identifier.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # The name of a device group, if you want to send the SMS message to all
+    # devices in the device group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The name of a service plan, if you want to only include devices that have
+    # that service plan.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['sms_message'] = 'smsMessage'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['data_encoding'] = 'dataEncoding'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['group_name'] = 'groupName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        custom_fields
+        data_encoding
+        device_ids
+        group_name
+        service_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, sms_message = nil, custom_fields = SKIP,
+                   data_encoding = SKIP, device_ids = SKIP, group_name = SKIP,
+                   service_plan = SKIP)
+      @account_name = account_name
+      @sms_message = sms_message
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @data_encoding = data_encoding unless data_encoding == SKIP
+      @device_ids = device_ids unless device_ids == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @service_plan = service_plan unless service_plan == 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
+      sms_message = hash.key?('smsMessage') ? hash['smsMessage'] : nil
+      # Parameter is an array, so we need to iterate through it
+      custom_fields = nil
+      unless hash['customFields'].nil?
+        custom_fields = []
+        hash['customFields'].each do |structure|
+          custom_fields << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      custom_fields = SKIP unless hash.key?('customFields')
+      data_encoding = hash.key?('dataEncoding') ? hash['dataEncoding'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      device_ids = nil
+      unless hash['deviceIds'].nil?
+        device_ids = []
+        hash['deviceIds'].each do |structure|
+          device_ids << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+
+      # Create object from extracted values.
+      SMSSendRequest.new(account_name,
+                         sms_message,
+                         custom_fields,
+                         data_encoding,
+                         device_ids,
+                         group_name,
+                         service_plan)
+    end
+  end
+end

data/lib/verizon/models/sms_trigger_request.rb

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

data/lib/verizon/models/software_package.rb

@@ -0,0 +1,102 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Software package information.
+  class SoftwarePackage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Software name.
+    # @return [String]
+    attr_accessor :software_name
+
+    # Software launch date.
+    # @return [Date]
+    attr_accessor :launch_date
+
+    # Software release note reserved for future use.
+    # @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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['software_name'] = 'softwareName'
+      @_hash['launch_date'] = 'launchDate'
+      @_hash['release_note'] = 'releaseNote'
+      @_hash['model'] = 'model'
+      @_hash['make'] = 'make'
+      @_hash['distribution_type'] = 'distributionType'
+      @_hash['device_platform_id'] = 'devicePlatformId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        release_note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(software_name = nil, launch_date = nil, model = nil,
+                   make = nil, distribution_type = nil,
+                   device_platform_id = nil, release_note = SKIP)
+      @software_name = software_name
+      @launch_date = launch_date
+      @release_note = release_note unless release_note == SKIP
+      @model = model
+      @make = make
+      @distribution_type = distribution_type
+      @device_platform_id = device_platform_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      software_name = hash.key?('softwareName') ? hash['softwareName'] : nil
+      launch_date = hash.key?('launchDate') ? hash['launchDate'] : nil
+      model = hash.key?('model') ? hash['model'] : nil
+      make = hash.key?('make') ? hash['make'] : nil
+      distribution_type =
+        hash.key?('distributionType') ? hash['distributionType'] : nil
+      device_platform_id =
+        hash.key?('devicePlatformId') ? hash['devicePlatformId'] : nil
+      release_note = hash.key?('releaseNote') ? hash['releaseNote'] : SKIP
+
+      # Create object from extracted values.
+      SoftwarePackage.new(software_name,
+                          launch_date,
+                          model,
+                          make,
+                          distribution_type,
+                          device_platform_id,
+                          release_note)
+    end
+  end
+end

data/lib/verizon/models/state.rb

@@ -0,0 +1,71 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Each service includes custom states.
+  class State < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the state.
+    # @return [String]
+    attr_accessor :name
+
+    # The workflow sequence number of this state.
+    # @return [Float]
+    attr_accessor :workflow_sequence_number
+
+    # The service plans that can be used to charge for services for devices in
+    # this state.
+    # @return [Array[String]]
+    attr_accessor :service_plans
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['workflow_sequence_number'] = 'workflowSequenceNumber'
+      @_hash['service_plans'] = 'servicePlans'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        workflow_sequence_number
+        service_plans
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, workflow_sequence_number = SKIP,
+                   service_plans = SKIP)
+      @name = name unless name == SKIP
+      @workflow_sequence_number = workflow_sequence_number unless workflow_sequence_number == SKIP
+      @service_plans = service_plans unless service_plans == 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'] : SKIP
+      workflow_sequence_number =
+        hash.key?('workflowSequenceNumber') ? hash['workflowSequenceNumber'] : SKIP
+      service_plans = hash.key?('servicePlans') ? hash['servicePlans'] : SKIP
+
+      # Create object from extracted values.
+      State.new(name,
+                workflow_sequence_number,
+                service_plans)
+    end
+  end
+end

data/lib/verizon/models/status_list.rb

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

data/lib/verizon/models/status_response.rb

@@ -0,0 +1,77 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # StatusResponse Model.
+  class StatusResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :request_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [Array[Subrequest]]
+    attr_accessor :subrequests
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'requestId'
+      @_hash['status'] = 'status'
+      @_hash['subrequests'] = 'subrequests'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        subrequests
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP, status = SKIP, subrequests = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @subrequests = subrequests unless subrequests == 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.
+      request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      subrequests = nil
+      unless hash['subrequests'].nil?
+        subrequests = []
+        hash['subrequests'].each do |structure|
+          subrequests << (Subrequest.from_hash(structure) if structure)
+        end
+      end
+
+      subrequests = SKIP unless hash.key?('subrequests')
+
+      # Create object from extracted values.
+      StatusResponse.new(request_id,
+                         status,
+                         subrequests)
+    end
+  end
+end

data/lib/verizon/models/stop_monitor_request.rb

@@ -0,0 +1,56 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # StopMonitorRequest Model.
+  class StopMonitorRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :monitor_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['monitor_ids'] = 'monitorIds'
+      @_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, monitor_ids = nil)
+      @account_name = account_name
+      @monitor_ids = monitor_ids
+    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
+      monitor_ids = hash.key?('monitorIds') ? hash['monitorIds'] : nil
+
+      # Create object from extracted values.
+      StopMonitorRequest.new(account_name,
+                             monitor_ids)
+    end
+  end
+end

data/lib/verizon/models/subrequest.rb

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

data/lib/{verizon_thing_space_quality_of_service_api_endpoints → verizon}/models/subscribe_request.rb

@@ -1,20 +1,20 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
+module Verizon
   # SubscribeRequest Model.
   class SubscribeRequest < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # The numeric name of an account
+    # TODO: Write general description for this method
     # @return [String]
     attr_accessor :account_name
 
-    # An array of device identifiers (deviceId values)
-    # @return [Array[DeviceInfo]]
+    # TODO: Write general description for this method
+    # @return [Array[QosDeviceInfo]]
     attr_accessor :device_info
 
     # A mapping from model property names to API property names.
@@ -27,10 +27,7 @@ module VerizonThingSpaceQualityOfServiceApiEndpoints
 
     # An array for optional fields
     def self.optionals
-      %w[
-        account_name
-        device_info
-      ]
+      []
     end
 
     # An array for nullable fields
@@ -38,9 +35,9 @@ module VerizonThingSpaceQualityOfServiceApiEndpoints
       []
     end
 
-    def initialize(account_name = SKIP, device_info = SKIP)
-      @account_name = account_name unless account_name == SKIP
-      @device_info = device_info unless device_info == SKIP
+    def initialize(account_name = nil, device_info = nil)
+      @account_name = account_name
+      @device_info = device_info
     end
 
     # Creates an instance of the object from a hash.
@@ -48,17 +45,17 @@ module VerizonThingSpaceQualityOfServiceApiEndpoints
       return nil unless hash
 
       # Extract variables from the hash.
-      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
       # Parameter is an array, so we need to iterate through it
       device_info = nil
       unless hash['deviceInfo'].nil?
         device_info = []
         hash['deviceInfo'].each do |structure|
-          device_info << (DeviceInfo.from_hash(structure) if structure)
+          device_info << (QosDeviceInfo.from_hash(structure) if structure)
         end
       end
 
-      device_info = SKIP unless hash.key?('deviceInfo')
+      device_info = nil unless hash.key?('deviceInfo')
 
       # Create object from extracted values.
       SubscribeRequest.new(account_name,