specs-sdk 1.3.0

data/lib/verizon/models/mec_platform_status_enum.rb

@@ -0,0 +1,26 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Status of the MEC Platform (default is 'unknown')
+  class MECPlatformStatusEnum
+    MEC_PLATFORM_STATUS_ENUM = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'Active'.freeze,
+
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'Inactive'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MEC_PLATFORM_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/mec_platforms_additional_support_info.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Additional service support information for the MEC platform.
+  class MECPlatformsAdditionalSupportInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of additional service support information for the MEC platform.
+    # @return [String]
+    attr_accessor :type
+
+    # Data about additional service support information for the MEC platform.
+    # @return [MECPlatformsAdditionalSupportInfoData]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP,
+                   data = SKIP)
+      @type = type unless type == SKIP
+      @data = data unless data == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      data = MECPlatformsAdditionalSupportInfoData.from_hash(hash['data']) if hash['data']
+
+      # Create object from extracted values.
+      MECPlatformsAdditionalSupportInfo.new(type,
+                                            data)
+    end
+  end
+end

data/lib/verizon/models/mec_platforms_additional_support_info_data.rb

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

data/lib/verizon/models/mec_profile.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # MECProfile Model.
+  class MECProfile < 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.
+      MECProfile.new(profile_id,
+                     profile_name)
+    end
+  end
+end

data/lib/verizon/models/mec_profile_list.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # MECProfileList Model.
+  class MECProfileList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[MECProfile]]
+    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 << (MECProfile.from_hash(structure) if structure)
+        end
+      end
+
+      profiles = SKIP unless hash.key?('profiles')
+
+      # Create object from extracted values.
+      MECProfileList.new(profiles)
+    end
+  end
+end

data/lib/verizon/models/mismatched_device.rb

@@ -0,0 +1,112 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # 4G devices with an ICCID (SIM) that was not activated with the expected IMEI
+  # (hardware) during a specified time frame.
+  class MismatchedDevice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account that the device is associated with.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The assigned phone number of the device.
+    # @return [String]
+    attr_accessor :mdn
+
+    # The date and time when the SIM was last activated.
+    # @return [String]
+    attr_accessor :activation_date
+
+    # The ID of the SIM.
+    # @return [String]
+    attr_accessor :iccid
+
+    # The IMEI of the device prior to the SIM OTA activation on simOtaDate.
+    # @return [String]
+    attr_accessor :pre_imei
+
+    # The IMEI of the device after the SIM OTA activation on simOtaDate.
+    # @return [String]
+    attr_accessor :post_imei
+
+    # The date and time of the SIM OTA activation.
+    # @return [String]
+    attr_accessor :sim_ota_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['mdn'] = 'mdn'
+      @_hash['activation_date'] = 'activationDate'
+      @_hash['iccid'] = 'iccid'
+      @_hash['pre_imei'] = 'preImei'
+      @_hash['post_imei'] = 'postImei'
+      @_hash['sim_ota_date'] = 'simOtaDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        mdn
+        activation_date
+        iccid
+        pre_imei
+        post_imei
+        sim_ota_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   mdn = SKIP,
+                   activation_date = SKIP,
+                   iccid = SKIP,
+                   pre_imei = SKIP,
+                   post_imei = SKIP,
+                   sim_ota_date = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @mdn = mdn unless mdn == SKIP
+      @activation_date = activation_date unless activation_date == SKIP
+      @iccid = iccid unless iccid == SKIP
+      @pre_imei = pre_imei unless pre_imei == SKIP
+      @post_imei = post_imei unless post_imei == SKIP
+      @sim_ota_date = sim_ota_date unless sim_ota_date == 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
+      mdn = hash.key?('mdn') ? hash['mdn'] : SKIP
+      activation_date =
+        hash.key?('activationDate') ? hash['activationDate'] : SKIP
+      iccid = hash.key?('iccid') ? hash['iccid'] : SKIP
+      pre_imei = hash.key?('preImei') ? hash['preImei'] : SKIP
+      post_imei = hash.key?('postImei') ? hash['postImei'] : SKIP
+      sim_ota_date = hash.key?('simOtaDate') ? hash['simOtaDate'] : SKIP
+
+      # Create object from extracted values.
+      MismatchedDevice.new(account_name,
+                           mdn,
+                           activation_date,
+                           iccid,
+                           pre_imei,
+                           post_imei,
+                           sim_ota_date)
+    end
+  end
+end

data/lib/verizon/models/move_device_request.rb

