sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/license_device_list.rb

@@ -0,0 +1,69 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # List of all devices.
+  class LicenseDeviceList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # For 4G devices, IMEI (decimal, up to 15 digits).
+    # @return [Array[LicenseDeviceId]]
+    attr_accessor :device_ids
+
+    # For 4G devices, IMEI (decimal, up to 15 digits).
+    # @return [String]
+    attr_accessor :ip_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['ip_address'] = 'ipAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+        ip_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = SKIP,
+                   ip_address = SKIP)
+      @device_ids = device_ids unless device_ids == SKIP
+      @ip_address = ip_address unless ip_address == 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
+      device_ids = nil
+      unless hash['deviceIds'].nil?
+        device_ids = []
+        hash['deviceIds'].each do |structure|
+          device_ids << (LicenseDeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+      ip_address = hash.key?('ipAddress') ? hash['ipAddress'] : SKIP
+
+      # Create object from extracted values.
+      LicenseDeviceList.new(device_ids,
+                            ip_address)
+    end
+  end
+end

data/lib/verizon/models/list_all_service_endpoints_result.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response on successful retrieval of all registered service endpoints.
+  class ListAllServiceEndpointsResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTP status code.
+    # @return [String]
+    attr_accessor :status
+
+    # A comma delimited list of all registered service endpoints.
+    # @return [Array[String]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status = 'success',
+                   data = SKIP)
+      @status = status unless status == 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.
+      status = hash['status'] ||= 'success'
+      data = hash.key?('data') ? hash['data'] : SKIP
+
+      # Create object from extracted values.
+      ListAllServiceEndpointsResult.new(status,
+                                        data)
+    end
+  end
+end

data/lib/verizon/models/list_mec_platforms_result.rb

@@ -0,0 +1,62 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to return the optimal 5G Edge platforms for deployment based on a
+  # region, service profile of the service that you want to deploy or user
+  # equipment.
+  class ListMECPlatformsResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of optimal MEC Platforms where you can register your deployed
+    # application.
+    # @return [Array[MECPlatformResource]]
+    attr_accessor :mec_platforms
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mec_platforms'] = 'MECPlatforms'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mec_platforms
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mec_platforms = SKIP)
+      @mec_platforms = mec_platforms unless mec_platforms == 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
+      mec_platforms = nil
+      unless hash['MECPlatforms'].nil?
+        mec_platforms = []
+        hash['MECPlatforms'].each do |structure|
+          mec_platforms << (MECPlatformResource.from_hash(structure) if structure)
+        end
+      end
+
+      mec_platforms = SKIP unless hash.key?('MECPlatforms')
+
+      # Create object from extracted values.
+      ListMECPlatformsResult.new(mec_platforms)
+    end
+  end
+end

data/lib/verizon/models/list_optimal_service_endpoints_result.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response on successful retrieval of optimal service endpoints for clients.
+  class ListOptimalServiceEndpointsResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of optimal Service Endpoint IDs for clients to connect to.
+    # @return [Array[ResourcesEdgeHostedService]]
+    attr_accessor :service_endpoints
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['service_endpoints'] = 'serviceEndpoints'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        service_endpoints
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(service_endpoints = SKIP)
+      @service_endpoints = service_endpoints unless service_endpoints == 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
+      service_endpoints = nil
+      unless hash['serviceEndpoints'].nil?
+        service_endpoints = []
+        hash['serviceEndpoints'].each do |structure|
+          service_endpoints << (ResourcesEdgeHostedService.from_hash(structure) if structure)
+        end
+      end
+
+      service_endpoints = SKIP unless hash.key?('serviceEndpoints')
+
+      # Create object from extracted values.
+      ListOptimalServiceEndpointsResult.new(service_endpoints)
+    end
+  end
+end

data/lib/verizon/models/list_regions_result.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to return an array of all regions in the Verizon 5G Edge service.
+  # You can use the region IDs from the response to find optimal Edge platforms
+  # or service endpoints.
+  class ListRegionsResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of all regions in the Verizon 5G Edge service.
+    # @return [Array[Region]]
+    attr_accessor :regions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['regions'] = 'regions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        regions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(regions = SKIP)
+      @regions = regions unless regions == 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
+      regions = nil
+      unless hash['regions'].nil?
+        regions = []
+        hash['regions'].each do |structure|
+          regions << (Region.from_hash(structure) if structure)
+        end
+      end
+
+      regions = SKIP unless hash.key?('regions')
+
+      # Create object from extracted values.
+      ListRegionsResult.new(regions)
+    end
+  end
+end

data/lib/verizon/models/list_service_profiles_result.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response on successful retrieval of service profiles.
+  class ListServiceProfilesResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTP status code.
+    # @return [String]
+    attr_accessor :status
+
+    # A comma delimited list of all the service profiles registered under your
+    # API key.
+    # @return [Array[String]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status = SKIP,
+                   data = SKIP)
+      @status = status unless status == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      data = hash.key?('data') ? hash['data'] : SKIP
+
+      # Create object from extracted values.
+      ListServiceProfilesResult.new(status,
+                                    data)
+    end
+  end
+end

