sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/mec_performance_metrics.rb

@@ -0,0 +1,88 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to query the most recent data for Key Performance Indicators (KPIs)
+  # like network availability, MEC hostnames and more.
+  class MECPerformanceMetrics < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Success or Failed.
+    # @return [String]
+    attr_accessor :query_status
+
+    # Timestamp of the query's start, format:mm/dd/yyyy,hr:min:sec.
+    # @return [String]
+    attr_accessor :start
+
+    # Timestamp of the query's end , format:mm/dd/yyyy, hr:min:sec.
+    # @return [String]
+    attr_accessor :mend
+
+    # MEC performance query result.
+    # @return [Array[MECPerformanceQueryResult]]
+    attr_accessor :query_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['query_status'] = 'QueryStatus'
+      @_hash['start'] = 'Start'
+      @_hash['mend'] = 'End'
+      @_hash['query_result'] = 'QueryResult'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        query_status
+        start
+        mend
+        query_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(query_status = SKIP, start = SKIP, mend = SKIP,
+                   query_result = SKIP)
+      @query_status = query_status unless query_status == SKIP
+      @start = start unless start == SKIP
+      @mend = mend unless mend == SKIP
+      @query_result = query_result unless query_result == 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.
+      query_status = hash.key?('QueryStatus') ? hash['QueryStatus'] : SKIP
+      start = hash.key?('Start') ? hash['Start'] : SKIP
+      mend = hash.key?('End') ? hash['End'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      query_result = nil
+      unless hash['QueryResult'].nil?
+        query_result = []
+        hash['QueryResult'].each do |structure|
+          query_result << (MECPerformanceQueryResult.from_hash(structure) if structure)
+        end
+      end
+
+      query_result = SKIP unless hash.key?('QueryResult')
+
+      # Create object from extracted values.
+      MECPerformanceMetrics.new(query_status,
+                                start,
+                                mend,
+                                query_result)
+    end
+  end
+end

data/lib/verizon/models/mec_performance_query_result.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Result of the query for obtaining MEC performance metrics.
+  class MECPerformanceQueryResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the parameter.
+    # @return [String]
+    attr_accessor :name
+
+    # Parameter values.
+    # @return [Array[String]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, data = SKIP)
+      @name = name unless name == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      data = hash.key?('data') ? hash['data'] : SKIP
+
+      # Create object from extracted values.
+      MECPerformanceQueryResult.new(name,
+                                    data)
+    end
+  end
+end

data/lib/verizon/models/mec_platform_resource.rb

@@ -0,0 +1,92 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # 5G Edge platform used for deployment of a service. The ern of each platform
+  # contains the name of the matching AWS Wavelength zone that can be used when
+  # deploying.
+  class MECPlatformResource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Edge Resource Name. A string identifier for a set of edge resources.
+    # @return [String]
+    attr_accessor :ern
+
+    # Unique identifier representing a zone. *Note:* This will have a null value
+    # as a placeholder.
+    # @return [String]
+    attr_accessor :zone
+
+    # MEC region name. Current valid values are US_WEST_2 and US_EAST_1.
+    # @return [String]
+    attr_accessor :region
+
+    # Status of the MEC Platform (default is 'unknown')
+    # @return [MECPlatformStatusEnum]
+    attr_accessor :status
+
+    # Status of the MEC Platform (default is 'unknown')
+    # @return [Object]
+    attr_accessor :properties
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ern'] = 'ern'
+      @_hash['zone'] = 'zone'
+      @_hash['region'] = 'region'
+      @_hash['status'] = 'status'
+      @_hash['properties'] = 'properties'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ern
+        zone
+        region
+        status
+        properties
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        zone
+      ]
+    end
+
+    def initialize(ern = SKIP, zone = SKIP, region = SKIP,
+                   status = MECPlatformStatusEnum::UNKNOWN, properties = SKIP)
+      @ern = ern unless ern == SKIP
+      @zone = zone unless zone == SKIP
+      @region = region unless region == SKIP
+      @status = status unless status == SKIP
+      @properties = properties unless properties == 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.
+      ern = hash.key?('ern') ? hash['ern'] : SKIP
+      zone = hash.key?('zone') ? hash['zone'] : SKIP
+      region = hash.key?('region') ? hash['region'] : SKIP
+      status = hash['status'] ||= MECPlatformStatusEnum::UNKNOWN
+      properties = hash.key?('properties') ? hash['properties'] : SKIP
+
+      # Create object from extracted values.
+      MECPlatformResource.new(ern,
+                              zone,
+                              region,
+                              status,
+                              properties)
+    end
+  end
+end

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,59 @@
+# 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/mismatched_device.rb

@@ -0,0 +1,108 @@
+# 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,133 @@
+# 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