sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/service_name_enum.rb

@@ -0,0 +1,23 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Service name
+  class ServiceNameEnum
+    SERVICE_NAME_ENUM = [
+      # TODO: Write general description for LOCATION
+      LOCATION = 'Location'.freeze,
+
+      # TODO: Write general description for FOTA
+      FOTA = 'fota'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SERVICE_NAME_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/service_plan.rb

@@ -0,0 +1,100 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Details of the service plan.
+  class ServicePlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The code that is used by the carrier for the service plan.
+    # @return [String]
+    attr_accessor :carrier_service_plan_code
+
+    # The code of the service plan, which may not be the same as the name.
+    # @return [String]
+    attr_accessor :code
+
+    # Any extended attributes for the service plan, as Key and Value pairs.
+    # @return [Array[CustomFields]]
+    attr_accessor :extended_attributes
+
+    # The name of the service plan.
+    # @return [String]
+    attr_accessor :name
+
+    # The size of the service plan in kilobytes.
+    # @return [Integer]
+    attr_accessor :size_kb
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_service_plan_code'] = 'carrierServicePlanCode'
+      @_hash['code'] = 'code'
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash['name'] = 'name'
+      @_hash['size_kb'] = 'sizeKb'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_service_plan_code
+        code
+        extended_attributes
+        name
+        size_kb
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(carrier_service_plan_code = SKIP, code = SKIP,
+                   extended_attributes = SKIP, name = SKIP, size_kb = SKIP)
+      unless carrier_service_plan_code == SKIP
+        @carrier_service_plan_code =
+          carrier_service_plan_code
+      end
+      @code = code unless code == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @name = name unless name == SKIP
+      @size_kb = size_kb unless size_kb == 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.
+      carrier_service_plan_code =
+        hash.key?('carrierServicePlanCode') ? hash['carrierServicePlanCode'] : SKIP
+      code = hash.key?('code') ? hash['code'] : 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')
+      name = hash.key?('name') ? hash['name'] : SKIP
+      size_kb = hash.key?('sizeKb') ? hash['sizeKb'] : SKIP
+
+      # Create object from extracted values.
+      ServicePlan.new(carrier_service_plan_code,
+                      code,
+                      extended_attributes,
+                      name,
+                      size_kb)
+    end
+  end
+end

data/lib/verizon/models/service_plan_trigger_attribute.rb

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

data/lib/verizon/models/service_plan_update_request.rb

@@ -0,0 +1,150 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Request to update service plan.
+  class ServicePlanUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The service plan code that you want to assign to all specified devices.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of a service plan, if you want to only include devices that have
+    # that service plan.
+    # @return [String]
+    attr_accessor :current_service_plan
+
+    # Custom field names and values, if you want to only include devices that
+    # have matching values.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # A list of the devices that you want to change, specified by device
+    # identifier.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # The name of a device group, if you want to restore service for all devices
+    # in that group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The name of a device group, if you want to restore service for all devices
+    # in that group.
+    # @return [String]
+    attr_accessor :carrier_ip_pool_name
+
+    # The name of a device group, if you want to restore service for all devices
+    # in that group.
+    # @return [DateTime]
+    attr_accessor :take_effect
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['account_name'] = 'accountName'
+      @_hash['current_service_plan'] = 'currentServicePlan'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['devices'] = 'devices'
+      @_hash['group_name'] = 'groupName'
+      @_hash['carrier_ip_pool_name'] = 'carrierIpPoolName'
+      @_hash['take_effect'] = 'takeEffect'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        current_service_plan
+        custom_fields
+        devices
+        group_name
+        carrier_ip_pool_name
+        take_effect
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(service_plan = nil, account_name = SKIP,
+                   current_service_plan = SKIP, custom_fields = SKIP,
+                   devices = SKIP, group_name = SKIP,
+                   carrier_ip_pool_name = SKIP, take_effect = SKIP)
+      @service_plan = service_plan
+      @account_name = account_name unless account_name == SKIP
+      @current_service_plan = current_service_plan unless current_service_plan == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @devices = devices unless devices == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @carrier_ip_pool_name = carrier_ip_pool_name unless carrier_ip_pool_name == SKIP
+      @take_effect = take_effect unless take_effect == 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.
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : nil
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      current_service_plan =
+        hash.key?('currentServicePlan') ? hash['currentServicePlan'] : SKIP
+      # 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')
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (AccountDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      carrier_ip_pool_name =
+        hash.key?('carrierIpPoolName') ? hash['carrierIpPoolName'] : SKIP
+      take_effect = if hash.key?('takeEffect')
+                      (DateTimeHelper.from_rfc3339(hash['takeEffect']) if hash['takeEffect'])
+                    else
+                      SKIP
+                    end
+
+      # Create object from extracted values.
+      ServicePlanUpdateRequest.new(service_plan,
+                                   account_name,
+                                   current_service_plan,
+                                   custom_fields,
+                                   devices,
+                                   group_name,
+                                   carrier_ip_pool_name,
+                                   take_effect)
+    end
+
+    def to_custom_take_effect
+      DateTimeHelper.to_rfc3339(take_effect)
+    end
+  end
+end

data/lib/verizon/models/service_usage.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ServiceUsage Model.
+  class ServiceUsage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Total requests for the account during the reporting period.
+    # @return [String]
+    attr_accessor :transactions_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['transactions_count'] = 'transactionsCount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        transactions_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, transactions_count = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @transactions_count = transactions_count unless transactions_count == 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
+      transactions_count =
+        hash.key?('transactionsCount') ? hash['transactionsCount'] : SKIP
+
+      # Create object from extracted values.
+      ServiceUsage.new(account_name,
+                       transactions_count)
+    end
+  end
+end

data/lib/verizon/models/session_report.rb

@@ -0,0 +1,81 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Session report for a device.
+  class SessionReport < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object containing the start and end time of the session with the amount
+    # of data transferred.
+    # @return [Array[DailyUsageItem]]
+    attr_accessor :sessions
+
+    # The 10-digit ID of the device.
+    # @return [String]
+    attr_accessor :id
+
+    # A unique string that associates the request with the location report
+    # information that is sent in asynchronous callback message.ThingSpace will
+    # send a separate callback message for each device that was in the request.
+    # All of the callback messages will have the same txid.
+    # @return [String]
+    attr_accessor :txid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sessions'] = 'sessions'
+      @_hash['id'] = 'id'
+      @_hash['txid'] = 'txid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sessions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        txid
+      ]
+    end
+
+    def initialize(id = nil, txid = nil, sessions = SKIP)
+      @sessions = sessions unless sessions == SKIP
+      @id = id
+      @txid = txid
+    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'] : nil
+      txid = hash.key?('txid') ? hash['txid'] : nil
+      # Parameter is an array, so we need to iterate through it
+      sessions = nil
+      unless hash['sessions'].nil?
+        sessions = []
+        hash['sessions'].each do |structure|
+          sessions << (DailyUsageItem.from_hash(structure) if structure)
+        end
+      end
+
+      sessions = SKIP unless hash.key?('sessions')
+
+      # Create object from extracted values.
+      SessionReport.new(id,
+                        txid,
+                        sessions)
+    end
+  end
+end

data/lib/verizon/models/session_report_request.rb

@@ -0,0 +1,101 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request for obtaining a session report.
+  class SessionReportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Device ids.
+    # @return [String]
+    attr_accessor :imei
+
+    # Start date of session to include. If not specified  information will be
+    # shown from the earliest available (180 days). Can be either date in ISO
+    # 8601 format or predefined constants.
+    # @return [String]
+    attr_accessor :start_date
+
+    # End date of session to include. If not specified  information will be
+    # shown to the latest available. Can be either date in ISO 8601 format or
+    # predefined constants.
+    # @return [String]
+    attr_accessor :end_date
+
+    # The Low value of session duration.
+    # @return [Integer]
+    attr_accessor :duration_low
+
+    # The High value of session duration.
+    # @return [Integer]
+    attr_accessor :duration_high
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['imei'] = 'imei'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['duration_low'] = 'durationLow'
+      @_hash['duration_high'] = 'durationHigh'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+        duration_low
+        duration_high
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        duration_low
+        duration_high
+      ]
+    end
+
+    def initialize(account_number = nil, imei = nil, start_date = SKIP,
+                   end_date = SKIP, duration_low = SKIP, duration_high = SKIP)
+      @account_number = account_number
+      @imei = imei
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @duration_low = duration_low unless duration_low == SKIP
+      @duration_high = duration_high unless duration_high == 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_number = hash.key?('accountNumber') ? hash['accountNumber'] : nil
+      imei = hash.key?('imei') ? hash['imei'] : nil
+      start_date = hash.key?('startDate') ? hash['startDate'] : SKIP
+      end_date = hash.key?('endDate') ? hash['endDate'] : SKIP
+      duration_low = hash.key?('durationLow') ? hash['durationLow'] : SKIP
+      duration_high = hash.key?('durationHigh') ? hash['durationHigh'] : SKIP
+
+      # Create object from extracted values.
+      SessionReportRequest.new(account_number,
+                               imei,
+                               start_date,
+                               end_date,
+                               duration_low,
+                               duration_high)
+    end
+  end
+end

data/lib/verizon/models/session_reset_password_request.rb

@@ -0,0 +1,48 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to a new, randomly generated password for the current username.
+  class SessionResetPasswordRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The current password for the username.
+    # @return [String]
+    attr_accessor :old_password
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['old_password'] = 'oldPassword'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(old_password = nil)
+      @old_password = old_password
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      old_password = hash.key?('oldPassword') ? hash['oldPassword'] : nil
+
+      # Create object from extracted values.
+      SessionResetPasswordRequest.new(old_password)
+    end
+  end
+end

data/lib/verizon/models/session_reset_password_result.rb

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