sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/provhistory_request.rb

@@ -0,0 +1,104 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # ProvhistoryRequest Model.
+  class ProvhistoryRequest < 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[GIODeviceId]]
+    attr_accessor :device_filter
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :earliest
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :latest
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['device_filter'] = 'deviceFilter'
+      @_hash['earliest'] = 'earliest'
+      @_hash['latest'] = 'latest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        device_filter
+        earliest
+        latest
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, device_filter = SKIP, earliest = SKIP,
+                   latest = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @device_filter = device_filter unless device_filter == SKIP
+      @earliest = earliest unless earliest == SKIP
+      @latest = latest unless latest == 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
+      # Parameter is an array, so we need to iterate through it
+      device_filter = nil
+      unless hash['deviceFilter'].nil?
+        device_filter = []
+        hash['deviceFilter'].each do |structure|
+          device_filter << (GIODeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_filter = SKIP unless hash.key?('deviceFilter')
+      earliest = if hash.key?('earliest')
+                   (DateTimeHelper.from_rfc3339(hash['earliest']) if hash['earliest'])
+                 else
+                   SKIP
+                 end
+      latest = if hash.key?('latest')
+                 (DateTimeHelper.from_rfc3339(hash['latest']) if hash['latest'])
+               else
+                 SKIP
+               end
+
+      # Create object from extracted values.
+      ProvhistoryRequest.new(account_name,
+                             device_filter,
+                             earliest,
+                             latest)
+    end
+
+    def to_custom_earliest
+      DateTimeHelper.to_rfc3339(earliest)
+    end
+
+    def to_custom_latest
+      DateTimeHelper.to_rfc3339(latest)
+    end
+  end
+end

data/lib/verizon/models/provisioning_history.rb

@@ -0,0 +1,125 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The provisioning history of a specified device during a specified time
+  # period.
+  class ProvisioningHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time when the provisioning event occured.
+    # @return [String]
+    attr_accessor :occurred_at
+
+    # The success or failure of the provisioning event.
+    # @return [String]
+    attr_accessor :status
+
+    # The user who performed the provisioning event.
+    # @return [String]
+    attr_accessor :event_by
+
+    # The provisioning action:Activate,Suspend,Restore,Deactivate,Device Move.
+    # @return [String]
+    attr_accessor :event_type
+
+    # The MDN assigned to the device after the provisioning event.
+    # @return [String]
+    attr_accessor :mdn
+
+    # The MSISDN assigned to the device after the provisioning event.
+    # @return [String]
+    attr_accessor :msisdn
+
+    # The service plan of the device after the provisioning event occurred.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # Any extended attributes for the event, as Key and Value pairs.
+    # @return [Array[CustomFields]]
+    attr_accessor :extended_attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['occurred_at'] = 'occurredAt'
+      @_hash['status'] = 'status'
+      @_hash['event_by'] = 'eventBy'
+      @_hash['event_type'] = 'eventType'
+      @_hash['mdn'] = 'mdn'
+      @_hash['msisdn'] = 'msisdn'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        occurred_at
+        status
+        event_by
+        event_type
+        mdn
+        msisdn
+        service_plan
+        extended_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(occurred_at = SKIP, status = SKIP, event_by = SKIP,
+                   event_type = SKIP, mdn = SKIP, msisdn = SKIP,
+                   service_plan = SKIP, extended_attributes = SKIP)
+      @occurred_at = occurred_at unless occurred_at == SKIP
+      @status = status unless status == SKIP
+      @event_by = event_by unless event_by == SKIP
+      @event_type = event_type unless event_type == SKIP
+      @mdn = mdn unless mdn == SKIP
+      @msisdn = msisdn unless msisdn == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == 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.
+      occurred_at = hash.key?('occurredAt') ? hash['occurredAt'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      event_by = hash.key?('eventBy') ? hash['eventBy'] : SKIP
+      event_type = hash.key?('eventType') ? hash['eventType'] : SKIP
+      mdn = hash.key?('mdn') ? hash['mdn'] : SKIP
+      msisdn = hash.key?('msisdn') ? hash['msisdn'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : 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')
+
+      # Create object from extracted values.
+      ProvisioningHistory.new(occurred_at,
+                              status,
+                              event_by,
+                              event_type,
+                              mdn,
+                              msisdn,
+                              service_plan,
+                              extended_attributes)
+    end
+  end
+end

data/lib/verizon/models/provisioning_status_filter_enum.rb

@@ -0,0 +1,62 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The last status of the device as a list filter.
+  class ProvisioningStatusFilterEnum
+    PROVISIONING_STATUS_FILTER_ENUM = [
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze,
+
+      # TODO: Write general description for DEACTIVATED
+      DEACTIVATED = 'DEACTIVATED'.freeze,
+
+      # TODO: Write general description for ACTIVATED
+      ACTIVATED = 'ACTIVATED'.freeze,
+
+      # TODO: Write general description for DEACTIVE
+      DEACTIVE = 'DEACTIVE'.freeze,
+
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for SUSPEND
+      SUSPEND = 'SUSPEND'.freeze,
+
+      # TODO: Write general description for PENDING_ACTIVATION
+      PENDING_ACTIVATION = 'PENDING_ACTIVATION'.freeze,
+
+      # TODO: Write general description for PENDING_DEACTIVATION
+      PENDING_DEACTIVATION = 'PENDING_DEACTIVATION'.freeze,
+
+      # TODO: Write general description for PRE_ACTIVE
+      PRE_ACTIVE = 'PRE_ACTIVE'.freeze,
+
+      # TODO: Write general description for ACTIVATION_READY
+      ACTIVATION_READY = 'ACTIVATION_READY'.freeze,
+
+      # TODO: Write general description for INVENTORY
+      INVENTORY = 'INVENTORY'.freeze,
+
+      # TODO: Write general description for PURGED
+      PURGED = 'PURGED'.freeze,
+
+      # TODO: Write general description for REPLACED
+      REPLACED = 'REPLACED'.freeze,
+
+      # TODO: Write general description for RETIRED
+      RETIRED = 'RETIRED'.freeze,
+
+      # TODO: Write general description for TEST_READY
+      TEST_READY = 'TEST_READY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROVISIONING_STATUS_FILTER_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/pwn_device_id.rb

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

data/lib/verizon/models/pwn_device_list.rb

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

data/lib/verizon/models/pwn_profile.rb

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

data/lib/verizon/models/pwn_profile_list.rb

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

data/lib/verizon/models/qos_device_id.rb

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

data/lib/{verizon_thing_space_quality_of_service_api_endpoints/models/device_info.rb → verizon/models/qos_device_info.rb}

@@ -1,24 +1,23 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
-  # DeviceInfo Model.
-  class DeviceInfo < BaseModel
+module Verizon
+  # QosDeviceInfo Model.
+  class QosDeviceInfo < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # device identifiers consisting of an ID value and what that value
-    # represents (kind)
-    # @return [DeviceId]
+    # TODO: Write general description for this method
+    # @return [QosDeviceId]
     attr_accessor :device_id
 
-    # the IPv6 IP address of the device
+    # TODO: Write general description for this method
     # @return [String]
     attr_accessor :device_i_pv6_addr
 
-    # The details of the data connection
+    # TODO: Write general description for this method
     # @return [Array[FlowInfo]]
     attr_accessor :flow_info
 
@@ -34,9 +33,7 @@ module VerizonThingSpaceQualityOfServiceApiEndpoints
     # An array for optional fields
     def self.optionals
       %w[
-        device_id
         device_i_pv6_addr
-        flow_info
       ]
     end
 
@@ -45,10 +42,10 @@ module VerizonThingSpaceQualityOfServiceApiEndpoints
       []
     end
 
-    def initialize(device_id = SKIP, device_i_pv6_addr = SKIP, flow_info = SKIP)
-      @device_id = device_id unless device_id == SKIP
+    def initialize(device_id = nil, flow_info = nil, device_i_pv6_addr = SKIP)
+      @device_id = device_id
       @device_i_pv6_addr = device_i_pv6_addr unless device_i_pv6_addr == SKIP
-      @flow_info = flow_info unless flow_info == SKIP
+      @flow_info = flow_info
     end
 
     # Creates an instance of the object from a hash.
@@ -56,9 +53,7 @@ module VerizonThingSpaceQualityOfServiceApiEndpoints
       return nil unless hash
 
       # Extract variables from the hash.
-      device_id = DeviceId.from_hash(hash['deviceId']) if hash['deviceId']
-      device_i_pv6_addr =
-        hash.key?('deviceIPv6Addr') ? hash['deviceIPv6Addr'] : SKIP
+      device_id = QosDeviceId.from_hash(hash['deviceId']) if hash['deviceId']
       # Parameter is an array, so we need to iterate through it
       flow_info = nil
       unless hash['flowInfo'].nil?
@@ -68,12 +63,14 @@ module VerizonThingSpaceQualityOfServiceApiEndpoints
         end
       end
 
-      flow_info = SKIP unless hash.key?('flowInfo')
+      flow_info = nil unless hash.key?('flowInfo')
+      device_i_pv6_addr =
+        hash.key?('deviceIPv6Addr') ? hash['deviceIPv6Addr'] : SKIP
 
       # Create object from extracted values.
-      DeviceInfo.new(device_id,
-                     device_i_pv6_addr,
-                     flow_info)
+      QosDeviceInfo.new(device_id,
+                        flow_info,
+                        device_i_pv6_addr)
     end
   end
 end