@@ -0,0 +1,137 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to move active devices from one billing account to another within a
+  # customer profile.
+  class MoveDeviceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the billing account that you want to move the devices to.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Specify the kind of the device identifier, the type of match, and the
+    # string that you want to match.
+    # @return [DeviceFilter]
+    attr_accessor :filter
+
+    # Custom field names and values, if you want to only include devices that
+    # have matching values.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # Up to 10,000 devices that you want to move to a different account,
+    # specified by device identifier.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # The name of a device group, to only include devices in that group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The pool from which device IP addresses will be derived in the new
+    # account. If you do not include this element, the default pool will be
+    # used.
+    # @return [String]
+    attr_accessor :carrier_ip_pool_name
+
+    # The service plan code that you want to assign to the devices in the new
+    # account. If you do not include this element, ThingSpace will attempt to
+    # use the current service plan, which will result in a error if the new
+    # account does not 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['filter'] = 'filter'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['devices'] = 'devices'
+      @_hash['group_name'] = 'groupName'
+      @_hash['carrier_ip_pool_name'] = 'carrierIpPoolName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filter
+        custom_fields
+        devices
+        group_name
+        carrier_ip_pool_name
+        service_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   filter = SKIP,
+                   custom_fields = SKIP,
+                   devices = SKIP,
+                   group_name = SKIP,
+                   carrier_ip_pool_name = SKIP,
+                   service_plan = SKIP)
+      @account_name = account_name
+      @filter = filter unless filter == 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
+      @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
+      filter = DeviceFilter.from_hash(hash['filter']) if hash['filter']
+      # 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
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+
+      # Create object from extracted values.
+      MoveDeviceRequest.new(account_name,
+                            filter,
+                            custom_fields,
+                            devices,
+                            group_name,
+                            carrier_ip_pool_name,
+                            service_plan)
+    end
+  end
+end

data/lib/verizon/models/network_resources_type.rb

@@ -0,0 +1,98 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Network resources of a service profile.
+  class NetworkResourcesType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Minimum required connection bandwidth in Kbit/s for the application.
+    # @return [Integer]
+    attr_accessor :min_bandwidth_kbits
+
+    # Indicates if service continuity support is required or not for the
+    # application.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :service_continuity_support
+
+    # Maximum request rate that the application can handle.
+    # @return [Integer]
+    attr_accessor :max_request_rate
+
+    # Maximum response time or latency that the application can handle, in
+    # milliseconds. Note: this value must be in multiples of 5.
+    # @return [Integer]
+    attr_accessor :max_latency_ms
+
+    # Minimum availability required for the server.
+    # @return [Integer]
+    attr_accessor :min_availability
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['min_bandwidth_kbits'] = 'minBandwidthKbits'
+      @_hash['service_continuity_support'] = 'serviceContinuitySupport'
+      @_hash['max_request_rate'] = 'maxRequestRate'
+      @_hash['max_latency_ms'] = 'maxLatencyMs'
+      @_hash['min_availability'] = 'minAvailability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        min_bandwidth_kbits
+        service_continuity_support
+        max_request_rate
+        min_availability
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(max_latency_ms = nil,
+                   min_bandwidth_kbits = SKIP,
+                   service_continuity_support = SKIP,
+                   max_request_rate = SKIP,
+                   min_availability = SKIP)
+      @min_bandwidth_kbits = min_bandwidth_kbits unless min_bandwidth_kbits == SKIP
+      unless service_continuity_support == SKIP
+        @service_continuity_support =
+          service_continuity_support
+      end
+      @max_request_rate = max_request_rate unless max_request_rate == SKIP
+      @max_latency_ms = max_latency_ms
+      @min_availability = min_availability unless min_availability == 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.
+      max_latency_ms = hash.key?('maxLatencyMs') ? hash['maxLatencyMs'] : nil
+      min_bandwidth_kbits =
+        hash.key?('minBandwidthKbits') ? hash['minBandwidthKbits'] : SKIP
+      service_continuity_support =
+        hash.key?('serviceContinuitySupport') ? hash['serviceContinuitySupport'] : SKIP
+      max_request_rate =
+        hash.key?('maxRequestRate') ? hash['maxRequestRate'] : SKIP
+      min_availability =
+        hash.key?('minAvailability') ? hash['minAvailability'] : SKIP
+
+      # Create object from extracted values.
+      NetworkResourcesType.new(max_latency_ms,
+                               min_bandwidth_kbits,
+                               service_continuity_support,
+                               max_request_rate,
+                               min_availability)
+    end
+  end
+end

data/lib/verizon/models/network_type.rb

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