data/lib/verizon/models/location.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device location information.
+  class Location < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # MDN.
+    # @return [String]
+    attr_accessor :msid
+
+    # Position data.
+    # @return [PositionData]
+    attr_accessor :pd
+
+    # Position error.
+    # @return [PositionError]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['msid'] = 'msid'
+      @_hash['pd'] = 'pd'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        msid
+        pd
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(msid = SKIP,
+                   pd = SKIP,
+                   error = SKIP)
+      @msid = msid unless msid == SKIP
+      @pd = pd unless pd == SKIP
+      @error = error unless error == 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.
+      msid = hash.key?('msid') ? hash['msid'] : SKIP
+      pd = PositionData.from_hash(hash['pd']) if hash['pd']
+      error = PositionError.from_hash(hash['error']) if hash['error']
+
+      # Create object from extracted values.
+      Location.new(msid,
+                   pd,
+                   error)
+    end
+  end
+end

data/lib/verizon/models/location_report.rb

@@ -0,0 +1,102 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Location information for up to 1,000 devices.
+  class LocationReport < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device location information.
+    # @return [Array[Location]]
+    attr_accessor :dev_location_list
+
+    # True if there are more device locations to retrieve.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # The zero-based number of the first record to return. Set startIndex=0 for
+    # the first request. If there are more than 1,000 devices to be returned
+    # (hasMoreData=true), set startIndex=1000 for the second request, 2000 for
+    # the third request, etc.
+    # @return [String]
+    attr_accessor :start_index
+
+    # The total number of devices in the original request and in the report.
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # The transaction ID of the report.
+    # @return [String]
+    attr_accessor :txid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['dev_location_list'] = 'devLocationList'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['start_index'] = 'startIndex'
+      @_hash['total_count'] = 'totalCount'
+      @_hash['txid'] = 'txid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        dev_location_list
+        has_more_data
+        start_index
+        total_count
+        txid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(dev_location_list = SKIP,
+                   has_more_data = SKIP,
+                   start_index = SKIP,
+                   total_count = SKIP,
+                   txid = SKIP)
+      @dev_location_list = dev_location_list unless dev_location_list == SKIP
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @start_index = start_index unless start_index == SKIP
+      @total_count = total_count unless total_count == SKIP
+      @txid = txid unless txid == 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
+      dev_location_list = nil
+      unless hash['devLocationList'].nil?
+        dev_location_list = []
+        hash['devLocationList'].each do |structure|
+          dev_location_list << (Location.from_hash(structure) if structure)
+        end
+      end
+
+      dev_location_list = SKIP unless hash.key?('devLocationList')
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+      start_index = hash.key?('startIndex') ? hash['startIndex'] : SKIP
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
+      txid = hash.key?('txid') ? hash['txid'] : SKIP
+
+      # Create object from extracted values.
+      LocationReport.new(dev_location_list,
+                         has_more_data,
+                         start_index,
+                         total_count,
+                         txid)
+    end
+  end
+end

data/lib/verizon/models/location_report_status.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Status of the report.
+  class LocationReportStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The transaction ID of the report.
+    # @return [String]
+    attr_accessor :txid
+
+    # Status of the report.
+    # @return [ReportStatusEnum]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['txid'] = 'txid'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        txid
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(txid = SKIP,
+                   status = SKIP)
+      @txid = txid unless txid == 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.
+      txid = hash.key?('txid') ? hash['txid'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      LocationReportStatus.new(txid,
+                               status)
+    end
+  end
+end

data/lib/verizon/models/location_request.rb

@@ -0,0 +1,88 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The body contains the the account name and list of devices that you want to
+  # locate, plus other options.
+  class LocationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # Device list.
+    # @return [Array[DeviceInfo]]
+    attr_accessor :device_list
+
+    # Accurary, currently only 0-coarse supported.
+    # @return [AccuracyModeEnum]
+    attr_accessor :accuracy_mode
+
+    # Location cache mode.
+    # @return [CacheModeEnum]
+    attr_accessor :cache_mode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['device_list'] = 'deviceList'
+      @_hash['accuracy_mode'] = 'accuracyMode'
+      @_hash['cache_mode'] = 'cacheMode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accuracy_mode
+        cache_mode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   device_list = nil,
+                   accuracy_mode = SKIP,
+                   cache_mode = SKIP)
+      @account_name = account_name
+      @device_list = device_list
+      @accuracy_mode = accuracy_mode unless accuracy_mode == SKIP
+      @cache_mode = cache_mode unless cache_mode == 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
+      # Parameter is an array, so we need to iterate through it
+      device_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (DeviceInfo.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+      accuracy_mode = hash.key?('accuracyMode') ? hash['accuracyMode'] : SKIP
+      cache_mode = hash.key?('cacheMode') ? hash['cacheMode'] : SKIP
+
+      # Create object from extracted values.
+      LocationRequest.new(account_name,
+                          device_list,
+                          accuracy_mode,
+                          cache_mode)
+    end
+  end
+end